Service | Microsoft Docs article | Related commit history on GitHub | Change details |
---|---|---|---|
v1.0 | Accesspackage Delete Incompatibleaccesspackage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackage-delete-incompatibleaccesspackage.md | DELETE https://graph.microsoft.com/beta/identityGovernance/entitlementManagement [!INCLUDE [sample-code](../includes/snippets/php/remove-incompatibleaccesspackage-from-accesspackage-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/remove-incompatibleaccesspackage-from-accesspackage-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Accesspackage Delete Incompatiblegroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackage-delete-incompatiblegroup.md | DELETE https://graph.microsoft.com/beta/identityGovernance/entitlementManagement [!INCLUDE [sample-code](../includes/snippets/php/remove-incompatiblegroup-from-accesspackage-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/remove-incompatiblegroup-from-accesspackage-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Accesspackage Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackage-delete.md | Namespace: microsoft.graph Delete an [accessPackage](../resources/accesspackage.md) object. -You can't delete an access package if it has any **accessPackageAssignment**. To delete the access package, first [query if there are any assignments](entitlementmanagement-list-accesspackageassignments.md) with a filter to indicate the specific access package, such as: `$filter=accessPackage/id eq 'a914b616-e04e-476b-aa37-91038f0b165b'`. For more information on how to remove assignments that are still in the delivered state, see [Remove an assignment](entitlementmanagement-post-accesspackageassignmentrequests.md#example-4-remove-an-assignment). +You can't delete an access package if it has any **accessPackageAssignment**. To delete the access package, first [query if there are any assignments](entitlementmanagement-list-accesspackageassignments.md) with a filter to indicate the specific access package, such as: `$filter=accessPackage/id eq 'a914b616-e04e-476b-aa37-91038f0b165b'`. For more information on how to remove assignments that are still in the delivered state, see [Remove an assignment](entitlementmanagement-post-accesspackageassignmentrequests.md#example-2-remove-an-assignment). [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Accesspackage Post Accesspackageresourcerolescopes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackage-post-accesspackageresourcerolescopes.md | Content-type: application/json "section": "documentation", "tocPath": "" }-->+++### Example 3: Add a Microsoft Entra role as a resource in an access package ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_accesspackageresourcerolescope_role_accesspackage" +}--> ++```http +POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackages/{id}/accessPackageResourceRoleScopes +Content-type: application/json ++{ + "role": { + "originId": "Eligible", + "displayName": "Eligible Member", + "originSystem": "DirectoryRole", + "resource": { + "id": "ea036095-57a6-4c90-a640-013edf151eb1" + } + }, + "scope": { + "description": "Root Scope", + "displayName": "Root", + "isRootScope": true, + "originSystem": "DirectoryRole", + "originId": "c4e39bd9-1100-46d3-8c65-fb160da0071f" + } +} +``` ++# [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.accessPackageResourceRoleScope" +} --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "id": "ea036095-57a6-4c90-a640-013edf151eb1_c4e39bd9-1100-46d3-8c65-fb160da0071f", + "createdDateTime": "2023-06-28T01:19:48.4216782Z" +} +``` |
v1.0 | Accesspackageresource Refresh | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackageresource-refresh.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -In [Azure AD entitlement management](../resources/entitlementmanagement-overview.md), refresh the [accessPackageResource](../resources/accesspackageresource.md) object to fetch the latest details for **displayName**, **description**, and **resourceType** from the origin system. For the `AadApplication` originSystem, this operation also updates the **displayName** and **description** for the [accessPackageResourceRole](../resources/accesspackageresourcerole.md). +In [Microsoft Entra entitlement management](../resources/entitlementmanagement-overview.md), refresh the [accessPackageResource](../resources/accesspackageresource.md) object to fetch the latest details for **displayName**, **description**, and **resourceType** from the origin system. For the `AadApplication` originSystem, this operation also updates the **displayName** and **description** for the [accessPackageResourceRole](../resources/accesspackageresourcerole.md). |
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 one of the following directory roles. To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): -+ Global Administrator +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 |
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)] -When calling on behalf of a user, the user needs to belong to the [Global Administrator](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) directory role. +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 List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-list-members.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_list_members" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-list-members-permissions.md)] + > [!NOTE]-> To view the members with a hidden membership in an administrative unit, the app must be granted the `Member.Read.Hidden` delegated or application permission. +> To view the members with a hidden membership in an administrative unit, the app must be granted the *Member.Read.Hidden* delegated or application permission. [!INCLUDE [rbac-admin-units-apis-read](../includes/rbac-for-apis/rbac-admin-units-apis-read.md)] - ## HTTP request ```http |
v1.0 | Administrativeunit Post Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-post-members.md | The following table shows the properties of the [group](../resources/group.md) r |:|:--|:-| | displayName | string | The name to display in the address book for the group. Required. | | description | string | A description for the group. Optional. |-| isAssignableToRole | Boolean | Set to **true** to enable the group to be assigned to a Microsoft Entra role. Only Privileged Role Administrator and Global Administrator can set the value of this property. Optional. | +| isAssignableToRole | Boolean | Set to **true** to enable the group to be assigned to a Microsoft Entra role. Privileged Role Administrator is the least privileged role to set the value of this property. Optional. | | mailEnabled | boolean | Set to **true** for mail-enabled groups. Required. | | mailNickname | string | The mail alias for the group. These characters cannot be used in the mailNickName: `@()\[]";:.<>,SPACE`. Required. | | securityEnabled | boolean | Set to **true** for security-enabled groups, including Microsoft 365 groups. Required. | |
v1.0 | Administrativeunit Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-update.md | 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)] -To update an administrative unit, the calling principal must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Privileged Role Administrator -* Global Administrator +To update 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 | Appcatalogs List Teamsapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appcatalogs-list-teamsapps.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog.-It includes apps from the Microsoft Teams store, and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request. ++This includes apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request. > [!NOTE] > In general, the **id** of a **teamsApp** resource is generated by the server. It is not the same as the **id** specified in a Teams app manifest, unless its **distributionMethod** is `store`. For other cases, the **id** provided by the developer as part of the Teams app manifest is stamped as the **externalId** in the **teamsApp** resource. Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "appcatalogs_list_teamsapps" } --> [!INCLUDE [permissions-table](../includes/permissions/appcatalogs-list-teamsapps-permissions.md)] -> **Note**: -The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. +> [!NOTE] +> The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. ## HTTP request Content-Type: application/json ### Example 4: List applications with a given ID, and return the submission review state -The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the submission review state of the app. `Submitted` means the review is pending, `published` means the admin approved the app, and `rejected` means the the admin rejected the app. +The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the submission review state of the app. `Submitted` means the review is pending, `published` means the admin approved the app, and `rejected` means the admin rejected app. #### Request |
v1.0 | Application Addpassword | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-addpassword.md | Title: "application: addPassword" description: "Add a strong password to an application." ms.localizationpriority: medium-+ doc_type: "apiPageType" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Adds a strong password to an [application](../resources/application.md). +Adds a strong password to an [application](../resources/application.md). You can also [add passwords while creating the application](../api/application-post-applications.md#example-2-create-a-new-application-and-add-a-password-secret). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] POST /applications(appId='{appId}')/addPassword In the request body, provide an optional `passwordCredential` object with the following properties. -| Property | Type |Description| +| Property | Type |Description| |:|:--|:-| | displayName | String | Friendly name for the password. Optional. | | endDateTime | DateTimeOffset | The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Optional. The default value is "startDateTime + 2 years". | |
v1.0 | Application List Extensionproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-list-extensionproperty.md | Title: "List extensionProperties (directory extensions)" description: "Retrieve a list of directory extension definitions." ms.localizationpriority: medium + doc_type: "apiPageType" |
v1.0 | Application Post Applications | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-applications.md | Namespace: microsoft.graph Create a new [application](../resources/application.md) object. > [!IMPORTANT]-> Adding [**passwordCredential**](../resources/passwordcredential.md) when creating applications is not supported. Use the [addPassword](application-addpassword.md) method to add passwords or secrets for an application. > > Do not share application client IDs (**appId**) in API documentation or code samples. In the request body, supply a JSON representation of [application](../resources/ If successful, this method returns `201 Created` response code and an [application](../resources/application.md) object in the response body. ## Examples-### Request ++### Example 1: Create an application with the default settings ++#### Request The following example shows a request. # [HTTP](#tab/http) Content-type: application/json -### Response +#### Response The following example shows the response. > **Note:** The response object shown here might be shortened for readability. Content-type: application/json } ``` +### Example 2: Create a new application and add a password secret ++#### Request +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_application_with_passwordcredentials" +}--> +```http +POST https://graph.microsoft.com/beta/applications +Content-type: application/json ++{ + "displayName": "MyAppName", + "passwordCredentials": [ + { + "displayName": "Password name" + } + ] +} +``` ++# [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 **secretText** property in the response object contains the strong passwords or secret generated by Microsoft Entra ID and is 16-64 characters in length. There is no way to retrieve this password in the future. ++> **Note**: The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.passwordCredential" +} --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications/$entity", + "id": "83ab4737-da9d-4084-86f2-f8fbec220647", + "deletedDateTime": null, + "appId": "9519e58c-bd06-4120-a7fd-2220d4de8409", + "applicationTemplateId": null, + "disabledByMicrosoftStatus": null, + "createdDateTime": "2024-04-01T19:10:02.6626202Z", + "displayName": "MyAppName", + "description": null, + "keyCredentials": [], + "parentalControlSettings": { + "countriesBlockedForMinors": [], + "legalAgeGroupRule": "Allow" + }, + "passwordCredentials": [ + { + "customKeyIdentifier": null, + "displayName": "Password name", + "endDateTime": "2026-04-01T19:10:02.6576213Z", + "hint": "puE", + "keyId": "09a0c91a-1bc3-4eaf-a945-c88c041fad6c", + "secretText": "1234567890abcdefghijklmnopqrstuvwxyzabcd", + "startDateTime": "2024-04-01T19:10:02.6576213Z" + } + ], + "publicClient": { + "redirectUris": [] + } +} +``` + <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!-- |
v1.0 | Application Post Calls | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-calls.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "application_post_calls" } --> [!INCLUDE [permissions-table](../includes/permissions/application-post-calls-permissions.md)] -> **Notes:** -> - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table. -> - Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. +> [!NOTE] > - The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).+> - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table. ++Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Application Post Extensionproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-extensionproperty.md | Title: "Create extensionProperty (directory extension)" description: "Create a new directory extension." ms.localizationpriority: medium + doc_type: "apiPageType" |
v1.0 | Application Post Onlinemeetings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-onlinemeetings.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "application_post_onlinemeetings" } --> [!INCLUDE [permissions-table](../includes/permissions/application-post-onlinemeetings-permissions.md)] -To use the OnlineMeetings.ReadWrite.All application permission for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and grant it to a user to authorize the app configured in the policy to create online meetings on behalf of that user (with user ID specified in the request path). +> [!NOTE] +> To use the OnlineMeetings.ReadWrite.All application permission for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and grant it to a user to authorize the app configured in the policy to create online meetings on behalf of that user (with user ID specified in the request path). ## HTTP request POST /users/{userId}/onlineMeetings ``` > [!NOTE]->- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy). +>- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more information, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy). ## Request headers |
v1.0 | Application Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-update.md | In the request body, supply the values for relevant fields that should be update | spa | [spaApplication](../resources/spaapplication.md) | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. | | 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 encrypts all the tokens it emits by using the key this property points to. 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. |+| uniqueName | String | The unique identifier that can be assigned to an application and used as an alternate key. Can updated only if `null` and is immutable once set. | | uniqueName | String | The unique identifier that can be assigned to an application as an alternative identifier. Immutable. Read-only. | | web | [webApplication](../resources/webapplication.md) | Specifies settings for a web application. | | spa | [spaApplication](../resources/spaapplication.md) | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. | |
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 | Applicationtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/applicationtemplate-get.md | Namespace: microsoft.graph Retrieve the properties of an [applicationTemplate](../resources/applicationtemplate.md) object. ## Permissions |
v1.0 | Applicationtemplate Instantiate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/applicationtemplate-instantiate.md | Add an instance of an application from the [Microsoft Entra application gallery] 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. ## Permissions |
v1.0 | Applicationtemplate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/applicationtemplate-list.md | Namespace: microsoft.graph Retrieve a list of [applicationTemplate](../resources/applicationtemplate.md) objects from the Microsoft Entra application gallery. ## Permissions |
v1.0 | Assignedcomputeinstancedetails Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/assignedcomputeinstancedetails-get.md | description: "Read the properties and relationships of an assignedComputeInstanc ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Attacksimulationroot Delete Trainingcampaigns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attacksimulationroot-delete-trainingcampaigns.md | + + Title: "Delete trainingCampaign" +description: "Delete a trainingCampaign object." ++ms.localizationpriority: medium +++# Delete trainingCampaign ++Namespace: microsoft.graph +++Delete a [trainingCampaign](../resources/trainingcampaign.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": "attacksimulationroot_delete_trainingcampaigns" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/$ref +``` ++## 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_trainingcampaign" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/{trainingCampaignId} +``` ++# [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 +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Attacksimulationroot List Trainingcampaigns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attacksimulationroot-list-trainingcampaigns.md | + + Title: "List trainingCampaign objects" +description: "Get a list of trainingCampaign objects and their properties." ++ms.localizationpriority: medium +++# List trainingCampaign objects ++Namespace: microsoft.graph +++Get a list of [trainingCampaign](../resources/trainingcampaign.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": "attacksimulationroot_list_trainingcampaigns" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/trainingCampaigns +``` ++## Optional query parameters ++This method supports the `$count`, `$filter`, `$orderby`, `$skipToken`, `$top`, and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. You can use the `$filter` and `$orderby` query parameters on the **campaignSchedule/completionDateTime**, **displayName**, **campaignSchedule/launchDateTime**, and **campaignSchedule/status** properties. ++If the result set spans multiple pages, the response body contains an `@odata.nextLink` that you can use to page through the result set. ++The following list shows some examples of requests that use the supported OData query parameters: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/trainingCampaigns?$count=true +GET /security/attackSimulation/trainingCampaigns?$filter={property} eq '{property-value}' +GET /security/attackSimulation/trainingCampaigns?$filter={property} eq '{property-value}'&$top=5 +GET /security/attackSimulation/trainingCampaigns?$orderby={property} +GET /security/attackSimulation/trainingCampaigns?$skipToken={skipToken} +GET /security/attackSimulation/trainingCampaigns?$top=1 +GET /security/attackSimulation/trainingCampaigns?$select={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 [trainingCampaign](../resources/trainingcampaign.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_trainingcampaign" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns +``` ++# [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.trainingCampaign)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.etag": "W/\"dub9zfj4Rk68MmY/KYwXKgADRgyGsw==\"", + "id": "81c59451-2929-5b39-86f0-5a2b15f1314f", + "displayName": "Sample Training Campaign", + "description": "Sample Training Campaign Description", + "createdDateTime": "2024-02-18T08:36:07.6534871Z", + "lastModifiedDateTime": "2024-02-19T08:00:01.9417887Z", + "endUserNotificationSetting": null, + "includedAccountTarget": null, + "excludedAccountTarget": null, + "trainingSetting": null, + "campaignSchedule": { + "launchDateTime": "2024-02-18T08:37:44Z", + "completionDateTime": "2024-02-19T07:59:44Z", + "status": "completed" + }, + "createdBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "lastModifiedBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + } + ] +} +``` + |
v1.0 | Attacksimulationroot Post Trainingcampaigns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attacksimulationroot-post-trainingcampaigns.md | + + Title: "Create trainingCampaign" +description: "Create a new trainingCampaign object." ++ms.localizationpriority: medium +++# Create trainingCampaign ++Namespace: microsoft.graph +++Create a new [trainingCampaign](../resources/trainingcampaign.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": "attacksimulationroot_post_trainingcampaigns" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/attackSimulation/trainingCampaigns +``` ++## 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 [trainingCampaign](../resources/trainingcampaign.md) object. ++You can specify the following properties when creating a **trainingCampaign**. ++|Property|Type|Description| +|:|:|:| +|createdBy|[emailIdentity](../resources/emailidentity.md)|The identity of the user who created the training campaign. Optional.| +|createdDateTime|DateTimeOffset|The date and time when the training campaign was created. Optional.| +|description|String|The description of the training campaign. Optional.| +|displayName|String|The display name of the training campaign. Required.| +|endUserNotificationSetting|[endUserNotificationSetting](../resources/endusernotificationsetting.md)|Details about the end user notification setting. Required.| +|excludedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|The users who are excluded from the training campaign. Optional.| +|includedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|The users who are targeted in the training campaign. Required.| +|lastModifiedDateTime|DateTimeOffset|The identity of the user who most recently modified the training campaign. Optional.| +|trainingSetting|[trainingSetting](../resources/trainingsetting.md)|Details about the training settings for a training campaign. Required.| +|campaignSchedule|[campaignSchedule](../resources/campaignschedule.md)|Details about the schedule and current status for a training campaign. Required.| ++## Response ++If successful, this method returns a `202 Accepted` response code and a tracking header named `location` in the response. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_trainingcampaign_from_" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns +Content-Type: application/json ++{ + "displayName": "Graph Training Campaign", + "description": "Graph Training Campaign Description", + "createdBy": { + "email": "john@contoso.com" + }, + "lastModifiedBy": { + "email": "john@contoso.com" + }, + "includedAccountTarget": { + "type": "addressBook", + "accountTargetEmails": [ + "john@contoso.com" + ] + }, + "endUserNotificationSetting": { + "notificationPreference": "microsoft", + "settingType": "trainingSelected", + "trainingReminder": { + "deliveryFrequency": "weekly", + "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('fe521249-9901-4584-a987-026a9980c58e')", + "defaultLanguage": "en" + }, + "trainingAssignment": { + "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('36fb4dc1-7c37-4b96-9096-12e6d6014fae')", + "defaultLanguage": "en" + } + }, + "trainingSetting": { + "settingType": "microsoftCustom", + "trainingAssignmentMappings": [ + { + "assignedTo": [ + "allUsers" + ], + "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('40454905-dc26-4f36-b854-3042a5362cb3')" + }, + { + "assignedTo": [ + "allUsers" + ], + "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('ea70ae06-3859-4818-be9d-270ee81d80a4')" + }, + { + "assignedTo": [ + "allUsers" + ], + "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('d733d88c-1b5a-48e3-a588-9910e41ac21d')" + } + ] + }, + "campaignSchedule": { + "launchDateTime": "2024-02-15T07:59:44Z", + "completionDateTime": "2024-02-18T07:59:44Z", + "status": "Scheduled" + } +} +``` ++# [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. ++<!-- { + "blockType": "response", + "truncated": true +} +--> ++```http +HTTP/1.1 202 Accepted +``` |
v1.0 | Attendancerecord List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attendancerecord-list.md | GET /me/onlineMeetings/{meetingId}/attendanceReports/{reportId}/attendanceRecord GET /users/{userId}/onlineMeetings/{meetingId}/attendanceReports/{reportId}/attendanceRecords ``` -To get attendance records of a webinar session's attendance report: +To get attendance records of a webinar session's attendance report with delegated and app permission: <!-- {"blockType": "ignored"}--> ``` http GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports/{reportId}/attendanceRecords |
v1.0 | Authenticationmethodsroot Usersregisteredbyfeature | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationmethodsroot-usersregisteredbyfeature.md | The following table shows the parameters that can be used with this function. |includedUserRoles|includedUserRoles|The role type for the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`.| |includedUserTypes|includedUserTypes|User type. Possible values are: `all`, `member`, `guest`.| -The value `privilegedAdmin` consists of the following privileged admin roles: +The value `privilegedAdmin` consists of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): * Global Administrator * Security Administrator The value `privilegedAdmin` consists of the following privileged admin roles: * User Administrator * Authentication Administrator -The value `admin` includes all Azure Active Director admin roles. +The value `admin` includes all Microsoft Entra admin roles. ## Request headers |
v1.0 | Authenticationmethodsroot Usersregisteredbymethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationmethodsroot-usersregisteredbymethod.md | The following table shows the parameters that can be used with this function. |includedUserRoles|includedUserRoles|The role type for the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`.| |includedUserTypes|includedUserTypes|User type. Possible values are: `all`, `member`, `guest`.| -The value `privilegedAdmin` consists of the following privileged admin roles: +The value `privilegedAdmin` consists of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): * Global Administrator * Security Administrator |
v1.0 | Authorizationsystem Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authorizationsystem-get.md | description: "Read the properties and relationships of an authorizationSystem ob ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Authorizationsystemtypeservice Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authorizationsystemtypeservice-get.md | description: "Read the properties and relationships of an authorizationSystemTyp ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsassociatedidentities List All | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsassociatedidentities-list-all.md | description: "Get a list of the awsIdentity objects and their properties." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsassociatedidentities List Roles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsassociatedidentities-list-roles.md | description: "Get the awsRole resources from the awsRoles navigation property." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsassociatedidentities List Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsassociatedidentities-list-users.md | description: "Get a list of the awsUser objects and their properties." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsauthorizationsystem List Actions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystem-list-actions.md | description: "List the awsAuthorizationSystemAction objects and their properties ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsauthorizationsystem List Policies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystem-list-policies.md | description: "List all awsPolicy objects and their properties for a specific AWS ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsauthorizationsystem List Resources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystem-list-resources.md | description: "List the awsAuthorizationSystemResource objects and their properti ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsauthorizationsystem List Services | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystem-list-services.md | description: "Get all services in an AWS authorization system." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsauthorizationsystem List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystem-list.md | description: "Get a list of the awsAuthorizationSystem objects and their propert ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsauthorizationsystemresource Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystemresource-get.md | description: "Read the properties and relationships of an awsAuthorizationSystem ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsauthorizationsystemtypeaction Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystemtypeaction-get.md | description: "Read the properties and relationships of an awsAuthorizationSystem ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsexternalsystemaccessfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsexternalsystemaccessfinding-get.md | description: "Read the properties and relationships of an awsExternalSystemAcces ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsexternalsystemaccessfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsexternalsystemaccessfinding-list.md | description: "Get a list of the awsExternalSystemAccessFinding objects and their ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsexternalsystemaccessrolefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsexternalsystemaccessrolefinding-get.md | description: "Read the properties and relationships of an awsExternalSystemAcces ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsexternalsystemaccessrolefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsexternalsystemaccessrolefinding-list.md | description: "Get a list of the awsExternalSystemAccessRoleFinding objects and t ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsidentity Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentity-get.md | description: "Read the properties and relationships of an awsIdentity object." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsidentityaccessmanagementkeyagefinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyagefinding-aggregatedsummary.md | description: "Get a raw count of AWS IAM Access Keys and their ages" ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsidentityaccessmanagementkeyagefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyagefinding-get.md | description: "Read the properties and relationships of an awsIdentityAccessManag ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsidentityaccessmanagementkeyagefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyagefinding-list.md | description: "Get a list of the awsIdentityAccessManagementKeyAgeFinding objects ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsidentityaccessmanagementkeyusagefinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyusagefinding-aggregatedsummary.md | description: "Get a count of the AWS IAM Access Keys that have not been used in ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsidentityaccessmanagementkeyusagefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyusagefinding-get.md | description: "Read the properties and relationships of an awsIdentityAccessManag ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsidentityaccessmanagementkeyusagefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyusagefinding-list.md | description: "Get a list of the awsIdentityAccessManagementKeyUsageFinding objec ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awspolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awspolicy-get.md | description: "Read the properties and relationships of an awsPolicy object." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsrole Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsrole-get.md | description: "Read the properties and relationships of an awsRole object." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsuser Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsuser-get.md | description: "Read the properties and relationships of an awsUser object." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Awsuser List Assumableroles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsuser-list-assumableroles.md | description: "Get the assumableRole objects for an awsUser." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureadauthentication Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureadauthentication-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Read the properties and relationships of an [azureADAuthentication](../resources/azureadauthentication.md) object to find the level of Microsoft Entra authentication availability for your tenant. The Microsoft Entra service Level Agreement (SLA) commits to at least 99.99% authentication availability, as described in [Microsoft Entra SLA performance](/azure/active-directory/reports-monitoring/reference-azure-ad-sla-performance). This object provides you with your tenantΓÇÖs actual performance against this commitment. +Read the properties and relationships of an [azureADAuthentication](../resources/azureadauthentication.md) object to find the level of Microsoft Entra authentication availability for your tenant. The Microsoft Entra service Level Agreement (SLA) commits to at least 99.99% authentication availability, as described in [Microsoft Entra SLA performance](/azure/active-directory/reports-monitoring/reference-azure-ad-sla-performance). This object provides you with your tenant's actual performance against this commitment. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "azureadauthentication_get" } --> [!INCLUDE [permissions-table](../includes/permissions/azureadauthentication-get-permissions.md)] -In addition to the delegated permissions, the signed-in user needs to belong to one of the following directory roles that allow them to read sign-in reports. To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): -+ Global Administrator +For delegated scenarios, the calling 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 Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and an [azureADAuthentication](../resources/azureadauthentication.md) object in the response body. Each returned value includes a score indicating the availability percentage of the tenantΓÇÖs authentications for the month, along with a startDate and endDate indicating the month that the availability percentage is assigned to. +If successful, this method returns a `200 OK` response code and an [azureADAuthentication](../resources/azureadauthentication.md) object in the response body. Each returned value includes a score indicating the availability percentage of the tenant's authentications for the month, along with a startDate and endDate indicating the month that the availability percentage is assigned to. ## Examples |
v1.0 | Azureassociatedidentities List All | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureassociatedidentities-list-all.md | description: "Get a list of the azureIdentity objects and their properties." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureassociatedidentities List Managedidentities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureassociatedidentities-list-managedidentities.md | description: "Get a list of the azureManagedIdentity objects and their propertie ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureassociatedidentities List Serviceprincipals | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureassociatedidentities-list-serviceprincipals.md | description: "Get a list of the azureServicePrincipal objects and their properti ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureassociatedidentities List Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureassociatedidentities-list-users.md | description: "Get a list of the azureUser objects and their properties." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureauthorizationsystem List Actions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystem-list-actions.md | description: "List the azureAuthorizationSystemTypeAction objects and their prop ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureauthorizationsystem List Resources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystem-list-resources.md | description: "List the azureAuthorizationSystemResource objects and their proper ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureauthorizationsystem List Roledefinitions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystem-list-roledefinitions.md | description: "Lists all Azure roles in an Azure authorization system." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureauthorizationsystem List Services | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystem-list-services.md | description: "Get all services in an Azure authorization system onboarded to Per ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureauthorizationsystem List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystem-list.md | description: "Get a list of the azureAuthorizationSystem objects and their prope ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureauthorizationsystemresource Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystemresource-get.md | description: "Read the properties and relationships of an azureAuthorizationSyst ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureauthorizationsystemtypeaction Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystemtypeaction-get.md | description: "Read the properties and relationships of an azureAuthorizationSyst ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureidentity Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureidentity-get.md | description: "Read the properties and relationships of an azureIdentity object." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azuremanagedidentity Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azuremanagedidentity-get.md | description: "Read the properties and relationships of an azureManagedIdentity o ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureroledefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureroledefinition-get.md | description: "Gets an Azure role in an Azure authorization system." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureserviceprincipal Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureserviceprincipal-get.md | description: "Read the properties and relationships of an azureServicePrincipal ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Azureuser Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureuser-get.md | description: "Read the properties and relationships of an azureUser object." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | B2cidentityuserflow Delete Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-delete-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_delete_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-delete-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request DELETE https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_CustomerSign [!INCLUDE [sample-code](../includes/snippets/php/delete-b2xuserflows-identityproviders-1-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-b2xuserflows-identityproviders-1-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | B2cidentityuserflow Delete Userflowidentityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-delete-userflowidentityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_delete_userflowidentityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-delete-userflowidentityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External ID user flow administrator ## HTTP request |
v1.0 | B2cidentityuserflow Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2cidentityuserflow Get Apiconnectorconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-get-apiconnectorconfiguration.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_get_apiconnectorconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-get-apiconnectorconfiguration-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2cidentityuserflow Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_get" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2cidentityuserflow List Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-list-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_list_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-list-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2cidentityuserflow List Languages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-list-languages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_list_languages" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-list-languages-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2cidentityuserflow List Userflowidentityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-list-userflowidentityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_list_userflowidentityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-list-userflowidentityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External ID user flow administrator ## HTTP request |
v1.0 | B2cidentityuserflow Post Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-post-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-post-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2cidentityuserflow Put Apiconnectorconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-put-apiconnectorconfiguration.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the [apiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md) property in a [b2cIdentityUserFlow](../resources/b2cidentityuserflow.md) to enable or disable an API connector in a user flow. Each relationship of the [apiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md) corresponds to a specific step in the user flow that can be configured to call an API connector. You configure an API connector for a particular step one at a time as shown below. +Update the [apiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md) property in a [b2cIdentityUserFlow](../resources/b2cidentityuserflow.md) to enable or disable an API connector in a user flow. Each relationship of the [apiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md) corresponds to a specific step in the user flow that can be configured to call an API connector. You configure an API connector for a particular step in the user flow at a time. ## Permissions Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_put_apiconnectorconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-put-apiconnectorconfiguration-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request If successful, this method returns a `204 No Content` response code. ## Examples -### Example 1: Enable API connector for Post IDP Federation on sign up +### Example 1: Enable API connector for Post IdP Federation on sign-up #### Request The following example shows the response. HTTP/1.1 204 No Content ``` -### Example 2: Enable API connector for Post Attribute Collection on sign up +### Example 2: Enable API connector for Post Attribute Collection on sign-up #### Request The following example shows the response. HTTP/1.1 204 No Content ``` -### Example 3: Disable an API connector for Post Attribute Collection on sign up +### Example 3: Disable an API connector for Post Attribute Collection on sign-up #### Request |
v1.0 | B2cidentityuserflow Put Languages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-put-languages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_put_languages" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-put-languages-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2cidentityuserflow Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_update" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-update-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2cidentityuserflow Userflowidentityproviders Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-userflowidentityproviders-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_userflowidentityproviders_update" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-userflowidentityproviders-update-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External ID user flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Delete Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-delete-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_delete_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-delete-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Delete Userflowidentityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-delete-userflowidentityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_delete_userflowidentityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-delete-userflowidentityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External ID user flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Get Apiconnectorconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-get-apiconnectorconfiguration.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_get_apiconnectorconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-get-apiconnectorconfiguration-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_get" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow List Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-list-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_list_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-list-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow List Languages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-list-languages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_list_languages" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-list-languages-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow List Userflowidentityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-list-userflowidentityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_list_userflowidentityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-list-userflowidentityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External ID user flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Post Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-post-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-post-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Put Apiconnectorconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-put-apiconnectorconfiguration.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_put_apiconnectorconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-put-apiconnectorconfiguration-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Userflowidentityproviders Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-userflowidentityproviders-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_userflowidentityproviders_update" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-userflowidentityproviders-update-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External ID user flow administrator ## HTTP request |
v1.0 | Basesitepage Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/basesitepage-delete.md | If successful, this method returns a `204 No Content` response code. It doesn't The following example shows a request. ```http-DELETE https://graph.microsoft.com/beta/sites/{site-id}/pages/{page-id} +DELETE https://graph.microsoft.com/beta/sites/a69edae4-9208-4f60-9aa3-cd0911ff0ce1/pages/7f7a2740-2d74-47ba-af0c-71ed3a3384ca ``` ### Response |
v1.0 | Basesitepage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/basesitepage-get.md | If successful, this method returns a `200` and a [baseSitePage](../resources/bas --> ```msgraph-interactive-GET /sites/{site-id}/pages/{page-id} +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202 ``` # [C#](#tab/csharp) Content-type: application/json "id": "f45354cb-d634-45df-8b88-2b4e96a1dc45", "lastModifiedDateTime": "2023-04-16T10:01:41Z", "name": "Electronic Convertible.aspx",- "webUrl": "SitePages/Electronic Convertible.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Electronic Convertible.aspx", "title": "Electronic Convertible", "pageLayout": "article", "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/_layouts/15/images/sitepagethumbnail.png", |
v1.0 | Basesitepage List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/basesitepage-list.md | Get the collection of [baseSitePage][] objects from the site pages [list][] in a | :-- | :- | | [sitePage][] | Represents a regular page. | -[basesitepage]: ../resources/baseSitePage.md -[sitepage]: ../resources/sitePage.md +[baseSitePage]: ../resources/baseSitePage.md +[sitePage]: ../resources/sitePage.md [list]: ../resources/list.md [site]: ../resources/site.md The following example shows a request. --> ```msgraph-interactive-GET /sites/{site-id}/pages +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages ``` # [C#](#tab/csharp) Content-type: application/json "id": "5fa48f95-2fdf-40e8-a28c-6d0d8345bcd2", "lastModifiedDateTime": "2023-04-16T08:37:51Z", "name": "Account holistic.aspx",- "webUrl": "SitePages/Account holistic.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Account holistic.aspx", "title": "CSS Global Lithuanian meter", "pageLayout": "article", "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/a830edad9050849vanaukyisx52.spgrid.com/_layouts/15/images/sitepagethumbnail.png", Content-type: application/json "id": "da0f67be-977e-4d09-88ac-506a1002e678", "lastModifiedDateTime": "2023-04-16T06:39:30Z", "name": "Analyst Fresh.aspx",- "webUrl": "SitePages/Analyst Fresh.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Analyst Fresh.aspx", "title": "Lesotho Account Metal Analyst du", "pageLayout": "article", "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/a830edad9050849vanaukyisx52.spgrid.com/_layouts/15/images/sitepagethumbnail.png", |
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 one of the following directory roles: --* Global administrator -* Cloud device administrator -* Helpdesk administrator -* Intune service administrator -* Security administrator -* Security reader -* Global reader +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 ## 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 roles, or the user must be the **registered owner** of the device that the BitLocker key was originally backed up from: -* Global administrator -* Cloud device administrator -* Helpdesk administrator -* Intune service administrator -* Security administrator -* Security reader -* Global reader +>**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 ## 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 | Namespace: microsoft.graph Cancel the specified [bookingAppointment](../resources/bookingappointment.md) in the specified [bookingBusiness](../resources/bookingbusiness.md), and send a message to the involved customer and staff members. ## Permissions |
v1.0 | Bookingappointment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingappointment-delete.md | Namespace: microsoft.graph Delete a [bookingAppointment](../resources/bookingappointment.md) in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingappointment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingappointment-get.md | Get the properties and relationships of a [bookingAppointment](../resources/book The **start** and **end** properties are always returned in UTC. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingappointment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingappointment-update.md | Namespace: microsoft.graph Update the properties of a [bookingAppointment](../resources/bookingappointment.md) object in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-delete.md | Namespace: microsoft.graph Delete a [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingbusiness Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-get.md | Namespace: microsoft.graph Get the properties and relationships of a [bookingBusiness](../resources/bookingbusiness.md) object. ## Permissions |
v1.0 | Bookingbusiness Getstaffavailability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-getstaffavailability.md | Namespace: microsoft.graph Get the availability information of [staff members](../resources/bookingstaffmember.md) of a [Microsoft Bookings calendar](../resources/bookingappointment.md). ## Permissions |
v1.0 | Bookingbusiness List Appointments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-appointments.md | Namespace: microsoft.graph Get a list of [bookingAppointment](../resources/bookingappointment.md) objects for the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingbusiness List Calendarview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-calendarview.md | Namespace: microsoft.graph Get the collection of [bookingAppointment](../resources/bookingappointment.md) objects for a [bookingBusiness](../resources/bookingbusiness.md), that occurs in the specified date 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). |
v1.0 | Bookingbusiness List Customers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-customers.md | Namespace: microsoft.graph Get a list of [bookingCustomer](../resources/bookingcustomer.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). |
v1.0 | Bookingbusiness List Customquestions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-customquestions.md | Namespace: microsoft.graph Get the [bookingCustomQuestion](../resources/bookingcustomquestion.md) resources associated with a [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness List Services | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-services.md | Namespace: microsoft.graph Get a list of [bookingService](../resources/bookingservice.md) objects in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness List Staffmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-staffmembers.md | Namespace: microsoft.graph Get a list of [bookingStaffMember](../resources/bookingstaffmember.md) objects in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list.md | You can also query for Bookings businesses by specifying a string in a `query` p > **Note:** Results are limited to 500 mailboxes. Pagination of the results is not currently supported. ## Permissions |
v1.0 | Bookingbusiness Post Appointments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-appointments.md | Namespace: microsoft.graph Create a new [bookingAppointment](../resources/bookingappointment.md) for the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness Post Bookingbusinesses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-bookingbusinesses.md | Create a new Microsoft Bookings business in a tenant. This is the first step in setting up a Bookings business where you must specify the business display name. You can include other information such as business address, web site address, and scheduling policy, or set that information later by [updating](bookingbusiness-update.md) the **bookingBusiness**. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingbusiness Post Customers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-customers.md | Namespace: microsoft.graph Create a new [bookingCustomer](../resources/bookingcustomer.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). |
v1.0 | Bookingbusiness Post Customquestions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-customquestions.md | Namespace: microsoft.graph Create a new [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions |
v1.0 | Bookingbusiness Post Services | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-services.md | Namespace: microsoft.graph Create a new [bookingService](../resources/bookingservice.md) for the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingbusiness Post Staffmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-staffmembers.md | Namespace: microsoft.graph Create a new [staff member](../resources/bookingstaffmember.md) in the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingbusiness Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-publish.md | 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. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingbusiness Unpublish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-unpublish.md | Make the scheduling page of this business not available to external customers. Set the **isPublished** property to false, and **publicUrl** property to null. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingbusiness Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-update.md | Namespace: microsoft.graph Update the properties of a [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingcurrency Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcurrency-get.md | Namespace: microsoft.graph Get the properties of a [bookingCurrency](../resources/bookingcurrency.md) object that is available to a Microsoft Bookings business. Use the **id** property, which is the currency code, to specify the currency. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingcurrency List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcurrency-list.md | Namespace: microsoft.graph Get a list of [bookingCurrency](../resources/bookingcurrency.md) objects available to a Microsoft Bookings business. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingcustomer Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomer-delete.md | Namespace: microsoft.graph Delete the specified [bookingCustomer](../resources/bookingcustomer.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). |
v1.0 | Bookingcustomer Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomer-get.md | Namespace: microsoft.graph Get the properties and relationships of a [bookingCustomer](../resources/bookingcustomer.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). |
v1.0 | Bookingcustomer Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomer-update.md | Namespace: microsoft.graph Update the properties of a [bookingCustomer](../resources/bookingcustomer.md) object. ## Permissions |
v1.0 | Bookingcustomquestion Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomquestion-delete.md | Namespace: microsoft.graph Delete the specified [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions |
v1.0 | Bookingcustomquestion Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomquestion-get.md | Namespace: microsoft.graph Read the properties and relationships of a [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions |
v1.0 | Bookingcustomquestion Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomquestion-update.md | Namespace: microsoft.graph Update the properties of a [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions |
v1.0 | Bookingservice Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingservice-delete.md | Namespace: microsoft.graph Delete a [bookingService](../resources/bookingservice.md) object in the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingservice Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingservice-get.md | Namespace: microsoft.graph Get the properties and relationships of a [bookingService](../resources/bookingservice.md) object in the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingservice Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingservice-update.md | The following are some examples you can customize for a service: - Any, time buffer to set up before or finish up after the service - [Scheduling policy](../resources/bookingschedulingpolicy.md) parameters such as minimum notice to book or cancel, and whether customers can select specific staff members for an appointment. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingstaffmember Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingstaffmember-delete.md | Namespace: microsoft.graph Delete a [staff member](../resources/bookingstaffmember.md) in the specified [bookingbusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingstaffmember Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingstaffmember-get.md | Namespace: microsoft.graph Get the properties and relationships of a [bookingStaffMember](../resources/bookingstaffmember.md) in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingstaffmember Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingstaffmember-update.md | Namespace: microsoft.graph Update the properties of a [bookingStaffMember](../resources/bookingstaffmember.md) in the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Calendar Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/calendar-delete.md | The following example shows a request. DELETE https://graph.microsoft.com/beta/me/calendar ``` -# [C#](#tab/csharp) --# [CLI](#tab/cli) --# [Go](#tab/go) --# [Java](#tab/java) - # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/delete-calendar-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) --# [Python](#tab/python) - ##### Response |
v1.0 | Callrecording Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/callrecording-delta.md | A GET request with the delta function returns either: - 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 completely opaque to the client. To proceed with a round of change tracking, simply 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. 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`. 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). Choose the permission or permissions marked as least privileged for this API. Us ## HTTP request <!-- { "blockType": "ignored" } -->-```http -GET /users/{id}/onlineMeetings/getAllRecordings/delta?$filter=meetingOrganizerId%20eq%20'{id}' +``` http +GET /users/{usersId}/onlineMeetings/getAllRecordings(meetingOrganizerUserId='{userId}',startDateTime={startDateTime})/delta ```->**Note:** If you don't specify a **meetingOrganizerId**, the request fails. +>**Note:** If you don't pass the function parameter **meetingOrganizerUserId**, the request fails. ## Query parameters In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLin |:|:--|:-| | `$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. | ## Request headers+ | Header | Value | ||| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| The following example shows a series of three requests to synchronize the call r - 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 additional recordings](#example-2-next-round-to-get-additional-recordings). +See also what you'll 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, <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings/delta?$filter=meetingOrganizerId%20eq%20'8b081ef6-4792-4def-b2c9-c363a1bf41d5' +GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta ``` #### Initial response HTTP/1.1 200 OK Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)", - "@odata.count": 2, - "@odata.nextLink": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeeting/getAllRecordings?$skiptoken=GGXvkS7mbjFAe9Uidm2D70e58K-BOnoJadAqkZEJmoLprr5eSP1hQPlb3dJ1AVz3xCYKxov6hSEJhsasyg", - "value":[ - { - "@odata.type": "#microsoft.graph.callRecording", - "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", - "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", - "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl/content", - "createdDateTime": "2023-08-03T22:29:42.6514074Z", - "id": "MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl" - }, - { + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)", + "@odata.nextLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken1}", + "@odata.count": 1, + "value": [ + { "@odata.type": "#microsoft.graph.callRecording",- "meetingId": "MSo4YjA5MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA5MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDExYWQ3OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl/content", - "createdDateTime": "2023-08-05T11:24:30.6414074Z", - "id": "MSMjMCMjZDExYWQ3OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl" - } - ] + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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" + } + } + } + ] } ``` Content-type: application/json 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/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeeting/getAllRecordings?$skiptoken=GGXvkS7mbjFAe9Uidm2D70e58K-BOnoJadAqkZEJmoLprr5eSP1hQPlb3dJ1AVz3xCYKxov6hSEJhsasyg +GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta +$skiptoken={skipToken1} ``` #### Second response -The second response returns the next two 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 a `@odata.nextLink` property with a `skipToken`, which indicates there are more recordings. <!-- { "blockType": "response", HTTP/1.1 200 OK Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)", - "@odata.count": 2, - "@odata.nextLink": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeeting/getAllRecordings?$skiptoken=GGXve9Uidm2D70kS7mbjFAe58K-BOnPlb3dJ1AVz3xCYmoLprr5eSP1hQKxov6hSEJhsasyg", - "value":[ - { - "@odata.type": "#microsoft.graph.callRecording", - "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", - "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", - "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content", - "createdDateTime": "2023-08-11T21:29:42.6514074Z", - "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl" - }, - { + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)", + "@odata.nextLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2}", + "@odata.count": 1, + "value": [ + { "@odata.type": "#microsoft.graph.callRecording",- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19BQkMxRDFEMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19BQkMxRDFEMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDIyYWQyMmEtMmVhYS0yMmFjLWJkZWItMjIyNjMyNjExYzRl/content", - "createdDateTime": "2023-08-12T11:24:30.6414074Z", - "id": "MSMjMCMjZDIyYWQyMmEtMmVhYS0yMmFjLWJkZWItMjIyNjMyNjExYzRl" - } - ] + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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" + } + } + } + ] } ``` The third request continues to use the latest `@odata.nextLink` returned from th <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeeting/getAllRecordings?$skiptoken=GGXve9Uidm2D70kS7mbjFAe58K-BOnPlb3dJ1AVz3xCYmoLprr5eSP1hQKxov6hSEJhsasyg +GET https://graph.microsoft.com/beta/users({userId})/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 have been 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 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. <!-- { "blockType": "response", HTTP/1.1 200 OK Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)", - "@odata.count": 1, - "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4", - "value":[ - { + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)", + "@odata.deltaLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1}", + "@odata.count": 1, + "value": [ + { "@odata.type": "#microsoft.graph.callRecording",- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content", - "createdDateTime": "2023-08-11T21:29:42.6514074Z", - "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl" - } - ] + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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 additional recordings +### 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. The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-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/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1} ``` - #### Response The following example shows the response. Content-type: application/json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)",- "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_yjz2nsMoh1gXNtXii7s78HapCi5woifXqwXlVNxICh8wUUnvE2gExsa8eZ2Vy_ch5rVIhm067_1mUPML3iYUVyg.3o0rhgaBUduuxOr98An5pjBDP5JjKUiVWku3flSiOsk", + "@odata.deltaLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken2}", + "@odata.count": 1, "value": [- { + { "@odata.type": "#microsoft.graph.callRecording",- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content", - "createdDateTime": "2023-08-11T21:29:42.6514074Z", - "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl" - } + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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 Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/calltranscript-delta.md | Title: "callTranscript: delta" -description: "Get a set of callTranscript resources that have been added for onlineMeeting instances organized by the specified user." +description: "Get a set of callTranscript resources added for onlineMeeting instances organized by the specified user." ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -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 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 a given user, and incremental synchronization that gets transcripts that have been 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 would 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 `@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 completely opaque to the client. To proceed with a round of change tracking, simply 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 that have been 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. 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`. 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). Choose the permission or permissions marked as least privileged for this API. Us ## HTTP request <!-- { "blockType": "ignored" } -->-```http -GET /users/{id}/onlineMeetings/getAllTranscripts/delta?$filter=meetingOrganizerId%20eq%20'{id}' +``` http +GET /users/{usersId}/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='{userId}',startDateTime={startDateTime})/delta ```->**Note:** If you don't specify a **meetingOrganizerId**, the request fails. +>**Note:** If you don't pass the function parameter **meetingOrganizerUserId**, the request fails. ## Query parameters In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLin |:|:--|:-| | `$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. | + ## Request headers | Header | Value | The following example shows a series of three requests to synchronize the call t - 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 additional transcripts](#example-2-next-round-to-get-additional-transcripts). +See also what you'll 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, <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts/delta?$filter=meetingOrganizerId%20eq%20'8b081ef6-4792-4def-b2c9-c363a1bf41d5' +GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta ``` #### Initial response The response includes two call transcripts and a `@odata.nextLink` response head <!-- { "blockType": "response", "truncated": true,- "@odata.type": "Collection(microsoft.graph.callTranscript)" + "@odata.type": "microsoft.graph.callTranscript", + "isCollection": true } --> ```http HTTP/1.1 200 OK Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)", - "@odata.count": 2, - "@odata.nextLink": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$skiptoken=GGXvkS7mbjFAe9Uidm2D70e58K-BOnoJadAqkZEJmoLprr5eSP1hQPlb3dJ1AVz3xCYKxov6hSEJhsasyg", - "value":[ - { - "@odata.type": "#microsoft.graph.callTranscript", - "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", - "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", - "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl/content", - "createdDateTime": "2023-08-03T22:29:42.6514074Z", - "id": "MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl" - }, - { + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)", + "@odata.nextLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken1}", + "@odata.count": 1, + "value": [ + { "@odata.type": "#microsoft.graph.callTranscript",- "meetingId": "MSo4YjA5MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA5MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDExYWQ3OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl/content", - "createdDateTime": "2023-08-05T11:24:30.6414074Z", - "id": "MSMjMCMjZDExYWQ3OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl" - } - ] + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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" + } + } + } + ] } ``` Content-type: application/json 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/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$skiptoken=GGXvkS7mbjFAe9Uidm2D70e58K-BOnoJadAqkZEJmoLprr5eSP1hQPlb3dJ1AVz3xCYKxov6hSEJhsasyg +GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta +$skiptoken={skipToken1} ``` #### Second response -The second response returns the next 2 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 a `@odata.nextLink` property with a `skipToken`, which indicates there are more transcripts. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "Collection(microsoft.graph.callTranscript)" + "@odata.type": "microsoft.graph.callTranscript", + "isCollection": true } --> ```http HTTP/1.1 200 OK Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)", - "@odata.count": 2, - "@odata.nextLink": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$skiptoken=GGXve9Uidm2D70kS7mbjFAe58K-BOnPlb3dJ1AVz3xCYmoLprr5eSP1hQKxov6hSEJhsasyg", - "value":[ - { - "@odata.type": "#microsoft.graph.callTranscript", - "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", - "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", - "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content", - "createdDateTime": "2023-08-11T21:29:42.6514074Z", - "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl" - }, - { + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)", + "@odata.nextLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2}", + "@odata.count": 1, + "value": [ + { "@odata.type": "#microsoft.graph.callTranscript",- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19BQkMxRDFEMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19BQkMxRDFEMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDIyYWQyMmEtMmVhYS0yMmFjLWJkZWItMjIyNjMyNjExYzRl/content", - "createdDateTime": "2023-08-12T11:24:30.6414074Z", - "id": "MSMjMCMjZDIyYWQyMmEtMmVhYS0yMmFjLWJkZWItMjIyNjMyNjExYzRl" - } - ] + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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" + } + } + } + ] } ``` The third request continues to use the latest `@odata.nextLink` returned from th <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$skiptoken=GGXve9Uidm2D70kS7mbjFAe58K-BOnPlb3dJ1AVz3xCYmoLprr5eSP1hQKxov6hSEJhsasyg +GET https://graph.microsoft.com/beta/users({userId})/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 have been 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 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. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "Collection(microsoft.graph.callTranscript)" + "@odata.type": "microsoft.graph.callTranscript", + "isCollection": true } --> ```http HTTP/1.1 200 OK Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)", - "@odata.count": 1, - "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4", - "value":[ - { + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)", + "@odata.deltaLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1}", + "@odata.count": 1, + "value": [ + { "@odata.type": "#microsoft.graph.callTranscript",- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content", - "createdDateTime": "2023-08-11T21:29:42.6514074Z", - "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl" - } - ] + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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 additional transcripts +### 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 that have been 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/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4 +GET https://graph.microsoft.com/beta/users({userId})/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)" + "@odata.type": "microsoft.graph.callTranscript", + "isCollection": true } --> ```http HTTP/1.1 200 OK Content-type: application/json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)",- "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_yjz2nsMoh1gXNtXii7s78HapCi5woifXqwXlVNxICh8wUUnvE2gExsa8eZ2Vy_ch5rVIhm067_1mUPML3iYUVyg.3o0rhgaBUduuxOr98An5pjBDP5JjKUiVWku3flSiOsk", + "@odata.deltaLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken2}", + "@odata.count": 1, "value": [ { "@odata.type": "#microsoft.graph.callTranscript",- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content", - "createdDateTime": "2023-08-11T21:29:42.6514074Z", - "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl" + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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 | Certificatebasedapplicationconfiguration List Trustedcertificateauthorities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedapplicationconfiguration-list-trustedcertificateauthorities.md | The following example shows how to get a list of trusted certificate authorities ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_certificateauthorityasentity" The following example shows a request. --> ``` http-GET directory/certificateAuthorities/certificateBasedApplicationConfigurations/0a6a9b97-b84c-406a-a703-14d699d1fbb1/trustedCertificateAuthorities +GET https://graph.microsoft.com/beta/directory/certificateAuthorities/certificateBasedApplicationConfigurations/0a6a9b97-b84c-406a-a703-14d699d1fbb1/trustedCertificateAuthorities ``` +# [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-HTTP/1.1 201 Created +HTTP/1.1 200 OK Content-Type: application/json { |
v1.0 | Certificatebasedapplicationconfiguration Post Trustedcertificateauthorities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedapplicationconfiguration-post-trustedcertificateauthorities.md | If successful, this method returns a `201 Created` response code and a [certific ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_certificateauthorityasentity_from_" The following example shows a request. --> ``` http-POST directory/certificateAuthorities/certificateBasedApplicationConfigurations/0a6a9b97-b84c-406a-a703-14d699d1fbb1/trustedCertificateAuthorities +POST https://graph.microsoft.com/beta/directory/certificateAuthorities/certificateBasedApplicationConfigurations/0a6a9b97-b84c-406a-a703-14d699d1fbb1/trustedCertificateAuthorities 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 | Certificatebasedauthconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-delete.md | Title: "Delete certificateBasedAuthConfiguration" description: "Delete certificateBasedAuthConfiguration." ms.localizationpriority: medium-+ doc_type: "apiPageType" |
v1.0 | Certificatebasedauthconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-get.md | Title: "Get certificateBasedAuthConfiguration" description: "Get the properties of a certificatebasedauthconfiguration object." ms.localizationpriority: medium-+ doc_type: "apiPageType" |
v1.0 | Certificatebasedauthconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-list.md | Title: "List certificateBasedAuthConfigurations" description: "Get a list of certificatebasedauthconfiguration objects." ms.localizationpriority: medium-+ doc_type: "apiPageType" |
v1.0 | Certificatebasedauthconfiguration Post Certificatebasedauthconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration.md | Title: "Create certificateBasedAuthConfiguration" description: "Use this API to create a new certificateBasedAuthConfiguration." ms.localizationpriority: medium-+ doc_type: "apiPageType" |
v1.0 | Channel Archive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-archive.md | + + Title: "channel: archive" +description: "Archive a channel in a team. " ++ms.localizationpriority: medium ++++# channel: archive ++Namespace: microsoft.graph +++Archive a [channel](../resources/channel.md) in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. ++You can delete an archived channel, or add and remove members from it. If you archive a team, its channels are archived for you. ++Archiving is asynchronous; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. ++A channel without an owner, or that belongs to a [group](../resources/group.md) that has no owner, can't be archived. ++To restore a channel from its archived state, use the [unarchive](channel-unarchive.md) method. A channel canΓÇÖt be archived or unarchived if its team is archived. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_archive" } --> ++> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +POST /teams/{team-id}/channels/{channel-id}/archive +POST /groups/{team-id}/team/channels/{channel-id}/archive +``` ++## Request headers ++| Header | Value | +|:|:--| +| Authorization | Bearer {token}. Required. | ++## Request body ++In the request, you can optionally include the `shouldSetSpoSiteReadOnlyForMembers` parameter in a JSON body, as follows. +```JSON +{ + "shouldSetSpoSiteReadOnlyForMembers": true +} +``` +This optional parameter defines whether to set permissions for channel members to read-only on the SharePoint Online site associated with the team. Setting it to false or omitting the body altogether results in this step being skipped. ++## Response ++If archiving is started successfully, this method returns a `202 Accepted` response code. The response contains a `Location` header, which contains the location of the [teamsAsyncOperation](../resources/teamsasyncoperation.md) that was created to handle archiving of the channel in a team. Check the status of the archiving operation by making a GET request to this location. ++## Examples ++### Example 1: Archive a channel ++The following example shows a request to archive a channel. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "archive_channel" +}--> +```http +POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive +``` ++# [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", + "name": "archive_channel" +}--> +```http +HTTP/1.1 202 Accepted +Location: /teams/{team-id}/operations/{operation-id} +Content-Type: text/plain +Content-Length: 0 +``` ++### Example 2: Archive a channel when the team is archived ++The following example shows a request when the **team is archived**. ++#### Request ++<!-- { "blockType": "ignored" } --> +```http +POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive +``` ++#### Response +The following example shows the `400` error response. ++<!-- { "blockType": "ignored" } --> ++```http +http/1.1 400 Bad Request +Content-Type: application/json +Content-Length: 193 ++{ + "error": { + "code": "BadRequest", + "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}", + "innerError": { + "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}", + "code": "Unknown", + "innerError": {}, + "date": "2023-12-11T04:26:35", + "request-id": "8f897345980-f6f3-49dd-83a8-a3064eeecdf8", + "client-request-id": "50a0er33-4567-3f6c-01bf-04d144fc8bbe" + } + } +} ++``` ++<!-- uuid: e848414b-4669-4484-ac36-1504c58a3fb8 +2015-10-25 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "Archive Channel", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [] +} +--> |
v1.0 | Channel Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-get.md | Choose the permission or permissions marked as least privileged for this API. Us This API supports admin permissions. Global admins and 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)] HTTP/1.1 200 OK "email": "", "webUrl": "https://teams.microsoft.com/l/channel/19%3Ad468258bc90f4a358361b5d73b89d39b%40thread.skype/General?groupId=8bb12236-b929-42e0-94a0-1c417466ebf8&tenantId=139d16b4-7223-43ad-b9a8-674ba63c7924", "membershipType": "standard",+ "isArchived": false, "moderationSettings": { "userNewMessageRestriction": "everyone", "replyRestriction": "everyone", Content-type: application/json "email": "", "webUrl": "https://teams.microsoft.com/l/channel/19%3Ad468258bc90f4a358361b5d73b89d39b%40thread.skype/General?groupId=8bb12236-b929-42e0-94a0-1c417466ebf8&tenantId=139d16b4-7223-43ad-b9a8-674ba63c7924", "membershipType": "standard",+ "isArchived": false, "moderationSettings": { "userNewMessageRestriction": "moderators", "replyRestriction": "everyone", Content-type: application/json "email": "", "webUrl": "https://teams.microsoft.com/l/channel/19%3Ad468258bc90f4a358361b5d73b89d39b%40thread.skype/General?groupId=8bb12236-b929-42e0-94a0-1c417466ebf8&tenantId=139d16b4-7223-43ad-b9a8-674ba63c7924", "membershipType": "private",+ "isArchived": false, "moderationSettings": null } ``` |
v1.0 | Channel Getallretainedmessages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-getallretainedmessages.md | To learn more about how to use the Microsoft Teams export APIs to export content [!INCLUDE [teams-metered-apis](../../includes/teams-metered-apis.md)] +> [!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). + [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Channel List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-list.md | Content-type: application/json "description": "AutoTestTeam_20210311_150740.2550_fim3udfdjen9", "membershipType": "standard", "email": "someperson@microsoft.com",- "moderationSettings": null + "moderationSettings": null, + "isArchived": false } ] } Content-type: application/json "createdDateTime": "2020-05-27T19:22:25.692Z", "displayName": "General", "description": "test private team",- "membershipType": "private" + "membershipType": "private", + "isArchived": false, } ] } Content-length: 262 "webUrl": "https://teams.microsoft.com/l/channel/19%3ALpxShHZZh9utjNcEmUS5aOEP9ASw85OUn05NcWYAhX81%40thread.tacv2/shared%20channel-01?groupId=6a720ba5-7373-463b-bc9f-4cd04b5c6742&tenantId=df81db53-c7e2-418a-8803-0e68d4b88607", "membershipType": "shared", "email": "someperson@microsoft.com",+ "isArchived": false, "moderationSettings": null } ] |
v1.0 | Channel Patch Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-patch-tabs.md | Update the properties of the specified [tab](../resources/teamstab.md). This API can be used to configure the content of the tab. +> [!NOTE] +> You can't use this API to update a static tab. An attempt to update a static tab returns a `400 Bad Request` response code. + [!INCLUDE [national-cloud-support](../../includes/global-us.md)] ## Permissions |
v1.0 | Channel Post Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-post-members.md | Include the following properties in the request body. If successful, this method returns a `201 Created` response code and a [conversationMember](../resources/conversationmember.md) object in the response body. +> [!NOTE] +> The response code `404 Not Found` is returned when you attempt to add a disabled/blocked user. + ## Examples ### Example 1: Add a member to a private channel |
v1.0 | Channel Post Messages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-post-messages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "channel_post_messages" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-post-messages-permissions.md)] -> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. --> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> [!NOTE] +> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. <!-- markdownlint-disable MD024 --> <!-- markdownlint-disable MD001 --> |
v1.0 | Channel Post Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-post-tabs.md | Namespace: microsoft.graph Add (pin) a [tab](../resources/teamstab.md) to the specified [channel](../resources/channel.md) within a [team](../resources/team.md). The app must be [preinstalled in the team](../api/team-list-installedapps.md) and have the [configurableTabs](/microsoftteams/platform/resources/schema/manifest-schema#configurabletabs) property defined in the app manifest. +> **Note**: If the app manifest for a given **appId** contains a static tab that matches the current scope (**team**), the static tab is pinned by default. + [!INCLUDE [national-cloud-support](../../includes/global-us.md)] ## Permissions POST /teams/{id}/channels/{id}/tabs ## Request body -A [teamsTab](../resources/teamstab.md). +In the request body, supply a JSON representation of a [teamsTab](../resources/teamstab.md). ++> [!NOTE] +> When you pin a static tab, Teams takes the **displayName** and **configuration** from the app manifest. If these properties are specified in the request body, this API returns a `400 Bad Request` response code. ## Response |
v1.0 | Channel Unarchive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-unarchive.md | + + Title: "channel: unarchive" +description: "Restore an archived channel in a team. Unarchiving restores the ability for users to send messages and edit the channel." +ms.localizationpriority: medium +++++# channel: unarchive ++Namespace: microsoft.graph +++Restore an archived [channel](../resources/channel.md). Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the [archive](channel-archive.md) API. ++Unarchiving is an asynchronous operation; a channel is unarchived when the asynchronous unarchive operation completes successfully, which might occur after this method responds. ++> **Note**: An archived channel that belongs to an archived team cannot be unarchived. Unarchive the team before you unarchive the channel; otherwise, an error will occur. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_unarchive" } --> ++> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +POST /teams/{team-id}/channels/{channel-id}/unarchive +POST /groups/{team-id}/team/channels/{channel-id}/unarchive +``` ++## Request headers ++| Header | Value | +|:|:--| +| Authorization | Bearer {token}. Required. | ++## Request body ++Don't supply a request body for this method. ++## Response ++If unarchiving is started successfully, this method returns a `202 Accepted` response code. The response contains a `Location` header, which contains the location of the [teamsAsyncOperation](../resources/teamsasyncoperation.md) that was created to handle unarchiving of the channel of the team. Check the status of the unarchiving operation by making a GET request to this location. ++## Example ++### Example 1: Unarchive a channel +The following example shows a request to unarchive a channel. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "unarchive_channel" +}--> +```http +POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/unarchive +``` ++# [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", + "name": "unarchive_channel" +}--> +```http +HTTP/1.1 202 Accepted +Location: /teams/{team-id}/operations/{operation-id} +Content-Type: text/plain +Content-Length: 0 +``` ++### Example 2: Unarchive a channel when the team is archived ++The following example shows a request to unarchive a channel in an archived team. ++#### Request ++<!-- { "blockType": "ignored" } --> +```http +POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/unarchive +``` ++#### Response +The following example shows the `400` error response. ++<!-- { "blockType": "ignored" } --> +```http +http/1.1 400 Bad Request +Content-Type: application/json +Content-Length: 193 ++{ + "error": { + "code": "BadRequest", + "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}", + "innerError": { + "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}", + "code": "Unknown", + "innerError": {}, + "date": "2023-12-11T04:26:35", + "request-id": "8f897345980-f6f3-49dd-83a8-a3064eeecdf8", + "client-request-id": "50a0er33-4567-3f6c-01bf-04d144fc8bbe" + } + } +} ++``` +<!-- uuid: 9a9bb83f-6f35-4426-bb04-73ca43ad6cc8 +2015-10-25 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "Unarchive channel", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [] +} +--> |
v1.0 | Chat Delete Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-delete-installedapps.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_delete_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-delete-installedapps-permissions.md)] -> **Note**: The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Chat Delete Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-delete-members.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_delete_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-delete-members-permissions.md)] -> **Note**: The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Chat Delete Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-delete-tabs.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_delete_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-delete-tabs-permissions.md)] -> **Note**: The TeamsTab.Delete.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsTab.Delete.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Chat Get Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get-installedapps.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_get_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-installedapps-permissions.md)] -> **Note**: -The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request Content-type: application/json ``` ### Example 2: Get the set of resource-specific permissions consented for the app installed in the specified chat -The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameterd is required to show the consented permission set. +The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameter is required to show the consented permission set. #### Request |
v1.0 | Chat Get Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get-members.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_get_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-members-permissions.md)] -> **Note**: The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat pPermissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat pPermissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> GET /users/{user-id | user-principal-name}/chats/{chat-id}/members/{membership-i ## Optional query parameters -This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers |
v1.0 | Chat Get Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get-tabs.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_get_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-tabs-permissions.md)] -> **Note**: The TeamsTab.Read.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsTab.Read.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Chat Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_get" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-permissions.md)] -> **Note**: The ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request Content-type: application/json "viewpoint": { "isHidden": true, "lastMessageReadDateTime": "2021-05-06T23:55:07.191Z"- } + }, + "isHiddenForAllMembers": false } ``` Content-type: application/json "viewpoint": { "isHidden": false, "lastMessageReadDateTime": "2021-07-06T22:26:27.98Z"- } + }, + "isHiddenForAllMembers": false } ``` Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "2021-08-09T17:38:24.101Z" },+ "isHiddenForAllMembers": false, "members": [ { "@odata.type": "#microsoft.graph.aadUserConversationMember", Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "2021-08-17T18:04:32.583Z" },+ "isHiddenForAllMembers": false, "onlineMeetingInfo": { "calendarEventId": "AAMkADAzMjNhY2NiLWVmNDItNDVjYS05MnFjLTExY2U0ZWMyZTNmZQBGAAAAAAARDMODhhR0TZRGWo9nN0NcBwAmvYmLhDvYR6hCFdQLgxR-AAAAAAENAAAmvYmLhDvYR6hCFdQLgxR-AABkrglJAAA=", "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3Ameeting_YDZlYTYxOWUtYzdlMi00ZmMxLWIxMTAtN2YzODZlZjAxYzI4%40thread.v2/0?context=%7b%22Tid%22%3a%222432b57b-0abd-43db-aa7b-16eadd115d34%22%2c%22Oid%22%3a%22bfb5bb25-3a8d-487d-9828-7875ced51a30%22%7d", Content-type: application/json "isHidden": true, "lastMessageReadDateTime": "2022-09-08T23:11:54.353Z" },+ "isHiddenForAllMembers": false, "lastMessagePreview@odata.context": "https://graph.microsoft.com/beta/$metadata#chats('19%3Aebe3857aa388434bab0cad9d2e09f4de%40thread.v2')/lastMessagePreview/$entity", "lastMessagePreview": { "id": "1662678714353", |
v1.0 | Chat Getallretainedmessages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-getallretainedmessages.md | Namespace: microsoft.graph 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. +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). + [!INCLUDE [teams-metered-apis](../../includes/teams-metered-apis.md)] +> [!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). + [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions The following example shows a request that uses the `$top` and `$filter` query p ```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| |
v1.0 | Chat List Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-installedapps.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_list_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-installedapps-permissions.md)] -> **Note:** -The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): +> [!NOTE] +> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat > - TeamsAppInstallation.ReadWriteAndConsentForChat > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat.All |
v1.0 | Chat List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-members.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_list_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-members-permissions.md)] -> **Note**: The ChatMember.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatMember.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Chat List Messages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-messages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_list_messages" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-messages-permissions.md)] -> **Note:** The ChatMessage.Read.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatMessage.Read.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request This method supports the following [OData query parameters](/graph/query-paramet | [$orderby](/graph/query-parameters#orderby-parameter) | Currently supports the **lastModifiedDateTime** (default) and **createdDateTime** properties in descending order. The ascending order is currently not supported.| | [$filter](/graph/query-parameters#filter-parameter) | Sets the date range filter for the **lastModifiedDateTime** and **createdDateTime** properties. The **lastModifiedDateTime** property supports the `gt` and `lt` operators. The **createdDateTime** property supports the `lt` operator. You can only filter results if the request URL contains the `$orderby` and `$filter` query parameters configured for the same property; otherwise, the `$filter` query option is ignored.| -The other [OData query parameters](/graph/query-parameters) are not currently supported. +The other [OData query parameters](/graph/query-parameters) aren't currently supported. ## Request headers |
v1.0 | Chat List Operations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-operations.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_list_operations" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-operations-permissions.md)] -> **Note:** The ChatSettings.Read.Chat and ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatSettings.Read.Chat and ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { |
v1.0 | Chat List Permissiongrants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-permissiongrants.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_list_permissiongrants" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-permissiongrants-permissions.md)] -> **Note**: The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Chat List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list.md | Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "2021-06-03T08:05:49.521Z" },- "webUrl": "https://teams.microsoft.com/l/chat/19%3Ameeting_MjdhNjM4YzUtYzExZi00OTFkLTkzZTAtNTVlNmZmMDhkNGU2@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f" + "webUrl": "https://teams.microsoft.com/l/chat/19%3Ameeting_MjdhNjM4YzUtYzExZi00OTFkLTkzZTAtNTVlNmZmMDhkNGU2@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f", + "isHiddenForAllMembers": false }, { "id": "19:561082c0f3f847a58069deb8eb300807@thread.v2", Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "2021-05-27T22:13:01.577Z" },- "webUrl": "https://teams.microsoft.com/l/chat/19%3A561082c0f3f847a58069deb8eb300807@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f" + "webUrl": "https://teams.microsoft.com/l/chat/19%3A561082c0f3f847a58069deb8eb300807@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f", + "isHiddenForAllMembers": false }, { "id": "19:d74fc2ed-cb0e-4288-a219-b5c71abaf2aa_8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca@unq.gbl.spaces", Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "0001-01-01T00:00:00Z" },- "webUrl": "https://teams.microsoft.com/l/chat/19%3Ad74fc2ed-cb0e-4288-a219-b5c71abaf2aa_8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca@unq.gbl.spaces/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f" + "webUrl": "https://teams.microsoft.com/l/chat/19%3Ad74fc2ed-cb0e-4288-a219-b5c71abaf2aa_8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca@unq.gbl.spaces/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f", + "isHiddenForAllMembers": false } ] } Content-type: application/json "lastMessageReadDateTime": "2021-04-02T08:15:02.091Z" }, "webUrl": "https://teams.microsoft.com/l/chat/19%3Ameeting_MjdhNjM4YzUtYzExZi00OTFkLTkzZTAtNTVlNmZmMDhkNGU2@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f",+ "isHiddenForAllMembers": false, "members": [ { "@odata.type": "#microsoft.graph.aadUserConversationMember", Content-type: application/json "lastMessageReadDateTime": "0001-01-01T00:00:00Z" }, "webUrl": "https://teams.microsoft.com/l/chat/19%3A561082c0f3f847a58069deb8eb300807@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f",+ "isHiddenForAllMembers": false, "members": [ { "@odata.type": "#microsoft.graph.aadUserConversationMember", Content-type: application/json "lastMessageReadDateTime": "2021-06-05T00:31:30.047Z" }, "webUrl": "https://teams.microsoft.com/l/chat/19%3Ad74fc2ed-cb0e-4288-a219-b5c71abaf2aa_8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca@unq.gbl.spaces/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f",+ "isHiddenForAllMembers": false, "members": [ { "@odata.type": "#microsoft.graph.aadUserConversationMember", Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "2021-06-05T00:31:30.047Z" },+ "isHiddenForAllMembers": false, "lastMessagePreview": { "id": "1622853091207", "createdDateTime": "2021-06-05T00:31:31.207Z", Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "2021-06-03T08:05:49.521Z" },+ "isHiddenForAllMembers": false, "lastMessagePreview": { "id": "1622707540293", "createdDateTime": "2021-06-03T08:05:40.293Z", Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "2021-06-04T05:34:23.712Z" },+ "isHiddenForAllMembers": false, "lastMessagePreview": { "id": "1622784857324", "createdDateTime": "2021-06-04T05:34:17.324Z", Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "2021-05-27T22:13:01.577Z" },+ "isHiddenForAllMembers": false, "lastMessagePreview": { "id": "1621533401696", "createdDateTime": "2021-05-20T17:56:41.696Z", Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "2021-06-05T00:01:30.233Z" },+ "isHiddenForAllMembers": false, "webUrl": "https://teams.microsoft.com/l/chat/19%3Ameeting_MjdhNjM4YzUtYzExZi00OTFkLTkzZTAtNTVlNmZmMDhkNGU2@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f", "members": [ { Content-type: application/json "isHidden": false, "lastMessageReadDateTime": "2021-06-05T00:31:30.047Z" },+ "isHiddenForAllMembers": false, "webUrl": "https://teams.microsoft.com/l/chat/19%3Ad74fc2ed-cb0e-4288-a219-b5c71abaf2aa_8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca@unq.gbl.spaces/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f", "members": [ { Content-type: application/json "viewpoint": { "isHidden": false, "lastMessageReadDateTime": "2022-05-03T18:15:42.307Z"- } + }, + "isHiddenForAllMembers": false }, { "id": "19:82fe7758-5bb3-4f0d-a43f-e555fd399c6f_bfb5bb25-3a8d-487d-9828-7875ced51a30@unq.gbl.spaces", Content-type: application/json "viewpoint": { "isHidden": true, "lastMessageReadDateTime": "2022-03-08T19:55:30.491Z"- } + }, + "isHiddenForAllMembers": false } ] } Content-type: application/json "viewpoint": { "isHidden": false, "lastMessageReadDateTime": "2023-06-29T10:22:15.024Z"- } + }, + "isHiddenForAllMembers": false } ] |
v1.0 | Chat Patch Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-patch-tabs.md | Namespace: microsoft.graph Update the properties of the specified [tab](../resources/teamstab.md) in a [chat](../resources/chat.md). This API can be used to configure the content of the tab. -> **Note:** If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then, effectively, the tab pinned in the meeting will be updated. +> [!NOTE] +> - If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then, effectively, the tab pinned in the meeting will be updated. +> - You can't use this API to update a static tab. An attempt to update a static tab returns a `400 Bad Request` response code. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_patch_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-patch-tabs-permissions.md)] -> **Note:** The TeamsTab.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsTab.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request PATCH /chats/{chat-id}/tabs/{tab-id} | Content-Type | application/json. Required. | ## Request body-In the request body, supply a JSON representation of [tab](../resources/teamstab.md) object. +In the request body, supply a JSON representation of a [tab](../resources/teamstab.md) object. ## Response |
v1.0 | Chat Patch | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-patch.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_patch" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-patch-permissions.md)] -> **Note:**S The ChatSettings.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatSettings.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Chat Post Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-post-installedapps.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_post_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-installedapps-permissions.md)] -> **Notes:** +> [!NOTE] > - The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions cannot be used to install apps that require consent to resource-specific permissions. > - The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). |
v1.0 | Chat Post Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-post-members.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_post_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-members-permissions.md)] -> **Note:** The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Chat Post Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-post-tabs.md | Namespace: microsoft.graph Add (pin) a [tab](../resources/teamstab.md) to the specified [chat](../resources/chat.md). The corresponding app must already be [installed in the chat](../api/chat-list-installedapps.md). -> **Note:** If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then, effectively, the tab will get added to the meeting. +> **Notes**: +> * If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then the tab is effectively added to the meeting. +> * If the app manifest for a given **appId** contains a static tab that matches the current scope (`chat`/`groupChat`), the static tab is pinned by default. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_post_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-tabs-permissions.md)] -> **Note:** The TeamsTab.Create.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsTab.Create.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> POST /chats/{chat-id}/tabs In the request body include a JSON representation of a [teamsTab](../resources/teamstab.md). +> [!NOTE] +> When you pin a static tab, Teams takes the **displayName** and **configuration** from the app manifest. If these properties are specified in the request body, this API returns a `400 Bad Request` response code. + ## Response If successful, this method returns a `201 Created` response code and an instance of the [teamsTab](../resources/teamstab.md) resource in the body. |
v1.0 | Chat Sendactivitynotification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-sendactivitynotification.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_sendactivitynotification" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-sendactivitynotification-permissions.md)] ->**Note:** The TeamsActivity.Send.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsActivity.Send.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Chat Teamsappinstallation Upgrade | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-teamsappinstallation-upgrade.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_teamsappinstallation_upgrade" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-teamsappinstallation-upgrade-permissions.md)] -> **Notes:** +> [!NOTE] > - The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions can't be used to install apps that require consent to resource-specific permissions. > - The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). |
v1.0 | Chatmessage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-get.md | One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account)|Not supported.| |Application| ChatMessage.Read.Chat, Chat.Read.All, Chat.ReadWrite.All| -> **Note**: The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc). +> [!NOTE] +> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc). ## HTTP request GET /me/chats/{chat-id}/messages/{message-id} ``` ## Optional query parameters-This method does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This method doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers | Header | Value | Content-type: application/json "messageHistory": [] } ```+### 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/beta/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/beta/$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=\"testsc\" source=\"https://graph.microsoft.com/beta/chats/19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2/messages/1706638496169/hostedContents/aWQ9LHR5cGU9MSx1cmw9aHR0cHM6Ly91cy1jYW5hcnkuYXN5bmNndy50ZWFtcy5taWNyb3NvZnQuY29tL3YxL29iamVjdHMvMC13dXMtZDItN2I1ZGRkZDZkZWMwM2RjMjA1ODFjY2RhMTUyYTJlMzgvdmlld3MvaW1ndDJfYW5pbQ==/$value\"></customemoji></p>" + }, + "attachments": [], + "mentions": [], + "reactions": [ + { + "reactionType": "💯", + "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", + "reactionContentUrl": "https://graph.microsoft.com/beta/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 |
v1.0 | Chatmessage List Hostedcontents | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-list-hostedcontents.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md) +Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md).s [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco |Delegated (personal Microsoft account)|Not supported.| |Application| ChannelMessage.Read.Group, ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | -> **Note**: The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ### Permissions for chat <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco |Delegated (personal Microsoft account)|Not supported.| |Application| ChatMessage.Read.Chat, Chat.Read.All, Chat.ReadWrite.All| -> **Note**: The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc). +> [!NOTE] +> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc). ## HTTP request |
v1.0 | Chatmessage List Replies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-list-replies.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chatmessage_list_replies" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-list-replies-permissions.md)] -> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Chatmessage Post Replies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-post-replies.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chatmessage_post_replies" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-replies-permissions.md)] -> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. --> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> [!NOTE] +> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Chatmessage Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-post.md | Namespace: microsoft.graph Send a new [chatMessage](../resources/chatmessage.md) in the specified [channel](../resources/channel.md) or a [chat](../resources/chat.md). -> **Notes:** +> [!NOTE] > - We don't recommend that you use this API for data migration. It does not have the throughput necessary for a typical migration. > - It is a violation of the [terms of use](/legal/microsoft-apis/terms-of-use) to use Microsoft Teams as a log file. Only send messages that people will read. Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chatmessage_post" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-permissions.md)] -> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. --> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> [!NOTE] +> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> - Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. ### Permissions for chat <!-- { "blockType": "permissions", "name": "chatmessage_post_2" } --> Content-type: application/json "messageHistory": [] } ```+### Example 5: Send a message with a file attachment in it using file share link ++#### Request +The following example shows a request ++>**Notes:** +> - The file to attach must already be in SharePoint. Use any GUID for your attachment ID. Use the file share link as **contentURL**. User must have permissions to drive item using the file [share link](/graph/api/shares-get?view=graph-rest-1.0&tabs=http). +> - Using file share link for sending messages is not supported in [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams) scenario. +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "post_chatmessage_5", + "sampleKeys": ["1e769eab-06a8-4b2e-ac42-1f040a4e52a1", "19:e28d1f9b354f4de88d2e9e4d8b983763@thread.tacv2"] +}--> +```http +POST https://graph.microsoft.com/v1.0/teams/1e769eab-06a8-4b2e-ac42-1f040a4e52a1/channels/19:e28d1f9b354f4de88d2e9e4d8b983763@thread.tacv2/messages +Content-type: application/json ++{ + "body": { + "contentType": "html", + "content": "Testing with file share link. <attachment id=\"668f7fa8-8129-4de7-b32b-fe1b442e6ef1\"></attachment>" + }, + "attachments": [ + { + "id": "668f7fa8-8129-4de7-b32b-fe1b442e6ef1", + "contentType": "reference", + "contentUrl": "https://teamsgraph-my.sharepoint.com/:w:/g/personal/test_teamsgraph_onmicrosoft_com/Eah_j2YpgedNsyv-G0QubvEBma6Sd_76UtYkXwoJ-nYVEg?e=0H2Ibm" + } + ] +} +``` ++# [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": "microsoft.graph.chatMessage" +} --> +```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('1e769eab-06a8-4b2e-ac42-1f040a4e52a1')/channels('19%3Ae28d1f9b354f4de88d2e9e4d8b983763%40thread.tacv2')/messages/$entity", + "id": "1709663385319", + "replyToId": null, + "etag": "1709663385319", + "messageType": "message", + "createdDateTime": "2024-03-05T18:29:45.319Z", + "lastModifiedDateTime": "2024-03-05T18:29:45.319Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": null, + "summary": null, + "chatId": null, + "importance": "normal", + "locale": "en-us", + "webUrl": "https://teams.microsoft.com/l/message/19%3Ae28d1f9b354f4de88d2e9e4d8b983763%40thread.tacv2/1709663385319?groupId=1e769eab-06a8-4b2e-ac42-1f040a4e52a1&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1709663385319&parentMessageId=1709663385319", + "policyViolation": null, + "eventDetail": null, + "from": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "28c10244-4bad-4fda-993c-f332faef94f0", + "displayName": "Test User", + "userIdentityType": "aadUser" + } + }, + "body": { + "contentType": "html", + "content": "Testing with file share link. <attachment id=\"668f7fa8-8129-4de7-b32b-fe1b442e6ef1\"></attachment>" + }, + "channelIdentity": { + "teamId": "1e769eab-06a8-4b2e-ac42-1f040a4e52a1", + "channelId": "19:e28d1f9b354f4de88d2e9e4d8b983763@thread.tacv2" + }, + "attachments": [ + { + "id": "668f7fa8-8129-4de7-b32b-fe1b442e6ef1", + "contentType": "reference", + "contentUrl": "https://teamsgraph-my.sharepoint.com/personal/test_teamsgraph_onmicrosoft_com/Documents/Personal%20Drive%20file%201.docx", + "content": null, + "name": "Personal Drive file 1.docx", + "thumbnailUrl": null, + "teamsAppId": null + } + ], + "mentions": [], + "reactions": [] +} +``` -### Example 5: Send inline images along with the message +### Example 6: Send inline images along with the message #### Request The following example shows a request. The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "post_chatmessage_5", + "name": "post_chatmessage_6", "sampleKeys": ["19:2da4c29f6d7041eca70b638b43d45437@thread.v2"] }--> ```http 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 } ``` -### Example 6: Send a card with inline images +### Example 7: Send a card with inline images #### Request The following example shows a request. The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "post_chatmessage_6", + "name": "post_chatmessage_7", "sampleKeys": ["fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"] }--> ```http 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 } ``` -### Example 7: @mention a channel in a channel message +### Example 8: @mention a channel in a channel message #### Request The following example shows a request. For information about how to get a list of channels in a team, see [List channels](../api/channel-list.md). Content-type: application/json } ``` -### Example 8: @mention a team in a channel message +### Example 9: @mention a team in a channel message #### Request The following example shows a request. Content-type: application/json } ``` -### Example 9: @mention a tag in a channel message +### Example 10: @mention a tag in a channel message #### Request The following example shows a request. For information about how to get a list of tags in a team, see [List teamworkTags](../api/teamworktag-list.md). Content-type: application/json } ``` -### Example 10: Send message that contains cards that are attributed to a Teams app +### Example 11: Send message that contains cards that are attributed to a Teams app #### Request The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "post_chatmessage_e10", + "name": "post_chatmessage_11", "sampleKeys": ["fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"] }--> 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 } ``` -### Example 11: Send a message that contains an announcement +### Example 12: Send a message that contains an announcement #### Request The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "post_chatmessage_11", + "name": "post_chatmessage_12", "sampleKeys": ["5c884e2f-83f8-4cff-af8e-0177f260b9f8", "19:81f49626414645c99469ee65a1a7e1a4@thread.tacv2"] }--> 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 ``` -### Example 12: Send a message with an emoji +### Example 13: Send a message with an emoji #### Request The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "post_chatmessage_12", + "name": "post_chatmessage_13", "sampleKeys": ["19:7fb82b685f9c457296a0ab6a1d98b4c1@thread.v2"] }--> 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)] |
v1.0 | Chatmessage Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-update.md | You can update all the properties of **chatMessage** in delegated permissions sc Updating works only for chats where conversation members are Microsoft Teams users. If one of the members is using Skype, the operation fails. -This method does not support federation. Only the user in the tenant who sent the message can perform data loss prevention (DLP) updates on the specified chat message. +This method doesn't support federation. Only the user in the tenant who sent the message can perform data loss prevention (DLP) updates on the specified chat message. [!INCLUDE [teams-model-A-only-disclaimer](../../includes/teams-model-A-only-disclaimer.md)] One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | ChannelMessage.UpdatePolicyViolation.All, Group.ReadWrite.All** | -> **Note:** The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ### Permissions for chat <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> PATCH /teams/(team-id)/channels/{channel-id}/messages/{message-id}/replies/{repl PATCH /chats/{chatThread-id}/messages/{message-id}?model=A ``` -If no `model` is specified, [evaluation mode](/graph/teams-licenses#evaluation-mode-default-requirements) will be used. +If no `model` is specified, [evaluation mode](/graph/teams-licenses#evaluation-mode-default-requirements) is used. ## Request headers HTTP/1.1 204 NoContent The following example shows a request to update the attachments on a Microsoft Teams channel message by using delegated permissions. - # [HTTP](#tab/http) <!-- { "blockType": "request", |
v1.0 | Chatmessagehostedcontent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessagehostedcontent-get.md | One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account)|Not supported.| |Application| ChannelMessage.Read.Group, ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | -> **Note:**: The Group.Read.All and Group.ReadWrite.All permissionsare supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.Read.All and Group.ReadWrite.All permissionsare supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ### Permissions for chat <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> GET /users/{user-id | user-principal-name}/chats/{chat-id}/messages/{message-id} ## Optional query parameters -This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers |
v1.0 | Chats Getallmessages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chats-getallmessages.md | GET /users/{id | user-principal-name}/chats/getAllMessages You can use the `model` query parameter, which supports the values `A` and `B`, based on the preferred [licensing and payment model](/graph/teams-licenses), as shown in the following examples. +<!-- { "blockType": "ignored" } --> ```http GET /users/{id | user-principal-name}/chats/getAllMessages?model=A GET /users/{id | user-principal-name}/chats/getAllMessages?model=B If no `model` parameter is specified, [evaluation mode](/graph/teams-licenses#ev This method also supportsΓÇ»[date range parameters](/graph/query-parameters) to customize the response, as shown in the following example. +<!-- { "blockType": "ignored" } --> ``` http GET /users/{id}/chats/getAllMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z ``` If successful, this method returns a `200 OK` response code and a list of [chatM ### Request +<!-- { + "blockType": "request", + "name": "chat_getallmessages_1" +}--> ```msgraph-interactive GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllMessages ``` |
v1.0 | Cloudclipboarditem Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudclipboarditem-get.md | Read the properties and relationships of a [cloudClipboardItem](../resources/clo This API doesn't support using another user's credentials to get a [cloudClipboardItem](../resources/cloudclipboarditem.md) for a 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). |
v1.0 | Cloudclipboardroot List Items | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudclipboardroot-list-items.md | Get a list of the [cloudClipboardItem](../resources/cloudclipboarditem.md) objec This API doesn't support using another user's credentials to get a [cloudClipboardItem](../resources/cloudclipboarditem.md) for a 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). |
v1.0 | Cloudpc Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-get.md | Content-Type: application/json "userPrincipalName": "pmitchell@contoso.com", "lastModifiedDateTime": "2020-11-03T18:14:34Z", "gracePeriodEndDateTime": "2020-11-010T20:00:34Z",- "provisioningType": "shared", + "provisioningType": "sharedByUser", "diskEncryptionState": "notAvailable" } ``` Content-Type: application/json The following example shows a request. - # [HTTP](#tab/http) <!-- { "blockType": "request", The following example shows a request. --> ``` http-GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/40cee9d2-03fb-4066-8d35-dbdf2875c33f?$select=id,displayName,imageDisplayName,lastModifiedDateTime,lastRemoteActionResult,lastLoginResult,connectivityResult +GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/40cee9d2-03fb-4066-8d35-dbdf2875c33f?$select=id,displayName,imageDisplayName,lastModifiedDateTime,lastRemoteActionResult,lastLoginResult,connectivityResult,allotmentDisplayName ``` # [C#](#tab/csharp) Content-Type: application/json "additionalDetails": "SessionHost unhealthy: SessionHost is not joined to a domain" } ]- } + }, + "allotmentDisplayName": null } ``` Content-Type: application/json "userPrincipalName": "pmitchell@contoso.com", "lastModifiedDateTime": "2020-11-03T18:14:34Z", "gracePeriodEndDateTime": "2020-11-010T20:00:34Z",- "provisioningType": "shared", + "provisioningType": "dedicated", "diskEncryptionState": "notAvailable" } ``` |
v1.0 | Cloudpc Getprovisionedcloudpcs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-getprovisionedcloudpcs.md | Content-Type: application/json "lastModifiedDateTime": "2020-07-23T10:29:57Z", "statusDetails": null, "provisioningType": "dedicated",+ "allotmentDisplayName": null, "connectivityResult": "", "gracePeriodEndDateTime": null, "lastLoginResult": "2020-07-23T10:29:57Z", Content-Type: application/json "lastModifiedDateTime": "2020-07-28T18:14:34Z", "statusDetails": null, "provisioningType": "dedicated",+ "allotmentDisplayName": null, "connectivityResult": "", "gracePeriodEndDateTime": null, "lastLoginResult": "2020-07-23T10:29:57Z", |
v1.0 | Cloudpcauditevent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcauditevent-get.md | HTTP/1.1 200 OK Content-Type: application/json {- "@odata.type": "#microsoft.graph.cloudPcAuditEvent", - "id": "250473f5-029f-4037-813d-ba4768201d61", - "displayName": "Display Name value", - "componentName": "Component Name value",  - "activity": "Activity value",  - "activityDateTime": "2021-02-14T13:10:51.814636+08:00", - "activityType": " Activity Type value",  - "activityOperationType": "Activity Operation Type value", - "activityResult": "Activity Result value",  - "correlationId": "a5c71cc6-2271-4d5c-9bfe-d94781e83fe6", - "category": "Category value", - "actor": { - "@odata.type": "microsoft.graph.cloudPcAuditActor", - "type": "Type value", - "userPermissions": [ - "User Permissions value" - ], - "applicationId": "Application Id value", - "applicationDisplayName": "Application Display Name value", - "userPrincipalName": "User Principal Name value", - "servicePrincipalName": "Service Principal Name value", - "ipAddress": "Ip Address value", - "userId": "User Id value", - "userRoleScopeTags": [ - { - "@odata.type": "microsoft.graph.cloudPcUserRoleScopeTagInfo", - "displayName": "Display Name value", - "roleScopeTagId": "Role Scope Tag Id value" - } - ], - "remoteTenantId": "Remote Tenant Id value", - "remoteUserId": "Remote User Id value" - }, - "resources": [ + "@odata.type": "#microsoft.graph.cloudPcAuditEvent", + "id": "250473f5-029f-4037-813d-ba4768201d61", + "displayName": "Update OnPremisesConnection", + "componentName": "CloudPcOnPremisesConnectionsController", + "activity": null, + "activityDateTime": "2021-02-14T13:10:51.814636+08:00", + "activityType": "Patch CloudPcOnPremisesConnection", + "activityOperationType": "Patch", + "activityResult": "Success", + "correlationId": "a5c71cc6-2271-4d5c-9bfe-d94781e83fe6", + "category": "Cloud PC", + "actor": { + "@odata.type": "microsoft.graph.cloudPcAuditActor", + "type": "application", + "userPermissions": [], + "applicationId": "69cc3193-b6c4-4172-98e5-ed0f38ab3ff8", + "applicationDisplayName": "Cloud PC Ibiza", + "userPrincipalName": null, + "servicePrincipalName": null, + "ipAddress": null, + "userId": "ccaf0214-2d5c-4c72-b23f-191ff2c87313", + "userRoleScopeTags": [ + { + "@odata.type": "microsoft.graph.cloudPcUserRoleScopeTagInfo", + "displayName": "Europe", + "roleScopeTagId": "8ad48104-cb5c-497c-b144-6fc9927354ab" + } + ], + "remoteTenantId": "33c73c76-bf5d-45ba-ab4f-ee49c9a9be76", + "remoteUserId": "ccaf0214-2d5c-4c72-b23f-191ff2c87313" + }, + "resources": [ + { + "@odata.type": "microsoft.graph.cloudPcAuditResource", + "displayName": "ecmadao-test-azureconnection-1", + "modifiedProperties": [ {- "@odata.type": "microsoft.graph.cloudPcAuditResource", - "displayName": "Display Name value", - "modifiedProperties": [ - { - "@odata.type": "microsoft.graph.cloudPcAuditProperty", - "displayName": "Display Name value", - "oldValue": "Old Value value", - "newValue": "New Value value" - } - ], - "type": "Type value", - "resourceId": "Resource Id value" + "@odata.type": "microsoft.graph.cloudPcAuditProperty", + "displayName": "AdDomainUsername", + "oldValue": "12312", + "newValue": "new-adDomainUsername" }- ] + ], + "type": "CloudPcOnPremisesConnection", + "resourceType": "CloudPcOnPremisesConnection", + "resourceId": "a7508af8-d334-41ba-83a7-26cc88959724" + } + ] } ``` |
v1.0 | Cloudpcbulkaction Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcbulkaction-get.md | + + Title: "Get cloudPcBulkAction" +description: "Read the properties and relationships of a cloudPcBulkAction object." ++ms.localizationpriority: medium ++++# Get cloudPcBulkAction +Namespace: microsoft.graph +++Read the properties and relationships of a [cloudPcBulkAction](../resources/cloudpcbulkaction.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": "cloudpcbulkaction_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/virtualEndpoint/bulkActions/{cloudPcBulkActionId} +``` ++## 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 [cloudPcBulkAction](../resources/cloudpcbulkaction.md) object in the response body. ++## Examples ++### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_cloudpcbulkaction" +} +--> +``` http +GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/bulkActions/231ad98f-41b3-872b-dd37-c70bf22cbdac +``` ++# [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.cloudPcBulkAction" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudPcBulkAction", + "id": "231ad98f-41b3-872b-dd37-c70bf22cbdac", + "displayName": "Bulk Power Off by Andy", + "cloudPcIds": [ + "d6e0b8ee-8836-4b8d-b038-6130a97a3a9d", + "85994912-197b-4927-b569-447bd81350ec" + ], + "actionSummary": { + "failedCount": 1, + "inProgressCount": 0, + "notSupportedCount": 0, + "pendingCount": 1, + "successfulCount": 0 + }, + "scheduledDuringMaintenanceWindow": true, + "createdDateTime": "2024-02-05T10:29:57Z" + } +} +``` + |
v1.0 | Cloudpcdeviceimage Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcdeviceimage-delete.md | If successful, this method returns a `204 No Content` response code. ### Request +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete_deviceimages_from_virtualendpoint" If successful, this method returns a `204 No Content` response code. DELETE https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/deviceImages/435849e6-0263-4621-9f93-8657667af3bb ``` +# [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. |
v1.0 | Cloudpcdeviceimage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcdeviceimage-get.md | If successful, this method returns a `200 OK` response code and a [cloudPcDevice ### Request +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpcdeviceimage" If successful, this method returns a `200 OK` response code and a [cloudPcDevice GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/deviceImages/eda7ed64-7705-4079-9d08-c2bd883f4fff ``` +# [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. |
v1.0 | Cloudpcexportjob Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcexportjob-get.md | Read the properties and relationships of a [cloudPcExportJob](../resources/cloud You can download a report by first [creating a new cloudPcExportJob resource](cloudpcreports-post-exportjobs.md) to initiate downloading. -Use this GET operation to verify the **exportJobStatus** property of the **cloudPcExportJob** resource. When the property becomes `completed`, the report has finished downloading in the location specified by the **exportUrl** property. +Use this GET operation to verify the **exportJobStatus** property of the **cloudPcExportJob** resource. The property becomes `completed` when the report finishes downloading in the location specified by the **exportUrl** property. ## Permissions-Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 least privileged permission or permissions to download reports with this API. Delegated access require read access to the report that you need to export. App-only tokens with CloudPC.ReadWrite.All have permission or permissions to download all reports without specific permission. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "cloudpcexportjob_get" } --> [!INCLUDE [permissions-table](../includes/permissions/cloudpcexportjob-get-permissions.md)] +The following permissions in the in the [Cloud PC admin portal](https://intune.microsoft.com/#view/Microsoft_Intune_DeviceSettings/RolesLandingMenuBlade/~/myPermissions) provide access to specific kinds of reports: +- ActionStatus/Read +- DeviceRecommendation/Read +- CrossRegionDisasterRecovery/Read +- FrontlineReports/Read +- InaccessibleReports/Read +- PerformanceReports/Read + ## HTTP request <!-- { If successful, this method returns a `200 OK` response code and a [cloudPcExport ### Example 1: Get an export job for the TotalAggregatedRemoteConnectionReports report -The following example shows how to get an export job that was created by the POST request for the `TotalAggregatedRemoteConnectionReports` report. +The following example shows how to get an export job that a POST request for the `TotalAggregatedRemoteConnectionReports` report created. #### Request Content-Type: application/json ### Example 2: Get an export job for the RemoteConnectionQualityReports report -The following example shows how to get an export job that was created by the POST request for the `RemoteConnectionQualityReports` report. +The following example shows how to get an export job that a POST request for the `RemoteConnectionQualityReports` report created. #### Request |
v1.0 | Cloudpcgalleryimage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcgalleryimage-get.md | If successful, this method returns a `200 OK` response code and a [cloudPcGaller The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpcgalleryimage", The following example shows a request. GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/galleryImages/MicrosoftWindowsDesktop_windows-ent-cpc_19h2-ent-cpc-os ``` +# [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 | Cloudpcprovisioningpolicy Apply | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-apply.md | + + Title: "cloudPcProvisioningPolicy: apply" +description: "Apply the current provisioning policy configuration to all Cloud PC devices under a specified policy." ++ms.localizationpriority: medium ++++# cloudPcProvisioningPolicy: apply ++Namespace: microsoft.graph +++Apply the current [provisioning policy](../resources/cloudpcprovisioningpolicy.md) configuration to all Cloud PC devices under a specified policy. Currently, the region is the only policy setting that you can apply. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "cloudpcprovisioningpolicy_apply" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +POST /deviceManagement/virtualEndpoint/provisioningPolicies/{id}/apply +``` ++## 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 parameter that you can use with this method. ++|Parameter|Type|Description| +|:|:|:| +|policySettings|cloudPcPolicySettingType|The target property of this apply action. Possible values are: `region`, `singleSignOn`, `unknownFutureValue`. The default value is `region`. This action applies `region` as a value if this parameter is `null`.| ++## 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": "apply_cloudpcprovisioningpolicy" +} +--> ++``` http +POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff/apply +Content-Type: application/json ++{ + "policySettings": "region" +} +``` ++# [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 | Cloudpcprovisioningpolicy Applyconfig | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-applyconfig.md | + + Title: "cloudPcProvisioningPolicy: applyConfig" +description: "Update the provisioning policy configuration for a set of Cloud PC devices by their IDs." ++ms.localizationpriority: medium ++++# cloudPcProvisioningPolicy: applyConfig ++Namespace: microsoft.graph +++Update the [provisioning policy](../resources/cloudpcprovisioningpolicy.md) configuration for a set of Cloud PC devices by their IDs. This method supports retry and allows you to apply the configuration to a subset of Cloud PCs initially to test. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "cloudpcprovisioningpolicy_applyconfig" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/virtualEndpoint/provisioningPolicies/applyConfig +``` ++## 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 you can use with this method. ++|Parameter|Type|Description| +|:|:|:| +|cloudPcIds|String collection|A collection of Cloud PC IDs.| +|policySettings|cloudPcPolicySettingType|The target property of this apply action. Possible values are: `region`, `singleSignOn`, `unknownFutureValue`. The default value is `region`. This action applies `region` as a value if this parameter is `null`.| ++## 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": "cloudpcprovisioningpolicythis.applyconfig" +} +--> +``` http +POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/applyConfig +Content-Type: application/json ++{ + "cloudPcIds": [ + "52aa2645-36ee-47d2-9eb3-b8fbb17c3fc4", + "ff117b6c-e3e6-41be-9cae-eb6743249a30" + ], + "policySettings": "region" +} +``` ++# [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 | Cloudpcprovisioningpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-get.md | Content-Type: application/json "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy", "description": "Description value", "displayName": "Display Name value",- "domainJoinConfiguration": { - "domainJoinType": "hybridAzureADJoin", - "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff" - }, "domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff", Content-Type: application/json "imageDisplayName": "Image Display Name value", "imageId": "Image ID value", "imageType": "custom",- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff", - "windowsSettings": { - "language": "en-US" - }, "windowsSetting": { "locale": "en-US" }, Content-Type: application/json "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy", "description": "Description value", "displayName": "Display Name value",- "domainJoinConfiguration": { - "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff", - "regionName": null, - "type": "hybridAzureADJoin" - }, "domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff", Content-Type: application/json "imageDisplayName": "Image Display Name value", "imageId": "Image ID value", "imageType": "custom",- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff", - "windowsSettings": { - "language": "en-US" - }, "windowsSetting": { "locale": "en-US" }, The following example shows a request. --> ``` http-GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/60b94f83-3e22-430e-a69d-440f65b922d6?$select=id,description,displayName,domainJoinConfiguration,imageDisplayName,imageId,imageType,onPremisesConnectionId,windowsSetting,managedBy,cloudPcGroupDisplayName,gracePeriodInHours,localAdminEnabled,alternateResourceUrl +GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/60b94f83-3e22-430e-a69d-440f65b922d6?$select=id,description,displayName,domainJoinConfigurations,imageDisplayName,imageId,imageType,windowsSetting,managedBy,cloudPcGroupDisplayName,gracePeriodInHours,localAdminEnabled,alternateResourceUrl ``` # [C#](#tab/csharp) Content-Type: application/json "cloudPcGroupDisplayName": "MyCloudPcGroup", "description": "The ProvisioningPolicy for West US employees.", "displayName": "WestUsPolicy",- "domainJoinConfiguration": { - "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff", - "regionName": null, - "type": "hybridAzureADJoin" - }, "domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff", Content-Type: application/json "imageType": "custom", "localAdminEnabled": true, "managedBy": "windows365",- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff", - "windowsSettings": { - "language": "en-US" - }, "windowsSetting": { "locale": "en-US" }, |
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 |imageId|String|The ID of the OS image you want to provision on Cloud PCs. The format for a gallery type image is: {publisher_offer_sku}. Supported values for each of the parameters are as follows: <ul><li>publisher: Microsoftwindowsdesktop.</li> <li>offer: windows-ent-cpc.</li> <li>sku: 21h1-ent-cpc-m365, 21h1-ent-cpc-os, 20h2-ent-cpc-m365, 20h2-ent-cpc-os, 20h1-ent-cpc-m365, 20h1-ent-cpc-os, 19h2-ent-cpc-m365 and 19h2-ent-cpc-os.</li></ul>| |imageType|cloudPcProvisioningPolicyImageType|The type of OS image (custom or gallery) you want to provision on Cloud PCs. Possible values are: `gallery`, `custom`.| |windowsSetting|[cloudPcWindowsSettings](../resources/cloudpcwindowssetting.md)|Indicates a specific Windows setting to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. |-|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID.| -|onPremisesConnectionId (deprecated)|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service.| +|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID. The **domainJoinConfiguration** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.| +|onPremisesConnectionId (deprecated)|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service. The **onPremisesConnectionId** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.| |windowsSettings (deprecated)|[cloudPcWindowsSettings](../resources/cloudpcwindowssettings.md)|Specific Windows settings to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. The **windowsSettings** property is deprecated and will stop returning data on January 31, 2024. Going forward, use the **windowsSetting** property.| ## Response |
v1.0 | Cloudpcreports Getdailyaggregatedremoteconnectionreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getdailyaggregatedremoteconnectionreports.md | Namespace: microsoft.graph Get the daily aggregated remote connection reports, such as round trip time, available bandwidth, and so on, in a given 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). |
v1.0 | Cloudpcreports Getrawremoteconnectionreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getrawremoteconnectionreports.md | Namespace: microsoft.graph Get the raw real-time remote connection report for a Cloud PC without any calculation, such as roundTripTime or available bandwidth, which are aggregated hourly from the raw event data. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Cloudpcreports Getrealtimeremoteconnectionlatency | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getrealtimeremoteconnectionlatency.md | Namespace: microsoft.graph Get the real-time connection latency information 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). |
v1.0 | Cloudpcreports Getrealtimeremoteconnectionstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getrealtimeremoteconnectionstatus.md | Namespace: microsoft.graph Get the real-time connection status information, such as **signInStatus** or **daysSinceLastUse**, 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). |
v1.0 | Cloudpcreports Getremoteconnectionhistoricalreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getremoteconnectionhistoricalreports.md | Namespace: microsoft.graph Get the remote connection history records of a Cloud PC during a given period. This report contains data such as signInDateTime, signOutDateTime, usageInHour, remoteSignInTimeInSec and roundTripTimeInMsP50, and so on. This data is aggregated hourly for a specified time period, such as the last seven 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). 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`.| +|filter|String|OData filter syntax. Supported filters include `and`, `or`, `lt`, `le`, `gt`, `ge` and `eq`. The `CloudPcId` filter is required; for example: `CloudPcId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`. If this filter is missing, malformed, or invalid, a query config will be thrown.| |select|String collection|OData select syntax. The columns to include in the report.| |search|String|The string to search for.| |groupBy|String collection|A list of columns that describe how to group the data in the report.| Content-length: 199 "UsageInHour", "RoundTripTimeInMsP50", "AvailableBandwidthInMBpsP50",- "RemoteSignInTimeInSec", + "RemoteSignInTimeInSec" ], "top": 25,- "skip": 0, + "skip": 0 } ``` |
v1.0 | Cloudpcreports Gettotalaggregatedremoteconnectionreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-gettotalaggregatedremoteconnectionreports.md | Namespace: microsoft.graph Get the total aggregated remote connection usage of a Cloud PC during a given time span. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Cloudpcreports Post Exportjobs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-post-exportjobs.md | Namespace: microsoft.graph Create a new [cloudPcExportJob](../resources/cloudpcexportjob.md) resource to initiate downloading the entire or specified portion of a report. -Use the [GET cloudPcExportJob](cloudpcexportjob-get.md) operation to verify the **exportJobStatus** property of the **cloudPcExportJob** resource. When the property result is `completed`, the report has finished downloading to the location specified by the **exportUrl** property. +Use the [GET cloudPcExportJob](cloudpcexportjob-get.md) operation to verify the **exportJobStatus** property of the **cloudPcExportJob** resource. When the property result is `completed`, the report finishes downloading to the location specified by the **exportUrl** property. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). POST /deviceManagement/virtualEndpoint/reports/exportJobs ## Request body In the request body, supply a JSON representation of the [cloudPcExportJob](../resources/cloudpcexportjob.md) object. -You can specify the following properties when creating a **cloudPcExportJob**. +You can specify the following properties when you create a **cloudPcExportJob**. |Property|Type|Description| |:|:|:| |filter|String|The filter applied on the report. Optional.|-|format|String|The format of the exported report. Optional.| -|reportName|cloudPcReportName|The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`. 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): `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `inaccessibleCloudPcReports`.| +|reportName|cloudPcReportName|The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`. 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`, `inaccessibleCloudPcReports`.| |select|String collection|The selected columns of the report. Optional.| ## Response |
v1.0 | Conditionalaccesspolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccesspolicy-update.md | PATCH /identity/conditionalAccess/policies/{id} ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. For the list of properties, see [conditionalAccessPolicy](../resources/conditionalaccesspolicy.md). Content-type: application/json "signInRiskLevels": [ "high", "medium",- "low", + "low" ] } } |
v1.0 | Customclaimspolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/customclaimspolicy-get.md | + + Title: "Get customClaimsPolicy" +description: "Get the properties and relationships of a custom claims policy object." ++ms.localizationpriority: medium ++++# Get customClaimsPolicy ++Namespace: microsoft.graph +++Get the properties and relationships of a [customClaimsPolicy](../resources/customclaimspolicy.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": "customclaimspolicy_get" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /servicePrincipals/{servicePrincipalsId}/claimsPolicy +``` ++## 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 [customClaimsPolicy](../resources/customclaimspolicy.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "list_customclaimspolicy" +} +--> +``` http +GET https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipalsId}/claimsPolicy +``` ++### 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.customClaimsPolicy)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.customClaimsPolicy", + "id": "f914f36d-167e-3fa7-cfa2-355cc5a36689", + "includeBasicClaimSet": "Boolean", + "includeApplicationIdInIssuer": "Boolean", + "audienceOverride": "String", + "claims": [ + { + "@odata.type": "microsoft.graph.customClaim" + } + ] + } + ] +} +``` |
v1.0 | Customclaimspolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/customclaimspolicy-update.md | + + Title: "Update customClaimsPolicy" +description: "Update a custom claims policy object." ++ms.localizationpriority: medium ++++# Update customClaimsPolicy ++Namespace: microsoft.graph +++Update a [customClaimsPolicy](../resources/customclaimspolicy.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": "customclaimspolicy_update" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /servicePrincipals/{servicePrincipalsId}/claimsPolicy +``` ++## 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 [customClaimsPolicy](../resources/customclaimspolicy.md) object. ++You can specify the following properties when creating a **customClaimsPolicy**. ++|Property|Type|Description| +|:|:|:| +|includeBasicClaimSet|Boolean|Determines whether the basic claim set is included in tokens affected by this policy. If set to `true`, all claims in the basic claim set are emitted in tokens affected by the policy. By default the basic claim set isn't in the tokens, unless they're explicitly configured in this policy. Optional.| +|includeApplicationIdInIssuer|Boolean|Indicates whether the application ID is added to the claim. It is relevant only for SAML2.0 and if a custom signing key is used. the default value is `true`. Optional.| +|audienceOverride|String|If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols. A custom signing key must be used for audienceOverride to be applied, otherwise audienceOverride value is ignored. The value provided must be in the format of an absolute URI. Optional.| +|claims|[customClaimBase](../resources/customclaimbase.md) collection|Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set. Optional.| ++## Response ++If successful, this method returns a `201 Created` response code and a [customClaimsPolicy](../resources/customclaimspolicy.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "update_customclaimspolicy_from_" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipalsId}/claimsPolicy +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.customClaimsPolicy", + "includeBasicClaimSet": "Boolean", + "includeApplicationIdInIssuer": "Boolean", + "audienceOverride": "String", + "claims": [ + { + "@odata.type": "microsoft.graph.customClaim" + } + ] +} +``` ++### 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.customClaimsPolicy" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.customClaimsPolicy", + "id": "f914f36d-167e-3fa7-cfa2-355cc5a36689", + "includeBasicClaimSet": "Boolean", + "includeApplicationIdInIssuer": "Boolean", + "audienceOverride": "String", + "claims": [ + { + "@odata.type": "microsoft.graph.customClaim" + } + ] +} +``` |
v1.0 | Dailyuserinsightmetricsroot List Activeusersbreakdown | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/dailyuserinsightmetricsroot-list-activeusersbreakdown.md | - Title: "List daily activeUsersBreakdown (deprecated)" -description: "Get a list of daily activeUsersBreakdown objects on apps registered in your tenant configured for Microsoft Entra External ID for customers." ---doc_type: apiPageType ---# List daily activeUsersBreakdown (deprecated) -Namespace: microsoft.graph ---> [!CAUTION] -> This API is deprecated and will stop returning data on March 9, 2024. Use the [List monthly activeUsers](../api/monthlyuserinsightmetricsroot-list-activeusers.md) API instead. --Get a list of daily [activeUsersBreakdown](../resources/activeusersbreakdownmetric.md) objects on apps registered in your tenant configured for Microsoft Entra External ID for customers. ---## Permissions -Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "dailyuserinsightmetricsroot_list_activeusersbreakdown" } --> ---## HTTP request -<!-- { - "blockType": "ignored" -} >-``` http -GET /reports/userInsights/daily/activeUsersBreakdown -``` --## Optional query parameters -This method supports the `$filter` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). --## Request headers -|Name|Description| -|:|:| -|Authorization|Bearer {token}. Required. 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 [activeUsersBreakdownMetric](../resources/activeusersbreakdownmetric.md) objects in the response body. --## Examples --### Request -The following example shows a request. -# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "list_dailyactiveusersbreakdownmetric" -} >-``` http -GET https://graph.microsoft.com/beta/reports/userInsights/daily/activeUsersBreakdown -``` --# [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.activeUsersBreakdownMetric)" -} >-``` http -HTTP/1.1 200 OK -Content-Type: application/json --{ - "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.activeUsersBreakdownMetric)", - "value": [ - { - "id": "2", - "appId": "7a30b8ef-42h3-4d1e-84ad-17d4ca3c9a52", - "appName": "Bank", - "count": 1, - "factDate": "2023-09-28", - "os": "Windows" - }, - { - "id": "1", - "appId": "65e59557-d9d1-485f-87c5-80b92a99dfda", - "appName": "Kiosk", - "count": 1, - "factDate": "2023-09-20", - "os": "Ios" - } - ] -} -``` |
v1.0 | Delegatedadminrelationship Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/delegatedadminrelationship-update.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the properties of a [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object. You can only update a relationship when it's in the `created` **status**. However, you can update the **autoExtendDuration** property when the relationship is in either the `created` or `active` **status**. +Update the properties of a [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object. ++The following restrictions apply: +- You can update this relationship when its **status** property is `created`. +- You can update the **autoExtendDuration** property when **status** is either `created` or `active`. +- You can only remove the Microsoft Entra Global Administrator role when the **status** property is `active`, which indicates a long-running operation. + [!INCLUDE [national-cloud-support](../../includes/global-only.md)] PATCH /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationsh ## Response -If successful, this method returns a `200 OK` response code and an updated [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object in the response body. +If successful, this method returns either a `200 OK` or a `202 Accepted` response code. The response body contains a + [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object when the response is `200 OK`. ++### Response headers +|Name|Description| +|:|:| +|Content-Type|application/json.| +|Location|The location of the long-running operation.| +|Retry-After|The time after which a subsequent API call can be made to the Location URL to check the status of the long-running operation.| ++This method returns a `202 Accepted` response if you remove the Microsoft Entra Global Administrator role from the relationship while its **status** property is `active`. The response includes a URL in the Location header that you can use to monitor the operation's progress. ++If you don't supply the template ID that corresponds to the Microsoft Entra Global Administrator role in the `unifiedRoles` array in the `accessDetails` property of the request body, then the API returns `200 OK` and the original [delegatedAdminRelationship](../resources/delegatedAdminRelationship.md) object in the response body. ## Examples ### Request+The following example shows the request. # [HTTP](#tab/http) <!-- { Content-Type: application/json ### Response+The following example shows the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json } ``` +The following is an example response that returns a `202 Accepted` response code along with **Location** and **Retry-After** headers. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.delegatedAdminRelationship" +} +--> ++``` http +HTTP/1.1 202 Accepted +Location: https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5e5594d3-6f82-458b-b567-77db4811f0cd-00000000-0000-0000-0000-000000001234/operations/d8dbb27b-7fe7-4523-a3df-f766355fe0f2 +Retry-After: 10 +Content-Type: application/json ++{ +} +``` + |
v1.0 | 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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Global Administrator*, *Intune Administrator*, or *Windows 365 Administrator*. +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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Global Administrator*, *Intune Administrator*, *Windows 365 Administrator*, or *Cloud Device Administrator*. +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*. ## HTTP request |
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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): +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): -* Global Administrator * Users * Directory Readers * Directory Writers |
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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): +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): -* Global Administrator * Users * Directory Readers * Directory Writers |
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 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): -* Global Administrator * Users * Directory Readers * Directory Writers |
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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Global Administrator*, *Intune Administrator*, or *Windows 365 Administrator*. +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 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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Global Administrator*, *Intune Administrator*, or *Windows 365 Administrator*. +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. -In delegated scenarios, 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): *Global Administrator*, *Intune Administrator*. A calling user in the *Cloud Device Administrator* role can only enable or disable devices using this API and a user with the *Windows 365 Administrator* role can only update basic device properties. +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. ## HTTP request In the request body, supply the values for the [device](../resources/device.md) | Property | Type |Description| |:|:--|:-|-|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Only callers in Global Administrator and Cloud Device Administrator roles can update this property. | +|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Only callers with at least the *Cloud Device Administrator* role can update this property. | |operatingSystem|String|The type of operating system on the device.| |operatingSystemVersion|String|The version of the operating system on the device| |displayName|String|The display name for the device.| |
v1.0 | Devicemanagement Alertrecord Changealertrecordsportalnotificationassent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/devicemanagement-alertrecord-changealertrecordsportalnotificationassent.md | + + Title: "alertRecord: changeAlertRecordsPortalNotificationAsSent" +description: "Change the isPortalNotificationSent property to true for a list of alert records for the current user." ++ms.localizationpriority: medium ++++# alertRecord: changeAlertRecordsPortalNotificationAsSent ++Namespace: microsoft.graph.deviceManagement +++Set the **isPortalNotificationSent** property of all [portal notification](../resources/devicemanagement-portalnotification.md) resources associated with the specified [alertRecord](../resources/devicemanagement-alertrecord.md) to `true`, marking them as sent. A maximum of 100 [alertRecord](../resources/devicemanagement-alertrecord.md) IDs can be received at one time, and a maximum of 100 **portal notification** resources can be changed in the **isPortalNotificationSent** property status. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "devicemanagement_alertrecord_changealertrecordsportalnotificationassent" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/monitoring/alertRecords/changeAlertRecordsPortalNotificationAsSent +``` ++## 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| +|:|:|:| +|alertRecordIds| String collection | A list of up to 100 [alertRecord](../resources/devicemanagement-alertrecord.md) IDs.| ++## Response ++If successful, this action returns a `202 Accepted` response code. ++## Example ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "alertrecordthis.changeAlertRecordsPortalNotificationAsSent" +} +--> +``` http +POST https://graph.microsoft.com/beta/deviceManagement/monitoring/alertRecords/changeAlertRecordsPortalNotificationAsSent ++{ + "alertRecordIds": [ + "1d2b92e3-539a-481f-b38a-c2c050b422ad", + "4bf624c4-a801-4631-989c-7f1a3a0d1d83", + ] ++} +``` ++# [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 | Directory Delete Externaluserprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-delete-externaluserprofiles.md | DELETE https://graph.microsoft.com/beta/directory/externalUserProfiles/{id} [!INCLUDE [sample-code](../includes/snippets/php/delete-externaluserprofile-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-externaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Directory Delete Pendingexternaluserprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-delete-pendingexternaluserprofiles.md | description: "Delete a pendingExternalUserProfile object." ms.localizationpriority: medium doc_type: apiPageType + DELETE https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles/{i [!INCLUDE [sample-code](../includes/snippets/php/delete-pendingexternaluserprofile-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-pendingexternaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Directory Deleteditems List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-deleteditems-list.md | ConsistencyLevel: eventual This example requires the **ConsistencyLevel** header because the `$orderby` and `$count` query parameters are used in the query. -### Examples using the $orderby OData query parameter +### $orderby OData query parameter examples -The `$orderby` OData query parameter is supported on the **deletedDateTime**, **displayName**, and **userPrincipalName** properties of the deleted object types. On the **deletedDateTime** property, the query requires adding the [advanced query parameters](/graph/aad-advanced-queries) (**ConsistencyLevel** header set to `true` and `$count=true` query string). +The `$orderby` OData query parameter is supported on the **deletedDateTime**, **displayName**, and **userPrincipalName** properties of the deleted object types. On the **deletedDateTime** property, the query requires adding the [advanced query parameters](/graph/aad-advanced-queries) (**ConsistencyLevel** header set to `eventual` and `$count=true` query string). | OData cast | Properties supporting $orderby | Example | | : | : | : | |
v1.0 | Directory List Externaluserprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-externaluserprofiles.md | GET https://graph.microsoft.com/beta/directory/externalUserProfiles [!INCLUDE [sample-code](../includes/snippets/php/list-externaluserprofiles-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-externaluserprofiles-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Directory List Inboundshareduserprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-inboundshareduserprofiles.md | Title: "List inboundSharedUserProfiles" description: "Retrieve the properties of an inboundSharedUserProfiles."-++ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Directory List Outboundshareduserprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-outboundshareduserprofiles.md | Title: "List outboundSharedUserProfiles" description: "Retrieve the properties of all outboundSharedUserProfiles."-++ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Directory List Pendingexternaluserprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-pendingexternaluserprofile.md | description: "List all pendingExternalUserProfile objects." ms.localizationpriority: medium doc_type: apiPageType + GET https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles [!INCLUDE [sample-code](../includes/snippets/php/list-pendingexternaluserprofiles-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-pendingexternaluserprofiles-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Directory Post Administrativeunits | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-administrativeunits.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)] -To create an administrative unit, the calling principal must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Privileged Role Administrator -* Global Administrator +To create 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 | Directory Post Attributesets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-attributesets.md | The following table shows the properties that you can configure when you create |Property|Type|Description| |:|:|:| |description|String|Description of the attribute set. Can be up to 128 characters long and include Unicode characters. Can be changed later. Optional.|-|id|String|Identifier for the attribute set that is unique within a tenant. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case insensitive. Required.| +|id|String|Identifier for the attribute set that is unique within a tenant. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case sensitive. Required.| |maxAttributesPerSet|Int32|Maximum number of custom security attributes that can be defined in this attribute set. Default value is `null`. If not specified, the administrator can add up to the maximum of 500 active attributes per tenant. Can be changed later. Optional.| ## Response |
v1.0 | Directory Post Customsecurityattributedefinitions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-customsecurityattributedefinitions.md | The following table shows the properties that you can configure when you create |Property|Type|Description| |:|:|:|-|attributeSet|String|Name of the attribute set. Case insensitive. Required.| +|attributeSet|String|Name of the attribute set. Case sensitive. Required.| |description|String|Description of the custom security attribute. Can be up to 128 characters long and include Unicode characters. Can't contain spaces or special characters. Can be changed later. Optional.| |isCollection|Boolean|Indicates whether multiple values can be assigned to the custom security attribute. Can't be changed later. If **type** is set to `Boolean`, **isCollection** can't be set to `true`. Required.| |isSearchable|Boolean|Indicates whether custom security attribute values are indexed for searching on objects that are assigned attribute values. Can't be changed later. Required.|-|name|String|Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Can't contain spaces or special characters. Can't be changed later. Case insensitive. Required.| +|name|String|Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Can't contain spaces or special characters. Can't be changed later. Case sensitive. Required.| |status|String|Specifies whether the custom security attribute is active or deactivated. Acceptable values are `Available` and `Deprecated`. Can be changed later. Required.| |type|String|Data type for the custom security attribute values. Supported types are: `Boolean`, `Integer`, and `String`. Can't be changed later. Required.| |usePreDefinedValuesOnly|Boolean|Indicates whether only predefined values can be assigned to the custom security attribute. If set to `false`, free-form values are allowed. Can later be changed from `true` to `false`, but can't be changed from `false` to `true`. If **type** is set to `Boolean`, **usePreDefinedValuesOnly** can't be set to `true`. Required.| |
v1.0 | Directory Post Pendingexternaluserprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-pendingexternaluserprofile.md | description: "Create a new pendingExternalUserProfile object." ms.localizationpriority: medium doc_type: apiPageType + Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-pendingexternaluserprofile-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-pendingexternaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Directoryobject Checkmemberobjects | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryobject-checkmemberobjects.md | description: "Check for membership in a list of groups, administrative units, or ms.localizationpriority: medium + doc_type: "apiPageType" |
v1.0 | Directoryrole List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-list-members.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directoryrole_list_members" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryrole-list-members-permissions.md)] - [!INCLUDE [limited-info](../../includes/limited-info.md)] + ## HTTP request You can address the directory role using either its **id** or **roleTemplateId**. |
v1.0 | Domain Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-delete.md | Title: "Delete domain" -description: "Deletes a domain from a tenant." -+description: "Delete a domain from a tenant." + ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Deletes a domain from a tenant. +Delete a domain from a tenant. > **Important:** > Deleted domains are not recoverable. 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 one of the following roles: --* Global Administrator -* Domain Name Administrator +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 | Title: "domain: forceDelete" -description: "Deletes a domain using an asynchronous operation." -+description: "Delete a domain using an asynchronous operation." + ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Deletes a domain using an asynchronous operation. +Delete a domain using an asynchronous operation. -Prior to calling [forceDelete](domain-forcedelete.md), you must update or remove any references to **Exchange** as the provisioning service. +Before performing this operation, you must update or remove any references to **Exchange** as the provisioning service. The following actions are performed as part of this operation: The following actions are performed as part of this operation: * If the number of objects to be renamed is greater than 1,000, an error is returned. -* If one of the applications to be renamed is a multi-tenant app, an error is returned. +* If one of the applications to be renamed is a multitenant app, an error is returned. -After the domain deletion completes, API operations for the deleted domain will return a 404 HTTP response code. To verify deletion of a domain, you can perform a [get domain](domain-get.md). If the domain was successfully deleted, a 404 HTTP response code will be returned in the response. +After the domain deletion completes, API operations for the deleted domain return a 404 HTTP response code. To verify deletion of a domain, you can perform a [get domain](domain-get.md). If the domain was successfully deleted, a 404 HTTP response code is returned in the response. [!INCLUDE [national-cloud-support](../../includes/all-clouds.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 one of the following roles: --* Global Administrator -* Domain Name Administrator +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 In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description| |:|:--|:-|-|disableUserAccounts|Boolean| Option to disable renamed user accounts. If a user account is disabled, the user will not be allowed to sign in.<br>*True* (default) - User accounts renamed as part of this operation are disabled.<br>*False* - User accounts renamed as part of this operation are not disabled. | +|disableUserAccounts|Boolean| Option to disable renamed user accounts. If a user account is disabled, the user isn't allowed to sign in.<br>`true` (default) - User accounts renamed as part of this operation are disabled.<br>`false` - User accounts renamed as part of this operation aren't disabled. | ## Response |
v1.0 | Domain Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-get.md | Title: "Get domain" description: "Retrieve the properties and relationships of domain object."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: +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). -* Global Administrator * User Administrator * Helpdesk Administrator * Service Support Administrator |
v1.0 | Domain List Domainnamereferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-domainnamereferences.md | Title: "List domainNameReferences" description: "Retrieve a list of directoryObject with a reference to the domain."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: --* Global Administrator -* Domain Name Administrator -* Global Reader - [!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). + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Domain List Serviceconfigurationrecords | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-serviceconfigurationrecords.md | Title: "List serviceConfigurationRecords" description: "Retrieves a list of domainDnsRecord objects needed to enable services for the domain."-+ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Domain List Verificationdnsrecords | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-verificationdnsrecords.md | Title: "List verificationDnsRecords" description: "Retrieve a list of domainDnsRecord objects."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: --* Global Administrator -* Domain Name Administrator -* Global Reader +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). ## 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 | Title: "List domains" description: "Retrieve a list of domain objects."-+ ms.localizationpriority: medium doc_type: apiPageType 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 roles: +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): -* Global Administrator * User Administrator * Helpdesk Administrator * Service Support Administrator |
v1.0 | Domain Post Domains | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-post-domains.md | Title: "Create domain" description: "Adds a domain to the tenant."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: --* Global Administrator -* Domain Name Administrator +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 | Title: "Create internalDomainFederation" description: "Create a new internalDomainFederation object." ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_post_federationconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-post-federationconfiguration-permissions.md)] +> [!IMPORTANT] +> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios. + [!INCLUDE [rbac-domainfederation-apis-write](../includes/rbac-for-apis/rbac-domainfederation-apis-write.md)] ## HTTP request You can specify the following properties when creating an **internalDomainFedera |displayName|String|The display name of the federated identity provider.| |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 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.| +|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`.| |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`.| |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 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.| +|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.| |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).| + ### federatedIdpMfaBehavior values | Member | Description | You can specify the following properties when creating an **internalDomainFedera | rejectMfaByFederatedIdp | Microsoft Entra ID always performs MFA and rejects MFA that's performed by the federated identity provider. | **Note:** **federatedIdpMfaBehavior** is an evolved version of the **SupportsMfa** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings). -+ Switching between **federatedIdpMfaBehavior** and **SupportsMfa** is not supported. ++ Switching between **federatedIdpMfaBehavior** and **SupportsMfa** isn't supported. + Once **federatedIdpMfaBehavior** property is set, Microsoft Entra ID ignores the **SupportsMfa** setting. + 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. Content-Type: application/json "federatedIdpMfaBehavior": "rejectMfaByFederatedIdp" } ```++<!-- +{ + "type": "#page.annotation", + "description": "", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: /api/domain-post-federationconfiguration.md: + Exception processing links. + Link Definition was null. Link text: !INCLUDE Azure AD PowerShell deprecation note (Parameter 'Definition')" + ] +} +--> |
v1.0 | Domain Promote | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-promote.md | Title: "domain: promote" description: "Promote a verified subdomain to the root domain."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: --* Global Administrator -* Domain Name Administrator +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 | Title: "Update domain" description: "Update the properties of domain object."-+ ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the properties of domain object. --> **Important:** -> Only verified domains can be updated. +Update the properties of [domain](../resources/domain.md) object. Only verified domains can be updated. [!INCLUDE [national-cloud-support](../../includes/all-clouds.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 one of the following roles: +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): -* Global Administrator * Domain Name Administrator * Security Administrator * External Identity Provider Administrator |
v1.0 | Domain Verify | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-verify.md | Title: "domain: verify" -description: "Validates the ownership of the domain." -+description: "Validate the ownership of a domain." + ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Validates the ownership of the domain. +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. 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 one of the following roles: --* Global Administrator -* Domain Name Administrator +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 Assignsensitivitylabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-assignsensitivitylabel.md | Namespace: microsoft.graph Asynchronously assign a sensitivity label to a [driveItem][item-resource]. -This API is part of Microsoft SharePoint and OneDrive APIs that perform advanced premium administrative functions and is considered a protected API. Protected APIs require you to have more validation, beyond permission and consent, before you can use them. Before you call this API, you must [request access](https://aka.ms/PreviewSPOPremiumAPI). --For more information about sensitivity labels from an administrator's perspective, see [Enable sensitivity labels for Office files in SharePoint and OneDrive](/microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files?view=o365-worldwide&preserve-view=true). +This API is part of the Microsoft SharePoint and OneDrive APIs that perform advanced premium administrative functions, and is considered a protected API. Protected APIs require you to have more validation, beyond permission and consent, before you can use them. > [!NOTE] -> This is a metered API and some charges for use may apply. For details, see [Overview of metered Microsoft 365 APIs in Microsoft Graph](/graph/metered-api-overview). +> This is a metered API and some charges for use may apply. For details, see [Overview of metered Microsoft 365 APIs in Microsoft Graph](/graph/metered-api-overview). Before you call this API, you must [Enable metered APIs and services in Microsoft Graph](/graph/metered-api-setup?tabs=azurecloudshell). ++This API applies sensitivity labels to files at rest. Office clients don't apply watermarks, headers, or footers to files that contain the label information. For more information about sensitivity labels from an administrator's perspective, see [Enable sensitivity labels for Office files in SharePoint and OneDrive](/microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files?view=o365-worldwide&preserve-view=true). [!INCLUDE [national-cloud-support](../../includes/global-only.md)] |
v1.0 | Driveitem Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-delta.md | This method supports the `$select`, `$expand`, and `$top` [OData query parameter |Name|Description| |:|:| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|+|deltaExcludeParent| String. If this request header is included, the response includes the items that have changed, and not the parent items in the hierarchy.| ## Request body |
v1.0 | Driveitem Get Contentstream | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-get-contentstream.md | Namespace: microsoft.graph Download the contents of the primary stream (file) of a [driveItem](../resources/driveitem.md). Only **driveItem** objects with the **file** property can be downloaded. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 example shows how to download a file. GET https://graph.microsoft.com/beta/drives/b!fMInbiL5dkK51VbATG0ddrCg6AJpEj9Lm4uGj5HgEi4guyuYp4W5SbH4dPfXTbCF/items/014Y52UITTNSVUQI43PZBJMKLAY6LJBUVE/contentStream ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/download-item-content-stream-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) + #### Response GET https://graph.microsoft.com/beta/drives/b!fMInbiL5dkK51VbATG0ddrCg6AJpEj9Lm4 Range: bytes=0-1023 ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/download-item-partial-stream-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 | Educationassignment Post Resources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationassignment-post-resources.md | Content-type: application/json ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) * [Upload files for education assignments and submissions](/graph/education-upload-resource-overview) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Educationassignment Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationassignment-publish.md | Title: "educationAssignment: publish" -description: "Change the state of an educationAssignment from its original draft status to the published status." +description: "Change the status of an educationAssignment from its original draft status to the published status." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Change the state of an [educationAssignment](../resources/educationassignment.md) from its original `draft` status to the `published` status. +Change the status of an [educationAssignment](../resources/educationassignment.md) from its original `draft` status to the `published` status. -You can change the state from `draft` to `scheduled` if the **assignment** is scheduled for a future date. +You can change the status from `draft` to `scheduled` if the **assignment** is scheduled for a future date. Only a teacher in the class can make this call. When an **assignment** is in draft status, students will not see the **assignment**, nor will there be any submission objects. When you call this API, [educationSubmission](../resources/educationsubmission.md) objects are created and the assignment appears in the student's list. -The state of the **assignment** goes back to `draft` if there is any backend failure during publish process. +The status of the **assignment** goes back to `draft` if there is any backend failure during publish process. To update the properties of a published **assignment**, see [update an assignment](../api/educationassignment-update.md). HTTP/1.1 200 Ok ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationassignment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationassignment-update.md | In the request body, supply the values for relevant fields that should be update | Property | Type |Description| |:|:--|:-| |addedStudentAction|String| Controls the behavior for students who are added after the assignment is published.|-|addToCalendarAction|educationAddToCalendarOptions|Optional field to control the assignment behavior for adding assignments to students' and teachers' calendars when the assignment is published. Possible values are: `none`, `studentsAndPublisher`, `studentsAndTeamOwners`, `studentsOnly` and `unknownFutureValue`. Default value is `none`. Can't be modified when assignment is in **Published** state. | +|addToCalendarAction|educationAddToCalendarOptions|Optional field to control the assignment behavior for adding assignments to students' and teachers' calendars when the assignment is published. Possible values are: `none`, `studentsAndPublisher`, `studentsAndTeamOwners`, `studentsOnly`, `unknownFutureValue`. Default value is `none`. Can't be modified when the assignment is in `published` status. | |allowLateSubmissions|Boolean| Whether submissions can be submitted after the due date.| |allowStudentsToAddResourcesToSubmission|Boolean| Whether a student can add resources to a submission. Indicated whether the only items on the submission came from the assignment resource list. |-|assignDateTime|DateTimeOffset| Date the assignment should be published to students. Can't be edited after the assignment has been published. | +|assignDateTime|DateTimeOffset| Date the assignment should be published to students. Can't be edited when the assignment is published. | |assignTo|[educationAssignmentRecipient](../resources/educationassignmentrecipient.md)| Students who get the assignment.| |closeDateTime|DateTimeOffset| Date when the assignment is closed for submissions. This is an optional field that can be null if the assignment doesn't allowLateSubmissions or the closeDateTime is the same as the dueDateTime but if specified, it must be greater than or equal to the dueDateTime.| |displayName|String| Name of assignment. | Content-type: application/json ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) * [Specify the default channel for education assignment notifications](/graph/education-build-notificationchannelurl) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Educationclass Delete Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationclass-delete-members.md | The following example shows a request. "sampleKeys": ["11003", "14008"] }--> ```http-DELETE https://graph.microsoft.com/beta/education/classes/11003/members/14008 +DELETE https://graph.microsoft.com/beta/education/classes/11003/members/14008/$ref ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/create-educationclass-from-educationschool-1-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 | Educationclass Post Assignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationclass-post-assignments.md | Namespace: microsoft.graph Create a new assignment. -Only teachers in a class can create an assignment. Assignments start in the Draft state, which means that students will not see the assignment until publication. +Only teachers in a class can create an assignment. Assignments start in draft status, which means that students can't see the assignment until it's published. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] Content-type: application/json ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationgradingscheme Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-delete.md | Namespace: microsoft.graph Delete an [educationGradingScheme](../resources/educationgradingscheme.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). DELETE https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-856 [!INCLUDE [sample-code](../includes/snippets/php/delete-educationgradingscheme-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-educationgradingscheme-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Educationgradingscheme Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-get.md | Namespace: microsoft.graph Read the properties and relationships of an [educationGradingScheme](../resources/educationgradingscheme.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). GET https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-8566-f [!INCLUDE [sample-code](../includes/snippets/php/get-educationgradingscheme-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-educationgradingscheme-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Educationgradingscheme Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-post.md | Namespace: microsoft.graph Create a new [educationGradingScheme](../resources/educationgradingscheme.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). |
v1.0 | Educationgradingscheme Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-update.md | Namespace: microsoft.graph Update the properties of an [educationGradingScheme](../resources/educationgradingscheme.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). Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-educationgradingscheme-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-educationgradingscheme-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-Type: application/json [!INCLUDE [snippet-not-available](../includes/snippets/snippet-not-available.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [Python](#tab/python) [!INCLUDE [snippet-not-available](../includes/snippets/snippet-not-available.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Educationsubmission Excuse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-excuse.md | HTTP/1.1 200 Ok ``` ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationsubmission Post Resources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-post-resources.md | Content-type: application/json ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) * [Upload files for education assignments and submissions](/graph/education-upload-resource-overview) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Educationsubmission Reassign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-reassign.md | HTTP/1.1 200 OK ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationsubmission Return | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-return.md | HTTP/1.1 200 Ok ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationsubmission Submit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-submit.md | HTTP/1.1 200 Ok ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationsubmission Unsubmit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-unsubmit.md | HTTP/1.1 200 Ok ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Encryptedawsstoragebucketfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedawsstoragebucketfinding-get.md | description: "Read the properties and relationships of an encryptedAwsStorageBuc ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Encryptedawsstoragebucketfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedawsstoragebucketfinding-list.md | description: "Get a list of the encryptedAwsStorageBucketFinding objects and the ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Encryptedazurestorageaccountfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedazurestorageaccountfinding-get.md | description: "Read the properties and relationships of an encryptedAzureStorageA ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Encryptedazurestorageaccountfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedazurestorageaccountfinding-list.md | description: "Get a list of the encryptedAzureStorageAccountFinding objects and ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Encryptedgcpstoragebucketfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedgcpstoragebucketfinding-get.md | description: "Read the properties and relationships of an encryptedGcpStorageBuc ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Encryptedgcpstoragebucketfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedgcpstoragebucketfinding-list.md | description: "Get a list of the encryptedGcpStorageBucketFinding objects and the ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Entitlementmanagement Post Accesspackageassignmentrequests | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/entitlementmanagement-post-accesspackageassignmentrequests.md | If successful, this method returns a 200-series response code and a new [accessP 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). ## Examples+ ### Example 1: Admin requests a direct assignment for a user already in the directory+ #### Request -The following example shows a request for a direct assignment, in which the administrator is requesting the creation of an assignment for the user. Because the [accessPackageSubject](../resources/accesspackagesubject.md) might not yet exist, the value of the **targetID** is the object ID of the user being assigned, the value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package. - +The following example shows a request for a direct assignment, in which the administrator requests the creation of an assignment for a user. Because the [accessPackageSubject](../resources/accesspackagesubject.md) might not yet exist, the value of the **targetID** is the object ID of the user being assigned, the value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package. # [HTTP](#tab/http) <!-- { HTTP/1.1 201 Created Content-type: application/json {- "id": "7e382d02-4454-436b-b700-59c7dd77f466", "requestType": "AdminAdd", "requestState": "Submitted", Content-type: application/json } ``` -### Example 2: User requests a package and answers questions for approval +### Example 2: Remove an assignment ++To remove assignments, create a new accessPackageAssignmentRequest object with the following settings: ++* The value of the **requestType** property set to `AdminRemove`. +* In the **accessPackageAssignment** property, include an object with the identifier of the **accessPackageAssignment** objects to delete. + #### Request +The following example shows how to remove an assignment. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_remove_assignment" +}--> ++```http +POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentRequests +Content-type: application/json ++{ + "requestType": "AdminRemove", + "accessPackageAssignment":{ + "id": "a6bb6942-3ae1-4259-9908-0133aaee9377" + } +} +``` ++# [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/beta/$metadata#accessPackageAssignmentRequests/$entity", ++ "id": "78eaee8c-e6cf-48c9-8f99-aae44c35e379", + "requestType": "AdminRemove", + "requestState": "Submitted", + "requestStatus": "Accepted" +} +``` ++### Example 3: Request an assignment by providing answers to questions + The following example shows a request where the requestor provided answers to the approver to help them make their decision.- +#### Request +The following example shows a request. # [HTTP](#tab/http) <!-- { Content-type: application/json ] } ```-### Example 3: Request a package and provide a justification -#### Request ++### Example 4: Request a package and provide a justification The following example shows how to request an access package and provide justification to the approver.- +#### Request +The following example shows a request. # [HTTP](#tab/http) <!-- { Content-type: application/json The following example shows the response. -> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. <!-- { "blockType": "response", Content-type: application/json } ``` -### Example 4: Remove an assignment --To remove assignments, create a new accessPackageAssignmentRequest object with the following settings: --+ The value of the **requestType** property set to `AdminRemove`. -+ In the accessPackageAssignment property, include an object with the identifier of the accessPackageAssignment objects to delete. +### Example 5: Admin requests a direct assignment for a user not yet in the directory #### Request -The following example shows how to remove an assignment. --+The following example shows a request for a direct assignment, in which the administrator requests the creation of an assignment for a user who doesn't exist in the directory. The value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_remove_assignment" + "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_direct_assignment" }--> ```http POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/a Content-type: application/json {- "requestType": "AdminRemove", - "accessPackageAssignment":{ - "id": "a6bb6942-3ae1-4259-9908-0133aaee9377" - } + "requestType": "AdminAdd", + "accessPackageAssignment":{ + "target": { + "email": "user@contoso.com" + }, + "assignmentPolicyId":"2264bf65-76ba-417b-a27d-54d291f0cbc8", + "accessPackageId":"a914b616-e04e-476b-aa37-91038f0b165b" + } } ``` # [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 the response. -> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> **Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity", -- "id": "78eaee8c-e6cf-48c9-8f99-aae44c35e379", - "requestType": "AdminRemove", - "requestState": "Submitted", - "requestStatus": "Accepted" + "id": "7e382d02-4454-436b-b700-59c7dd77f466", + "requestType": "AdminAdd", + "requestState": "Submitted", + "requestStatus": "Accepted", + "isValidationOnly": false } ``` -### Example 5: Admin requests a direct assignment for a user not yet in the directory -#### Request +### Example 6: Request an update to answers for an assignment -The following example shows a request for a direct assignment, in which the administrator is requesting the creation of an assignment for the user, for a user who does not exist in the directory. The value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package. +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. +#### Request ++The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_direct_assignment" + "name": "update_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_to_approver" }-->- ```http POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentRequests Content-type: application/json {- "requestType": "AdminAdd", - "accessPackageAssignment":{ - "target": { - "email": "user@contoso.com" - }, - "assignmentPolicyId":"2264bf65-76ba-417b-a27d-54d291f0cbc8", - "accessPackageId":"a914b616-e04e-476b-aa37-91038f0b165b" - } + "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest", + "id": "7a6ab703-0780-4b37-8445-81f679b2d75c", + "requestType": "adminUpdate", + "answers": [ + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "UpdatedAnswerValue", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion", + "id": "8fe745e7-80b2-490d-bd22-4e708c77288c" + } + }, + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "My updated answer.", + "displayValue": "This is my updated answer to the question.", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", + "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6" + } + } + ], + "assignment": { + "id": "44c741c1-2cf4-40db-83b6-e0112f8e5a83" + } } ``` # [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 the response. -> **Note:** The response object shown here might be shortened for readability. +> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. <!-- { "blockType": "response", HTTP/1.1 201 Created Content-type: application/json {-- "id": "7e382d02-4454-436b-b700-59c7dd77f466", - "requestType": "AdminAdd", - "requestState": "Submitted", - "requestStatus": "Accepted", - "isValidationOnly": false + "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity", + "id": "0c471116-e439-40a6-8441-fe739dd48dab", + "requestType": "adminUpdate", + "state": "submitted", + "status": "Accepted", + "createdDateTime": null, + "completedDateTime": null, + "schedule": { + "startDateTime": null, + "recurrence": null, + "expiration": { + "endDateTime": null, + "duration": null, + "type": "notSpecified" + } + }, + "answers": [ + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "UpdatedAnswerValue", + "displayValue": "This is the answer to a multiple choice question", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion", + "id": "8fe745e7-80b2-490d-bd22-4e708c77288c" + } + }, + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "My updated answer.", + "displayValue": "This is my updated answer to the question.", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", + "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6" + } + } + ] } ``` - <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 2019-02-04 14:57:30 UTC --> <!-- { |
v1.0 | Entitlementmanagement Post Assignmentrequests | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/entitlementmanagement-post-assignmentrequests.md | If this is an `adminAdd` request, then subsequently an [accessPackageAssignment] ## Examples ### Example 1: Admin requests a direct assignment for a user already in the directory+ #### Request -The following example shows a request for a direct assignment, in which the administrator is requesting the creation of an assignment for the user. Because the [accessPackageSubject](../resources/accesspackagesubject.md) might not yet exist, the value of the **targetID** is the object ID of the user being assigned, the value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package. +The following example shows a request for a direct assignment, in which the administrator requests the creation of an assignment for a user. Because the [accessPackageSubject](../resources/accesspackagesubject.md) might not yet exist, the value of the **targetID** is the object ID of the user being assigned, the value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package. # [HTTP](#tab/http) <!-- { HTTP/1.1 201 Created Content-type: application/json {-- "id": "7e382d02-4454-436b-b700-59c7dd77f466", + "id": "46184453-e63b-4f20-86c2-c557ed5d5df9", "requestType": "adminAdd", "requestState": "Submitted", "requestStatus": "Accepted" Content-type: application/json ### Example 2: Remove an assignment -To remove assignments, create a new accessPackageAssignmentRequest object with the following settings: +To remove assignments, create a new **accessPackageAssignmentRequest** object with the following settings: -+ The value of the **requestType** property set to `adminRemove`. -+ In the assignment property, include an object with the identifier of the accessPackageAssignment object to delete. +* The value of the **requestType** property set to `adminRemove`. +* In the **assignment** property, include an object with the identifier of the **accessPackageAssignment** object to delete. #### Request Content-type: application/json The following example shows the response. -> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. <!-- { "blockType": "response", HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#accessPackageAssignmentRequests/$entity", -+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity", "id": "78eaee8c-e6cf-48c9-8f99-aae44c35e379", "requestType": "adminRemove", "requestState": "Submitted", Content-type: application/json } ``` -### Example 3: Request an assignment +### Example 3: Request an assignment by providing answers to questions -The following example shows how a user can request an access package assignment for themselves. +The following example shows how a user can request an access package assignment for themselves by answering questions required by the policy during the request process. #### Request +The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_packageID" + "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_approver" }-->+ ```http POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/assignmentRequests Content-type: application/json {+ "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest", "requestType": "userAdd",+ "answers": [ + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "displayValue": "This is the answer to a multiple choice question", + "value": "MultipleChoiceAnswerValue", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion", + "id": "8fe745e7-80b2-490d-bd22-4e708c77288c" + } + }, + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "This is my answer to a text input question.", + "displayValue": "This is my answer.", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", + "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6" + } + } + ], "assignment": {- "accessPackageId": "d7be3253-b9c6-4fab-adef-30d30de8da2b" + "accessPackageId": "977c7ff4-ef8f-4910-9d31-49048ddf3120" } } ``` # [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 the response. -> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. <!-- { "blockType": "response", HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/entitlementManagement/assignmentRequests/$entity", - "id": "724bc62d-90ff-48f3-903f-b59ec8453343", + "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity", + "id": "7a6ab703-0780-4b37-8445-81f679b2d75c", "requestType": "userAdd",- "state": "submitted" + "state": "submitted", + "status": "Accepted", + "createdDateTime": null, + "completedDateTime": null, + "schedule": { + "startDateTime": null, + "recurrence": null, + "expiration": { + "endDateTime": null, + "duration": null, + "type": "notSpecified" + } + }, + "answers": [ + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "MultipleChoiceAnswerValue", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion", + "id": "8fe745e7-80b2-490d-bd22-4e708c77288c" + }, + "displayValue": "This is the answer to a multiple choice question" + }, + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "This is my answer to a text input question.", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", + "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6" + }, + "displayValue": "This is my answer." + } + ] } ``` -### Example 4: Request an assignment by providing answers to questions +### Example 4: Request a package and provide a justification -The following example shows how a user can request an access package assignment for themselves by answering questions required by the policy while making the request. +The following example shows how to request an access package and provide justification to the approver. #### Request +The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_approver" + "name": "create_assignmentrequests_from_assignmentrequests_justification_provided" }--> ```http POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/a Content-type: application/json {- "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest", - "requestType": "userAdd", - "answers": [ - { - "@odata.type": "#microsoft.graph.accessPackageAnswerString", - "displayValue": "This is the answer to a multiple choice question", - "value": "MultipleChoiceAnswerValue", - "answeredQuestion": { - "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion", - "id": "8fe745e7-80b2-490d-bd22-4e708c77288c" - } - }, - { - "@odata.type": "#microsoft.graph.accessPackageAnswerString", - "value": "This is my answer to a text input question.", - "displayValue": "This is my answer.", - "answeredQuestion": { - "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", - "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6" - } - } - ], - "assignment": { - "accessPackageId": "977c7ff4-ef8f-4910-9d31-49048ddf3120" - } + "requestType": "UserAdd", + "accessPackageAssignment": { + "accessPackageId": "a914b616-e04e-476b-aa37-91038f0b165b" + }, + "justification":"Need access to New Hire access package" } ``` # [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 the response. -> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. <!-- { "blockType": "response", HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#accessPackageAssignmentRequests/$entity", - "id": "7a6ab703-0780-4b37-8445-81f679b2d75c", - "requestType": "userAdd", - "state": "submitted", - "status": "Accepted", + "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/assignmentRequests/$entity", + "id": "9c1e258d-7723-43b1-ae21-e6eeeb324fe5", + "requestType": "UserAdd", + "requestState": "Submitted", + "requestStatus": "Accepted", "createdDateTime": null,- "completedDateTime": null, + "completedDate": null, + "justification": "Need access to New Hire access package", + "isValidationOnly": false, "schedule": { "startDateTime": null, "recurrence": null, Content-type: application/json "type": "notSpecified" } },- "answers": [ - { - "@odata.type": "#microsoft.graph.accessPackageAnswerString", - "value": "MultipleChoiceAnswerValue", - "answeredQuestion": { - "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion", - "id": "8fe745e7-80b2-490d-bd22-4e708c77288c" - }, - "displayValue": "This is the answer to a multiple choice question" - }, - { - "@odata.type": "#microsoft.graph.accessPackageAnswerString", - "value": "This is my answer to a text input question.", - "answeredQuestion": { - "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", - "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6" - }, - "displayValue": "This is my answer." + "answers": [], + "verifiedCredentialsData": [], + "customExtensionHandlerInstances": [], + "customExtensionCalloutInstances": [] +} +``` ++### Example 5: Admin requests a direct assignment for a user not yet in the directory ++#### Request ++The following example shows a request for a direct assignment, in which the administrator is requests the creation of an assignment for a user who doesn't exist in the directory. The value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_assignmentrequest_from_assignmentrequests_direct_assignment" +}--> ++```http +POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/assignmentRequests +Content-type: application/json ++{ + "requestType": "AdminAdd", + "accessPackageAssignment":{ + "target": { + "email": "user@contoso.com" + }, + "assignmentPolicyId":"2264bf65-76ba-417b-a27d-54d291f0cbc8", + "accessPackageId":"a914b616-e04e-476b-aa37-91038f0b165b" + } +} +``` ++# [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.accessPackageAssignmentRequest" +} --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/assignmentRequests/$entity", + "id": "cb32aef9-2976-496d-9804-eb432fd894a7", + "requestType": "AdminAdd", + "requestState": "Submitted", + "requestStatus": "Accepted", + "createdDateTime": null, + "completedDate": null, + "justification": null, + "isValidationOnly": false, + "schedule": { + "startDateTime": null, + "recurrence": null, + "expiration": { + "endDateTime": null, + "duration": null, + "type": "notSpecified" }- ] + }, + "answers": [], + "verifiedCredentialsData": [], + "customExtensionHandlerInstances": [], + "customExtensionCalloutInstances": [] } ``` -### Example 5: Request an update to answers for an assignment +### Example 6: 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 while requesting the 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. #### Request +The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "update_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_to_approver" + "name": "update_accesspackageassignmentrequest_from_assignmentrequests_requestor_answer_to_approver" }--> ```http POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/assignmentRequests 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 the response. -> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. <!-- { "blockType": "response", HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#accessPackageAssignmentRequests/$entity", + "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity", "id": "0c471116-e439-40a6-8441-fe739dd48dab", "requestType": "adminUpdate", "state": "submitted", Content-type: application/json ] } ```++<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 +2019-02-04 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "Create accessPackageAssignmentRequest", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> |
v1.0 | Extensionproperty Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/extensionproperty-delete.md | Title: "Delete extensionProperty (directory extension)" description: "Delete a directory extension definition." ms.localizationpriority: medium + doc_type: "apiPageType" |
v1.0 | Extensionproperty Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/extensionproperty-get.md | Title: "Get extensionProperty (directory extension)" description: "Read a directory extension definition." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Externalauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalauthenticationmethodconfiguration-delete.md | + + Title: "Delete externalAuthenticationMethodConfiguration" +description: "Delete an externalAuthenticationMethodConfiguration object." ++ms.localizationpriority: medium ++++# Delete externalAuthenticationMethodConfiguration ++Namespace: microsoft.graph +++Delete an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.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": "externalauthenticationmethodconfiguration-delete-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{id} +``` ++## 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_externalauthenticationmethodconfiguration" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/b3107ab7-68c7-4553-a167-48c1e9c24d52 +``` ++# [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 | Externalauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalauthenticationmethodconfiguration-get.md | + + Title: "Get externalAuthenticationMethodConfiguration" +description: "Read the properties and relationships of an externalAuthenticationMethodConfiguration object." ++ms.localizationpriority: medium ++++# Get externalAuthenticationMethodConfiguration ++Namespace: microsoft.graph +++Read the properties and relationships of an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.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": "externalauthenticationmethodconfiguration-get-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{id} +``` ++## 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 an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_externalauthenticationmethodconfiguration" +} +--> +``` http +GET https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/b3107ab7-68c7-4553-a167-48c1e9c24d52 +``` ++# [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.externalAuthenticationMethodConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.externalAuthenticationMethodConfiguration", + "id": "b3107ab7-68c7-4553-a167-48c1e9c24d52", + "displayName": "Adatum", + "appId": "fb262304-618c-4ffb-878a-114490bdf200", + "openIdConnectSetting": { + "clientId": "06a011bd-ec92-4404-80fb-db6d5ada8ee2", + "discoveryUrl": "https//Adatum.com/.well-known/openid-configuration" + }, + "state": "disabled", + "excludeTargets": [], + "includeTargets": [] +} +``` + |
v1.0 | Externalauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalauthenticationmethodconfiguration-update.md | + + Title: "Update externalAuthenticationMethodConfiguration" +description: "Update the properties of an externalAuthenticationMethodConfiguration object." ++ms.localizationpriority: medium ++++# Update externalAuthenticationMethodConfiguration ++Namespace: microsoft.graph +++Update the properties of an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.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": "externalauthenticationmethodconfiguration-update-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{id} +``` ++## 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|authenticationMethodState|The state of the method in the policy. The possible values are: `enabled`, `disabled`. | +|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups representing the users that should be excluded from the policy. | +|appId|String|**appId** for the app registration in Microsoft Entra ID representing the integration with the external provider.| +|openIdConnectSetting|[openIdConnectSetting](../resources/openidconnectsetting.md)|Object representing the required settings for the OIDC request to the external provider.| ++++## 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_externalauthenticationmethodconfiguration" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/b183b746-e7db-4fa2-bafc-69ecf18850dd +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.externalAuthenticationMethodConfiguration", + "includeTargets": [ + { + "targetType": "group", + "id": "b183b746-e7db-4fa2-bafc-69ecf18850dd", + "isRegistrationRequired": false, + } + ], + "state": "enabled" +} ++``` ++# [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 | Externalconnectors External List Authorizationsystems | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalconnectors-external-list-authorizationsystems.md | description: "List the authorizationSystem objects and their properties." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Externallyaccessibleawsstoragebucketfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessibleawsstoragebucketfinding-get.md | description: "Read the properties and relationships of an externallyAccessibleAw ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Externallyaccessibleawsstoragebucketfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessibleawsstoragebucketfinding-list.md | description: "Get a list of the externallyAccessibleAwsStorageBucketFinding obje ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Externallyaccessibleazureblobcontainerfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessibleazureblobcontainerfinding-get.md | description: "Read the properties and relationships of an externallyAccessibleAz ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Externallyaccessibleazureblobcontainerfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessibleazureblobcontainerfinding-list.md | description: "Get a list of the externallyAccessibleAzureBlobContainerFinding ob ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Externallyaccessiblegcpstoragebucketfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessiblegcpstoragebucketfinding-get.md | description: "Read the properties and relationships of an externallyAccessibleGc ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Externallyaccessiblegcpstoragebucketfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessiblegcpstoragebucketfinding-list.md | description: "Get a list of the externallyAccessibleGcpStorageBucketFinding obje ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Externaluserprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externaluserprofile-get.md | GET https://graph.microsoft.com/beta/directory/externalUserProfiles/{id} [!INCLUDE [sample-code](../includes/snippets/php/get-externaluserprofile-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-externaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Externaluserprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externaluserprofile-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-externaluserprofile-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-externaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Federatedidentitycredential Upsert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/federatedidentitycredential-upsert.md | Namespace: microsoft.graph Create a new [federatedIdentityCredential](../resources/federatedidentitycredential.md) object for an application if it does exist, or update the properties of an existing [federatedIdentityCredential](../resources/federatedidentitycredential.md) object. By [configuring a trust relationship](/azure/active-directory/develop/workload-identity-federation-create-trust) between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to 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 | Federatedtokenvalidationpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/federatedtokenvalidationpolicy-get.md | Namespace: microsoft.graph Read the properties and relationships of a [federatedTokenValidationPolicy](../resources/federatedtokenvalidationpolicy.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). Choose the permission or permissions marked as least privileged for this API. Us --> [!INCLUDE [permissions-table](../includes/permissions/federatedtokenvalidationpolicy-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Federatedtokenvalidationpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/federatedtokenvalidationpolicy-update.md | Choose the permission or permissions marked as least privileged for this API. Us --> [!INCLUDE [permissions-table](../includes/permissions/federatedtokenvalidationpolicy-update-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Filestorage Delete Containers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-delete-containers.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Delete a [fileStorageContainer](../resources/filestoragecontainer.md) object. This method moves the **fileStorageContainer** to the recycle bin; it doesn't permanently delete it. ++Delete a [fileStorageContainer](../resources/filestoragecontainer.md) object. Deleting a file storage container with this API moves it to the deleted container collection, so that it can 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). --<!-- { "blockType": "permissions", "name": "filestorage_delete_containers" } --> +<!-- { + "blockType": "permissions", + "name": "filestorage-delete-containers-permissions" +} +--> [!INCLUDE [permissions-table](../includes/permissions/filestorage-delete-containers-permissions.md)] + ## HTTP request <!-- { The following example shows a request. } --> ``` http-DELETE https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId} +DELETE https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z ``` - ### Response The following example shows the response.+>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true The following example shows the response. ``` http HTTP/1.1 204 No Content ```- |
v1.0 | Filestorage Delete Deletedcontainers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-delete-deletedcontainers.md | + + Title: "Remove deleted fileStorageContainer" +description: "Remove a deleted fileStorageContainer object." ++ms.localizationpriority: medium ++++# Remove deleted fileStorageContainer ++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). ++<!-- { + "blockType": "permissions", + "name": "filestorage-delete-deletedcontainers-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /deletedStorageContainers/{containerId} +``` ++## 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", + "name": "remove_deleted_filestoragecontainer" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/deletedStorageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z +``` +++### 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 204 No Content +``` + |
v1.0 | Filestorage Get Deletedcontainers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-get-deletedcontainers.md | + + Title: "Get deleted fileStorageContainer" +description: "Get a deleted fileStorageContainer resource." ++ms.localizationpriority: medium ++++# Get deleted fileStorageContainer ++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). ++<!-- { + "blockType": "permissions", + "name": "filestorage-get-deletedcontainers-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deletedStorageContainers/{containerId} +``` ++## 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. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "get_deleted_filestoragecontainer" +} +--> +``` http +GET https://graph.microsoft.com/beta/deletedStorageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z?$select=*,members +``` +++### 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.fileStorageContainer" +} +--> +``` http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.fileStorageContainer", + "id": "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z", + "displayName": "My Application Storage Container", + "containerTypeId": "91710488-5756-407f-9046-fbe5f0b4de73", + "createdDateTime": "2021-11-24T15:41:52.347Z", + "deletedDateTime": "2022-08-11T12:35:16.300Z", + "expiryDateTime": "2022-11-09T12:35:16.300Z", + "members": [ + { + "id": "EBA7DBE0-B42F-4BC8-AEF6-97B66EFC77D0" + }, + { + "id": "ABE7DBE0-B42F-4BC8-AEF6-97B66EFC0000" + } + ] +} +``` + |
v1.0 | Filestorage List Deletedcontainers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-list-deletedcontainers.md | + + Title: "List deleted fileStoageContainers" +description: "Get a list of deleted fileStorageContainers." ++ms.localizationpriority: medium ++++# List deletedContainers ++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). ++<!-- { + "blockType": "permissions", + "name": "filestorage-list-deletedcontainers-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deletedStorageContainers?$filter=containerTypeId eq {containerTypeId} +``` ++## Query parameters +This method requires the `containerTypeId` parameter. It supports OData skip-top paging and the `$orderBy` and `$filter` query parameters, but doesn't support the `$expand` query parameter. ++## 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 [fileStorageContainer](../resources/filestoragecontainer.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "list_deleted_filestoragecontainer" +} +--> +``` http +GET https://graph.microsoft.com/beta/deletedStorageContainers?$filter=containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082 +``` +++### 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.fileStorageContainer)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.fileStorageContainer", + "id": "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z", + "displayName": "My File Storage Container", + "createdDateTime": "2021-11-24T15:41:52.347Z", + "deletedDateTime": "2022-08-11T12:35:16.300Z" + } + ] +} +``` + |
v1.0 | Filestoragecontainer Activate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-activate.md | -# fileStorageContainer: activate +# fileStorageContainer: activate Namespace: microsoft.graph Namespace: microsoft.graph Activate a [fileStorageContainer](../resources/filestoragecontainer.md) object. -A **fileStorageContainer** object is created in an inactive state, as indicated by the **status** property. A container must be activated within 24 hours after creation, or it is automatically deleted. Upon activation, the value of the status property changes from `inactive` to `active`. --A **fileStorageContainer** can be activated by calling the activate API or any API that updates or modifies the **fileStorageContainer** or its content. For example, uploading a file to a **fileStorageContainer**, adding permission to a **fileStorageContainer**, creating a custom property on a **fileStorageContainer**, or updating the properties of a **fileStorageContainer** can activate it. +A **fileStorageContainer** object is created in an inactive state, as indicated by the **status** property. A container that isn't activated within 24 hours after creation is automatically deleted. Upon activation, the value of the status property changes from `inactive` to `active`. +A file storage container can be activated by calling this API or any API that updates or modifies it or its content. For example, uploading a file to a file storage container activates it. It's also activated when you add permissions to it or update them, or create a custom property on it. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_activate" } --> [!INCLUDE [permissions-table](../includes/permissions/filestoragecontainer-activate-permissions.md)] |
v1.0 | Filestoragecontainer Delete Column | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-delete-column.md | + + Title: "Delete column" +description: "Delete a columnDefinition from a fileStorageContainer." ++ms.localizationpriority: medium ++++# Delete column ++Namespace: microsoft.graph +++Delete a [columnDefinition](../resources/columndefinition.md) from 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). ++<!-- { + "blockType": "permissions", + "name": "filestoragecontainer-delete-columns-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /storageContainers/{containerId}/columns/{column-id} +``` ++## 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", + "name": "delete_columndefinition_for_fileStorageContainer" +} +--> +``` http +DELETE https://graph.microsoft.com/bet/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns/99ddcf45-e2f7-4f17-82b0-6fba34445103 +Content-Type: application/json ++{ + "description": "test", + "enforceUniqueValues": false, + "hidden": false, + "indexed": false, + "name": "Title", + "text": { + "allowMultipleLines": false, + "appendChangesToExistingText": false, + "linesForEditing": 0, + "maxLength": 255 + } +} +``` +++### 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 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 | + + Title: "Delete recycleBin items" +description: "Delete items from fileStorageContainer recycleBin." ++ms.localizationpriority: medium ++++# Delete recycle bin items ++Namespace: microsoft.graph +++Permanently delete [recycleBinItem](../resources/recyclebinitem.md) objects from the [recycleBin](../resources/recyclebin.md) of a [fileStorageContainer](../resources/filestoragecontainer.md). Items deleted by this method can't be restored. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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-delete-recyclebin-items-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /storageContainers/{containerId}/recycleBin/items/delete +``` ++## 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 [recycleBinItem](../resources/recyclebinitem.md) objects to delete. +++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "delete_filestoragecontainer_recyclebin_items", + "@odata.type": "Collection(microsoft.graph.recyclebinitem)" +} +--> +``` http +POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items/delete +Content-Type: application/json ++{ + "ids": ["5d625d33-338c-4a77-a98a-3e287116440c", "73133853-48f2-4956-bc4a-03f8d1675042"] +} +``` ++### 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 204 No Content +``` + |
v1.0 | Filestoragecontainer Get Column | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-get-column.md | + + Title: "Get column" +description: "Get a column from a fileStorageContainer." ++ms.localizationpriority: medium ++++# Get column ++Namespace: microsoft.graph +++Get the properties of a 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). ++<!-- { + "blockType": "permissions", + "name": "filestoragecontainer-get-columns-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /storageContainers/{containerId}/columns/{column-id} +``` ++## 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 [columnDefinition](../resources/columndefinition.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "get_columndefinition_for_fileStorageContainer" +} +--> +``` http +GET https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns/99ddcf45-e2f7-4f17-82b0-6fba34445103 +``` +++### 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.columnDefinition" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "description": "test", + "displayName": "Title", + "enforceUniqueValues": false, + "hidden": false, + "id": "99ddcf45-e2f7-4f17-82b0-6fba34445103", + "indexed": false, + "name": "Title", + "text": { + "allowMultipleLines": false, + "appendChangesToExistingText": false, + "linesForEditing": 0, + "maxLength": 255 + } +} +``` + |
v1.0 | Filestoragecontainer List Columns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-list-columns.md | + + Title: "List columns" +description: "List columns in a fileStorageContainer." ++ms.localizationpriority: medium ++++# List columns ++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). ++<!-- { + "blockType": "permissions", + "name": "filestoragecontainer-list-columns-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +GET /storageContainers/{containerId}/columns +``` ++## 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 [columnDefinition](../resources/columndefinition.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "list_columndefinition" +} +--> ++``` http +GET https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns +``` +++### 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.columnDefinition)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "description": "", + "displayName": "Title", + "hidden": false, + "id": "99ddcf45-e2f7-4f17-82b0-6fba34445103", + "indexed": false, + "name": "Title", + "readOnly": false, + "required": false, + "text": { + "allowMultipleLines": false, + "appendChangesToExistingText": false, + "linesForEditing": 0, + "maxLength": 255 + } + }, + { + "description": "", + "displayName": "Address", + "id": "11dfef35-e2f7-4f17-82b0-6fba34445103", + "indexed": false, + "name": "Address", + "readOnly": false, + "required": false, + "text": { + "allowMultipleLines": false, + "appendChangesToExistingText": false, + "linesForEditing": 0, + "maxLength": 255 + } + } + ] +} +``` + |
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 | + + Title: "List recycleBin items" +description: "Get a list of recycle bin items from a fileStorageContainer recycleBin." ++ms.localizationpriority: medium ++++# List recycleBin items ++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). ++<!-- { + "blockType": "permissions", + "name": "filestoragecontainer-list-recyclebin-items-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +GET /storageContainers/{containerId}/recycleBin/items +``` ++## 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 [recycleBinItem](../resources/recyclebinitem.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. ++<!-- { + "blockType": "request", + "name": "list_recyclebin_items" +} +--> ++``` http +GET https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items +``` +++### 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.recycleBinItem)" +} +--> ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "id": "5d625d33-338c-4a77-a98a-3e287116440c", + "name": "document.docx", + "size": 1024, + "deletedDateTime": "2022-04-25T20:11:51Z", + "title": "my document", + "deletedBy": { + "user": { + "displayName": "Tenant Admin User", + "id": "EBA7DBE0-B42F-4BC8-AEF6-97B66EFC77D0", + "userPrincipalName": "jhan@contoso.com" + } + } + } + ] +} +``` + |
v1.0 | Filestoragecontainer Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-permanentdelete.md | + + Title: "fileStorageContainer: permanentDelete" +description: "Permanently delete a fileStorageContainer." ++ms.localizationpriority: medium ++++# fileStorageContainer: permanentDelete ++Namespace: microsoft.graph +++Permanently delete a [fileStorageContainer](../resources/filestoragecontainer.md). 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). ++<!-- { + "blockType": "permissions", + "name": "filestoragecontainer-permanentdelete-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /storageContainers/{containerId}/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. ++<!-- { + "blockType": "request", + "name": "filestoragecontainerthis.permanentdelete" +} +--> ++``` http +POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/permanentDelete +``` +++### 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 204 No Content +``` + |
v1.0 | Filestoragecontainer Post Columns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-post-columns.md | + + Title: "Create column" +description: "Create a columnDefinition in a fileStorageContainer." ++ms.localizationpriority: medium ++++# Create column ++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). ++<!-- { + "blockType": "permissions", + "name": "filestoragecontainer-post-columns-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /storageContainers/{containerId}/columns +``` ++## 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 [columnDefinition](../resources/columndefinition.md) object. ++Only the following type-related properties are supported and they're mutually exclusive; a column can only have one of them specified at a time. ++|Property|Type|Description| +|:|:|:| +|boolean|[booleanColumn](../resources/booleancolumn.md)|This column stores boolean values.| +|choice|[choiceColumn](../resources/choicecolumn.md)|This column stores data from a list of choices.| +|currency|[currencyColumn](../resources/currencycolumn.md)|This column stores currency values.| +|dateTime|[dateTimeColumn](../resources/datetimecolumn.md)|This column stores DateTime values.| +|hyperlinkOrPicture|[hyperlinkOrPictureColumn](../resources/hyperlinkorpicturecolumn.md)|This column stores hyperlink or picture values.| +|number|[numberColumn](../resources/numbercolumn.md)|This column stores number values.| +|personOrGroup|[personOrGroupColumn](../resources/personorgroupcolumn.md)|This column stores Person or Group values.| +|text|[textColumn](../resources/textcolumn.md)|This column stores text values.| ++## Response ++If successful, this method returns a `201 Created` response code and a [columnDefinition](../resources/columndefinition.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++<!-- { + "blockType": "request", + "name": "create_columndefinition_for_fileStorageContainer" +} +--> ++``` http +POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns +Content-Type: application/json ++{ + "description": "test", + "enforceUniqueValues": false, + "hidden": false, + "indexed": false, + "name": "Title", + "text": { + "allowMultipleLines": false, + "appendChangesToExistingText": false, + "linesForEditing": 0, + "maxLength": 255 + } +} +``` +++### 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.columnDefinition" +} +--> ++``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "description": "test", + "displayName": "Title", + "enforceUniqueValues": false, + "hidden": false, + "id": "99ddcf45-e2f7-4f17-82b0-6fba34445103", + "indexed": false, + "name": "Title", + "text": { + "allowMultipleLines": false, + "appendChangesToExistingText": false, + "linesForEditing": 0, + "maxLength": 255 + } +} +``` + |
v1.0 | Filestoragecontainer Post Customproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-post-customproperty.md | You can specify the following properties when you create a custom property. ## Response -If successful, this method returns either a `200 Created` or `201 Created` response code. +If successful, this method returns a `200 Created` response code. ## Examples -### Request +### Example 1: Create a custom property ++#### Request The following example shows how to create a custom property called `clientUniqueId` for a container. <!-- { "blockType": "request", Content-Type: application/json } ``` -### Response +#### Response The following example shows the response. By default, the property isn't searchable. <!-- { "blockType": "response", The following example shows the response. By default, the property isn't searcha ``` http HTTP/1.1 200 Created ```+### Example 2: Create a custom searchable property -### Request +#### Request The following example shows how to create a searchable custom property called `clientUniqueId` for a container. <!-- { "blockType": "request", Content-Type: application/json } } ```-### Response +#### Response The following example shows the response. <!-- { "blockType": "response", The following example shows the response. HTTP/1.1 200 Created ``` -### Request -The following example shows how to create multiple custom properties for a container. -<!-- { - "blockType": "request", - "name": "post_filestoragecontainer_customproperty_3" -} >-``` http -PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/customProperties -Content-Type: application/json --{ - "property1": { - "value": "valueOfProperty1", - "isSearchable": true - }, - "property2": { - "value": "valueOfProperty2", - "isSearchable": false - } -} -``` --### Response -The following example shows the response. -<!-- { - "blockType": "response", - "truncated": true -} >-``` http -HTTP/1.1 201 Created -``` |
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 | + + Title: "Restore recycleBin items" +description: "Restore recycleBin items to a fileStorageContainer." ++ms.localizationpriority: medium ++++# Restore recycle bin items ++Namespace: microsoft.graph +++Restore [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). ++<!-- { + "blockType": "permissions", + "name": "filestoragecontainer-restore-recyclebin-items-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +POST /storageContainers/{containerId}/recycleBin/items/restore +``` ++## 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 [recycleBinItem](../resources/recyclebinitem.md) objects to restore. ++## Response ++If successful, this method returns a `207 Multi-Status` response code and the set of restored [recycleBinItem](../resources/recyclebinitem.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. ++<!-- { + "blockType": "request", + "name": "restore_filestoragecontainer_recyclebin_items", + "@odata.type": "Collection(microsoft.graph.recycleBinItem)" +} +--> ++``` http +POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items/restore +Content-Type: application/json ++{ + "ids": ["5d625d33-338c-4a77-a98a-3e287116440c", "73133853-48f2-4956-bc4a-03f8d1675042"] +} +``` ++### 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.recycleBinItem)" +} +--> ++``` http +HTTP/1.1 207 Multi-Status +Content-Type: application/json ++{ + "value": [ + { + "id": "5d625d33-338c-4a77-a98a-3e287116440c" + }, + { + "id": "73133853-48f2-4956-bc4a-03f8d1675042" + } + ] +} +``` + |
v1.0 | Filestoragecontainer Restore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-restore.md | + + Title: "Restore deleted fileStorageContainer" +description: "Restore deleted fileStorageContainer from the deleted container collection." ++ms.localizationpriority: medium ++++# fileStorageContainer: restore ++Namespace: microsoft.graph +++Restore 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). ++<!-- { + "blockType": "permissions", + "name": "filestoragecontainer-restore-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deletedStorageContainers/{containerId}/restore +``` ++## 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 [fileStorageContainer](../resources/filestoragecontainer.md) in the response body. ++## Examples ++### Request ++The following example shows a request. ++<!-- { + "blockType": "request", + "name": "filestoragecontainerthis.restore" +} +--> +``` http +POST https://graph.microsoft.com/beta/deletedStorageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/restore +``` +++### 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.fileStorageContainer" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "microsoft.graph.fileStorageContainer", + "id": "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z", + "displayName": "My Application Storage Container", + "containerTypeId": "91710488-5756-407f-9046-fbe5f0b4de73", + "createdDateTime": "2021-11-24T15:41:52.347Z", + "deletedDateTime": "2022-08-11T12:35:16.300Z" +} +``` + |
v1.0 | Filestoragecontainer Update Column | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-update-column.md | + + Title: "Update column" +description: "Update a columnDefinition in a fileStorageContainer." ++ms.localizationpriority: medium ++++# Update column ++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). ++<!-- { + "blockType": "permissions", + "name": "filestoragecontainer-update-columns-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /storageContainers/{containerId}/columns/{column-id} +``` ++## 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 [columnDefinition](../resources/columndefinition.md) object with the properties to update. The `id` property can't be changed. Existing properties not 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 and a [columnDefinition](../resources/columndefinition.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++<!-- { + "blockType": "request", + "name": "update_columndefinition_for_fileStorageContainer" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns/11dfef35-e2f7-4f17-82b0-6fba34445103 +Content-Type: application/json ++{ + "required": true, + "hidden": false +} +``` +++### 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.columnDefinition" +} +--> +``` http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "description": "", + "displayName": "Custom Column", + "enforceUniqueValues": false, + "hidden": false, + "id": "11dfef35-e2f7-4f17-82b0-6fba34445103", + "indexed": false, + "name": "Custom Column", + "readOnly": false, + "required": true, + "text": { + "allowMultipleLines": false, + "appendChangesToExistingText": false, + "linesForEditing": 0, + "maxLength": 255 + } +} +``` + |
v1.0 | Gcpassociatedidentities List All | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpassociatedidentities-list-all.md | description: "Get a list of the gcpIdentity objects and their properties." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpassociatedidentities List Serviceaccounts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpassociatedidentities-list-serviceaccounts.md | description: "Get a list of the gcpServiceAccount objects and their properties." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpassociatedidentities List Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpassociatedidentities-list-users.md | description: "Get a list of the gcpUser objects and their properties." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpauthorizationsystem List Actions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystem-list-actions.md | description: "List the gcpAuthorizationSystemTypeAction objects and their proper ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpauthorizationsystem List Resources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystem-list-resources.md | description: "List the gcpAuthorizationSystemResource objects and their properti ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpauthorizationsystem List Roles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystem-list-roles.md | description: "List all GCP roles in a GCP authorization system." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpauthorizationsystem List Services | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystem-list-services.md | description: "Get all services in a GCP authorization system." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpauthorizationsystem List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystem-list.md | description: "Get a list of the gcpAuthorizationSystem objects and their propert ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpauthorizationsystemresource Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystemresource-get.md | description: "Read the properties and relationships of a gcpAuthorizationSystemR ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpauthorizationsystemtypeaction Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystemtypeaction-get.md | description: "Read the properties and relationships of a gcpAuthorizationSystemT ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpidentity Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpidentity-get.md | description: "Read the properties and relationships of a gcpIdentity object." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcprole Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcprole-get.md | description: "Get a GCP role in a GCP authorization system." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpserviceaccount Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpserviceaccount-get.md | description: "Read the properties and relationships of a gcpServiceAccount objec ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Gcpuser Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpuser-get.md | description: "Read the properties and relationships of a gcpUser object." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Group Assignlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-assignlicense.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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +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 - Groups Administrator - License Administrator - User Administrator-- Global Administrator ## HTTP request |
v1.0 | Group Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-delete.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/group-delete-permissions.md)] The following conditions apply for apps to delete role-assignable groups:-+ For delegated scenarios, the app must be assigned the _RoleManagement.ReadWrite.Directory_ delegated permission, and the calling user must be the creator of the group or a global administrator or a privileged role administrator. -+ For app-only scenarios, the calling app must be the owner of the group or be assigned the _RoleManagement.ReadWrite.Directory_ application permission or be assigned the Global Administrator or Privileged Role Administrator Microsoft Entra role. ++ For delegated scenarios, the app must be assigned the _RoleManagement.ReadWrite.Directory_ delegated permission, and the calling user must be the creator of the group or a privileged role administrator.++ For app-only scenarios, the calling app must be the owner of the group or be assigned the _RoleManagement.ReadWrite.Directory_ application permission or be assigned the Privileged Role Administrator Microsoft Entra role. ## HTTP request |
v1.0 | Group List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-list-members.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "group_list_members" } --> [!INCLUDE [permissions-table](../includes/permissions/group-list-members-permissions.md)] -> **Note:** To list the members of a hidden membership group, the Member.Read.Hidden permission is required. - [!INCLUDE [limited-info](../../includes/limited-info.md)] +> **Note:** To list the members of a hidden membership group, the *Member.Read.Hidden* permission is also required. + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Group List Transitivemembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-list-transitivemembers.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "group_list_transitivemembers" } --> [!INCLUDE [permissions-table](../includes/permissions/group-list-transitivemembers-permissions.md)] -> **Note:** To list the members of a hidden membership group, the _Member.Read.Hidden_ permission is required. - [!INCLUDE [limited-info](../../includes/limited-info.md)] +> **Note:** To list the members of a hidden membership group, the _Member.Read.Hidden_ permission is required. + ## HTTP request <!-- { "blockType": "ignored" } --> |
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. | 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. | | mailNickname | String | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : . <> , SPACE`. |-| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. To update this property, the calling user must be assigned one of the following Microsoft Entra roles: <br><ul><li> Global Administrator <li> User Account Administrator <li> Directory Writer <li> Exchange Administrator <li> SharePoint Administrator </ul> <br/>For more information about this property, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction). | +| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. To update this property, the calling user must be assigned at least one of the following Microsoft Entra roles: <br><ul><li> User Account Administrator <li> Directory Writer <li> Exchange Administrator <li> SharePoint Administrator </ul> <br/>For more information about this property, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction). | | securityEnabled | Boolean | Specifies whether the group is a security group, including Microsoft 365 groups. |+| uniqueName | String | The unique identifier that can be assigned to a group and used as an alternate key. Can updated only if `null` and is immutable once set. | | visibility | String | Specifies the visibility of a Microsoft 365 group. Possible values are: **Private**, **Public**, or empty (which is interpreted as **Public**). | | writebackConfiguration | [groupWritebackConfiguration](../resources/groupwritebackconfiguration.md) | Specifies whether or not a group is configured to write back group object properties to on-premise Active Directory. These properties are used when group writeback is configured in the [Microsoft Entra Connect](/azure/active-directory/hybrid/how-to-connect-group-writeback-v2) sync client.| |
v1.0 | Group Upsert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-upsert.md | You can create or update the following types of group: - Microsoft 365 group (unified group) - Security group - By default, this operation returns only a subset of the properties for each group. For a list of properties that are returned by default, see thethe [Properties](../resources/group.md#properties) section of the [group](../resources/group.md) resource. To get properties that are _not_ returned by default, do a [GET operation](group-get.md) and specify the properties in a `$select` OData query option. + By default, this operation returns only a subset of the properties for each group. For a list of properties that are returned by default, see the [Properties](../resources/group.md#properties) section of the [group](../resources/group.md) resource. To get properties that are _not_ returned by default, do a [GET operation](group-get.md) and specify the properties in a `$select` OData query option. -**Note**: To create a [team](../resources/team.md), first create a group then add a team to it, see [create team](../api/team-put-teams.md). +> **Note**: To create a [team](../resources/team.md), first create a group, and then add a team to it. For more information, see [Create team](../api/team-put-teams.md). ## Permissions The following table lists the properties that are required when you create the [ | Property | Type | Description | | :-- | : | :-- |-| displayName | string | The name to display in the address book for the group. Maximum length is 256 characters. Required. | -| mailEnabled | boolean | Set to `true` for mail-enabled groups. Required. | -| mailNickname | string | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : <> , SPACE`. Required. | -| securityEnabled | boolean | Set to `true` for security-enabled groups, including Microsoft 365 groups. Required. **Note:** Groups created using the Microsoft Entra admin center or the Azure portal always have **securityEnabled** initially set to `true`. | +| displayName | String | The name to display in the address book for the group. Maximum length is 256 characters. Required. | +| mailEnabled | Boolean | Set to `true` for mail-enabled groups. Required. | +| mailNickname | String | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : <> , SPACE`. Required. | +| securityEnabled | Boolean | Set to `true` for security-enabled groups, including Microsoft 365 groups. Required. **Note:** Groups created using the Microsoft Entra admin center or the Azure portal always have **securityEnabled** initially set to `true`. | > [!IMPORTANT]-> > - Creating a group using the **Group.Create** application permission without specifying owners will create the group anonymously and the group will not be modifiable. Add owners to the group while creating it to specify owners who can modify the group.-> > - Creating a Microsoft 365 group programmatically with an app-only context and without specifying owners will create the group anonymously. Doing so can result in the associated SharePoint Online site not being created automatically until further manual action is taken.-> -> - 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**. +> - 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 ### Example 2: Create a security group with an owner and members if it doesn't exist -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 [add member](/graph/api/group-post-members?view=graph-rest-beta&preserve-view=true) API or JSON batching. +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. #### Request The following example shows the response. The value of the **preferredDataLocati HTTP/1.1 204 No Content ``` -## See also +## Related content - [Add custom data to resources using extensions](/graph/extensibility-overview) - [Add custom data to users using open extensions (preview)](/graph/extensibility-open-users) |
v1.0 | Horizontalsection Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/horizontalsection-delete.md | DELETE /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/ho ## Request body -Do not supply a request body with this method. +Don't supply a request body with this method. ## Response If the target horizontal section is not found, this method returns `404 Not Foun <!-- { "blockType": "ignored" } --> ``` http-DELETE https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId} +DELETE https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1 ``` -ve ### Response <!-- { "blockType": "response" } --> |
v1.0 | Horizontalsection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/horizontalsection-get.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ``` http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId} +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1 ``` #### Response Content-Type: application/json ### Example 2: Get a horizontalSection object using select and expand #### Request -With `select` and `expand` statements, you can retrieve horizontalSection metadata and column information in a single request. +With `$select` and `$expand` statements, you can retrieve horizontalSection metadata and column information in a single request. <!-- { "blockType": "ignored" } --> ``` http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId}?select=id,expand=columns +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1?$select=id&$expand=columns ``` #### Response |
v1.0 | Horizontalsection List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/horizontalsection-list.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ``` http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections ``` ### Response |
v1.0 | Horizontalsection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/horizontalsection-update.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ``` http-PATCH https://graph.microsoft.com/beta/sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId} +PATCH https://graph.microsoft.com/beta/sites/a69edae4-9208-4f60-9aa3-cd0911ff0ce1/pages/7f7a2740-2d74-47ba-af0c-71ed3a3384ca/microsoft.graph.sitePage/canvasLayout/horizontalSections/1 Content-Type: application/json |
v1.0 | Horizontalsectioncolumn Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/horizontalsectioncolumn-get.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId}/columns/{horizontalSectionColumnId} +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1/columns/1 ``` #### Response Content-Type: application/json ### Example 2: Get a horizontalSectionColumn using select and expand #### Request -With `select` and `expand` statements, you can retrieve horizontalSectionColumn metadata and associated webParts in a single request. +With `$select` and `$expand` statements, you can retrieve horizontalSectionColumn metadata and associated webParts in a single request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId}/columns/{horizontalSectionColumnId}?select=id,expand=webparts +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1/columns/1?$select=id&$expand=webparts ``` #### Response |
v1.0 | Identityapiconnector Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-create.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_create" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-create-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identityapiconnector Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identityapiconnector Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identityapiconnector List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_list" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-list-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identityapiconnector Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-update-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identityapiconnector Uploadclientcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-uploadclientcertificate.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_uploadclientcertificate" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-uploadclientcertificate-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identitycontainer List B2cuserflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-list-b2cuserflows.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_list_b2cuserflows" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-b2cuserflows-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identitycontainer List B2xuserflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-list-b2xuserflows.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_list_b2xuserflows" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-b2xuserflows-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## 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 | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_list_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator -* External ID user flow administrator ## HTTP request |
v1.0 | Identitycontainer Post Authenticationeventlisteners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-authenticationeventlisteners.md | Create a new [authenticationEventListener](../resources/authenticationeventliste - [onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md) - [onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md) +> [!NOTE] +> +> You can have a maximum of 250 event listeners. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Identitycontainer Post Authenticationeventsflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-authenticationeventsflows.md | If successful, this method returns a `201 Created` response code and a JSON repr ## Examples -<a name='example-1-create-a-basic-external-identities-sign-up-and-sign-in-user-flow-on-an-azure-ad-customer-tenant'></a> --### Example 1: Create a basic External Identities sign-up and sign-in user flow on a Microsoft Entra customer tenant +### Example 1: Create a basic External Identities sign-up and sign-in user flow in an external tenant #### Request The following example shows a request. In this example, you create a user flow named "Woodgrove User Flow" with the following configuration. Content-Type: application/json } ``` -<a name='example-2-create-a-basic-external-identities-sign-up-and-sign-in-user-flow-with-an-attached-application-on-an-azure-ad-customer-tenant'></a> --### Example 2: Create a basic external identities sign-up and sign-in user flow with an attached application on a Microsoft Entra customer tenant +### Example 2: Create a basic external identities sign-up and sign-in user flow with an attached application in an external tenant #### Request The following example shows a request. In this example, you create a user flow named "Woodgrove User Flow" with the following configuration. |
v1.0 | Identitycontainer Post B2cuserflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-b2cuserflows.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_post_b2cuserflows" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-b2cuserflows-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identitycontainer Post B2xuserflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-b2xuserflows.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_post_b2xuserflows" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-b2xuserflows-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identitycontainer Post Customauthenticationextensions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-customauthenticationextensions.md | Create a new [customAuthenticationExtension](../resources/customauthenticationex - [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type. - [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type. +> [!NOTE] +> +> You can have a maximum of 100 custom extension policies. + [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Identitycontainer Post Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identitygovernance Insights Toptasksprocessedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/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 +``` ++## 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. +<!-- { + "blockType": "request", + "name": "insightsthis.toptasksprocessedsummary" +} +--> +``` http +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/insights/topTasksProcessedSummary(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z) +``` ++### 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/beta/$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/beta/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 +``` ++## 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. +<!-- { + "blockType": "request", + "name": "insightsthis.topworkflowsprocessedsummary" +} +--> +``` http +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/insights/topWorkflowsProcessedSummary(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z) +``` ++### 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/beta/$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/beta/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 +``` ++## 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 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. +<!-- { + "blockType": "request", + "name": "insightsthis.workflowsprocessedbycategory" +} +--> +``` http +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/insights/workflowsProcessedByCategory(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z) +``` +++### 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/beta/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 +``` ++## 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. +<!-- { + "blockType": "request", + "name": "insightsthis.workflowsprocessedsummary" +} +--> +``` http +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/insights/workflowsProcessedSummary(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z) +``` ++### 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/beta/$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/beta/api/identitygovernance-lifecycleworkflowscontainer-list-taskdefinitions.md | Content-Type: application/json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions",- "@odata.count": 16, + "@odata.count": 25, "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 "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", Content-Type: application/json "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", Content-Type: application/json "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" + } + ] + }, + { + "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 Lifecycleworkflowscontainer List Workflowtemplates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-workflowtemplates.md | Content-Type: application/json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates",+ "@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/workflowTemplates?$select=category,description", "value": [ { "category": "joiner", Content-Type: application/json "category": "joiner", "continueOnError": false, "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", "executionSequence": 1, "id": "3e062c24-d219-483d-9258-288f2a039b94", "isEnabled": true, Content-Type: application/json "category": "joiner,leaver", "continueOnError": false, "description": "Enable user account in the directory",- "displayName": "Enable User Account", + "displayName": "Enable user account", "executionSequence": 1, "id": "e18f3208-311c-46a3-a27b-d9c15cd595bc", "isEnabled": true, Content-Type: application/json "category": "joiner", "continueOnError": false, "description": "Send welcome email to new hire",- "displayName": "Send Welcome Email", + "displayName": "Send welcome email", "executionSequence": 2, "id": "e9551045-4302-499f-9108-60b9e23c067a", "isEnabled": true, Content-Type: application/json "category": "joiner,leaver", "continueOnError": false, "description": "Add user to selected groups",- "displayName": "Add User To Groups", + "displayName": "Add user to groups", "executionSequence": 3, "id": "560acd0c-321e-4e7e-9f31-ff8899c55878", "isEnabled": true, Content-Type: application/json } ] },+ { + "category": "joiner", + "description": "Configure onboarding tasks for an employee after their first day of work.", + "displayName": "Post-Onboarding of an employee", + "id": "dce038a6-482a-46a2-9ee0-675c5e8477b9", + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "scope": { + "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet", + "rule": "department eq 'Marketing'" + }, + "trigger": { + "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger", + "timeBasedAttribute": "employeeHireDate", + "offsetInDays": 7 + } + }, + "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('dce038a6-482a-46a2-9ee0-675c5e8477b9')/tasks", + "tasks": [ + { + "category": "joiner,leaver", + "continueOnError": false, + "description": "Add user to selected groups", + "displayName": "Add user to groups", + "executionSequence": 1, + "id": "33350498-4404-487f-94ae-db312e436eda", + "isEnabled": true, + "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910", + "arguments": [ + { + "name": "groupID", + "value": "" + } + ] + }, + { + "category": "joiner,leaver", + "continueOnError": false, + "description": "Add user to selected Teams", + "displayName": "Add user To Teams", + "executionSequence": 2, + "id": "6f7925a5-633d-4cd9-9c4b-8f4b2f040e2b", + "isEnabled": true, + "taskDefinitionId": "e440ed8d-25a1-4618-84ce-091ed5be5594", + "arguments": [ + { + "name": "teamID", + "value": "" + } + ] + } + ] + }, + { + "category": "mover", + "description": "Execute real-time tasks for employee job changes", + "displayName": "Real-time employee job change", + "id": "77a82a99-9dfb-471d-a396-107954328b7f", + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.onDemandExecutionOnly" + }, + "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('77a82a99-9dfb-471d-a396-107954328b7f')/tasks", + "tasks": [ + { + "category": "joiner,leaver,mover", + "continueOnError": false, + "description": "Run a Custom Task Extension to callout to an external system.", + "displayName": "Run a Custom Task Extension", + "executionSequence": 1, + "id": "f187bcde-830a-4f4b-bed0-e2347b418c01", + "isEnabled": true, + "taskDefinitionId": "4262b724-8dba-4fad-afc3-43fcbb497a0e", + "arguments": [ + { + "name": "customTaskExtensionID", + "value": "" + } + ] + } + ] + }, + { + "category": "mover", + "description": "Configure mover tasks for employees once their group membership changes", + "displayName": "Employee group membership changes", + "id": "56da3093-d105-40d4-9886-fccd074f2f2a", + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "scope": { + "@odata.type": "#microsoft.graph.identityGovernance.groupBasedSubjectSet", + "groups": [ + { + "id": "groupID" + } + ] + }, + "trigger": { + "@odata.type": "#microsoft.graph.identityGovernance.membershipChangeTrigger", + "changeType": "add" + } + }, + "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('56da3093-d105-40d4-9886-fccd074f2f2a')/tasks", + "tasks": [ + { + "category": "leaver,mover", + "continueOnError": false, + "description": "Remove user assignment of selected access package", + "displayName": "Remove access package assignment for user", + "executionSequence": 1, + "id": "db0500d1-c988-4114-a005-f227649aedfd", + "isEnabled": true, + "taskDefinitionId": "4a0b64f2-c7ec-46ba-b117-18f262946c50", + "arguments": [ + { + "name": "accessPackageId", + "value": "" + } + ] + }, + { + "category": "joiner,leaver,mover", + "continueOnError": false, + "description": "Remove user from membership of selected Teams", + "displayName": "Remove user from selected Teams", + "executionSequence": 2, + "id": "b1049615-0be5-43dc-a919-1f5bf6db967b", + "isEnabled": true, + "taskDefinitionId": "06aa7acb-01af-4824-8899-b14e5ed788d6", + "arguments": [ + { + "name": "teamID", + "value": "" + } + ] + }, + { + "category": "mover", + "continueOnError": false, + "description": "Send email to notify userΓÇÖs manager of user move", + "displayName": "Send email to notify manager of user move", + "executionSequence": 3, + "id": "96c00437-3a06-4710-bd0b-ab57773a9189", + "isEnabled": true, + "taskDefinitionId": "aab41899-9972-422a-9d97-f626014578b7", + "arguments": [] + } + ] + }, + { + "category": "mover", + "description": "Configure mover tasks for employees once their job profile changes", + "displayName": "Employee job profile change", + "id": "16819b2d-74e9-4fb9-9ba7-48b8a26ab11d", + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "scope": { + "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet", + "rule": "department eq 'Marketing'" + }, + "trigger": { + "@odata.type": "#microsoft.graph.identityGovernance.attributeChangeTrigger", + "triggerAttributes": [ + { + "name": "department" + } + ] + } + }, + "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('16819b2d-74e9-4fb9-9ba7-48b8a26ab11d')/tasks", + "tasks": [ + { + "category": "mover", + "continueOnError": false, + "description": "Send email to notify userΓÇÖs manager of user move", + "displayName": "Send email to notify manager of user move", + "executionSequence": 1, + "id": "96c00437-3a06-4710-bd0b-ab57773a9189", + "isEnabled": true, + "taskDefinitionId": "aab41899-9972-422a-9d97-f626014578b7", + "arguments": [] + }, + { + "category": "joiner,leaver,mover", + "continueOnError": false, + "description": "Remove user from membership of selected Azure AD groups", + "displayName": "Remove user from selected groups", + "executionSequence": 2, + "id": "e9e641d3-e457-433c-9d6c-78a4f2505aef", + "isEnabled": true, + "taskDefinitionId": "1953a66c-751c-45e5-8bfe-01462c70da3c", + "arguments": [ + { + "name": "groupID", + "value": "" + } + ] + }, + { + "category": "joiner,leaver,mover", + "continueOnError": false, + "description": "Remove user from membership of selected Teams", + "displayName": "Remove user from selected Teams", + "executionSequence": 3, + "id": "b1049615-0be5-43dc-a919-1f5bf6db967b", + "isEnabled": true, + "taskDefinitionId": "06aa7acb-01af-4824-8899-b14e5ed788d6", + "arguments": [ + { + "name": "teamID", + "value": "" + } + ] + }, + { + "category": "joiner,mover", + "continueOnError": false, + "description": "Request user assignment to selected access package", + "displayName": "Request user access package assignment", + "executionSequence": 4, + "id": "8c2c653f-46a1-4042-9b4d-2c3d503a4fcc", + "isEnabled": true, + "taskDefinitionId": "c1ec1e76-f374-4375-aaa6-0bb6bd4c60be", + "arguments": [ + { + "name": "assignmentPolicyId", + "value": "" + }, + { + "name": "accessPackageId", + "value": "" + } + ] + } + ] + }, { "category": "leaver", "description": "Execute real-time termination tasks for employees on their last day of work", Content-Type: application/json "category": "leaver", "continueOnError": false, "description": "Delete user account in Azure AD",- "displayName": "Delete User Account", + "displayName": "Delete user account", "executionSequence": 3, "id": "adbd4f05-99f0-4260-a155-7657623ca071", "isEnabled": true, Content-Type: application/json "category": "joiner,leaver", "continueOnError": false, "description": "Disable user account in the directory",- "displayName": "Disable User Account", + "displayName": "Disable user account", "executionSequence": 1, "id": "8d9eab35-6c32-4b76-acbd-6a22cb07aa6a", "isEnabled": true, Content-Type: application/json "category": "leaver", "continueOnError": false, "description": "Delete user account in Azure AD",- "displayName": "Delete User Account", + "displayName": "Delete user account", "executionSequence": 3, "id": "46849618-30e7-4b67-abf0-f8c7f0d54b95", "isEnabled": true, Content-Type: application/json The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf ++ #### Response <!-- { |
v1.0 | Identitygovernance Lifecycleworkflowscontainer Post Workflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-post-workflows.md | Title: "Create workflow" -description: "Create a new workflow object. You can create up to 50 workflows in a tenant." +description: "Create a new workflow object. You can create up to 100 workflows in a tenant." ms.localizationpriority: medium Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new [workflow](../resources/identitygovernance-workflow.md) object. You can create up to 50 workflows in a tenant. +Create a new [workflow](../resources/identitygovernance-workflow.md) object. You can create up to 100 workflows in a tenant. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] You can specify the following properties when creating a **workflow**. |Property|Type|Description| |:|:|:|-|category|[microsoft.graph.identityGovernance.lifecycleWorkflowCategory](../resources/identitygovernance-workflow.md)|The category of the workflow. The possible values are: `joiner`, `leaver`, `unknownFutureValue`. Can be only one value. Required.| +|category|[microsoft.graph.identityGovernance.lifecycleWorkflowCategory](../resources/identitygovernance-workflow.md)|The category of the workflow. The possible values are: `joiner`, `leaver`, `unknownFutureValue`. It can be only one value. Required.| |description|String|A string that describes the purpose of the workflow for administrative use.| |displayName|String|A unique string that identifies the workflow. Required.|-|executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Defines for who and when a workflow will run. Required. | +|executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Defines for who and when a workflow runs. Required. | |id|String|Identifier used for individually addressing a specific workflow.| |isEnabled|Boolean|A Boolean value that denotes whether the workflow is set to run or not.| |isSchedulingEnabled|Boolean|A Boolean value that denotes whether scheduling is enabled or not. | If successful, this method returns a `201 Created` response code and a [microsof ## Examples -### Example 1: Create a new workflow +### Example 1: Create a joiner workflow using the time based trigger #### Request The following example shows a request that creates a workflow with the following configuration:-+ It's a "joiner" workflow that's enabled and schedule to run. -+ It runs for new users that are based in Australia, on their employeeHireDate. ++ It's a "joiner" workflow-enabled and scheduled to run.++ It runs for new users based in Australia, on their employeeHireDate using the time-based attribute trigger. + Two tasks are carried out when the workflow runs: the user's account is enabled and a "Welcome" email is sent to the user. # [HTTP](#tab/http) Content-Type: application/json } ``` -### Example 2: Create a new version of a task with customized email +### Example 2: Create a mover workflow using the attribute changes trigger #### Request -The following example shows a request. +The following example shows a request that creates a workflow with the following configuration: ++ It's a "mover" workflow-enabled and scheduled to run.++ It runs for existing users added to the "Sales" department using the attribute changes trigger.++ One task is carried out, which is to send an email to notify the user's manager of the move. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "lifecycleworkflows_create_workflow_from_customemail" + "name": "lifecycleworkflows_create_workflow_from_attribute" } --> ``` http Content-Type: application/json Content-length: 631 {- "category": "joiner", - "description": "Configure new hire tasks for onboarding employees on their first day", - "displayName": "custom email marketing API test", + "category": "mover", + "description": "Configure mover tasks for a user when their job profile changes", + "displayName": "Sales contractor moves to full-time employee", "isEnabled": true,- "isSchedulingEnabled": false, + "isSchedulingEnabled": true, "executionConditions": { "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", "scope": { "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",- "rule": "(department eq 'Marketing')" + "rule": "(department eq 'Sales')" }, "trigger": {- "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger", - "timeBasedAttribute": "employeeHireDate", - "offsetInDays": 0 + "@odata.type": "#microsoft.graph.identityGovernance.attributeChangeTrigger", + "triggerAttributes": [ + { + "name": "department" + } + ] } }, "tasks": [ { "continueOnError": false,- "description": "Enable user account in the directory", - "displayName": "Enable User Account", + "description": "Send email to moving employee's manager", + "displayName": "Notify manager of move", "isEnabled": true,- "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc", + "taskDefinitionId": "aab41899-9972-422a-9d97-f626014578b7", "arguments": []+ } + ] +} +``` ++# [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.workflow" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "category": "mover", + "description": "Configure mover tasks for a user when their job profile changes", + "displayName": "Sales contractor moves to full time employee", + "isEnabled": true, + "isSchedulingEnabled": true, + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "scope": { + "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet", + "rule": "(department eq 'Sales')" },+ "trigger": { + "@odata.type": "#microsoft.graph.identityGovernance.attributeChangeTrigger", + "triggerAttributes": [ + { + "name": "department" + } + ] + } + }, + "tasks": [ { "continueOnError": false,- "description": "Send welcome email to new hire", - "displayName": "Send Welcome Email", + "description": "Send email to moving employee's manager", + "displayName": "Notify manager of move", "isEnabled": true,- "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea", - "arguments": [ - { - "name": "cc", - "value": "1baa57fa-3c4e-4526-ba5a-db47a9df95f0" - }, - { - "name": "customSubject", - "value": "Welcome to the organization {{userDisplayName}}!" - }, - { - "name": "customBody", - "value": "Welcome to our organization {{userGivenName}}!" - }, + "taskDefinitionId": "aab41899-9972-422a-9d97-f626014578b7", + "arguments": [] + } + ] +} +``` ++### Example 3: Create a leaver workflow using the group based trigger ++#### Request ++The following example shows a request that creates a workflow with the following configuration: ++ It's a "leaver" workflow enabled and scheduled to run.++ It runs for users who are removed from the Sales group using the group-based trigger.++ Two tasks are carried out when the workflow runs: Remove user from all Teams, Remove user from all groups.++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "lifecycleworkflows_create_workflow_from_group" +} +--> +``` http +POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows +Content-Type: application/json ++{ + "category": "leaver", + "description": "Configure offboarding tasks for employees on their last day of work", + "displayName": "Offboard an employee", + "isEnabled": true, + "isSchedulingEnabled": true, + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "scope": { + "@odata.type": "#microsoft.graph.identityGovernance.groupBasedSubjectSet", + "groups": [ {- "name": "locale", - "value": "en-us" + "id": "668e7540-7f8e-4ca4-a207-b7dffbb6d038" } ]+ }, + "trigger": { + "@odata.type": "#microsoft.graph.identityGovernance.membershipChangeTrigger", + "changeType": "remove" + } + }, + "tasks": [ + { + "category": "leaver", + "continueOnError": false, + "description": "Remove user from all Teams memberships", + "displayName": "Remove user from all Teams", + "isEnabled": true, + "taskDefinitionId": "81f7b200-2816-4b3b-8c5d-dc556f07b024", + "arguments": [] + }, + { + "category": "leaver", + "continueOnError": false, + "description": "Remove user from all Azure AD groups memberships", + "displayName": "Remove user from all groups", + "isEnabled": true, + "taskDefinitionId": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc", + "arguments": [] } ] } ``` # [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 - The following example shows the response. >**Note:** The response object shown here might be shortened for readability. <!-- { The following example shows the response. } --> ``` http-HTTP/1.1 200 OK +HTTP/1.1 201 Created Content-Type: application/json {- "workflow":{ - "category": "joiner", - "description": "Configure new hire tasks for onboarding employees on their first day", - "displayName": "Global onboard new hire employee", - "isEnabled": true, - "isSchedulingEnabled": false, - "executionConditions": { - "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", - "scope": { - "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet", - "rule": "(department eq 'Marketing')" - }, - "trigger": { - "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger", - "timeBasedAttribute": "employeeHireDate", - "offsetInDays": 1 - } + "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows/$entity", + "category": "leaver", + "description": "Configure offboarding tasks for employees on their last day of work", + "displayName": "Offboard an employee", + "isEnabled": true, + "isSchedulingEnabled": true, + "lastModifiedDateTime": "2024-03-28T20:20:05.6599449Z", + "createdDateTime": "2024-03-28T20:20:05.6599142Z", + "deletedDateTime": null, + "id": "73ed8912-6a04-4f5d-bef8-61fcc94336a7", + "nextScheduleRunDateTime": "2024-03-28T20:37:08Z", + "version": 1, + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "scope": { + "@odata.type": "#microsoft.graph.identityGovernance.groupBasedSubjectSet" },- "tasks": [ - { - "continueOnError": false, - "description": "Enable user account in the directory", - "displayName": "Enable User Account", - "isEnabled": true, - "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc", - "arguments": [] - }, - { - "continueOnError": false, - "description": "Send welcome email to new hire", - "displayName": "Send Welcome Email", - "isEnabled": true, - "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea", - "arguments": [ - { - "name": "cc", - "value": "b47471b9-af8f-4a5a-bfa2-b78e82398f6e, a7a23ce0-909b-40b9-82cf-95d31f0aaca2" - }, - { - "name": "customSubject", - "value": "Welcome to the organization {{userDisplayName}}!" - }, - { - "name": "customBody", - "value": "Welcome to our organization {{userGivenName}} {{userSurname}}. \nFor more information, reach out to your manager {{managerDisplayName}} at {{managerEmail}}." - }, - { - "name": "locale", - "value": "en-us" - }, - ] - } - ] + "trigger": { + "@odata.type": "#microsoft.graph.identityGovernance.membershipChangeTrigger", + "changeType": "remove" + } } } ``` |
v1.0 | Identitygovernance Workflow Createnewversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-workflow-createnewversion.md | If successful, this action returns a `200 OK` response code and a [microsoft.gra ## Examples -### Example 1: Create a new version of a workflow +### Example 1: Create a new version of a joiner workflow with time based trigger #### Request |
v1.0 | Identityprovider Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identityprovider Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity Provider administrator ## HTTP request |
v1.0 | Identityprovider List Availableprovidertypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-list-availableprovidertypes.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_list_availableprovidertypes" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-list-availableprovidertypes-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identityprovider List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_list" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-list-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identityprovider Post Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-post-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-post-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: -* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identityprovider Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-update-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identityproviderbase Availableprovidertypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityproviderbase-availableprovidertypes.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityproviderbase_availableprovidertypes" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-availableprovidertypes-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identityproviderbase Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityproviderbase-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityproviderbase_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identityproviderbase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityproviderbase-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityproviderbase_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator -* External ID user flow administrator +The work or school account needs to belong to at least the *External Identity Provider Administrator* or *External Identity User Flow administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Identityproviderbase Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityproviderbase-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityproviderbase_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-update-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Inactiveawsresourcefinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveawsresourcefinding-aggregatedsummary.md | description: View the count of inactive AWS resources for the specified authoriz ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveawsresourcefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveawsresourcefinding-get.md | description: "Read the properties and relationships of an inactiveAwsResourceFin ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveawsresourcefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveawsresourcefinding-list.md | description: "List the details of inactive AWS resources." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveawsrolefinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveawsrolefinding-aggregatedsummary.md | description: "Retrieve the raw count of inactive roles relative to the total rol ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveawsrolefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveawsrolefinding-list.md | description: "List the details of inactive roles in AWS authorization systems on ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveazureserviceprincipalfinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveazureserviceprincipalfinding-aggregatedsummary.md | description: "View the count of inactive Azure service principals for the specif ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveazureserviceprincipalfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveazureserviceprincipalfinding-get.md | description: "Read the properties and relationships of an inactiveAzureServicePr ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveazureserviceprincipalfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveazureserviceprincipalfinding-list.md | description: "Get a list of the inactiveAzureServicePrincipalFinding objects and ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactivegcpserviceaccountfinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactivegcpserviceaccountfinding-aggregatedsummary.md | description: View the count of inactive GCP service accounts in your authorizati ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactivegcpserviceaccountfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactivegcpserviceaccountfinding-get.md | description: "Read the properties and relationships of an inactiveGcpServiceAcco ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactivegcpserviceaccountfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactivegcpserviceaccountfinding-list.md | description: "Get a list of the inactiveGcpServiceAccountFinding objects and the ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactivegroupfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactivegroupfinding-get.md | description: "Get details about an inactive group in AWS, Azure, or GCP environm ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactivegroupfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactivegroupfinding-list.md | description: "List inactive groups in AWS, Azure and GCP environments." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveserverlessfunctionfinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveserverlessfunctionfinding-aggregatedsummary.md | description: "A raw count of inactive serverless functions in the specified AWS, ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveserverlessfunctionfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveserverlessfunctionfinding-get.md | description: "Read the properties and relationships of inactive serverless funct ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveserverlessfunctionfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveserverlessfunctionfinding-list.md | description: "List the details of inactive serverless functions in authorization ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveuserfinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveuserfinding-aggregatedsummary.md | description: "View the raw count of inactive users in the specified AWS, Azure, ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveuserfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveuserfinding-get.md | description: "Get the details of an inactiveUserFinding in an authorization syst ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inactiveuserfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveuserfinding-list.md | description: "Get a list of the inactiveUserFinding objects and their properties ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Inboundshareduserprofile Exportpersonaldata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inboundshareduserprofile-exportpersonaldata.md | Title: "inboundSharedUserProfile: exportPersonalData" description: "Create a request to export the personal data for an inboundSharedUserProfile."-++ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Inboundshareduserprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inboundshareduserprofile-get.md | Title: "Get inboundSharedUserProfile" description: "Read the properties of an inboundSharedUserProfile."-++ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Inboundshareduserprofile Removepersonaldata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inboundshareduserprofile-removepersonaldata.md | Title: "inboundSharedUserProfile: removePersonalData" description: "Create a request to remove the personal data for an inboundSharedUserProfile."-++ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Industrydata Administrativeunitprovisioningflow Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-administrativeunitprovisioningflow-delete.md | + + Title: "Delete administrativeUnitProvisioningFlow" +description: "Delete an administrativeUnitProvisioningFlow object." ++ms.localizationpriority: medium ++++# Delete administrativeUnitProvisioningFlow ++Namespace: microsoft.graph.industryData +++Delete an [administrativeUnitProvisioningFlow](../resources/industrydata-administrativeunitprovisioningflow.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": "industrydata-administrativeunitprovisioningflow-delete-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +DELETE /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## 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_administrativeunitprovisioningflow" +} +--> ++```http +DELETE https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/f66e97ad-0870-46e0-3ff3-08dc49dccdc9 +``` ++# [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 +} +--> ++```http +HTTP/1.1 204 No Content +``` |
v1.0 | Industrydata Administrativeunitprovisioningflow Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-administrativeunitprovisioningflow-get.md | + + Title: "Get administrativeUnitProvisioningFlow" +description: "Read the properties and relationships of an administrativeUnitProvisioningFlow object." ++ms.localizationpriority: medium ++++# Get administrativeUnitProvisioningFlow ++Namespace: microsoft.graph.industryData +++Read the properties and relationships of an [administrativeUnitProvisioningFlow](../resources/industrydata-administrativeunitprovisioningflow.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": "industrydata-administrativeunitprovisioningflow-get-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [microsoft.graph.industryData.administrativeUnitProvisioningFlow](../resources/industrydata-administrativeunitprovisioningflow.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_administrativeunitprovisioningflow" +} +--> ++```msgraph-interactive +GET https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/f66e97ad-0870-46e0-3ff3-08dc49dccdc9 +``` ++# [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.industryData.administrativeUnitProvisioningFlow" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity", + "@odata.type": "#microsoft.graph.industryData.administrativeUnitProvisioningFlow", + "id": "f66e97ad-0870-46e0-3ff3-08dc49dccdc9", + "createdDateTime": "2024-03-22T21:28:02.7164229Z", + "lastModifiedDateTime": "2024-03-22T21:28:02.7164229Z", + "readinessStatus": "disabled", + "creationOptions": { + "createBasedOnOrg": true, + "createBasedOnOrgPlusRoleGroup": true + } +} +``` |
v1.0 | Industrydata Administrativeunitprovisioningflow Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-administrativeunitprovisioningflow-update.md | + + Title: "Update administrativeUnitProvisioningFlow" +description: "Update the properties of an administrativeUnitProvisioningFlow object." ++ms.localizationpriority: medium ++++# Update administrativeUnitProvisioningFlow ++Namespace: microsoft.graph.industryData +++Update the properties of an [administrativeUnitProvisioningFlow](../resources/industrydata-administrativeunitprovisioningflow.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": "industrydata-administrativeunitprovisioningflow-update-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PATCH /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Request headers ++| Name | Description | +| : | :-- | +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required. | ++## Request body +++|Property|Type|Description| +|:|:|:| +|creationOptions|[microsoft.graph.industryData.adminUnitCreationOptions](../resources/industrydata-adminunitcreationoptions.md)|The different attribute choices for the administrative units to be provisioned. Required.| ++## 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_administrativeunitprovisioningflow" +} +--> ++```http +PATCH https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/f66e97ad-0870-46e0-3ff3-08dc49dccdc9 +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.industryData.administrativeUnitProvisioningFlow", + "creationOptions": + { + "createBasedOnOrg": true, + "createBasedOnOrgPlusroleGroup": 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. ++<!-- { + "blockType": "response", + "truncated": true +} +--> ++```http +HTTP/1.1 204 No Content +``` |
v1.0 | Industrydata Classgroupprovisioningflow Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-classgroupprovisioningflow-delete.md | + + Title: "Delete classGroupProvisioningFlow" +description: "Delete a classGroupProvisioningFlow object." ++ms.localizationpriority: medium ++++# Delete classGroupProvisioningFlow ++Namespace: microsoft.graph.industryData +++Delete a [classGroupProvisioningFlow](../resources/industrydata-classgroupprovisioningflow.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": "industrydata-classgroupprovisioningflow-delete-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +DELETE /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## 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_classgroupprovisioningflow" +} +--> ++```http +DELETE https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/417a82c8-7caa-4f82-3ac6-08dc4ac6fb7f +``` ++# [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 +} +--> ++```http +HTTP/1.1 204 No Content +``` |
v1.0 | Industrydata Classgroupprovisioningflow Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-classgroupprovisioningflow-get.md | + + Title: "Get classGroupProvisioningFlow" +description: "Read the properties and relationships of a classGroupProvisioningFlow object." ++ms.localizationpriority: medium ++++# Get classGroupProvisioningFlow ++Namespace: microsoft.graph.industryData +++Read the properties and relationships of a [classGroupProvisioningFlow](../resources/industrydata-classgroupprovisioningflow.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": "industrydata-classgroupprovisioningflow-get-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [microsoft.graph.industryData.classGroupProvisioningFlow](../resources/industrydata-classgroupprovisioningflow.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_classgroupprovisioningflow" +} +--> ++```msgraph-interactive +GET https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/417a82c8-7caa-4f82-3ac6-08dc4ac6fb7f +``` ++# [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.industryData.classGroupProvisioningFlow" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity", + "@odata.type": "#microsoft.graph.industryData.classGroupProvisioningFlow", + "id": "417a82c8-7caa-4f82-3ac6-08dc4ac6fb7f", + "createdDateTime": "2024-03-22T23:34:18.5035988Z", + "lastModifiedDateTime": "2024-03-22T23:34:18.5035988Z", + "readinessStatus": "disabled", + "configuration": { + "additionalAttributes": [ + "courseTitle", + "courseCode", + "courseSubject", + "courseGradeLevel", + "courseExternalId", + "academicSessionTitle", + "academicSessionExternalId" + ], + "additionalOptions": { + "createTeam": true, + "writeDisplayNameOnCreateOnly": true + }, + "enrollmentMappings": { + "ownerEnrollmentMappings": [ + { + "code": "teacher" + }, + { + "code": "proctor" + }, + { + "code": "teacherAssistant" + }, + { + "code": "paraprofessional" + }, + { + "code": "physicalTherapist" + }, + { + "code": "speechTherapist" + }, + { + "code": "visionTherapist" + }, + { + "code": "occupationalTherapist" + }, + { + "code": "staff" + } + ], + "memberEnrollmentMappings": [ + { + "code": "student" + }, + { + "code": "substitute" + }, + { + "code": "aide" + }, + { + "code": "proctor" + }, + { + "code": "teacherAssistant" + }, + { + "code": "paraprofessional" + }, + { + "code": "physicalTherapist" + }, + { + "code": "speechTherapist" + }, + { + "code": "visionTherapist" + }, + { + "code": "occupationalTherapist" + }, + { + "code": "staff" + } + ] + } + } +} +``` |
v1.0 | Industrydata Classgroupprovisioningflow Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-classgroupprovisioningflow-update.md | + + Title: "Update classGroupProvisioningFlow" +description: "Update the properties of a classGroupProvisioningFlow object." ++ms.localizationpriority: medium ++++# Update classGroupProvisioningFlow ++Namespace: microsoft.graph.industryData +++Update the properties of a [classGroupProvisioningFlow](../resources/industrydata-classgroupprovisioningflow.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": "industrydata-classgroupprovisioningflow-update-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PATCH /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Request headers ++| Name | Description | +| : | :-- | +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required. | ++## Request body +++| Property | Type | Description | +| : | :-- | :-- | +| configuration | [microsoft.graph.industryData.classGroupConfiguration](../resources/industrydata-classgroupconfiguration.md) | The different attribute choices for the class groups to be provisioned. Required. | ++## 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_classgroupprovisioningflow" +} +--> ++```http +PATCH https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/417a82c8-7caa-4f82-3ac6-08dc4ac6fb7f +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.industryData.classGroupProvisioningFlow", + "configuration": { + "@odata.type": "#microsoft.graph.industryData.classGroupConfiguration", + "additionalAttributes": [ + "courseTitle", + "courseCode" + ], + "additionalOptions": { + "@odata.type": "#microsoft.graph.industryData.additionalClassGroupOptions", + "createTeam": false, + "writeDisplayNameOnCreateOnly": false + }, + "enrollmentMappings": { + "@odata.type": "#microsoft.graph.industryData.enrollmentMappings", + "memberEnrollmentMappings": [ + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "substitute" + } + ], + "ownerEnrollmentMappings": [ + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "teacher" + } + ] + } + } +} +``` ++# [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 | Industrydata Industrydataroot Delete Outboundprovisioningflowsets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-industrydataroot-delete-outboundprovisioningflowsets.md | + + Title: "Delete outboundProvisioningFlowSet" +description: "Delete an outboundProvisioningFlowSet object." ++ms.localizationpriority: medium ++++# Delete outboundProvisioningFlowSet ++Namespace: microsoft.graph.industryData +++Delete an [outboundProvisioningFlowSet](../resources/industrydata-outboundprovisioningflowset.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": "industrydata-industrydataroot-delete-outboundprovisioningflowsets-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +DELETE /external/industryData/outboundProvisioningFlowSets/{id} +``` ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## 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_outboundprovisioningflowset" +} +--> ++```http +DELETE https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/8ac3c08f-6f93-465b-4bd9-08dc4ac773d0 +``` ++# [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 | Industrydata Industrydataroot List Outboundprovisioningflowsets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-industrydataroot-list-outboundprovisioningflowsets.md | + + Title: "List outboundProvisioningFlowSet objects" +description: "Get a list of the outboundProvisioningFlowSet objects and their properties." ++ms.localizationpriority: medium ++++# List outboundProvisioningFlowSet objects ++Namespace: microsoft.graph.industryData +++Get a list of the [outboundProvisioningFlowSet](../resources/industrydata-outboundprovisioningflowset.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": "industrydata-industrydataroot-list-outboundprovisioningflowsets-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /external/industryData/outboundProvisioningFlowSets +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [outboundProvisioningFlowSet](../resources/industrydata-outboundprovisioningflowset.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_outboundprovisioningflowset" +} +--> ++```msgraph-interactive +GET https://graph.microsoft.com/beta/external/industryData/outboundProvisioningFlowSets +``` ++# [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.industryData.outboundProvisioningFlowSet)" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets", + "value": [ + { + "id": "6c74bedb-23fa-44c9-d478-08dc3a38e458", + "createdDateTime": "2024-03-05T02:12:29.6430906Z", + "lastModifiedDateTime": "2024-03-05T02:12:29.6430906Z", + "displayName": "Outbound Provisioning Flow Test", + "filter": { + "@odata.type": "#microsoft.graph.industryData.basicFilter", + "attribute": "orgExternalId", + "in": [ + "Quarter", + "Demo" + ] + } + }, + { + "id": "8c33d025-5e64-4550-2aa3-08dc4ac66fca", + "createdDateTime": "2024-03-25T22:24:06.0882415Z", + "lastModifiedDateTime": "2024-03-25T22:24:06.0882415Z", + "displayName": "Outbound Provisioning Flow", + "filter": { + "@odata.type": "#microsoft.graph.industryData.basicFilter", + "attribute": "orgExternalId", + "in": [ + "Practice", + "Tactics" + ] + } + } + ] +} +``` |
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 | + + Title: "Create outboundProvisioningFlowSet" +description: "Create a new outboundProvisioningFlowSet object." ++ms.localizationpriority: medium ++++# Create outboundProvisioningFlowSet ++Namespace: microsoft.graph.industryData +++Create a new [outboundProvisioningFlowSet](../resources/industrydata-outboundprovisioningflowset.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": "industrydata-industrydataroot-post-outboundprovisioningflowsets-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +POST /external/industryData/OutboundProvisioningFlowSets +``` ++## Request headers ++| Name | Description | +| : | :-- | +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required. | ++## Request body ++In the request body, supply a JSON representation of the [outboundProvisioningFlowSet](../resources/industrydata-outboundprovisioningflowset.md) object. ++## Response ++If successful, this method returns a `201 Created` response code and an [outboundProvisioningFlowSet](../resources/industrydata-outboundprovisioningflowset.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_outboundprovisioningflowset_from_" +} +--> ++```http +POST https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.industryData.outboundProvisioningFlowSet", + "displayName": "Outbound Provisioning Flow Test", + "filter": { + "@odata.type": "#microsoft.graph.industryData.basicFilter", + "attribute": "orgExternalId", + "in": [ + "Quarter", + "Demo" + ] + } +} +``` ++# [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.industryData.outboundProvisioningFlowSet" +} +--> ++```http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets/$entity", + "id": "8ac3c08f-6f93-465b-4bd9-08dc4ac773d0", + "createdDateTime": "2024-03-25T21:55:03.495336Z", + "lastModifiedDateTime": "2024-03-25T21:55:03.495336Z", + "displayName": "Outbound Provisioning Flow Test", + "filter": { + "@odata.type": "#microsoft.graph.industryData.basicFilter", + "attribute": "orgExternalId", + "in": [ + "Quarter", + "Demo" + ] + } +} +``` |
v1.0 | Industrydata Outboundprovisioningflowset Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-outboundprovisioningflowset-get.md | + + Title: "Get outboundProvisioningFlowSet" +description: "Read the properties and relationships of an outboundProvisioningFlowSet object." ++ms.localizationpriority: medium ++++# Get outboundProvisioningFlowSet ++Namespace: microsoft.graph.industryData +++Read the properties and relationships of an [outboundProvisioningFlowSet](../resources/industrydata-outboundprovisioningflowset.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": "industrydata-outboundprovisioningflowset-get-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /external/industryData/outboundProvisioningFlowSets/{id} +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and an [outboundProvisioningFlowSet](../resources/industrydata-outboundprovisioningflowset.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_outboundprovisioningflowset" +} +--> ++```msgraph-interactive +GET https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/8ac3c08f-6f93-465b-4bd9-08dc4ac773d0 +``` ++# [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.industryData.outboundProvisioningFlowSet" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets/$entity", + "id": "8ac3c08f-6f93-465b-4bd9-08dc4ac773d0", + "createdDateTime": "2024-03-25T21:55:03.495336Z", + "lastModifiedDateTime": "2024-03-25T21:55:03.495336Z", + "displayName": "Outbound Provisioning Flow Test", + "filter": { + "@odata.type": "#microsoft.graph.industryData.basicFilter", + "attribute": "orgExternalId", + "in": [ + "Quarter", + "Demo" + ] + } +} +``` |
v1.0 | Industrydata Outboundprovisioningflowset List Provisioningflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-outboundprovisioningflowset-list-provisioningflows.md | + + Title: "List provisioningFlow objects" +description: "Get a list of the provisioningFlow objects and their properties." ++ms.localizationpriority: medium ++++# List provisioningFlow objects ++Namespace: microsoft.graph.industryData +++Get a list of the [provisioningFlow](../resources/industrydata-provisioningflow.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": "industrydata-outboundprovisioningflowset-list-provisioningflows-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /external/industryData/outboundProvisioningFlowSets/{id}/provisioningFlows +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [provisioningFlow](../resources/industrydata-provisioningflow.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_provisioningflow" +} +--> ++```msgraph-interactive +GET https://graph.microsoft.com/beta/external/industryData/outboundProvisioningFlowSets/8c33d025-5e64-4550-2aa3-08dc4ac66fca/provisioningFlows +``` ++# [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.industryData.provisioningFlow)" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('8c33d025-5e64-4550-2aa3-08dc4ac66fca')/provisioningFlows", + "value": [ + { + "@odata.type": "#microsoft.graph.industryData.securityGroupProvisioningFlow", + "id": "51f99e09-bdc5-47ff-7a0a-08dc4ac74cf1", + "createdDateTime": "2024-03-25T22:29:22.6303479Z", + "lastModifiedDateTime": "2024-03-25T22:29:22.6303479Z", + "readinessStatus": "disabled", + "creationOptions": { + "createBasedOnRoleGroup": true, + "createBasedOnOrgPlusRoleGroup": false + } + }, + { + "@odata.type": "#microsoft.graph.industryData.classGroupProvisioningFlow", + "id": "6207e7d7-5eba-4ddc-e607-08dc4ac77409", + "createdDateTime": "2024-03-25T22:29:16.1177912Z", + "lastModifiedDateTime": "2024-03-25T22:29:16.1177912Z", + "readinessStatus": "disabled", + "configuration": { + "additionalAttributes": [ + "courseTitle", + "courseCode", + "courseSubject", + "courseGradeLevel", + "courseExternalId", + "academicSessionTitle", + "academicSessionExternalId" + ], + "additionalOptions": { + "createTeam": true, + "writeDisplayNameOnCreateOnly": true + }, + "enrollmentMappings": { + "ownerEnrollmentMappings": [ + { + "code": "teacher" + }, + { + "code": "proctor" + }, + { + "code": "teacherAssistant" + }, + { + "code": "paraprofessional" + }, + { + "code": "physicalTherapist" + }, + { + "code": "speechTherapist" + }, + { + "code": "visionTherapist" + }, + { + "code": "occupationalTherapist" + }, + { + "code": "staff" + } + ], + "memberEnrollmentMappings": [ + { + "code": "student" + }, + { + "code": "substitute" + }, + { + "code": "aide" + }, + { + "code": "proctor" + }, + { + "code": "teacherAssistant" + }, + { + "code": "paraprofessional" + }, + { + "code": "physicalTherapist" + }, + { + "code": "speechTherapist" + }, + { + "code": "visionTherapist" + }, + { + "code": "occupationalTherapist" + }, + { + "code": "staff" + } + ] + } + } + }, + { + "@odata.type": "#microsoft.graph.industryData.administrativeUnitProvisioningFlow", + "id": "7b355e84-0af2-42fd-d392-08dc4ac68cf2", + "createdDateTime": "2024-03-25T22:29:05.4272368Z", + "lastModifiedDateTime": "2024-03-25T22:29:05.4272368Z", + "readinessStatus": "disabled", + "creationOptions": { + "createBasedOnOrg": true, + "createBasedOnOrgPlusRoleGroup": true + } + }, + { + "@odata.type": "#microsoft.graph.industryData.userProvisioningFlow", + "id": "dfeec276-d507-4008-d393-08dc4ac68cf2", + "createdDateTime": "2024-03-25T22:29:10.0687495Z", + "lastModifiedDateTime": "2024-03-25T22:29:10.0687495Z", + "readinessStatus": "disabled", + "createUnmatchedUsers": true, + "managementOptions": { + "additionalAttributes": [ + "userGradeLevel" + ], + "additionalOptions": { + "markAllStudentsAsMinors": true, + "allowStudentContactAssociation": false + } + }, + "creationOptions": { + "configurations": [ + { + "licenseSkus": [ + "world-class" + ], + "defaultPasswordSettings": { + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "***************" + }, + "roleGroup@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('8c33d025-5e64-4550-2aa3-08dc4ac66fca')/provisioningFlows('dfeec276-d507-4008-d393-08dc4ac68cf2')/microsoft.graph.industryData.userProvisioningFlow/creationOptions/configurations/roleGroup/$entity", + "roleGroup": { + "id": "students", + "displayName": "Students", + "roles": [ + { + "code": "student" + } + ] + } + }, + { + "licenseSkus": [ + "Strategist" + ], + "defaultPasswordSettings": { + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "***************" + }, + "roleGroup@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('8c33d025-5e64-4550-2aa3-08dc4ac66fca')/provisioningFlows('dfeec276-d507-4008-d393-08dc4ac68cf2')/microsoft.graph.industryData.userProvisioningFlow/creationOptions/configurations/roleGroup/$entity", + "roleGroup": { + "id": "staff", + "displayName": "Staff", + "roles": [ + { + "code": "adjunct" + }, + { + "code": "administrator" + }, + { + "code": "advisor" + }, + { + "code": "affiliate" + }, + { + "code": "aide" + }, + { + "code": "alumni" + }, + { + "code": "assistant" + }, + { + "code": "chair" + }, + { + "code": "coach" + }, + { + "code": "faculty" + }, + { + "code": "instructor" + }, + { + "code": "itAdmin" + }, + { + "code": "lecturer" + }, + { + "code": "nurse" + }, + { + "code": "occupationalTherapist" + }, + { + "code": "officeStaff" + }, + { + "code": "paraprofessional" + }, + { + "code": "physicalTherapist" + }, + { + "code": "principal" + }, + { + "code": "proctor" + }, + { + "code": "professor" + }, + { + "code": "researcher" + }, + { + "code": "specialServices" + }, + { + "code": "speechTherapist" + }, + { + "code": "staff" + }, + { + "code": "substitute" + }, + { + "code": "teacher" + }, + { + "code": "teacherAssistant" + }, + { + "code": "visionTherapist" + } + ] + } + } + ] + } + } + ] +} +``` |
v1.0 | Industrydata Outboundprovisioningflowset Post Provisioningflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-outboundprovisioningflowset-post-provisioningflows.md | + + Title: "Create provisioningFlow" +description: "Create a new provisioningFlow object." ++ms.localizationpriority: medium ++++# Create provisioningFlow ++Namespace: microsoft.graph.industryData +++Create a new [provisioningFlow](../resources/industrydata-provisioningflow.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": "industrydata-outboundprovisioningflowset-post-provisioningflows-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +POST /external/industryData/outboundProvisioningFlowSets/{id}/provisioningFlows +``` ++## Request headers ++| Name | Description | +| : | :-- | +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required. | ++## Request body ++In the request body, supply a JSON representation of the [provisioningFlow](../resources/industrydata-provisioningflow.md) object. ++Any of the following provisioning flows are valid: ++- [administrativeUnitProvisioningFlow](../resources/industrydata-administrativeUnitProvisioningFlow.md) +- [classGroupProvisioningFlow](../resources/industrydata-classGroupProvisioningFlow.md) +- [securityGroupProvisioningFlow](../resources/industrydata-securityGroupProvisioningFlow.md) +- [userProvisioningFlow](../resources/industrydata-userProvisioningFlow.md) ++## Response ++If successful, this method returns a `201 Created` response code and a [provisioningFlow](../resources/industrydata-provisioningflow.md) object in the response body. ++## Examples ++### Example 1: Create an administrativeUnitProvisioningFlow ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "post_adminunit" +}--> ++```http +POST https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.industryData.administrativeUnitProvisioningFlow", + "creationOptions": + { + "createBasedOnOrg": true, + "createBasedOnOrgPlusroleGroup": 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. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.industryData.provisioningFlow" +} --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity", + "@odata.type": "#microsoft.graph.industryData.administrativeUnitProvisioningFlow", + "id": "f66e97ad-0870-46e0-3ff3-08dc49dccdc9", + "createdDateTime": "2024-03-22T21:28:02.7164229Z", + "lastModifiedDateTime": "2024-03-22T21:28:02.7164229Z", + "readinessStatus": "notReady", + "creationOptions": { + "createBasedOnOrg": true, + "createBasedOnOrgPlusRoleGroup": true + } +} +``` ++### Example 2: Create a classGroupProvisioningFlow ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "post_classgroup" +}--> ++```http +POST https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.industryData.classGroupProvisioningFlow", + "configuration": { + "@odata.type": "#microsoft.graph.industryData.classGroupConfiguration", + "additionalAttributes": [ + "courseTitle", + "courseCode", + "courseSubject", + "courseGradeLevel", + "courseExternalId", + "academicSessionTitle", + "academicSessionExternalId" + ], + "additionalOptions": { + "@odata.type": "#microsoft.graph.industryData.additionalClassGroupOptions", + "createTeam": true, + "writeDisplayNameOnCreateOnly": true + }, + "enrollmentMappings": { + "@odata.type": "#microsoft.graph.industryData.enrollmentMappings", + "ownerEnrollmentMappings": [ + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "teacher" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "proctor" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "teacherAssistant" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "paraProfessional" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "physicalTherapist" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "speechTherapist" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "visionTherapist" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "occupationalTherapist" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "staff" + } + ], + "memberEnrollmentMappings": [ + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "student" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "substitute" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "aide" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "proctor" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "teacherAssistant" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "paraProfessional" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "physicalTherapist" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "speechTherapist" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "visionTherapist" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "occupationalTherapist" + }, + { + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "staff" + } + ] + } + } +} +``` ++# [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.industryData.provisioningFlow" +} --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity", + "@odata.type": "#microsoft.graph.industryData.classGroupProvisioningFlow", + "id": "417a82c8-7caa-4f82-3ac6-08dc4ac6fb7f", + "createdDateTime": "2024-03-22T23:34:18.5035988Z", + "lastModifiedDateTime": "2024-03-22T23:34:18.5035988Z", + "readinessStatus": "notReady", + "configuration": { + "additionalAttributes": [ + "courseTitle", + "courseCode", + "courseSubject", + "courseGradeLevel", + "courseExternalId", + "academicSessionTitle", + "academicSessionExternalId" + ], + "additionalOptions": { + "createTeam": true, + "writeDisplayNameOnCreateOnly": true + }, + "enrollmentMappings": { + "ownerEnrollmentMappings": [ + { + "code": "teacher" + }, + { + "code": "proctor" + }, + { + "code": "teacherAssistant" + }, + { + "code": "paraprofessional" + }, + { + "code": "physicalTherapist" + }, + { + "code": "speechTherapist" + }, + { + "code": "visionTherapist" + }, + { + "code": "occupationalTherapist" + }, + { + "code": "staff" + } + ], + "memberEnrollmentMappings": [ + { + "code": "student" + }, + { + "code": "substitute" + }, + { + "code": "aide" + }, + { + "code": "proctor" + }, + { + "code": "teacherAssistant" + }, + { + "code": "paraprofessional" + }, + { + "code": "physicalTherapist" + }, + { + "code": "speechTherapist" + }, + { + "code": "visionTherapist" + }, + { + "code": "occupationalTherapist" + }, + { + "code": "staff" + } + ] + } + } +} +``` ++### Example 3: Create a securityGroupProvisioningFlow ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "post_securitygroup" +}--> ++```http +POST https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.industryData.securityGroupProvisioningFlow", + "creationOptions": + { + "createBasedOnroleGroup": true, + "createBasedOnOrgPlusroleGroup": 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", + "truncated": true, + "@odata.type": "microsoft.graph.industryData.provisioningFlow" +} --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity", + "@odata.type": "#microsoft.graph.industryData.securityGroupProvisioningFlow", + "id": "4598f62a-7bd9-40a1-d38a-08dc4ac68cf2", + "createdDateTime": "2024-03-22T23:55:06.3141592Z", + "lastModifiedDateTime": "2024-03-22T23:55:06.3141592Z", + "readinessStatus": "notReady", + "creationOptions": { + "createBasedOnRoleGroup": true, + "createBasedOnOrgPlusRoleGroup": false + } +} +``` ++### Example 4: Create a userProvisioningFlow ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "post_user" +}--> ++```http +POST https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.industryData.userProvisioningFlow", + "createUnmatchedUsers": true, + "managementOptions": + { + "additionalAttributes": ["userGradeLevel"], + "additionalOptions": + { + "markAllStudentsAsMinors": true, + "allowStudentContactAssociation" : false + } + }, + "creationOptions": + { + "configurations": [ + { + "roleGroup@odata.bind": "https://graph.microsoft.com/beta/external/industryData/roleGroups/staff", + "defaultPasswordSettings": + { + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "********" + }, + "licenseSkus": [ "Sku1"] + }, + { + "roleGroup@odata.bind": "https://graph.microsoft.com/beta/external/industryData/roleGroups/students", + "defaultPasswordSettings": + { + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "********" + }, + "licenseSkus": [ "Sku2"] + } + ] + } +} +``` ++# [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.industryData.provisioningFlow" +} --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity", + "@odata.type": "#microsoft.graph.industryData.userProvisioningFlow", + "id": "dbd36d16-c574-4ed8-3ac7-08dc4ac6fb7f", + "createdDateTime": "2024-03-23T00:24:32.3286035Z", + "lastModifiedDateTime": "2024-03-23T00:24:32.3286035Z", + "readinessStatus": "notReady", + "createUnmatchedUsers": true, + "managementOptions": { + "additionalAttributes": [ + "userGradeLevel" + ], + "additionalOptions": { + "markAllStudentsAsMinors": true, + "allowStudentContactAssociation": false + } + }, + "creationOptions": { + "configurations": [ + { + "licenseSkus": [ + "Sku1" + ], + "defaultPasswordSettings": { + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "***************" + } + }, + { + "licenseSkus": [ + "Sku2" + ], + "defaultPasswordSettings": { + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "***************" + } + } + ] + } +} +``` |
v1.0 | Industrydata Outboundprovisioningflowset Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-outboundprovisioningflowset-update.md | + + Title: "Update outboundProvisioningFlowSet" +description: "Update the properties of an outboundProvisioningFlowSet object." ++ms.localizationpriority: medium ++++# Update outboundProvisioningFlowSet ++Namespace: microsoft.graph.industryData +++Update the properties of an [outboundProvisioningFlowSet](../resources/industrydata-outboundprovisioningflowset.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": "industrydata-outboundprovisioningflowset-update-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PATCH /external/industryData/outboundProvisioningFlowSets/{id} +``` ++## Request headers ++| Name | Description | +| : | :-- | +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required. | ++## Request body +++| Property | Type | Description | +| :- | :- | :- | +| displayName | String | The display name of the flowSet provided by the caller. Required. | +| filter | [microsoft.graph.industryData.filter](../resources/industrydata-filter.md) | The collection of provisioning filters applicable to all the flows under the given flowSet. Optional. | ++## 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_outboundprovisioningflowset" +} +--> ++```http +PATCH https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/8ac3c08f-6f93-465b-4bd9-08dc4ac773d0 +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.industryData.outboundProvisioningFlowSet", + "displayName": "Outbound provisioning flow Updated" +} +``` ++# [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 | Industrydata Provisioningflow Reset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-provisioningflow-reset.md | + + Title: "provisioningFlow: reset" +description: "Reset a provisioningFlow." ++ms.localizationpriority: medium ++++# provisioningFlow: reset ++Namespace: microsoft.graph.industryData +++Reset a [provisioningFlow](../resources/industrydata-provisioningflow.md). This action reprovisions all current data as if it were the initial run, and clears out the existing errors associated with the 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). ++<!-- { + "blockType": "permissions", + "name": "industrydata-provisioningflow-reset-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /external/industryData/outboundProvisioningFlowSets/{outboundProvisioningFlowSetId}/provisioningFlows/{provisioningFlowId}/reset +``` ++## Request headers ++| Name | Description | +| :-- | : | +| Authorization| Bearer {token}. Required. | ++## 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. +<!-- { + "blockType": "request", + "name": "provisioningflowthis.reset" +} +--> +``` http +POST https://graph.microsoft.com/beta/external/industryData/outboundProvisioningFlowSets/8c33d025-5e64-4550-2aa3-08dc4ac66fca/provisioningFlows/51f99e09-bdc5-47ff-7a0a-08dc4ac74cf1/reset +``` +++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 202 Accepted +``` + |
v1.0 | Industrydata Securitygroupprovisioningflow Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-securitygroupprovisioningflow-delete.md | + + Title: "Delete securityGroupProvisioningFlow" +description: "Delete a securityGroupProvisioningFlow object." ++ms.localizationpriority: medium ++++# Delete securityGroupProvisioningFlow ++Namespace: microsoft.graph.industryData +++Delete a [securityGroupProvisioningFlow](../resources/industrydata-securitygroupprovisioningflow.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": "industrydata-securitygroupprovisioningflow-delete-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +DELETE /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## 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_securitygroupprovisioningflow" +} +--> ++```http +DELETE https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/4598f62a-7bd9-40a1-d38a-08dc4ac68cf2 +``` ++# [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 +} +--> ++```http +HTTP/1.1 204 No Content +``` |
v1.0 | Industrydata Securitygroupprovisioningflow Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-securitygroupprovisioningflow-get.md | + + Title: "Get securityGroupProvisioningFlow" +description: "Read the properties and relationships of a securityGroupProvisioningFlow object." ++ms.localizationpriority: medium ++++# Get securityGroupProvisioningFlow ++Namespace: microsoft.graph.industryData +++Read the properties and relationships of a [securityGroupProvisioningFlow](../resources/industrydata-securitygroupprovisioningflow.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": "industrydata-securitygroupprovisioningflow-get-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [securityGroupProvisioningFlow](../resources/industrydata-securitygroupprovisioningflow.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_securitygroupprovisioningflow" +} +--> ++```msgraph-interactive +GET https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/4598f62a-7bd9-40a1-d38a-08dc4ac68cf2 +``` ++# [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.industryData.securityGroupProvisioningFlow" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity", + "@odata.type": "#microsoft.graph.industryData.securityGroupProvisioningFlow", + "id": "4598f62a-7bd9-40a1-d38a-08dc4ac68cf2", + "createdDateTime": "2024-03-22T23:55:06.3141592Z", + "lastModifiedDateTime": "2024-03-22T23:55:06.3141592Z", + "readinessStatus": "disabled", + "creationOptions": { + "createBasedOnRoleGroup": true, + "createBasedOnOrgPlusRoleGroup": false + } +} +``` |
v1.0 | Industrydata Securitygroupprovisioningflow Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-securitygroupprovisioningflow-update.md | + + Title: "Update securityGroupProvisioningFlow" +description: "Update the properties of a securityGroupProvisioningFlow object." ++ms.localizationpriority: medium ++++# Update securityGroupProvisioningFlow ++Namespace: microsoft.graph.industryData +++Update the properties of a [securityGroupProvisioningFlow](../resources/industrydata-securitygroupprovisioningflow.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": "industrydata-securitygroupprovisioningflow-update-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PATCH /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Request headers ++| Name | Description | +| : | :-- | +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required. | ++## Request body +++| Property | Type | Description | +| :-- | : | :-- | +| creationOptions | [microsoft.graph.industryData.securityGroupCreationOptions](../resources/industrydata-securitygroupcreationoptions.md) | The different attribute choices for the class groups to be provisioned. Required. | ++## 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_securitygroupprovisioningflow" +} +--> ++```http +PATCH https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/4598f62a-7bd9-40a1-d38a-08dc4ac68cf2 +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.industryData.securityGroupProvisioningFlow", + "creationOptions": + { + "createBasedOnRoleGroup": true, + "createBasedOnOrgPlusRoleGroup": 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", + "truncated": true +} +--> ++```http +HTTP/1.1 204 No Content +``` |
v1.0 | Industrydata Userprovisioningflow Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-userprovisioningflow-delete.md | + + Title: "Delete userProvisioningFlow" +description: "Delete a userProvisioningFlow object." ++ms.localizationpriority: medium ++++# Delete userProvisioningFlow ++Namespace: microsoft.graph.industryData +++Delete a [userProvisioningFlow](../resources/industrydata-userprovisioningflow.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": "industrydata-userprovisioningflow-delete-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +DELETE /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## 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_userprovisioningflow" +} +--> ++```http +DELETE https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/dbd36d16-c574-4ed8-3ac7-08dc4ac6fb7f +``` ++# [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 | Industrydata Userprovisioningflow Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-userprovisioningflow-get.md | + + Title: "Get userProvisioningFlow" +description: "Read the properties and relationships of a userProvisioningFlow object." ++ms.localizationpriority: medium ++++# Get userProvisioningFlow ++Namespace: microsoft.graph.industryData +++Read the properties and relationships of a [userProvisioningFlow](../resources/industrydata-userprovisioningflow.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": "industrydata-userprovisioningflow-get-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [userProvisioningFlow](../resources/industrydata-userprovisioningflow.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_userprovisioningflow" +} +--> ++```msgraph-interactive +GET https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/dbd36d16-c574-4ed8-3ac7-08dc4ac6fb7f +``` ++# [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.industryData.userProvisioningFlow" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/testprodbetalocal_sds-ppe/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity", + "@odata.type": "#microsoft.graph.industryData.userProvisioningFlow", + "id": "dbd36d16-c574-4ed8-3ac7-08dc4ac6fb7f", + "createdDateTime": "2024-03-23T00:24:32.3286035Z", + "lastModifiedDateTime": "2024-03-23T00:24:32.3286035Z", + "readinessStatus": "disabled", + "createUnmatchedUsers": true, + "managementOptions": { + "additionalAttributes": [ + "userGradeLevel" + ], + "additionalOptions": { + "markAllStudentsAsMinors": true, + "allowStudentContactAssociation": false + } + }, + "creationOptions": { + "configurations": [ + { + "licenseSkus": [ + "Sku1" + ], + "defaultPasswordSettings": { + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "***************" + }, + "roleGroup@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows('dbd36d16-c574-4ed8-3ac7-08dc4ac6fb7f')/microsoft.graph.industryData.userProvisioningFlow/creationOptions/configurations/roleGroup/$entity", + "roleGroup": { + "id": "students", + "displayName": "Students", + "roles": [ + { + "code": "student" + } + ] + } + }, + { + "licenseSkus": [ + "Sku2" + ], + "defaultPasswordSettings": { + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "***************" + }, + "roleGroup@odata.context": "https://canary.graph.microsoft.com/testprodbetalocal_sds-ppe/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows('dbd36d16-c574-4ed8-3ac7-08dc4ac6fb7f')/microsoft.graph.industryData.userProvisioningFlow/creationOptions/configurations/roleGroup/$entity", + "roleGroup": { + "id": "staff", + "displayName": "Staff", + "roles": [ + { + "code": "adjunct" + }, + { + "code": "administrator" + }, + { + "code": "advisor" + }, + { + "code": "affiliate" + }, + { + "code": "aide" + }, + { + "code": "alumni" + }, + { + "code": "assistant" + }, + { + "code": "chair" + }, + { + "code": "coach" + }, + { + "code": "faculty" + }, + { + "code": "instructor" + }, + { + "code": "itAdmin" + }, + { + "code": "lecturer" + }, + { + "code": "nurse" + }, + { + "code": "occupationalTherapist" + }, + { + "code": "officeStaff" + }, + { + "code": "paraprofessional" + }, + { + "code": "physicalTherapist" + }, + { + "code": "principal" + }, + { + "code": "proctor" + }, + { + "code": "professor" + }, + { + "code": "researcher" + }, + { + "code": "specialServices" + }, + { + "code": "speechTherapist" + }, + { + "code": "staff" + }, + { + "code": "substitute" + }, + { + "code": "teacher" + }, + { + "code": "teacherAssistant" + }, + { + "code": "visionTherapist" + } + ] + } + } + ] + } +} +``` |
v1.0 | Industrydata Userprovisioningflow Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-userprovisioningflow-update.md | + + Title: "Update userProvisioningFlow" +description: "Update the properties of a userProvisioningFlow object." ++ms.localizationpriority: medium ++++# Update userProvisioningFlow ++Namespace: microsoft.graph.industryData +++Update the properties of a [userProvisioningFlow](../resources/industrydata-userprovisioningflow.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": "industrydata-userprovisioningflow-update-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PATCH /external/industryData/OutboundProvisioningFlowSets/{id}/provisioningFlows/{id} +``` ++## Request headers ++| Name | Description | +| : | :-- | +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required. | ++## Request body +++| Property | Type | Description | +| :- | :-- | : | +| createUnmatchedUsers | Boolean | A boolean choice indicating whether unmatched users should be created or ignored. Optional. | +| managementOptions | [microsoft.graph.industryData.userManagementOptions](../resources/industrydata-usermanagementoptions.md) | The different attribute choices for all the users to be considered. Required. | +| creationOptions | [microsoft.graph.industryData.userCreationOptions](../resources/industrydata-usercreationoptions.md) | The different management choices for the new users to be provisioned. Optional. | ++## 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_userprovisioningflow" +} +--> ++```http +PATCH https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows/dbd36d16-c574-4ed8-3ac7-08dc4ac6fb7f +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.industryData.userProvisioningFlow", + "createUnmatchedUsers": true, + "managementOptions": + { + "additionalAttributes": ["userGradeLevel"], + "additionalOptions": + { + "markAllStudentsAsMinors": true, + "allowStudentContactAssociation" : true + } + }, + "creationOptions": + { + "configurations": [ + { + "roleGroup@odata.bind": "https://graph.microsoft.com/beta/external/industryData/roleGroups/staff", + "defaultPasswordSettings": + { + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "********" + }, + "licenseSkus": [ "SkuUpdated"] + }, + { + "roleGroup@odata.bind": "https://graph.microsoft.com/beta/external/industryData/roleGroups/students", + "defaultPasswordSettings": + { + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "********" + }, + "licenseSkus": [ "SkuUpdated2"] + } + ] + } +} +``` ++# [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 | Insightssettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/insightssettings-update.md | To learn more about customizing insights privacy for your organization, see: 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). +### To update **contact insights** settings for an organization <!-- { "blockType": "permissions", "name": "insightssettings_update" } --> [!INCLUDE [permissions-table](../includes/permissions/insightssettings-update-permissions.md)] -To update settings for item insights or people insights, one of the following permissions is required to call this API. To learn more, including how to choose permissions, see [permissions](/graph/permissions-reference). +### To update **item insights** settings for an organization <!-- { "blockType": "permissions", "name": "insightssettings_update_2" } --> [!INCLUDE [permissions-table](../includes/permissions/insightssettings-update-2-permissions.md)] +### To update **people insights** settings for an organization +<!-- { "blockType": "permissions", "name": "insightssettings_update_3" } --> >**Note:** Using delegated permissions for this operation to update insights for contacts, item, or people requires the signed-in user to have a Global Administrator role. To update settings for item insights: <!-- { "blockType": "ignored" } --> ```http-PATCH /organization/{organizationId}/settings/itemInsights +PATCH /admin/people/itemInsights ``` To update settings for people insights: PATCH /organization/{organizationId}/settings/peopleInsights | Property | Type |Description| |:|:--|:-| |disabledForGroup|String| The ID of a Microsoft Entra group, of which the specified type of insights are disabled for its members. Default is `empty`. Optional.|-|isEnabledInOrganization|Boolean| `true` if the specified type of insights are enabled for the organization; `false` if the specified type of insights are disabled for all users without exceptions. Default is `true`. Optional.| +|isEnabledInOrganization|Boolean| `true` if the specified insight type is enabled for the organization; `false` if the specified insight type is disabled for all users without exceptions. Default is `true`. Optional.| >**Note:** This operation does not verify the **disabledForGroup** property value if you include it in the request body. If you set the **disabledForGroup** property to a String, this operation does not check the existence of the corresponding Microsoft Entra group. This means, if you set **disabledForGroup** to a Microsoft Entra group that does not exist or is deleted afterwards, this operation will not be able to identify any group membership and disable item or people insights for any specific users. If **isEnabledInOrganization** is set to `true`, the operation will enable the specified type of insights for _all_ the users in the organization. The following example shows how an admin updates the **disabledForGroup** privac }--> ```http-PATCH https://graph.microsoft.com/beta/organization/{organizationId}/settings/itemInsights +PATCH https://graph.microsoft.com/beta/admin/people/itemInsights Content-type: application/json { |
v1.0 | Internaldomainfederation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/internaldomainfederation-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "internaldomainfederation_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/internaldomainfederation-delete-permissions.md)] +> [!IMPORTANT] +> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios. ++<!-- Domain Name Administrator and Hybrid Identity Administrator can't delete federated domains --> The calling user must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): - Security Administrator |
v1.0 | Internaldomainfederation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/internaldomainfederation-update.md | Title: "Update internalDomainFederation" description: "Update the properties of an internalDomainFederation object." ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "internaldomainfederation_update" } --> [!INCLUDE [permissions-table](../includes/permissions/internaldomainfederation-update-permissions.md)] +> [!IMPORTANT] +> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios. + [!INCLUDE [rbac-domainfederation-apis-write](../includes/rbac-for-apis/rbac-domainfederation-apis-write.md)] ## HTTP request PATCH /domains/{domainsId}/federationConfiguration/{internalDomainFederationId} |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`. | |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 will update the federation settings for the domain when a new certificate is available. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| +|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.| |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).| + ### federatedIdpMfaBehavior values | Member | Description | Content-Type: application/json "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp" } ```++<!-- +{ + "type": "#page.annotation", + "description": "", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: /api/internaldomainfederation-update.md: + Exception processing links. + Link Definition was null. Link text: !INCLUDE Azure AD PowerShell deprecation note (Parameter 'Definition')" + ] +} +--> |
v1.0 | Intune Apps Deviceappmanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-deviceappmanagement-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 [deviceAppManagement](../resources/intune-apps-deviceappmanagement.md) object. +Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceAppManagement](../resources/intune-apps-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
v1.0 | Intune Apps Deviceappmanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-deviceappmanagement-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 [deviceAppManagement](../resources/intune-apps-deviceappmanagement.md) object. +Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-apps-deviceappmanagement.md) object. +In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. -The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-apps-deviceappmanagement.md). +The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.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 [deviceAppManagement](../resources/intune-apps-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
v1.0 | Intune Apps Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-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-apps-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-apps-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Apps Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-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-apps-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-apps-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-apps-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-apps-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Apps Ioslobappprovisioningconfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-ioslobappprovisioningconfiguration-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 [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) object. +Create a new [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] The following table shows the properties that are required when you create the i ## Response-If successful, this method returns a `201 Created` response code and a [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) object in the response body. ## Example |
v1.0 | Intune Apps Ioslobappprovisioningconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-ioslobappprovisioningconfiguration-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 [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md). +Deletes a [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Apps Ioslobappprovisioningconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-ioslobappprovisioningconfiguration-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 [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) object. +Read properties and relationships of the [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) object in the response body. +If successful, this method returns a `200 OK` response code and [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) object in the response body. ## Example |
v1.0 | Intune Apps Ioslobappprovisioningconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-ioslobappprovisioningconfiguration-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 [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) objects. +List properties and relationships of the [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceAppManagement/iosLobAppProvisioningConfigurations Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) objects in the response body. ## Example |
v1.0 | Intune Apps Ioslobappprovisioningconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-ioslobappprovisioningconfiguration-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 [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) object. +Update the properties of a [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement/iosLobAppProvisioningConfigurations/{iosLobAppProvisi |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) object. +In the request body, supply a JSON representation for the [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) object. -The following table shows the properties that are required when you create the [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md). +The following table shows the properties that are required when you create the [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.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 [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) object in the response body. ## Example |
v1.0 | Intune Apps Iosvppapp Revokealllicenses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppapp-revokealllicenses.md | Content-length: 36 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 Apps Iosvppapp Revokedevicelicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppapp-revokedevicelicense.md | Content-length: 85 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 Apps Iosvppapp Revokeuserlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppapp-revokeuserlicense.md | Content-length: 66 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 Apps Iosvppappassigneddevicelicense Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassigneddevicelicense-create.md | Content-Length: 376 "managedDeviceId": "Managed Device Id value", "deviceName": "Device Name value" }-``` +``` |
v1.0 | Intune Apps Iosvppappassigneddevicelicense Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassigneddevicelicense-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAp 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 Apps Iosvppappassigneddevicelicense Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassigneddevicelicense-get.md | Content-Length: 411 "deviceName": "Device Name value" } }-``` +``` |
v1.0 | Intune Apps Iosvppappassigneddevicelicense List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassigneddevicelicense-list.md | Content-Length: 441 } ] }-``` +``` |
v1.0 | Intune Apps Iosvppappassigneddevicelicense Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassigneddevicelicense-update.md | Content-Length: 376 "managedDeviceId": "Managed Device Id value", "deviceName": "Device Name value" }-``` +``` |
v1.0 | Intune Apps Iosvppappassignedlicense Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassignedlicense-create.md | Content-Length: 283 "userName": "User Name value", "userPrincipalName": "User Principal Name value" }-``` +``` |
v1.0 | Intune Apps Iosvppappassignedlicense Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassignedlicense-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAp 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 Apps Iosvppappassignedlicense Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassignedlicense-get.md | Content-Length: 314 "userPrincipalName": "User Principal Name value" } }-``` +``` |
v1.0 | Intune Apps Iosvppappassignedlicense List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassignedlicense-list.md | Content-Length: 340 } ] }-``` +``` |
v1.0 | Intune Apps Iosvppappassignedlicense Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassignedlicense-update.md | Content-Length: 283 "userName": "User Name value", "userPrincipalName": "User Principal Name value" }-``` +``` |
v1.0 | Intune Apps Iosvppappassigneduserlicense Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassigneduserlicense-create.md | Content-Length: 287 "userName": "User Name value", "userPrincipalName": "User Principal Name value" }-``` +``` |
v1.0 | Intune Apps Iosvppappassigneduserlicense Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassigneduserlicense-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAp 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 Apps Iosvppappassigneduserlicense Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassigneduserlicense-get.md | Content-Length: 318 "userPrincipalName": "User Principal Name value" } }-``` +``` |
v1.0 | Intune Apps Iosvppappassigneduserlicense List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassigneduserlicense-list.md | Content-Length: 344 } ] }-``` +``` |
v1.0 | Intune Apps Iosvppappassigneduserlicense Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-iosvppappassigneduserlicense-update.md | Content-Length: 287 "userName": "User Name value", "userPrincipalName": "User Principal Name value" }-``` +``` |
v1.0 | Intune Apps Macosvppappassignedlicense Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-macosvppappassignedlicense-create.md | Content-Length: 285 "userName": "User Name value", "userPrincipalName": "User Principal Name value" }-``` +``` |
v1.0 | Intune Apps Macosvppappassignedlicense Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-macosvppappassignedlicense-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAp 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 Apps Macosvppappassignedlicense Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-macosvppappassignedlicense-get.md | Content-Length: 316 "userPrincipalName": "User Principal Name value" } }-``` +``` |
v1.0 | Intune Apps Macosvppappassignedlicense List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-macosvppappassignedlicense-list.md | Content-Length: 342 } ] }-``` +``` |
v1.0 | Intune Apps Macosvppappassignedlicense Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-macosvppappassignedlicense-update.md | Content-Length: 285 "userName": "User Name value", "userPrincipalName": "User Principal Name value" }-``` +``` |
v1.0 | Intune Apps Microsoftstoreforbusinesscontainedapp Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-microsoftstoreforbusinesscontainedapp-create.md | Content-Length: 176 "id": "bf1d79df-79df-bf1d-df79-1dbfdf791dbf", "appUserModelId": "App User Model Id value" }-``` +``` |
v1.0 | Intune Apps Microsoftstoreforbusinesscontainedapp Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-microsoftstoreforbusinesscontainedapp-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAp 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 Apps Microsoftstoreforbusinesscontainedapp Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-microsoftstoreforbusinesscontainedapp-get.md | Content-Length: 201 "appUserModelId": "App User Model Id value" } }-``` +``` |
v1.0 | Intune Apps Microsoftstoreforbusinesscontainedapp List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-microsoftstoreforbusinesscontainedapp-list.md | Content-Length: 221 } ] }-``` +``` |
v1.0 | Intune Apps Microsoftstoreforbusinesscontainedapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-microsoftstoreforbusinesscontainedapp-update.md | Content-Length: 176 "id": "bf1d79df-79df-bf1d-df79-1dbfdf791dbf", "appUserModelId": "App User Model Id value" }-``` +``` |
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 | Content-Length: 1010 "supersededAppCount": 2 } }-``` +``` |
v1.0 | Intune Apps Mobileapp Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileapp-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 [mobileApp](../resources/intune-apps-mobileapp.md) object. +Read properties and relationships of the [mobileApp](../resources/intune-shared-mobileapp.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [mobileApp](../resources/intune-apps-mobileapp.md) object in the response body. +If successful, this method returns a `200 OK` response code and [mobileApp](../resources/intune-shared-mobileapp.md) object in the response body. ## Example |
v1.0 | Intune Apps Mobileapp Getpublishingconstraints | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileapp-getpublishingconstraints.md | Content-Length: 245 } } }-``` +``` |
v1.0 | Intune Apps Mobileapp List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileapp-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 [mobileApp](../resources/intune-apps-mobileapp.md) objects. +List properties and relationships of the [mobileApp](../resources/intune-shared-mobileapp.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceAppManagement/mobileApps Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [mobileApp](../resources/intune-apps-mobileapp.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [mobileApp](../resources/intune-shared-mobileapp.md) objects in the response body. ## Example |
v1.0 | Intune Apps Mobileappcontent Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontent-create.md | Content-Length: 107 "@odata.type": "#microsoft.graph.mobileAppContent", "id": "fe0bb9a9-b9a9-fe0b-a9b9-0bfea9b90bfe" }-``` +``` |
v1.0 | Intune Apps Mobileappcontent Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontent-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAp 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 Apps Mobileappcontent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontent-get.md | Content-Length: 130 "id": "fe0bb9a9-b9a9-fe0b-a9b9-0bfea9b90bfe" } }-``` +``` |
v1.0 | Intune Apps Mobileappcontent List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontent-list.md | Content-Length: 148 } ] }-``` +``` |
v1.0 | Intune Apps Mobileappcontent Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontent-update.md | Content-Length: 107 "@odata.type": "#microsoft.graph.mobileAppContent", "id": "fe0bb9a9-b9a9-fe0b-a9b9-0bfea9b90bfe" }-``` +``` |
v1.0 | Intune Apps Mobileappcontentfile Commit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontentfile-commit.md | Content-length: 399 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 Apps Mobileappcontentfile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontentfile-create.md | Content-Length: 555 "isFrameworkFile": true, "isDependency": true }-``` +``` |
v1.0 | Intune Apps Mobileappcontentfile Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontentfile-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAp 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 Apps Mobileappcontentfile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontentfile-get.md | Content-Length: 604 "isDependency": true } }-``` +``` |
v1.0 | Intune Apps Mobileappcontentfile List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontentfile-list.md | Content-Length: 648 } ] }-``` +``` |
v1.0 | Intune Apps Mobileappcontentfile Renewupload | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontentfile-renewupload.md | POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppI 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 Apps Mobileappcontentfile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappcontentfile-update.md | Content-Length: 555 "isFrameworkFile": true, "isDependency": true }-``` +``` |
v1.0 | Intune Apps Mobileappinstallstatus Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappinstallstatus-create.md | The following table shows the properties that are required when you create the m |deviceName|String|Device name| |deviceId|String|Device ID| |lastSyncDateTime|DateTimeOffset|Last sync date time|-|mobileAppInstallStatusValue|[resultantAppState](../resources/intune-apps-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| -|installState|[resultantAppState](../resources/intune-apps-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| +|mobileAppInstallStatusValue|[resultantAppState](../resources/intune-shared-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| +|installState|[resultantAppState](../resources/intune-shared-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| |installStateDetail|[resultantAppStateDetail](../resources/intune-apps-resultantappstatedetail.md)|The install state detail of the app. Possible values are: `noAdditionalDetails`, `dependencyFailedToInstall`, `dependencyWithRequirementsNotMet`, `dependencyPendingReboot`, `dependencyWithAutoInstallDisabled`, `supersededAppUninstallFailed`, `supersededAppUninstallPendingReboot`, `removingSupersededApps`, `iosAppStoreUpdateFailedToInstall`, `vppAppHasUpdateAvailable`, `userRejectedUpdate`, `uninstallPendingReboot`, `supersedingAppsDetected`, `supersededAppsDetected`, `seeInstallErrorCode`, `autoInstallDisabled`, `managedAppNoLongerPresent`, `userRejectedInstall`, `userIsNotLoggedIntoAppStore`, `untargetedSupersedingAppsDetected`, `appRemovedBySupersedence`, `seeUninstallErrorCode`, `pendingReboot`, `installingDependencies`, `contentDownloaded`, `supersedingAppsNotApplicable`, `powerShellScriptRequirementNotMet`, `registryRequirementNotMet`, `fileSystemRequirementNotMet`, `platformNotApplicable`, `minimumCpuSpeedNotMet`, `minimumLogicalProcessorCountNotMet`, `minimumPhysicalMemoryNotMet`, `minimumOsVersionNotMet`, `minimumDiskSpaceNotMet`, `processorArchitectureNotApplicable`.| |errorCode|Int32|The error code for install or uninstall failures.| |osVersion|String|OS Version| Content-Length: 604 "userPrincipalName": "User Principal Name value", "displayVersion": "Display Version value" }-``` +``` |
v1.0 | Intune Apps Mobileappinstallstatus Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappinstallstatus-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAp 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 Apps Mobileappinstallstatus Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappinstallstatus-get.md | Content-Length: 651 "displayVersion": "Display Version value" } }-``` +``` |
v1.0 | Intune Apps Mobileappinstallstatus List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappinstallstatus-list.md | Content-Length: 693 } ] }-``` +``` |
v1.0 | Intune Apps Mobileappinstallstatus Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappinstallstatus-update.md | The following table shows the properties that are required when you create the [ |deviceName|String|Device name| |deviceId|String|Device ID| |lastSyncDateTime|DateTimeOffset|Last sync date time|-|mobileAppInstallStatusValue|[resultantAppState](../resources/intune-apps-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| -|installState|[resultantAppState](../resources/intune-apps-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| +|mobileAppInstallStatusValue|[resultantAppState](../resources/intune-shared-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| +|installState|[resultantAppState](../resources/intune-shared-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| |installStateDetail|[resultantAppStateDetail](../resources/intune-apps-resultantappstatedetail.md)|The install state detail of the app. Possible values are: `noAdditionalDetails`, `dependencyFailedToInstall`, `dependencyWithRequirementsNotMet`, `dependencyPendingReboot`, `dependencyWithAutoInstallDisabled`, `supersededAppUninstallFailed`, `supersededAppUninstallPendingReboot`, `removingSupersededApps`, `iosAppStoreUpdateFailedToInstall`, `vppAppHasUpdateAvailable`, `userRejectedUpdate`, `uninstallPendingReboot`, `supersedingAppsDetected`, `supersededAppsDetected`, `seeInstallErrorCode`, `autoInstallDisabled`, `managedAppNoLongerPresent`, `userRejectedInstall`, `userIsNotLoggedIntoAppStore`, `untargetedSupersedingAppsDetected`, `appRemovedBySupersedence`, `seeUninstallErrorCode`, `pendingReboot`, `installingDependencies`, `contentDownloaded`, `supersedingAppsNotApplicable`, `powerShellScriptRequirementNotMet`, `registryRequirementNotMet`, `fileSystemRequirementNotMet`, `platformNotApplicable`, `minimumCpuSpeedNotMet`, `minimumLogicalProcessorCountNotMet`, `minimumPhysicalMemoryNotMet`, `minimumOsVersionNotMet`, `minimumDiskSpaceNotMet`, `processorArchitectureNotApplicable`.| |errorCode|Int32|The error code for install or uninstall failures.| |osVersion|String|OS Version| Content-Length: 604 "userPrincipalName": "User Principal Name value", "displayVersion": "Display Version value" }-``` +``` |
v1.0 | Intune Apps Mobileappinstallsummary Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappinstallsummary-get.md | Content-Length: 466 "pendingInstallUserCount": 7 } }-``` +``` |
v1.0 | Intune Apps Mobileappinstallsummary Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappinstallsummary-update.md | Content-Length: 423 "notInstalledUserCount": 5, "pendingInstallUserCount": 7 }-``` +``` |
v1.0 | Intune Apps Mobilecontainedapp Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobilecontainedapp-get.md | Content-Length: 132 "id": "3c02d875-d875-3c02-75d8-023c75d8023c" } }-``` +``` |
v1.0 | Intune Apps Mobilecontainedapp List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobilecontainedapp-list.md | Content-Length: 150 } ] }-``` +``` |
v1.0 | Intune Apps Userappinstallstatus Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-userappinstallstatus-create.md | Content-Length: 288 "failedDeviceCount": 1, "notInstalledDeviceCount": 7 }-``` +``` |
v1.0 | Intune Apps Userappinstallstatus Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-userappinstallstatus-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAp 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 Apps Userappinstallstatus Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-userappinstallstatus-get.md | Content-Length: 321 "notInstalledDeviceCount": 7 } }-``` +``` |
v1.0 | Intune Apps Userappinstallstatus List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-userappinstallstatus-list.md | Content-Length: 349 } ] }-``` +``` |
v1.0 | Intune Apps Userappinstallstatus Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-userappinstallstatus-update.md | Content-Length: 288 "failedDeviceCount": 1, "notInstalledDeviceCount": 7 }-``` +``` |
v1.0 | Intune Apps Windowsuniversalappxcontainedapp Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-windowsuniversalappxcontainedapp-create.md | Content-Length: 171 "id": "2d03284a-284a-2d03-4a28-032d4a28032d", "appUserModelId": "App User Model Id value" }-``` +``` |
v1.0 | Intune Apps Windowsuniversalappxcontainedapp Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-windowsuniversalappxcontainedapp-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAp 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 Apps Windowsuniversalappxcontainedapp Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-windowsuniversalappxcontainedapp-get.md | Content-Length: 196 "appUserModelId": "App User Model Id value" } }-``` +``` |
v1.0 | Intune Apps Windowsuniversalappxcontainedapp List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-windowsuniversalappxcontainedapp-list.md | Content-Length: 216 } ] }-``` +``` |
v1.0 | Intune Apps Windowsuniversalappxcontainedapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-windowsuniversalappxcontainedapp-update.md | Content-Length: 171 "id": "2d03284a-284a-2d03-4a28-032d4a28032d", "appUserModelId": "App User Model Id value" }-``` +``` |
v1.0 | Intune Auditing Auditevent Getauditactivitytypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-auditing-auditevent-getauditactivitytypes.md | Content-Length: 61 "Get Audit Activity Types value" ] }-``` +``` |
v1.0 | Intune Auditing Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-auditing-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-auditing-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-auditing-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Auditing Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-auditing-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-auditing-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-auditing-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-auditing-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-auditing-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Books Deviceappmanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-books-deviceappmanagement-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 [deviceAppManagement](../resources/intune-books-deviceappmanagement.md) object. +Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceAppManagement](../resources/intune-books-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
v1.0 | Intune Books Deviceappmanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-books-deviceappmanagement-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 [deviceAppManagement](../resources/intune-books-deviceappmanagement.md) object. +Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-books-deviceappmanagement.md) object. +In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. -The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-books-deviceappmanagement.md). +The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.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 [deviceAppManagement](../resources/intune-books-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
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 Chromebooksync Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-chromebooksync-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-chromebooksync-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-chromebooksync-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Chromebooksync Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-chromebooksync-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-chromebooksync-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-chromebooksync-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-chromebooksync-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-chromebooksync-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Cloudpkigraphservice Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-devicemanagement-get.md | + + Title: "Get deviceManagement" +description: "Read properties and relationships of the deviceManagement object." ++localization_priority: Normal ++++# 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-shared-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-shared-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 Cloudpkigraphservice Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-devicemanagement-update.md | + + Title: "Update deviceManagement" +description: "Update the properties of a deviceManagement object." ++localization_priority: Normal ++++# 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-shared-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-shared-devicemanagement.md) object. ++The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-devicemanagement.md). ++|Property|Type|Description| +|:|:|:| +|id|String|Required Graph property| ++++## 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. ++## 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 Companyterms Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-companyterms-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-companyterms-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-companyterms-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Companyterms Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-companyterms-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-companyterms-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-companyterms-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-companyterms-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-companyterms-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Deviceconfig Androidcertificateprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidcertificateprofilebase-get.md | Content-Length: 1723 ] } }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownercertificateprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownercertificateprofilebase-get.md | Content-Length: 1734 "subjectAlternativeNameType": "emailAddress" } }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerimportedpfxcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownerimportedpfxcertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |intendedPurpose|[intendedPurpose](../resources/intune-deviceconfig-intendedpurpose.md)|Intended Purpose of the Certificate Profile - which could be Unassigned, SmimeEncryption, SmimeSigning etc. Possible values are: `unassigned`, `smimeEncryption`, `smimeSigning`, `vpn`, `wifi`.| |certificateAccessType|[androidDeviceOwnerCertificateAccessType](../resources/intune-deviceconfig-androiddeviceownercertificateaccesstype.md)|Certificate access type. Possible values are: `userApproval`, `specificApps`, `unknownFutureValue`.| |
v1.0 | Intune Deviceconfig Androiddeviceownerimportedpfxcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownerimportedpfxcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |intendedPurpose|[intendedPurpose](../resources/intune-deviceconfig-intendedpurpose.md)|Intended Purpose of the Certificate Profile - which could be Unassigned, SmimeEncryption, SmimeSigning etc. Possible values are: `unassigned`, `smimeEncryption`, `smimeSigning`, `vpn`, `wifi`.| |certificateAccessType|[androidDeviceOwnerCertificateAccessType](../resources/intune-deviceconfig-androiddeviceownercertificateaccesstype.md)|Certificate access type. Possible values are: `userApproval`, `specificApps`, `unknownFutureValue`.| |
v1.0 | Intune Deviceconfig Androiddeviceownerpkcscertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownerpkcscertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |
v1.0 | Intune Deviceconfig Androiddeviceownerpkcscertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownerpkcscertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |
v1.0 | Intune Deviceconfig Androiddeviceownerscepcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownerscepcertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |
v1.0 | Intune Deviceconfig Androiddeviceownerscepcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownerscepcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |
v1.0 | Intune Deviceconfig Androiddeviceownertrustedrootcertificate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownertrustedrootcertificate-create.md | Content-Length: 1323 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownertrustedrootcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownertrustedrootcertificate-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 Deviceconfig Androiddeviceownertrustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownertrustedrootcertificate-get.md | Content-Length: 1410 "certFileName": "Cert File Name value" } }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownertrustedrootcertificate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownertrustedrootcertificate-list.md | Content-Length: 1492 } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownertrustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androiddeviceownertrustedrootcertificate-update.md | Content-Length: 1323 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkcertificateprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkcertificateprofilebase-get.md | Content-Length: 1730 "subjectAlternativeNameType": "emailAddress" } }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkimportedpfxcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkimportedpfxcertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |intendedPurpose|[intendedPurpose](../resources/intune-deviceconfig-intendedpurpose.md)|Intended Purpose of the Certificate Profile - which could be Unassigned, SmimeEncryption, SmimeSigning etc. Possible values are: `unassigned`, `smimeEncryption`, `smimeSigning`, `vpn`, `wifi`.| |
v1.0 | Intune Deviceconfig Androidforworkimportedpfxcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkimportedpfxcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |intendedPurpose|[intendedPurpose](../resources/intune-deviceconfig-intendedpurpose.md)|Intended Purpose of the Certificate Profile - which could be Unassigned, SmimeEncryption, SmimeSigning etc. Possible values are: `unassigned`, `smimeEncryption`, `smimeSigning`, `vpn`, `wifi`.| |
v1.0 | Intune Deviceconfig Androidforworkpkcscertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkpkcscertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |
v1.0 | Intune Deviceconfig Androidforworkpkcscertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkpkcscertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |
v1.0 | Intune Deviceconfig Androidforworkscepcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkscepcertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |
v1.0 | Intune Deviceconfig Androidforworkscepcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkscepcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |
v1.0 | Intune Deviceconfig Androidforworktrustedrootcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworktrustedrootcertificate-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 Deviceconfig Androidforworktrustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworktrustedrootcertificate-get.md | Content-Length: 1406 "certFileName": "Cert File Name value" } }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworktrustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworktrustedrootcertificate-update.md | Content-Length: 1319 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Androidimportedpfxcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidimportedpfxcertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |intendedPurpose|[intendedPurpose](../resources/intune-deviceconfig-intendedpurpose.md)|Intended Purpose of the Certificate Profile - which could be Unassigned, SmimeEncryption, SmimeSigning etc. Possible values are: `unassigned`, `smimeEncryption`, `smimeSigning`, `vpn`, `wifi`.| |
v1.0 | Intune Deviceconfig Androidimportedpfxcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidimportedpfxcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |intendedPurpose|[intendedPurpose](../resources/intune-deviceconfig-intendedpurpose.md)|Intended Purpose of the Certificate Profile - which could be Unassigned, SmimeEncryption, SmimeSigning etc. Possible values are: `unassigned`, `smimeEncryption`, `smimeSigning`, `vpn`, `wifi`.| |
v1.0 | Intune Deviceconfig Androidpkcscertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidpkcscertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |certificateTemplateName|String|PKCS Certificate Template Name| |
v1.0 | Intune Deviceconfig Androidpkcscertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidpkcscertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |certificateTemplateName|String|PKCS Certificate Template Name| |
v1.0 | Intune Deviceconfig Androidscepcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidscepcertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| |
v1.0 | Intune Deviceconfig Androidscepcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidscepcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| |
v1.0 | Intune Deviceconfig Androidtrustedrootcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidtrustedrootcertificate-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 Deviceconfig Androidtrustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidtrustedrootcertificate-get.md | Content-Length: 1399 "certFileName": "Cert File Name value" } }-``` +``` |
v1.0 | Intune Deviceconfig Androidtrustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidtrustedrootcertificate-update.md | Content-Length: 1312 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilecertificateprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofilecertificateprofilebase-get.md | Content-Length: 1734 "subjectAlternativeNameType": "emailAddress" } }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilepkcscertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofilepkcscertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |
v1.0 | Intune Deviceconfig Androidworkprofilepkcscertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofilepkcscertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |
v1.0 | Intune Deviceconfig Androidworkprofilescepcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofilescepcertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |
v1.0 | Intune Deviceconfig Androidworkprofilescepcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofilescepcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |
v1.0 | Intune Deviceconfig Androidworkprofiletrustedrootcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofiletrustedrootcertificate-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 Deviceconfig Androidworkprofiletrustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofiletrustedrootcertificate-get.md | Content-Length: 1410 "certFileName": "Cert File Name value" } }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofiletrustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofiletrustedrootcertificate-update.md | Content-Length: 1323 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownercertificateprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownercertificateprofilebase-get.md | Content-Length: 1731 "subjectAlternativeNameType": "emailAddress" } }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownerpkcscertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownerpkcscertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |
v1.0 | Intune Deviceconfig Aospdeviceownerpkcscertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownerpkcscertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |
v1.0 | Intune Deviceconfig Aospdeviceownerscepcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownerscepcertificateprofile-create.md | The following table shows the properties that are required when you create the a |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |
v1.0 | Intune Deviceconfig Aospdeviceownerscepcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownerscepcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |
v1.0 | Intune Deviceconfig Aospdeviceownertrustedrootcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownertrustedrootcertificate-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 Deviceconfig Aospdeviceownertrustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownertrustedrootcertificate-get.md | Content-Length: 1407 "certFileName": "Cert File Name value" } }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownertrustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownertrustedrootcertificate-update.md | Content-Length: 1320 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancepolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-devicecompliancepolicy-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 [deviceCompliancePolicy](../resources/intune-deviceconfig-devicecompliancepolicy.md) object. +Read properties and relationships of the [deviceCompliancePolicy](../resources/intune-shared-devicecompliancepolicy.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceCompliancePolicy](../resources/intune-deviceconfig-devicecompliancepolicy.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceCompliancePolicy](../resources/intune-shared-devicecompliancepolicy.md) object in the response body. ## Example |
v1.0 | Intune Deviceconfig Devicecompliancepolicy List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-devicecompliancepolicy-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 [deviceCompliancePolicy](../resources/intune-deviceconfig-devicecompliancepolicy.md) objects. +List properties and relationships of the [deviceCompliancePolicy](../resources/intune-shared-devicecompliancepolicy.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceManagement/deviceCompliancePolicies Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [deviceCompliancePolicy](../resources/intune-deviceconfig-devicecompliancepolicy.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [deviceCompliancePolicy](../resources/intune-shared-devicecompliancepolicy.md) objects in the response body. ## Example |
v1.0 | Intune Deviceconfig Deviceconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-deviceconfiguration-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 [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md) object. +Read properties and relationships of the [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md) object in the response body. ## Example |
v1.0 | Intune Deviceconfig Deviceconfiguration Getomasettingplaintextvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-deviceconfiguration-getomasettingplaintextvalue.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). -> [!NOTE] -> This API involves potential secret values; ReadWrite permission is required. - |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 57 { "value": "Get Oma Setting Plain Text Value value" }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-deviceconfiguration-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 [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md) objects. +List properties and relationships of the [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.gra Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md) objects in the response body. ## Example |
v1.0 | Intune Deviceconfig Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-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-deviceconfig-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-deviceconfig-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Deviceconfig Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-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-deviceconfig-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-deviceconfig-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-deviceconfig-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-deviceconfig-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Deviceconfig Devicemanagementderivedcredentialsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-devicemanagementderivedcredentialsettings-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 [deviceManagementDerivedCredentialSettings](../resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md) object. +Read properties and relationships of the [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceManagementDerivedCredentialSettings](../resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object in the response body. ## Example Content-Length: 155 "id": "bc650741-0741-bc65-4107-65bc410765bc" } }-``` +``` |
v1.0 | Intune Deviceconfig Devicemanagementderivedcredentialsettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-devicemanagementderivedcredentialsettings-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 [deviceManagementDerivedCredentialSettings](../resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md) object. +Update the properties of a [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.g |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagementDerivedCredentialSettings](../resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md) object. +In the request body, supply a JSON representation for the [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object. -The following table shows the properties that are required when you create the [deviceManagementDerivedCredentialSettings](../resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md). +The following table shows the properties that are required when you create the [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.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 [deviceManagementDerivedCredentialSettings](../resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object in the response body. ## Example Content-Length: 132 "@odata.type": "#microsoft.graph.deviceManagementDerivedCredentialSettings", "id": "bc650741-0741-bc65-4107-65bc410765bc" }-``` +``` |
v1.0 | Intune Deviceconfig Hardwareconfiguration Assignhardwareconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-hardwareconfiguration-assignhardwareconfiguration.md | Content-Length: 504 } ] }-``` +``` |
v1.0 | Intune Deviceconfig Hardwareconfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-hardwareconfiguration-create.md | The following table shows the properties that are required when you create the h |Property|Type|Description| |:|:|:|-|id|String|Unique Identifier for the hardware configuration| -|version|Int32|Version of the hardware configuration (E.g. 1, 2, 3 ...)| -|displayName|String|Name of the hardware configuration| -|description|String|Description of the hardware configuration| -|createdDateTime|DateTimeOffset|Timestamp of when the hardware configuration was created. This property is read-only.| -|lastModifiedDateTime|DateTimeOffset|Timestamp of when the hardware configuration was modified. This property is read-only.| -|fileName|String|File name of the hardware configuration| -|configurationFileContent|Binary|File content of the hardware configuration| -|hardwareConfigurationFormat|[hardwareConfigurationFormat](../resources/intune-deviceconfig-hardwareconfigurationformat.md)|Oem type of the hardware configuration (E.g. DELL, HP, Surface and SurfaceDock). Possible values are: `dell`, `surface`, `surfaceDock`.| -|roleScopeTagIds|String collection|List of Scope Tag IDs for the hardware configuration| -|perDevicePasswordDisabled|Boolean|A value indicating whether per devcive pasword disabled| +|id|String|The unique identifier of the hardware BIOS configuration profile for the enrolled devices. This id is and is autogenerated and assigned when new hardware BIOS configuration profile is created. This distinguishes profiles from each other and cannot be null. Returned by default. Read-Only.| +|version|Int32|The version of the hardware configuration (E.g. 1, 2, 3 ...). This is incremented after a change to the BIOS configuration profile's settings file name (FileName property), settings file content (ConfigurationFileContent property), or the PerDevicePasswordDisabled property. Read-Only.| +|displayName|String|The name of the hardware BIOS configuration profile. It serves as user-friendly name to identify hardware BIOS configuration profiles. Max length is 150 characters. Required. Read-Only.| +|description|String|The description of the hardware configuration. Use this to provide context, purpose, applications, etc of the BIOS configuration profile for your organization's admins. Max length is 1000 characters. Optional.| +|createdDateTime|DateTimeOffset|The date and time of when the BIOS configuration profile was created. The value cannot be modified and is automatically populated when the device is enrolled. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-Only. This property is read-only.| +|lastModifiedDateTime|DateTimeOffset|The date and time of when the BIOS configuration profile was last modified. The value cannot be modified and is automatically populated when the device is enrolled. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-Only. Read-Only. This property is read-only.| +|fileName|String|The file name for the BIOS configuration profile's ConfigurationFileContent. Max length is 150 characters. Required.| +|configurationFileContent|Binary|The file content contains custom hardware settings that will be applied to the assigned devices' BIOS. Max allowed file size is 5KB. Represented as bytes. Required.| +|hardwareConfigurationFormat|[hardwareConfigurationFormat](../resources/intune-deviceconfig-hardwareconfigurationformat.md)|The OEM type associated with BIOS configuration profile's custom hardware settings. All devices that adheres to profile must be from the same selected OEM. Possible values are Dell, Surface, and Surface dock. Required. Possible values are: `dell`, `surface`, `surfaceDock`.| +|roleScopeTagIds|String collection|A list of unique Scope Tag IDs associated with the hardware configuration. Optional.| +|perDevicePasswordDisabled|Boolean|When TRUE, indicates whether the policy-assigned devices' passwords are disabled. When FALSE, indicates they are enabled. Default is FALSE. Required.| |
v1.0 | Intune Deviceconfig Hardwareconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-hardwareconfiguration-update.md | The following table shows the properties that are required when you create the [ |Property|Type|Description| |:|:|:|-|id|String|Unique Identifier for the hardware configuration| -|version|Int32|Version of the hardware configuration (E.g. 1, 2, 3 ...)| -|displayName|String|Name of the hardware configuration| -|description|String|Description of the hardware configuration| -|createdDateTime|DateTimeOffset|Timestamp of when the hardware configuration was created. This property is read-only.| -|lastModifiedDateTime|DateTimeOffset|Timestamp of when the hardware configuration was modified. This property is read-only.| -|fileName|String|File name of the hardware configuration| -|configurationFileContent|Binary|File content of the hardware configuration| -|hardwareConfigurationFormat|[hardwareConfigurationFormat](../resources/intune-deviceconfig-hardwareconfigurationformat.md)|Oem type of the hardware configuration (E.g. DELL, HP, Surface and SurfaceDock). Possible values are: `dell`, `surface`, `surfaceDock`.| -|roleScopeTagIds|String collection|List of Scope Tag IDs for the hardware configuration| -|perDevicePasswordDisabled|Boolean|A value indicating whether per devcive pasword disabled| +|id|String|The unique identifier of the hardware BIOS configuration profile for the enrolled devices. This id is and is autogenerated and assigned when new hardware BIOS configuration profile is created. This distinguishes profiles from each other and cannot be null. Returned by default. Read-Only.| +|version|Int32|The version of the hardware configuration (E.g. 1, 2, 3 ...). This is incremented after a change to the BIOS configuration profile's settings file name (FileName property), settings file content (ConfigurationFileContent property), or the PerDevicePasswordDisabled property. Read-Only.| +|displayName|String|The name of the hardware BIOS configuration profile. It serves as user-friendly name to identify hardware BIOS configuration profiles. Max length is 150 characters. Required. Read-Only.| +|description|String|The description of the hardware configuration. Use this to provide context, purpose, applications, etc of the BIOS configuration profile for your organization's admins. Max length is 1000 characters. Optional.| +|createdDateTime|DateTimeOffset|The date and time of when the BIOS configuration profile was created. The value cannot be modified and is automatically populated when the device is enrolled. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-Only. This property is read-only.| +|lastModifiedDateTime|DateTimeOffset|The date and time of when the BIOS configuration profile was last modified. The value cannot be modified and is automatically populated when the device is enrolled. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-Only. Read-Only. This property is read-only.| +|fileName|String|The file name for the BIOS configuration profile's ConfigurationFileContent. Max length is 150 characters. Required.| +|configurationFileContent|Binary|The file content contains custom hardware settings that will be applied to the assigned devices' BIOS. Max allowed file size is 5KB. Represented as bytes. Required.| +|hardwareConfigurationFormat|[hardwareConfigurationFormat](../resources/intune-deviceconfig-hardwareconfigurationformat.md)|The OEM type associated with BIOS configuration profile's custom hardware settings. All devices that adheres to profile must be from the same selected OEM. Possible values are Dell, Surface, and Surface dock. Required. Possible values are: `dell`, `surface`, `surfaceDock`.| +|roleScopeTagIds|String collection|A list of unique Scope Tag IDs associated with the hardware configuration. Optional.| +|perDevicePasswordDisabled|Boolean|When TRUE, indicates whether the policy-assigned devices' passwords are disabled. When FALSE, indicates they are enabled. Default is FALSE. Required.| |
v1.0 | Intune Deviceconfig Ioscertificateprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-ioscertificateprofile-get.md | Content-Length: 1279 "version": 7 } }-``` +``` |
v1.0 | Intune Deviceconfig Ioscertificateprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-ioscertificateprofilebase-get.md | Content-Length: 1512 "certificateValidityPeriodScale": "months" } }-``` +``` |
v1.0 | Intune Deviceconfig Iosscepcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-iosscepcertificateprofile-create.md | The following table shows the properties that are required when you create the i |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| |keySize|[keySize](../resources/intune-shared-keysize.md)|SCEP Key Size. Possible values are: `size1024`, `size2048`, `size4096`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. The OnPremisesUserPrincipalName variable is support as well as others documented here: https://go.microsoft.com/fwlink/?LinkId=2027630. This collection can contain a maximum of 500 elements.| |
v1.0 | Intune Deviceconfig Iosscepcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-iosscepcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| |keySize|[keySize](../resources/intune-shared-keysize.md)|SCEP Key Size. Possible values are: `size1024`, `size2048`, `size4096`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. The OnPremisesUserPrincipalName variable is support as well as others documented here: https://go.microsoft.com/fwlink/?LinkId=2027630. This collection can contain a maximum of 500 elements.| |
v1.0 | Intune Deviceconfig Iostrustedrootcertificate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-iostrustedrootcertificate-create.md | Content-Length: 1308 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Iostrustedrootcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-iostrustedrootcertificate-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 Deviceconfig Iostrustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-iostrustedrootcertificate-get.md | Content-Length: 1395 "certFileName": "Cert File Name value" } }-``` +``` |
v1.0 | Intune Deviceconfig Iostrustedrootcertificate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-iostrustedrootcertificate-list.md | Content-Length: 1477 } ] }-``` +``` |
v1.0 | Intune Deviceconfig Iostrustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-iostrustedrootcertificate-update.md | Content-Length: 1308 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Macoscertificateprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-macoscertificateprofilebase-get.md | Content-Length: 1514 "certificateValidityPeriodScale": "months" } }-``` +``` |
v1.0 | Intune Deviceconfig Macosscepcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-macosscepcertificateprofile-create.md | The following table shows the properties that are required when you create the m |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| |keySize|[keySize](../resources/intune-shared-keysize.md)|SCEP Key Size. Possible values are: `size1024`, `size2048`, `size4096`.| |hashAlgorithm|[hashAlgorithms](../resources/intune-shared-hashalgorithms.md)|SCEP Hash Algorithm. Possible values are: `sha1`, `sha2`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements.| |
v1.0 | Intune Deviceconfig Macosscepcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-macosscepcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| |keySize|[keySize](../resources/intune-shared-keysize.md)|SCEP Key Size. Possible values are: `size1024`, `size2048`, `size4096`.| |hashAlgorithm|[hashAlgorithms](../resources/intune-shared-hashalgorithms.md)|SCEP Hash Algorithm. Possible values are: `sha1`, `sha2`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements.| |
v1.0 | Intune Deviceconfig Macostrustedrootcertificate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-macostrustedrootcertificate-create.md | Content-Length: 1310 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Macostrustedrootcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-macostrustedrootcertificate-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 Deviceconfig Macostrustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-macostrustedrootcertificate-get.md | Content-Length: 1397 "certFileName": "Cert File Name value" } }-``` +``` |
v1.0 | Intune Deviceconfig Macostrustedrootcertificate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-macostrustedrootcertificate-list.md | Content-Length: 1479 } ] }-``` +``` |
v1.0 | Intune Deviceconfig Macostrustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-macostrustedrootcertificate-update.md | Content-Length: 1310 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Manageddevicecertificatestate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-manageddevicecertificatestate-create.md | Content-Length: 1566 "certificateIssuanceDateTime": "2016-12-31T23:59:41.5044473-08:00", "certificateErrorCode": 4 }-``` +``` |
v1.0 | Intune Deviceconfig Manageddevicecertificatestate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-manageddevicecertificatestate-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 Deviceconfig Manageddevicecertificatestate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-manageddevicecertificatestate-get.md | Content-Length: 1637 "certificateErrorCode": 4 } }-``` +``` |
v1.0 | Intune Deviceconfig Manageddevicecertificatestate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-manageddevicecertificatestate-list.md | Content-Length: 1703 } ] }-``` +``` |
v1.0 | Intune Deviceconfig Manageddevicecertificatestate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-manageddevicecertificatestate-update.md | Content-Length: 1566 "certificateIssuanceDateTime": "2016-12-31T23:59:41.5044473-08:00", "certificateErrorCode": 4 }-``` +``` |
v1.0 | Intune Deviceconfig Reportroot Deviceconfigurationdeviceactivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-reportroot-deviceconfigurationdeviceactivity.md | GET /reports/deviceConfigurationDeviceActivity 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-deviceconfig-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-report.md) in the response body. ## Example |
v1.0 | Intune Deviceconfig Reportroot Deviceconfigurationuseractivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-reportroot-deviceconfigurationuseractivity.md | GET /reports/deviceConfigurationUserActivity 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-deviceconfig-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-report.md) in the response body. ## Example |
v1.0 | Intune Deviceconfig Reportroot Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-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-deviceconfig-reportroot.md) object. +Read properties and relationships of the [reportRoot](../resources/intune-shared-reportroot.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-deviceconfig-reportroot.md) object in the response body. +If successful, this method returns a `200 OK` response code and [reportRoot](../resources/intune-shared-reportroot.md) object in the response body. ## Example |
v1.0 | Intune Deviceconfig Reportroot Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-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-deviceconfig-reportroot.md) object. +Update the properties of a [reportRoot](../resources/intune-shared-reportroot.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /reports |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [reportRoot](../resources/intune-deviceconfig-reportroot.md) object. +In the request body, supply a JSON representation for the [reportRoot](../resources/intune-shared-reportroot.md) object. -The following table shows the properties that are required when you create the [reportRoot](../resources/intune-deviceconfig-reportroot.md). +The following table shows the properties that are required when you create the [reportRoot](../resources/intune-shared-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-deviceconfig-reportroot.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [reportRoot](../resources/intune-shared-reportroot.md) object in the response body. ## Example |
v1.0 | Intune Deviceconfig Softwareupdatestatussummary Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-softwareupdatestatussummary-update.md | Content-Length: 567 "conflictUserCount": 1, "notApplicableUserCount": 6 }-``` +``` |
v1.0 | Intune Deviceconfig Windows10pkcscertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10pkcscertificateprofile-create.md | The following table shows the properties that are required when you create the w |certificationAuthorityName|String|PKCS Certification Authority Name| |certificateTemplateName|String|PKCS Certificate Template Name| |subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements.| |
v1.0 | Intune Deviceconfig Windows10pkcscertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10pkcscertificateprofile-update.md | The following table shows the properties that are required when you create the [ |certificationAuthorityName|String|PKCS Certification Authority Name| |certificateTemplateName|String|PKCS Certificate Template Name| |subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements.| |
v1.0 | Intune Deviceconfig Windows10vpnconfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10vpnconfiguration-create.md | The following table shows the properties that are required when you create the w |rememberUserCredentials|Boolean|Remember user credentials.| |enableConditionalAccess|Boolean|Enable conditional access.| |enableSingleSignOnWithAlternateCertificate|Boolean|Enable single sign-on (SSO) with alternate certificate.|-|singleSignOnEku|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md)|Single sign-on Extended Key Usage (EKU).| +|singleSignOnEku|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md)|Single sign-on Extended Key Usage (EKU).| |singleSignOnIssuerHash|String|Single sign-on issuer hash.| |eapXml|Binary|Extensible Authentication Protocol (EAP) XML. (UTF8 encoded byte array)| |proxyServer|[windows10VpnProxyServer](../resources/intune-deviceconfig-windows10vpnproxyserver.md)|Proxy Server.| |
v1.0 | Intune Deviceconfig Windows10vpnconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10vpnconfiguration-update.md | The following table shows the properties that are required when you create the [ |rememberUserCredentials|Boolean|Remember user credentials.| |enableConditionalAccess|Boolean|Enable conditional access.| |enableSingleSignOnWithAlternateCertificate|Boolean|Enable single sign-on (SSO) with alternate certificate.|-|singleSignOnEku|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md)|Single sign-on Extended Key Usage (EKU).| +|singleSignOnEku|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md)|Single sign-on Extended Key Usage (EKU).| |singleSignOnIssuerHash|String|Single sign-on issuer hash.| |eapXml|Binary|Extensible Authentication Protocol (EAP) XML. (UTF8 encoded byte array)| |proxyServer|[windows10VpnProxyServer](../resources/intune-deviceconfig-windows10vpnproxyserver.md)|Proxy Server.| |
v1.0 | Intune Deviceconfig Windows81scepcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows81scepcertificateprofile-create.md | The following table shows the properties that are required when you create the w |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windows81CertificateProfileBase](../resources/intune-deviceconfig-windows81certificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windows81CertificateProfileBase](../resources/intune-deviceconfig-windows81certificateprofilebase.md)| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements. Inherited from [windows81CertificateProfileBase](../resources/intune-deviceconfig-windows81certificateprofilebase.md)| |scepServerUrls|String collection|SCEP Server Url(s).| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |
v1.0 | Intune Deviceconfig Windows81scepcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows81scepcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windows81CertificateProfileBase](../resources/intune-deviceconfig-windows81certificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windows81CertificateProfileBase](../resources/intune-deviceconfig-windows81certificateprofilebase.md)| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements. Inherited from [windows81CertificateProfileBase](../resources/intune-deviceconfig-windows81certificateprofilebase.md)| |scepServerUrls|String collection|SCEP Server Url(s).| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |
v1.0 | Intune Deviceconfig Windows81trustedrootcertificate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows81trustedrootcertificate-create.md | Content-Length: 1370 "certFileName": "Cert File Name value", "destinationStore": "computerCertStoreIntermediate" }-``` +``` |
v1.0 | Intune Deviceconfig Windows81trustedrootcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows81trustedrootcertificate-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 Deviceconfig Windows81trustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows81trustedrootcertificate-get.md | Content-Length: 1459 "destinationStore": "computerCertStoreIntermediate" } }-``` +``` |
v1.0 | Intune Deviceconfig Windows81trustedrootcertificate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows81trustedrootcertificate-list.md | Content-Length: 1543 } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windows81trustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows81trustedrootcertificate-update.md | Content-Length: 1370 "certFileName": "Cert File Name value", "destinationStore": "computerCertStoreIntermediate" }-``` +``` |
v1.0 | Intune Deviceconfig Windowscertificateprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowscertificateprofilebase-get.md | Content-Length: 1576 "certificateValidityPeriodScale": "months" } }-``` +``` |
v1.0 | Intune Deviceconfig Windowsdomainjoinconfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) object. +Create a new [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] The following table shows the properties that are required when you create the w |Property|Type|Description| |:|:|:|-|id|String|Key of the entity. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|lastModifiedDateTime|DateTimeOffset|DateTime the object was last modified. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|supportsScopeTags|Boolean|Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceManagementApplicabilityRuleOsEdition|[deviceManagementApplicabilityRuleOsEdition](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md)|The OS edition applicability for this Policy. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceManagementApplicabilityRuleOsVersion|[deviceManagementApplicabilityRuleOsVersion](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md)|The OS version applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceManagementApplicabilityRuleDeviceMode|[deviceManagementApplicabilityRuleDeviceMode](../resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md)|The device mode applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|createdDateTime|DateTimeOffset|DateTime the object was created. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| +|id|String|Key of the entity. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|lastModifiedDateTime|DateTimeOffset|DateTime the object was last modified. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|supportsScopeTags|Boolean|Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsEdition|[deviceManagementApplicabilityRuleOsEdition](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md)|The OS edition applicability for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsVersion|[deviceManagementApplicabilityRuleOsVersion](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md)|The OS version applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleDeviceMode|[deviceManagementApplicabilityRuleDeviceMode](../resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md)|The device mode applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|createdDateTime|DateTimeOffset|DateTime the object was created. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |computerNameStaticPrefix|String|Fixed prefix to be used for computer name.| |computerNameSuffixRandomCharCount|Int32|Dynamically generated characters used as suffix for computer name. Valid values 3 to 14| |activeDirectoryDomainName|String|Active Directory domain name to join.| The following table shows the properties that are required when you create the w ## Response-If successful, this method returns a `201 Created` response code and a [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object in the response body. ## Example |
v1.0 | Intune Deviceconfig Windowsdomainjoinconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md). +Deletes a [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Deviceconfig Windowsdomainjoinconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) object. +Read properties and relationships of the [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) object in the response body. +If successful, this method returns a `200 OK` response code and [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object in the response body. ## Example |
v1.0 | Intune Deviceconfig Windowsdomainjoinconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) objects. +List properties and relationships of the [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.gra Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) objects in the response body. ## Example |
v1.0 | Intune Deviceconfig Windowsdomainjoinconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) object. +Update the properties of a [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.g |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) object. +In the request body, supply a JSON representation for the [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object. -The following table shows the properties that are required when you create the [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md). +The following table shows the properties that are required when you create the [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md). |Property|Type|Description| |:|:|:|-|id|String|Key of the entity. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|lastModifiedDateTime|DateTimeOffset|DateTime the object was last modified. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|supportsScopeTags|Boolean|Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceManagementApplicabilityRuleOsEdition|[deviceManagementApplicabilityRuleOsEdition](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md)|The OS edition applicability for this Policy. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceManagementApplicabilityRuleOsVersion|[deviceManagementApplicabilityRuleOsVersion](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md)|The OS version applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceManagementApplicabilityRuleDeviceMode|[deviceManagementApplicabilityRuleDeviceMode](../resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md)|The device mode applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|createdDateTime|DateTimeOffset|DateTime the object was created. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| +|id|String|Key of the entity. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|lastModifiedDateTime|DateTimeOffset|DateTime the object was last modified. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|supportsScopeTags|Boolean|Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsEdition|[deviceManagementApplicabilityRuleOsEdition](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md)|The OS edition applicability for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsVersion|[deviceManagementApplicabilityRuleOsVersion](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md)|The OS version applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleDeviceMode|[deviceManagementApplicabilityRuleDeviceMode](../resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md)|The device mode applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|createdDateTime|DateTimeOffset|DateTime the object was created. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |computerNameStaticPrefix|String|Fixed prefix to be used for computer name.| |computerNameSuffixRandomCharCount|Int32|Dynamically generated characters used as suffix for computer name. Valid values 3 to 14| |activeDirectoryDomainName|String|Active Directory domain name to join.| 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 [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object in the response body. ## Example |
v1.0 | Intune Deviceconfig Windowsphone81certificateprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsphone81certificateprofilebase-get.md | Content-Length: 1783 ] } }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphone81scepcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsphone81scepcertificateprofile-create.md | The following table shows the properties that are required when you create the w |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validtiy Period. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md)| |scepServerUrls|String collection|SCEP Server Url(s).| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| |
v1.0 | Intune Deviceconfig Windowsphone81scepcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsphone81scepcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validtiy Period. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md)| |scepServerUrls|String collection|SCEP Server Url(s).| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| |
v1.0 | Intune Deviceconfig Windowsphone81trustedrootcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsphone81trustedrootcertificate-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 Deviceconfig Windowsphone81trustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsphone81trustedrootcertificate-get.md | Content-Length: 1406 "certFileName": "Cert File Name value" } }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphone81trustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsphone81trustedrootcertificate-update.md | Content-Length: 1319 "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsprivacydataaccesscontrolitem Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsprivacydataaccesscontrolitem-create.md | Content-Length: 299 "appPackageFamilyName": "App Package Family Name value", "appDisplayName": "App Display Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsprivacydataaccesscontrolitem Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsprivacydataaccesscontrolitem-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 Deviceconfig Windowsprivacydataaccesscontrolitem Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsprivacydataaccesscontrolitem-get.md | Content-Length: 330 "appDisplayName": "App Display Name value" } }-``` +``` |
v1.0 | Intune Deviceconfig Windowsprivacydataaccesscontrolitem List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsprivacydataaccesscontrolitem-list.md | Content-Length: 356 } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windowsprivacydataaccesscontrolitem Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsprivacydataaccesscontrolitem-update.md | Content-Length: 299 "appPackageFamilyName": "App Package Family Name value", "appDisplayName": "App Display Name value" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsupdateforbusinessconfiguration Extendfeatureupdatespause | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsupdateforbusinessconfiguration-extendfeatureupdatespause.md | POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{dev Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ``` http HTTP/1.1 204 No Content-``` +``` |
v1.0 | Intune Deviceconfig Windowsupdateforbusinessconfiguration Extendqualityupdatespause | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windowsupdateforbusinessconfiguration-extendqualityupdatespause.md | POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{dev 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 ." --localization_priority: Normal --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 |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|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.| |
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 [ |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|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.| |
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 | One of the following permissions is required to call this API. To learn more, in } --> ``` http+POST /deviceManagement/inventoryCategories POST /deviceManagement/complianceCategories POST /deviceManagement/configurationCategories ``` The following table shows the properties that are required when you create the d |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| -|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`.| +|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`.| +|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.| |childCategoryIds|String collection|List of child ids of the category.| 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/complianceCategories +POST https://graph.microsoft.com/beta/deviceManagement/inventoryCategories Content-type: application/json Content-length: 523 |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationcategory Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationcategory-delete.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+DELETE /deviceManagement/inventoryCategories/{deviceManagementConfigurationCategoryId} DELETE /deviceManagement/complianceCategories/{deviceManagementConfigurationCategoryId} DELETE /deviceManagement/configurationCategories/{deviceManagementConfigurationCategoryId} ``` 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/complianceCategories/{deviceManagementConfigurationCategoryId} +DELETE https://graph.microsoft.com/beta/deviceManagement/inventoryCategories/{deviceManagementConfigurationCategoryId} ``` ### Response |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationcategory Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationcategory-get.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+GET /deviceManagement/inventoryCategories/{deviceManagementConfigurationCategoryId} GET /deviceManagement/complianceCategories/{deviceManagementConfigurationCategoryId} GET /deviceManagement/configurationCategories/{deviceManagementConfigurationCategoryId} ``` 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/complianceCategories/{deviceManagementConfigurationCategoryId} +GET https://graph.microsoft.com/beta/deviceManagement/inventoryCategories/{deviceManagementConfigurationCategoryId} ``` ### Response |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationcategory List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationcategory-list.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+GET /deviceManagement/inventoryCategories GET /deviceManagement/complianceCategories GET /deviceManagement/configurationCategories ``` 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/complianceCategories +GET https://graph.microsoft.com/beta/deviceManagement/inventoryCategories ``` ### Response |
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 | One of the following permissions is required to call this API. To learn more, in } --> ``` http+PATCH /deviceManagement/inventoryCategories/{deviceManagementConfigurationCategoryId} PATCH /deviceManagement/complianceCategories/{deviceManagementConfigurationCategoryId} PATCH /deviceManagement/configurationCategories/{deviceManagementConfigurationCategoryId} ``` The following table shows the properties that are required when you create the [ |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| -|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`.| +|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`.| +|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.| |childCategoryIds|String collection|List of child ids of the category.| 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/complianceCategories/{deviceManagementConfigurationCategoryId} +PATCH https://graph.microsoft.com/beta/deviceManagement/inventoryCategories/{deviceManagementConfigurationCategoryId} Content-type: application/json Content-length: 523 |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingcollectiondefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectiondefinition-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 Devicemanagementconfigurationchoicesettingcollectiondefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectiondefinition-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 Devicemanagementconfigurationchoicesettingcollectiondefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectiondefinition-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 Devicemanagementconfigurationchoicesettingcollectiondefinition List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectiondefinition-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 Devicemanagementconfigurationchoicesettingcollectiondefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectiondefinition-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 Devicemanagementconfigurationchoicesettingdefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingdefinition-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 Devicemanagementconfigurationchoicesettingdefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingdefinition-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 Devicemanagementconfigurationchoicesettingdefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingdefinition-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 Devicemanagementconfigurationchoicesettingdefinition List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingdefinition-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 Devicemanagementconfigurationchoicesettingdefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingdefinition-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 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 ." --localization_priority: Normal --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 ." --localization_priority: Normal --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 |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|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| |lastModifiedDateTime|DateTimeOffset|Policy last modification date and time| |settingCount|Int32|Number of settings| |
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 [ |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|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| |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." --localization_priority: Normal --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/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/compliancePolicies/{deviceManagementCompliancePolicyId}/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." --localization_priority: Normal --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/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/compliancePolicies/{deviceManagementCompliancePolicyId}/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." --localization_priority: Normal --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/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/compliancePolicies/{deviceManagementCompliancePolicyId}/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." --localization_priority: Normal --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/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/compliancePolicies/{deviceManagementCompliancePolicyId}/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." --localization_priority: Normal --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/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/compliancePolicies/{deviceManagementCompliancePolicyId}/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 |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|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`.| |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 [ |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|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`.| |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 Devicemanagementconfigurationredirectsettingdefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationredirectsettingdefinition-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 Devicemanagementconfigurationredirectsettingdefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationredirectsettingdefinition-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 Devicemanagementconfigurationredirectsettingdefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationredirectsettingdefinition-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 Devicemanagementconfigurationredirectsettingdefinition List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationredirectsettingdefinition-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 Devicemanagementconfigurationredirectsettingdefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationredirectsettingdefinition-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 Devicemanagementconfigurationsimplesettingcollectiondefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectiondefinition-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 Devicemanagementconfigurationsimplesettingcollectiondefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectiondefinition-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 Devicemanagementconfigurationsimplesettingcollectiondefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectiondefinition-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 Devicemanagementconfigurationsimplesettingcollectiondefinition List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectiondefinition-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 Devicemanagementconfigurationsimplesettingcollectiondefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectiondefinition-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 Devicemanagementconfigurationsimplesettingdefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingdefinition-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 Devicemanagementconfigurationsimplesettingdefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingdefinition-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 Devicemanagementconfigurationsimplesettingdefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingdefinition-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 Devicemanagementconfigurationsimplesettingdefinition List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingdefinition-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 Devicemanagementconfigurationsimplesettingdefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingdefinition-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 Deviceintent Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-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-deviceintent-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-deviceintent-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Deviceintent Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-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-deviceintent-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-deviceintent-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-deviceintent-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-deviceintent-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Deviceintent Devicemanagementintent Compare | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-devicemanagementintent-compare.md | Content-Length: 364 } ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementtemplate Compare | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-devicemanagementtemplate-compare.md | Content-Length: 364 } ] }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinecategorystatesummary Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinecategorystatesummary-create.md | Content-Length: 310 "notApplicableCount": 2, "displayName": "Display Name value" }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinecategorystatesummary Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinecategorystatesummary-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/templates/{deviceManage 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 Deviceintent Securitybaselinecategorystatesummary Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinecategorystatesummary-get.md | Content-Length: 347 "displayName": "Display Name value" } }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinecategorystatesummary List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinecategorystatesummary-list.md | Content-Length: 379 } ] }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinecategorystatesummary Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinecategorystatesummary-update.md | Content-Length: 310 "notApplicableCount": 2, "displayName": "Display Name value" }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinedevicestate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinedevicestate-create.md | Content-Length: 359 "state": "secure", "lastReportedDateTime": "2017-01-01T00:00:17.7769392-08:00" }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinedevicestate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinedevicestate-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/templates/{deviceManage 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 Deviceintent Securitybaselinedevicestate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinedevicestate-get.md | Content-Length: 392 "lastReportedDateTime": "2017-01-01T00:00:17.7769392-08:00" } }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinedevicestate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinedevicestate-list.md | Content-Length: 420 } ] }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinedevicestate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinedevicestate-update.md | Content-Length: 359 "state": "secure", "lastReportedDateTime": "2017-01-01T00:00:17.7769392-08:00" }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinestatesummary Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinestatesummary-get.md | Content-Length: 297 "notApplicableCount": 2 } }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinestatesummary Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceintent-securitybaselinestatesummary-update.md | Content-Length: 262 "conflictCount": 13, "notApplicableCount": 2 }-``` +``` |
v1.0 | Intune Devices Deviceappmanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceappmanagement-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 [deviceAppManagement](../resources/intune-devices-deviceappmanagement.md) object. +Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceAppManagement](../resources/intune-devices-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
v1.0 | Intune Devices Deviceappmanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceappmanagement-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 [deviceAppManagement](../resources/intune-devices-deviceappmanagement.md) object. +Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-devices-deviceappmanagement.md) object. +In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. -The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-devices-deviceappmanagement.md). +The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.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 [deviceAppManagement](../resources/intune-devices-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
v1.0 | Intune Devices Devicecategory Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicecategory-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 [deviceCategory](../resources/intune-devices-devicecategory.md) object. +Read properties and relationships of the [deviceCategory](../resources/intune-shared-devicecategory.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceCategory](../resources/intune-devices-devicecategory.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceCategory](../resources/intune-shared-devicecategory.md) object in the response body. ## Example Content-Length: 128 "id": "f881b841-b841-f881-41b8-81f841b881f8" } }-``` +``` |
v1.0 | Intune Devices Devicecategory Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicecategory-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 [deviceCategory](../resources/intune-devices-devicecategory.md) object. +Update the properties of a [deviceCategory](../resources/intune-shared-devicecategory.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/devic |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceCategory](../resources/intune-devices-devicecategory.md) object. +In the request body, supply a JSON representation for the [deviceCategory](../resources/intune-shared-devicecategory.md) object. -The following table shows the properties that are required when you create the [deviceCategory](../resources/intune-devices-devicecategory.md). +The following table shows the properties that are required when you create the [deviceCategory](../resources/intune-shared-devicecategory.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 [deviceCategory](../resources/intune-devices-devicecategory.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceCategory](../resources/intune-shared-devicecategory.md) object in the response body. ## Example Content-Length: 105 "@odata.type": "#microsoft.graph.deviceCategory", "id": "f881b841-b841-f881-41b8-81f841b881f8" }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptpolicystate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicehealthscriptpolicystate-create.md | Content-Length: 1094 "Assignment Filter Ids value" ] }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptpolicystate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicehealthscriptpolicystate-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts 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 Devicehealthscriptpolicystate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicehealthscriptpolicystate-get.md | Content-Length: 1155 ] } }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptpolicystate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicehealthscriptpolicystate-list.md | Content-Length: 1211 } ] }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptpolicystate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicehealthscriptpolicystate-update.md | Content-Length: 1094 "Assignment Filter Ids value" ] }-``` +``` |
v1.0 | Intune Devices Devicelogcollectionresponse Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicelogcollectionresponse-create.md | Content-Length: 607 "sizeInKB": 2.6666666666666665, "enrolledByUser": "Enrolled By User value" }-``` +``` |
v1.0 | Intune Devices Devicelogcollectionresponse Createdownloadurl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicelogcollectionresponse-createdownloadurl.md | Content-Length: 57 { "value": "https://example.com/createDownloadUrl/" }-``` +``` |
v1.0 | Intune Devices Devicelogcollectionresponse Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicelogcollectionresponse-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts 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 Devicelogcollectionresponse Downloaddevicelogs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicelogcollectionresponse-downloaddevicelogs.md | + + Title: "downloadDeviceLogs action" +description: "Intune Devices Devicelogcollectionresponse Downloaddevicelogs Api ." ++localization_priority: Normal ++++# downloadDeviceLogs 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/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/logCollectionRequests/{deviceLogCollectionResponseId}/downloadDeviceLogs +``` ++## 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 String 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/logCollectionRequests/{deviceLogCollectionResponseId}/downloadDeviceLogs +``` ++### 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: 45 ++{ + "value": "Download Device Logs value" +} +``` |
v1.0 | Intune Devices Devicelogcollectionresponse Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicelogcollectionresponse-get.md | Content-Length: 650 "enrolledByUser": "Enrolled By User value" } }-``` +``` |
v1.0 | Intune Devices Devicelogcollectionresponse List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicelogcollectionresponse-list.md | Content-Length: 688 } ] }-``` +``` |
v1.0 | Intune Devices Devicelogcollectionresponse Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicelogcollectionresponse-update.md | Content-Length: 607 "sizeInKB": 2.6666666666666665, "enrolledByUser": "Enrolled By User value" }-``` +``` |
v1.0 | Intune Devices Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-devices-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Devices Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-devices-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-devices-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-devices-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Devices Devicemanagementscript Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicemanagementscript-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 [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) object. +Create a new [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] The following table shows the properties that are required when you create the d |scriptContent|Binary|The script content.| |createdDateTime|DateTimeOffset|The date and time the device management script was created. This property is read-only.| |lastModifiedDateTime|DateTimeOffset|The date and time the device management script was last modified. This property is read-only.|-|runAsAccount|[runAsAccountType](../resources/intune-devices-runasaccounttype.md)|Indicates the type of execution context. Possible values are: `system`, `user`.| +|runAsAccount|[runAsAccountType](../resources/intune-shared-runasaccounttype.md)|Indicates the type of execution context. Possible values are: `system`, `user`.| |fileName|String|Script file name.| |roleScopeTagIds|String collection|List of Scope Tag IDs for this PowerShellScript instance.| ## Response-If successful, this method returns a `201 Created` response code and a [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) object in the response body. ## Example |
v1.0 | Intune Devices Devicemanagementscript Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicemanagementscript-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 [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md). +Deletes a [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Devices Devicemanagementscript Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicemanagementscript-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 [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) object. +Read properties and relationships of the [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) object in the response body. ## Example |
v1.0 | Intune Devices Devicemanagementscript List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicemanagementscript-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 [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) objects. +List properties and relationships of the [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceManagement/deviceManagementScripts Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) objects in the response body. ## Example |
v1.0 | Intune Devices Devicemanagementscript Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicemanagementscript-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 [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) object. +Update the properties of a [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement/deviceManagementScripts/{deviceManagementScriptId} |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) object. +In the request body, supply a JSON representation for the [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) object. -The following table shows the properties that are required when you create the [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md). +The following table shows the properties that are required when you create the [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md). |Property|Type|Description| |:|:|:| The following table shows the properties that are required when you create the [ |scriptContent|Binary|The script content.| |createdDateTime|DateTimeOffset|The date and time the device management script was created. This property is read-only.| |lastModifiedDateTime|DateTimeOffset|The date and time the device management script was last modified. This property is read-only.|-|runAsAccount|[runAsAccountType](../resources/intune-devices-runasaccounttype.md)|Indicates the type of execution context. Possible values are: `system`, `user`.| +|runAsAccount|[runAsAccountType](../resources/intune-shared-runasaccounttype.md)|Indicates the type of execution context. Possible values are: `system`, `user`.| |fileName|String|Script file name.| |roleScopeTagIds|String collection|List of Scope Tag IDs for this PowerShellScript instance.| ## Response-If successful, this method returns a `200 OK` response code and an updated [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) object in the response body. ## Example |
v1.0 | Intune Devices Devicemanagementscriptrunsummary Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-devicemanagementscriptrunsummary-update.md | Content-Length: 228 "successUserCount": 0, "errorUserCount": 14 }-``` +``` |
v1.0 | Intune Devices Manageddevice Appdiagnostics | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-manageddevice-appdiagnostics.md | Content-Length: 485 } ] }-``` +``` |
v1.0 | Intune Devices Manageddevice Retrievedevicelogcollectionrequests | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-manageddevice-retrievedevicelogcollectionrequests.md | Content-Length: 667 "enrolledByUserPrincipalName": "Enrolled By User Principal Name value" } }-``` +``` |
v1.0 | Intune Devices Manageddevice Syncpayloads | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-manageddevice-syncpayloads.md | Content-length: 421 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 Manageddevice Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-manageddevice-update.md | The following table shows the properties that are required when you create the [ |deviceType|[deviceType](../resources/intune-shared-devicetype.md)|Platform of the device. Examples: Desktop, WindowsRT, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Possible values are: `desktop`, `windowsRT`, `winMO6`, `nokia`, `windowsPhone`, `mac`, `winCE`, `winEmbedded`, `iPhone`, `iPad`, `iPod`, `android`, `iSocConsumer`, `unix`, `macMDM`, `holoLens`, `surfaceHub`, `androidForWork`, `androidEnterprise`, `windows10x`, `androidnGMS`, `chromeOS`, `linux`, `blackberry`, `palm`, `unknown`, `cloudPC`.| |complianceState|[complianceState](../resources/intune-devices-compliancestate.md)|Compliance state of the device. Examples: Compliant, Conflict, Error, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Possible values are: `unknown`, `compliant`, `noncompliant`, `conflict`, `error`, `inGracePeriod`, `configManager`.| |jailBroken|String|Whether the device is jail broken or rooted. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only.|-|managementAgent|[managementAgentType](../resources/intune-devices-managementagenttype.md)|Management channel of the device. Examples: Intune, EAS, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`, `microsoft365ManagedMdm`, `msSense`, `intuneAosp`, `google`, `unknownFutureValue`.| +|managementAgent|[managementAgentType](../resources/intune-shared-managementagenttype.md)|Management channel of the device. Examples: Intune, EAS, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`, `microsoft365ManagedMdm`, `msSense`, `intuneAosp`, `google`, `unknownFutureValue`.| |osVersion|String|Operating system version of the device. This property is read-only.| |easActivated|Boolean|Whether the device is Exchange ActiveSync activated. This property is read-only.| |easDeviceId|String|Exchange ActiveSync Id of the device. This property is read-only.| The following table shows the properties that are required when you create the [ |configurationManagerClientInformation|[configurationManagerClientInformation](../resources/intune-devices-configurationmanagerclientinformation.md)|Configuration manager client information, valid only for devices managed, duel-managed or tri-managed by ConfigMgr Agent| |ethernetMacAddress|String|Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only.| |physicalMemoryInBytes|Int64|Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only.|-|processorArchitecture|[managedDeviceArchitecture](../resources/intune-devices-manageddevicearchitecture.md)|Processor architecture. This property is read-only. Possible values are: `unknown`, `x86`, `x64`, `arm`, `arM64`.| +|processorArchitecture|[managedDeviceArchitecture](../resources/intune-shared-manageddevicearchitecture.md)|Processor architecture. This property is read-only. Possible values are: `unknown`, `x86`, `x64`, `arm`, `arM64`.| |specificationVersion|String|Specification version. This property is read-only.| |joinType|[joinType](../resources/intune-devices-jointype.md)|Device join type. Possible values are: `unknown`, `azureADJoined`, `azureADRegistered`, `hybridAzureADJoined`.| |skuFamily|String|Device sku family| |
v1.0 | Intune Devices Manageddeviceoverview Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-manageddeviceoverview-update.md | Content-Length: 1384 }, "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00" }-``` +``` |
v1.0 | Intune Devices Mobileapptroubleshootingevent Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-mobileapptroubleshootingevent.md) object. +Create a new [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-devices-mobileapptroubleshootingevent.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object in the response body. ## Example |
v1.0 | Intune Devices Mobileapptroubleshootingevent Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-mobileapptroubleshootingevent.md). +Deletes a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Devices Mobileapptroubleshootingevent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-mobileapptroubleshootingevent.md) object. +Read properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-devices-mobileapptroubleshootingevent.md) object in the response body. +If successful, this method returns a `200 OK` response code and [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object in the response body. ## Example |
v1.0 | Intune Devices Mobileapptroubleshootingevent List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-mobileapptroubleshootingevent.md) objects. +List properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceManagement/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-devices-mobileapptroubleshootingevent.md) objects in the response body. +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. ## Example |
v1.0 | Intune Devices Mobileapptroubleshootingevent Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-mobileapptroubleshootingevent.md) object. +Update the properties of a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement/mobileAppTroubleshootingEvents/{mobileAppTroubleshooting |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md) object. +In the request body, supply a JSON representation for the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. -The following table shows the properties that are required when you create the [mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md). +The following table shows the properties that are required when you create the [mobileAppTroubleshootingEvent](../resources/intune-shared-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-devices-mobileapptroubleshootingevent.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object in the response body. ## Example |
v1.0 | Intune Devices User Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-user.md) object. +Create a new [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-devices-user.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [user](../resources/intune-shared-user.md) object in the response body. ## Example Content-Length: 95 "@odata.type": "#microsoft.graph.user", "id": "d36894ae-94ae-d368-ae94-68d3ae9468d3" }-``` +``` |
v1.0 | Intune Devices User Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-user.md). +Deletes a [user](../resources/intune-shared-user.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] DELETE https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts 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 User Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-user.md) object. +Read properties and relationships of the [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-devices-user.md) object in the response body. +If successful, this method returns a `200 OK` response code and [user](../resources/intune-shared-user.md) object in the response body. ## Example Content-Length: 118 "id": "d36894ae-94ae-d368-ae94-68d3ae9468d3" } }-``` +``` |
v1.0 | Intune Devices User List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-user.md) objects. +List properties and relationships of the [user](../resources/intune-shared-user.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceR 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-devices-user.md) objects in the response body. +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. ## Example Content-Length: 136 } ] }-``` +``` |
v1.0 | Intune Devices User Removealldevicesfrommanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-user-removealldevicesfrommanagement.md | POST https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{ 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 User Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-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-devices-user.md) object. +Update the properties of a [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/devic |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [user](../resources/intune-devices-user.md) object. +In the request body, supply a JSON representation for the [user](../resources/intune-shared-user.md) object. -The following table shows the properties that are required when you create the [user](../resources/intune-devices-user.md). +The following table shows the properties that are required when you create the [user](../resources/intune-shared-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-devices-user.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [user](../resources/intune-shared-user.md) object in the response body. ## Example Content-Length: 95 "@odata.type": "#microsoft.graph.user", "id": "d36894ae-94ae-d368-ae94-68d3ae9468d3" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdeviceperformance Summarizedeviceperformancedevices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-userexperienceanalyticsdeviceperformance-summarizedeviceperformancedevices.md | Content-Length: 909 } ] }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicetimelineevents Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-userexperienceanalyticsdevicetimelineevents-get.md | Content-Length: 479 "eventAdditionalInformation": "Event Additional Information value" } }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsmetric Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-userexperienceanalyticsmetric-get.md | Content-Length: 204 "unit": "Unit value" } }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsmetric List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-userexperienceanalyticsmetric-list.md | Content-Length: 226 } ] }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsregressionsummary Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-userexperienceanalyticsregressionsummary-get.md | Content-Length: 154 "id": "41683327-3327-4168-2733-684127336841" } }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsregressionsummary Summarizedeviceregressionperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-userexperienceanalyticsregressionsummary-summarizedeviceregressionperformance.md | Content-Length: 154 "id": "41683327-3327-4168-2733-684127336841" } }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsremoteconnection Summarizedeviceremoteconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-userexperienceanalyticsremoteconnection-summarizedeviceremoteconnection.md | Content-Length: 715 } ] }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsresourceperformance Summarizedeviceresourceperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-userexperienceanalyticsresourceperformance-summarizedeviceresourceperformance.md | Content-Length: 979 } ] }-``` +``` |
v1.0 | Intune Devices Windowsdevicemalwarestate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsdevicemalwarestate-create.md | Content-Length: 533 "detectionCount": 14, "category": "adware" }-``` +``` |
v1.0 | Intune Devices Windowsdevicemalwarestate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsdevicemalwarestate-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts 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 Windowsdevicemalwarestate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsdevicemalwarestate-get.md | Content-Length: 576 "category": "adware" } }-``` +``` |
v1.0 | Intune Devices Windowsdevicemalwarestate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsdevicemalwarestate-list.md | Content-Length: 614 } ] }-``` +``` |
v1.0 | Intune Devices Windowsdevicemalwarestate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsdevicemalwarestate-update.md | Content-Length: 533 "detectionCount": 14, "category": "adware" }-``` +``` |
v1.0 | Intune Devices Windowsmanageddevice Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsmanageddevice-create.md | The following table shows the properties that are required when you create the w |deviceType|[deviceType](../resources/intune-shared-devicetype.md)|Platform of the device. Examples: Desktop, WindowsRT, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `desktop`, `windowsRT`, `winMO6`, `nokia`, `windowsPhone`, `mac`, `winCE`, `winEmbedded`, `iPhone`, `iPad`, `iPod`, `android`, `iSocConsumer`, `unix`, `macMDM`, `holoLens`, `surfaceHub`, `androidForWork`, `androidEnterprise`, `windows10x`, `androidnGMS`, `chromeOS`, `linux`, `blackberry`, `palm`, `unknown`, `cloudPC`.| |complianceState|[complianceState](../resources/intune-devices-compliancestate.md)|Compliance state of the device. Examples: Compliant, Conflict, Error, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `compliant`, `noncompliant`, `conflict`, `error`, `inGracePeriod`, `configManager`.| |jailBroken|String|Whether the device is jail broken or rooted. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)|-|managementAgent|[managementAgentType](../resources/intune-devices-managementagenttype.md)|Management channel of the device. Examples: Intune, EAS, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`, `microsoft365ManagedMdm`, `msSense`, `intuneAosp`, `google`, `unknownFutureValue`.| +|managementAgent|[managementAgentType](../resources/intune-shared-managementagenttype.md)|Management channel of the device. Examples: Intune, EAS, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`, `microsoft365ManagedMdm`, `msSense`, `intuneAosp`, `google`, `unknownFutureValue`.| |osVersion|String|Operating system version of the device. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |easActivated|Boolean|Whether the device is Exchange ActiveSync activated. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |easDeviceId|String|Exchange ActiveSync Id of the device. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| The following table shows the properties that are required when you create the w |configurationManagerClientInformation|[configurationManagerClientInformation](../resources/intune-devices-configurationmanagerclientinformation.md)|Configuration manager client information, valid only for devices managed, duel-managed or tri-managed by ConfigMgr Agent Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |ethernetMacAddress|String|Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |physicalMemoryInBytes|Int64|Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)|-|processorArchitecture|[managedDeviceArchitecture](../resources/intune-devices-manageddevicearchitecture.md)|Processor architecture. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `x86`, `x64`, `arm`, `arM64`.| +|processorArchitecture|[managedDeviceArchitecture](../resources/intune-shared-manageddevicearchitecture.md)|Processor architecture. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `x86`, `x64`, `arm`, `arM64`.| |specificationVersion|String|Specification version. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |joinType|[joinType](../resources/intune-devices-jointype.md)|Device join type Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `azureADJoined`, `azureADRegistered`, `hybridAzureADJoined`.| |skuFamily|String|Device sku family Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |
v1.0 | Intune Devices Windowsmanageddevice Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsmanageddevice-update.md | The following table shows the properties that are required when you create the [ |deviceType|[deviceType](../resources/intune-shared-devicetype.md)|Platform of the device. Examples: Desktop, WindowsRT, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `desktop`, `windowsRT`, `winMO6`, `nokia`, `windowsPhone`, `mac`, `winCE`, `winEmbedded`, `iPhone`, `iPad`, `iPod`, `android`, `iSocConsumer`, `unix`, `macMDM`, `holoLens`, `surfaceHub`, `androidForWork`, `androidEnterprise`, `windows10x`, `androidnGMS`, `chromeOS`, `linux`, `blackberry`, `palm`, `unknown`, `cloudPC`.| |complianceState|[complianceState](../resources/intune-devices-compliancestate.md)|Compliance state of the device. Examples: Compliant, Conflict, Error, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `compliant`, `noncompliant`, `conflict`, `error`, `inGracePeriod`, `configManager`.| |jailBroken|String|Whether the device is jail broken or rooted. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)|-|managementAgent|[managementAgentType](../resources/intune-devices-managementagenttype.md)|Management channel of the device. Examples: Intune, EAS, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`, `microsoft365ManagedMdm`, `msSense`, `intuneAosp`, `google`, `unknownFutureValue`.| +|managementAgent|[managementAgentType](../resources/intune-shared-managementagenttype.md)|Management channel of the device. Examples: Intune, EAS, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`, `microsoft365ManagedMdm`, `msSense`, `intuneAosp`, `google`, `unknownFutureValue`.| |osVersion|String|Operating system version of the device. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |easActivated|Boolean|Whether the device is Exchange ActiveSync activated. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |easDeviceId|String|Exchange ActiveSync Id of the device. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| The following table shows the properties that are required when you create the [ |configurationManagerClientInformation|[configurationManagerClientInformation](../resources/intune-devices-configurationmanagerclientinformation.md)|Configuration manager client information, valid only for devices managed, duel-managed or tri-managed by ConfigMgr Agent Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |ethernetMacAddress|String|Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |physicalMemoryInBytes|Int64|Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)|-|processorArchitecture|[managedDeviceArchitecture](../resources/intune-devices-manageddevicearchitecture.md)|Processor architecture. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `x86`, `x64`, `arm`, `arM64`.| +|processorArchitecture|[managedDeviceArchitecture](../resources/intune-shared-manageddevicearchitecture.md)|Processor architecture. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `x86`, `x64`, `arm`, `arM64`.| |specificationVersion|String|Specification version. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |joinType|[joinType](../resources/intune-devices-jointype.md)|Device join type Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `azureADJoined`, `azureADRegistered`, `hybridAzureADJoined`.| |skuFamily|String|Device sku family Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |
v1.0 | Intune Devices Windowsmanagementapp Setasmanagedinstaller | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsmanagementapp-setasmanagedinstaller.md | POST https://graph.microsoft.com/beta/deviceAppManagement/windowsManagementApp/s 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 Windowsmanagementapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsmanagementapp-update.md | Content-Length: 284 "managedInstaller": "enabled", "managedInstallerConfiguredDateTime": "Managed Installer Configured Date Time value" }-``` +``` |
v1.0 | Intune Devices Windowsmanagementapphealthstate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsmanagementapphealthstate-create.md | Content-Length: 349 "deviceName": "Device Name value", "deviceOSVersion": "Device OSVersion value" }-``` +``` |
v1.0 | Intune Devices Windowsmanagementapphealthstate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsmanagementapphealthstate-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/windowsManagementApp 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 Windowsmanagementapphealthstate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsmanagementapphealthstate-get.md | Content-Length: 382 "deviceOSVersion": "Device OSVersion value" } }-``` +``` |
v1.0 | Intune Devices Windowsmanagementapphealthstate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsmanagementapphealthstate-list.md | Content-Length: 410 } ] }-``` +``` |
v1.0 | Intune Devices Windowsmanagementapphealthstate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsmanagementapphealthstate-update.md | Content-Length: 349 "deviceName": "Device Name value", "deviceOSVersion": "Device OSVersion value" }-``` +``` |
v1.0 | Intune Devices Windowsprotectionstate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsprotectionstate-get.md | Content-Length: 1083 "tamperProtectionEnabled": true } }-``` +``` |
v1.0 | Intune Devices Windowsprotectionstate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-windowsprotectionstate-update.md | Content-Length: 1020 "isVirtualMachine": true, "tamperProtectionEnabled": true }-``` +``` |
v1.0 | Intune Enrollment Activedirectorywindowsautopilotdeploymentprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-activedirectorywindowsautopilotdeploymentprofile-create.md | The following table shows the properties that are required when you create the a |Property|Type|Description| |:|:|:| |id|String|Profile Key Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|displayName|String|Name of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|description|String|Description of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|language|String|Language configured on the device Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|createdDateTime|DateTimeOffset|Profile creation time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|lastModifiedDateTime|DateTimeOffset|Profile last modified time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|Out of box experience setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|displayName|String|The display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|description|String|A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|language|String|The language code to be used when configuring the device. E.g. en-US. The default value is os-default. 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 locale instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|locale|String|The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|createdDateTime|DateTimeOffset|The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|lastModifiedDateTime|DateTimeOffset|The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSetting|[outOfBoxExperienceSetting](../resources/intune-enrollment-outofboxexperiencesetting.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| |enrollmentStatusScreenSettings|[windowsEnrollmentStatusScreenSettings](../resources/intune-enrollment-windowsenrollmentstatusscreensettings.md)|Enrollment status screen setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|extractHardwareHash|Boolean|HardwareHash Extraction for the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceNameTemplate|String|The template used to name the AutoPilot Device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The AutoPilot device type that this profile is applicable to. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| -|enableWhiteGlove|Boolean|Enable Autopilot White Glove for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|roleScopeTagIds|String collection|Scope tags for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|managementServiceAppId|String|AzureAD management app ID used during client device-based enrollment discovery Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|extractHardwareHash|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. 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 hardwareHashExtractionEnabled instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|hardwareHashExtractionEnabled|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceNameTemplate|String|The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The Windows device type that this profile is applicable to. Possible values include windowsPc, holoLens, and virtualMachine. The default is windowsPc. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| +|enableWhiteGlove|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|preprovisioningAllowed|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|roleScopeTagIds|String collection|List of role scope tags for the deployment profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|managementServiceAppId|String|The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| |hybridAzureADJoinSkipConnectivityCheck|Boolean|The Autopilot Hybrid Azure AD join flow will continue even if it does not establish domain controller connectivity during OOBE.| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/windowsAutopilotDeploymentProfiles Content-type: application/json-Content-length: 1282 +Content-length: 1690 { "@odata.type": "#microsoft.graph.activeDirectoryWindowsAutopilotDeploymentProfile", "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "outOfBoxExperienceSettings": { "@odata.type": "microsoft.graph.outOfBoxExperienceSettings", "hidePrivacySettings": true, Content-length: 1282 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-length: 1282 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids 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: 1454 +Content-Length: 1862 { "@odata.type": "#microsoft.graph.activeDirectoryWindowsAutopilotDeploymentProfile", Content-Length: 1454 "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "outOfBoxExperienceSettings": { Content-Length: 1454 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-Length: 1454 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids value" ], |
v1.0 | Intune Enrollment Activedirectorywindowsautopilotdeploymentprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-activedirectorywindowsautopilotdeploymentprofile-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: 1543 +Content-Length: 1975 { "value": { Content-Length: 1543 "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "outOfBoxExperienceSettings": { Content-Length: 1543 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-Length: 1543 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids value" ], |
v1.0 | Intune Enrollment Activedirectorywindowsautopilotdeploymentprofile List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-activedirectorywindowsautopilotdeploymentprofile-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: 1627 +Content-Length: 2083 { "value": [ Content-Length: 1627 "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "outOfBoxExperienceSettings": { Content-Length: 1627 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-Length: 1627 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids value" ], |
v1.0 | Intune Enrollment Activedirectorywindowsautopilotdeploymentprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-activedirectorywindowsautopilotdeploymentprofile-update.md | The following table shows the properties that are required when you create the [ |Property|Type|Description| |:|:|:| |id|String|Profile Key Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|displayName|String|Name of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|description|String|Description of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|language|String|Language configured on the device Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|createdDateTime|DateTimeOffset|Profile creation time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|lastModifiedDateTime|DateTimeOffset|Profile last modified time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|Out of box experience setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|displayName|String|The display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|description|String|A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|language|String|The language code to be used when configuring the device. E.g. en-US. The default value is os-default. 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 locale instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|locale|String|The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|createdDateTime|DateTimeOffset|The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|lastModifiedDateTime|DateTimeOffset|The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSetting|[outOfBoxExperienceSetting](../resources/intune-enrollment-outofboxexperiencesetting.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| |enrollmentStatusScreenSettings|[windowsEnrollmentStatusScreenSettings](../resources/intune-enrollment-windowsenrollmentstatusscreensettings.md)|Enrollment status screen setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|extractHardwareHash|Boolean|HardwareHash Extraction for the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceNameTemplate|String|The template used to name the AutoPilot Device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The AutoPilot device type that this profile is applicable to. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| -|enableWhiteGlove|Boolean|Enable Autopilot White Glove for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|roleScopeTagIds|String collection|Scope tags for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|managementServiceAppId|String|AzureAD management app ID used during client device-based enrollment discovery Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|extractHardwareHash|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. 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 hardwareHashExtractionEnabled instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|hardwareHashExtractionEnabled|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceNameTemplate|String|The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The Windows device type that this profile is applicable to. Possible values include windowsPc, holoLens, and virtualMachine. The default is windowsPc. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| +|enableWhiteGlove|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|preprovisioningAllowed|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|roleScopeTagIds|String collection|List of role scope tags for the deployment profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|managementServiceAppId|String|The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| |hybridAzureADJoinSkipConnectivityCheck|Boolean|The Autopilot Hybrid Azure AD join flow will continue even if it does not establish domain controller connectivity during OOBE.| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/windowsAutopilotDeploymentProfiles/{windowsAutopilotDeploymentProfileId} Content-type: application/json-Content-length: 1282 +Content-length: 1690 { "@odata.type": "#microsoft.graph.activeDirectoryWindowsAutopilotDeploymentProfile", "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "outOfBoxExperienceSettings": { "@odata.type": "microsoft.graph.outOfBoxExperienceSettings", "hidePrivacySettings": true, Content-length: 1282 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-length: 1282 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids 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: 1454 +Content-Length: 1862 { "@odata.type": "#microsoft.graph.activeDirectoryWindowsAutopilotDeploymentProfile", Content-Length: 1454 "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "outOfBoxExperienceSettings": { Content-Length: 1454 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-Length: 1454 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids value" ], |
v1.0 | Intune Enrollment Azureadwindowsautopilotdeploymentprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-azureadwindowsautopilotdeploymentprofile-create.md | The following table shows the properties that are required when you create the a |Property|Type|Description| |:|:|:| |id|String|Profile Key Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|displayName|String|Name of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|description|String|Description of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|language|String|Language configured on the device Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|createdDateTime|DateTimeOffset|Profile creation time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|lastModifiedDateTime|DateTimeOffset|Profile last modified time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|Out of box experience setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|displayName|String|The display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|description|String|A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|language|String|The language code to be used when configuring the device. E.g. en-US. The default value is os-default. 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 locale instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|locale|String|The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|createdDateTime|DateTimeOffset|The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|lastModifiedDateTime|DateTimeOffset|The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSetting|[outOfBoxExperienceSetting](../resources/intune-enrollment-outofboxexperiencesetting.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| |enrollmentStatusScreenSettings|[windowsEnrollmentStatusScreenSettings](../resources/intune-enrollment-windowsenrollmentstatusscreensettings.md)|Enrollment status screen setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|extractHardwareHash|Boolean|HardwareHash Extraction for the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceNameTemplate|String|The template used to name the AutoPilot Device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The AutoPilot device type that this profile is applicable to. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| -|enableWhiteGlove|Boolean|Enable Autopilot White Glove for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|roleScopeTagIds|String collection|Scope tags for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|managementServiceAppId|String|AzureAD management app ID used during client device-based enrollment discovery Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|extractHardwareHash|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. 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 hardwareHashExtractionEnabled instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|hardwareHashExtractionEnabled|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceNameTemplate|String|The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The Windows device type that this profile is applicable to. Possible values include windowsPc, holoLens, and virtualMachine. The default is windowsPc. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| +|enableWhiteGlove|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|preprovisioningAllowed|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|roleScopeTagIds|String collection|List of role scope tags for the deployment profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|managementServiceAppId|String|The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/windowsAutopilotDeploymentProfiles Content-type: application/json-Content-length: 1223 +Content-length: 1631 { "@odata.type": "#microsoft.graph.azureADWindowsAutopilotDeploymentProfile", "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "outOfBoxExperienceSettings": { "@odata.type": "microsoft.graph.outOfBoxExperienceSettings", "hidePrivacySettings": true, Content-length: 1223 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-length: 1223 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids 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: 1395 +Content-Length: 1803 { "@odata.type": "#microsoft.graph.azureADWindowsAutopilotDeploymentProfile", Content-Length: 1395 "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "outOfBoxExperienceSettings": { Content-Length: 1395 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-Length: 1395 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids value" ], |
v1.0 | Intune Enrollment Azureadwindowsautopilotdeploymentprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-azureadwindowsautopilotdeploymentprofile-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: 1482 +Content-Length: 1914 { "value": { Content-Length: 1482 "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "outOfBoxExperienceSettings": { Content-Length: 1482 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-Length: 1482 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids value" ], |
v1.0 | Intune Enrollment Azureadwindowsautopilotdeploymentprofile List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-azureadwindowsautopilotdeploymentprofile-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: 1564 +Content-Length: 2020 { "value": [ Content-Length: 1564 "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "outOfBoxExperienceSettings": { Content-Length: 1564 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-Length: 1564 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids value" ], |
v1.0 | Intune Enrollment Azureadwindowsautopilotdeploymentprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-azureadwindowsautopilotdeploymentprofile-update.md | The following table shows the properties that are required when you create the [ |Property|Type|Description| |:|:|:| |id|String|Profile Key Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|displayName|String|Name of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|description|String|Description of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|language|String|Language configured on the device Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|createdDateTime|DateTimeOffset|Profile creation time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|lastModifiedDateTime|DateTimeOffset|Profile last modified time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|Out of box experience setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|displayName|String|The display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|description|String|A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|language|String|The language code to be used when configuring the device. E.g. en-US. The default value is os-default. 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 locale instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|locale|String|The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|createdDateTime|DateTimeOffset|The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|lastModifiedDateTime|DateTimeOffset|The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSetting|[outOfBoxExperienceSetting](../resources/intune-enrollment-outofboxexperiencesetting.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| |enrollmentStatusScreenSettings|[windowsEnrollmentStatusScreenSettings](../resources/intune-enrollment-windowsenrollmentstatusscreensettings.md)|Enrollment status screen setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|extractHardwareHash|Boolean|HardwareHash Extraction for the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceNameTemplate|String|The template used to name the AutoPilot Device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The AutoPilot device type that this profile is applicable to. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| -|enableWhiteGlove|Boolean|Enable Autopilot White Glove for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|roleScopeTagIds|String collection|Scope tags for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|managementServiceAppId|String|AzureAD management app ID used during client device-based enrollment discovery Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|extractHardwareHash|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. 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 hardwareHashExtractionEnabled instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|hardwareHashExtractionEnabled|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceNameTemplate|String|The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The Windows device type that this profile is applicable to. Possible values include windowsPc, holoLens, and virtualMachine. The default is windowsPc. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| +|enableWhiteGlove|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|preprovisioningAllowed|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|roleScopeTagIds|String collection|List of role scope tags for the deployment profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|managementServiceAppId|String|The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/windowsAutopilotDeploymentProfiles/{windowsAutopilotDeploymentProfileId} Content-type: application/json-Content-length: 1223 +Content-length: 1631 { "@odata.type": "#microsoft.graph.azureADWindowsAutopilotDeploymentProfile", "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "outOfBoxExperienceSettings": { "@odata.type": "microsoft.graph.outOfBoxExperienceSettings", "hidePrivacySettings": true, Content-length: 1223 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-length: 1223 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids 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: 1395 +Content-Length: 1803 { "@odata.type": "#microsoft.graph.azureADWindowsAutopilotDeploymentProfile", Content-Length: 1395 "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "outOfBoxExperienceSettings": { Content-Length: 1395 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-Length: 1395 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids value" ], |
v1.0 | Intune Enrollment Depiosenrollmentprofile Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-depiosenrollmentprofile-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/depOnboardingSettings/{ 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 Enrollment Depiosenrollmentprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-depiosenrollmentprofile-update.md | Content-Length: 2623 "carrierActivationUrl": "https://example.com/carrierActivationUrl/", "userlessSharedAadModeEnabled": true }-``` +``` |
v1.0 | Intune Enrollment Depmacosenrollmentprofile Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-depmacosenrollmentprofile-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/depOnboardingSettings/{ 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 Enrollment Depmacosenrollmentprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-depmacosenrollmentprofile-update.md | Content-Length: 2172 "requestRequiresNetworkTether": true, "autoAdvanceSetupEnabled": true }-``` +``` |
v1.0 | Intune Enrollment Deponboardingsetting Getexpiringvpptokencount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-deponboardingsetting-getexpiringvpptokencount.md | Content-Length: 18 { "value": 8 }-``` +``` |
v1.0 | Intune Enrollment Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-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-enrollment-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-enrollment-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Enrollment Devicemanagement Getsuggestedenrollmentlimit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-devicemanagement-getsuggestedenrollmentlimit.md | Content-Length: 117 "suggestedDailyLimit": 3 } }-``` +``` |
v1.0 | Intune Enrollment Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-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-enrollment-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-enrollment-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-enrollment-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-enrollment-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Enrollment Windowsautopilotdeploymentprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-windowsautopilotdeploymentprofile-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 [windowsAutopilotDeploymentProfile](../resources/intune-enrollment-windowsautopilotdeploymentprofile.md) object. +Read properties and relationships of the [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [windowsAutopilotDeploymentProfile](../resources/intune-enrollment-windowsautopilotdeploymentprofile.md) object in the response body. +If successful, this method returns a `200 OK` response code and [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md) object in the response body. ## Example 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: 1475 +Content-Length: 1907 { "value": { Content-Length: 1475 "displayName": "Display Name value", "description": "Description value", "language": "Language value",+ "locale": "Locale value", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "outOfBoxExperienceSettings": { Content-Length: 1475 "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "standard", + "deviceUsageType": "shared", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Content-Length: 1475 "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "Device Name Template value", "deviceType": "surfaceHub2", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "Role Scope Tag Ids value" ], |
v1.0 | Intune Enrollment Windowsautopilotdeploymentprofileassignment Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-windowsautopilotdeploymentprofileassignment-create.md | Content-Length: 460 "source": "policySets", "sourceId": "Source Id value" }-``` +``` |
v1.0 | Intune Enrollment Windowsautopilotdeploymentprofileassignment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-windowsautopilotdeploymentprofileassignment-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/windowsAutopilotDeviceI 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 Enrollment Windowsautopilotdeploymentprofileassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-windowsautopilotdeploymentprofileassignment-get.md | Content-Length: 497 "sourceId": "Source Id value" } }-``` +``` |
v1.0 | Intune Enrollment Windowsautopilotdeploymentprofileassignment List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-windowsautopilotdeploymentprofileassignment-list.md | Content-Length: 529 } ] }-``` +``` |
v1.0 | Intune Enrollment Windowsautopilotdeploymentprofileassignment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-windowsautopilotdeploymentprofileassignment-update.md | Content-Length: 460 "source": "policySets", "sourceId": "Source Id value" }-``` +``` |
v1.0 | Intune Enrollment Windowsautopilotdeviceidentity Deletedevices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-windowsautopilotdeviceidentity-deletedevices.md | Content-Length: 301 } ] }-``` +``` |
v1.0 | Intune Enrollment Windowsdomainjoinconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-enrollment-windowsdomainjoinconfiguration.md) object. +Read properties and relationships of the [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [windowsDomainJoinConfiguration](../resources/intune-enrollment-windowsdomainjoinconfiguration.md) object in the response body. +If successful, this method returns a `200 OK` response code and [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object in the response body. ## Example Content-Length: 93 "@odata.type": "#microsoft.graph.windowsDomainJoinConfiguration" } }-``` +``` |
v1.0 | Intune Enrollment Windowsdomainjoinconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-enrollment-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-enrollment-windowsdomainjoinconfiguration.md) object. +Update the properties of a [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement/windowsAutopilotDeviceIdentities/{windowsAutopilotDevice |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [windowsDomainJoinConfiguration](../resources/intune-enrollment-windowsdomainjoinconfiguration.md) object. +In the request body, supply a JSON representation for the [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object. -The following table shows the properties that are required when you create the [windowsDomainJoinConfiguration](../resources/intune-enrollment-windowsdomainjoinconfiguration.md). +The following table shows the properties that are required when you create the [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.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 [windowsDomainJoinConfiguration](../resources/intune-enrollment-windowsdomainjoinconfiguration.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object in the response body. ## Example Content-Length: 72 { "@odata.type": "#microsoft.graph.windowsDomainJoinConfiguration" }-``` +``` |
v1.0 | Intune Epmgraphapiservice Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-epmgraphapiservice-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-epmgraphapiservice-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-epmgraphapiservice-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Epmgraphapiservice Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-epmgraphapiservice-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-epmgraphapiservice-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-epmgraphapiservice-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-epmgraphapiservice-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-epmgraphapiservice-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Epmgraphapiservice Privilegemanagementelevationrequest Revoke | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-epmgraphapiservice-privilegemanagementelevationrequest-revoke.md | + + Title: "revoke action" +description: "Intune Epmgraphapiservice Privilegemanagementelevationrequest Revoke Api ." ++localization_priority: Normal ++++# revoke 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/elevationRequests/{privilegeManagementElevationRequestId}/revoke +``` ++## 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| +|:|:|:| +|reviewerJustification|String|| ++++## Response +If successful, this action returns a `200 OK` response code and a [privilegeManagementElevationRequest](../resources/intune-epmgraphapiservice-privilegemanagementelevationrequest.md) in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/elevationRequests/{privilegeManagementElevationRequestId}/revoke ++Content-type: application/json +Content-length: 63 ++{ + "reviewerJustification": "Reviewer Justification 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: 1480 ++{ + "value": { + "@odata.type": "#microsoft.graph.privilegeManagementElevationRequest", + "id": "3df245af-45af-3df2-af45-f23daf45f23d", + "requestedByUserId": "Requested By User Id value", + "requestedOnDeviceId": "Requested On Device Id value", + "requestedByUserPrincipalName": "Requested By User Principal Name value", + "deviceName": "Device Name value", + "requestCreatedDateTime": "2017-01-01T00:00:35.2743776-08:00", + "requestLastModifiedDateTime": "2016-12-31T23:58:50.6194179-08:00", + "requestJustification": "Request Justification value", + "applicationDetail": { + "@odata.type": "microsoft.graph.applicationDetail", + "fileHash": "File Hash value", + "fileName": "File Name value", + "filePath": "File Path value", + "fileDescription": "File Description value", + "publisherName": "Publisher Name value", + "publisherCert": "Publisher Cert value", + "productName": "Product Name value", + "productInternalName": "Product Internal Name value", + "productVersion": "Product Version value" + }, + "status": "pending", + "reviewCompletedByUserId": "Review Completed By User Id value", + "reviewCompletedByUserPrincipalName": "Review Completed By User Principal Name value", + "reviewCompletedDateTime": "2016-12-31T23:59:07.609607-08:00", + "requestExpiryDateTime": "2017-01-01T00:02:44.7662751-08:00", + "reviewerJustification": "Reviewer Justification value" + } +} +``` |
v1.0 | Intune Esim Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-esim-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-esim-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-esim-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Esim Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-esim-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-esim-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-esim-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-esim-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-esim-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Gpanalyticsservice Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-gpanalyticsservice-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-gpanalyticsservice-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-gpanalyticsservice-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Gpanalyticsservice Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-gpanalyticsservice-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-gpanalyticsservice-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-gpanalyticsservice-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-gpanalyticsservice-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-gpanalyticsservice-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Grouppolicy Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-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-grouppolicy-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-grouppolicy-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Grouppolicy Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-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-grouppolicy-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-grouppolicy-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-grouppolicy-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-grouppolicy-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Grouppolicy Grouppolicyoperation Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicyoperation-create.md | Content-Length: 285 "id": "4d18865b-865b-4d18-5b86-184d5b86184d", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyoperation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicyoperation-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicyoperation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicyoperation-get.md | Content-Length: 316 "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00" } }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyoperation List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicyoperation-list.md | Content-Length: 342 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyoperation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicyoperation-update.md | Content-Length: 285 "id": "4d18865b-865b-4d18-5b86-184d5b86184d", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentation-update.md | Content-Length: 205 "id": "a33caa6a-aa6a-a33c-6aaa-3ca36aaa3ca3", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationcheckbox Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationcheckbox-create.md | Content-Length: 240 "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "defaultChecked": true }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationcheckbox Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationcheckbox-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicypresentationcheckbox List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationcheckbox-list.md | Content-Length: 293 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationcheckbox Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationcheckbox-update.md | Content-Length: 240 "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "defaultChecked": true }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationcombobox Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationcombobox-create.md | Content-Length: 346 "required": true, "maxLength": 9 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationcombobox Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationcombobox-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicypresentationcombobox List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationcombobox-list.md | Content-Length: 419 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationcombobox Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationcombobox-update.md | Content-Length: 346 "required": true, "maxLength": 9 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationdecimaltextbox Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationdecimaltextbox-create.md | Content-Length: 334 "minValue": 8, "maxValue": 8 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationdecimaltextbox Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationdecimaltextbox-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicypresentationdecimaltextbox List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationdecimaltextbox-list.md | Content-Length: 407 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationdecimaltextbox Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationdecimaltextbox-update.md | Content-Length: 334 "minValue": 8, "maxValue": 8 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationdropdownlist Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationdropdownlist-create.md | Content-Length: 602 ], "required": true }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationdropdownlist Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationdropdownlist-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicypresentationdropdownlist List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationdropdownlist-list.md | Content-Length: 703 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationdropdownlist Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationdropdownlist-update.md | Content-Length: 602 ], "required": true }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationlistbox Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationlistbox-create.md | Content-Length: 278 "explicitValue": true, "valuePrefix": "Value Prefix value" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationlistbox Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationlistbox-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicypresentationlistbox List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationlistbox-list.md | Content-Length: 335 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationlistbox Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationlistbox-update.md | Content-Length: 278 "explicitValue": true, "valuePrefix": "Value Prefix value" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationlongdecimaltextbox Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationlongdecimaltextbox-create.md | Content-Length: 338 "minValue": 8, "maxValue": 8 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationlongdecimaltextbox Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationlongdecimaltextbox-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicypresentationlongdecimaltextbox List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationlongdecimaltextbox-list.md | Content-Length: 411 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationlongdecimaltextbox Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationlongdecimaltextbox-update.md | Content-Length: 338 "minValue": 8, "maxValue": 8 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationmultitextbox Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationmultitextbox-create.md | Content-Length: 278 "maxLength": 9, "maxStrings": 10 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationmultitextbox Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationmultitextbox-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicypresentationmultitextbox List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationmultitextbox-list.md | Content-Length: 339 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationmultitextbox Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationmultitextbox-update.md | Content-Length: 278 "maxLength": 9, "maxStrings": 10 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationtext Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationtext-create.md | Content-Length: 209 "id": "bc77d545-d545-bc77-45d5-77bc45d577bc", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationtext Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationtext-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicypresentationtext List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationtext-list.md | Content-Length: 258 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationtext Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationtext-update.md | Content-Length: 209 "id": "bc77d545-d545-bc77-45d5-77bc45d577bc", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationtextbox Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationtextbox-create.md | Content-Length: 294 "required": true, "maxLength": 9 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationtextbox Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationtextbox-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicypresentationtextbox List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationtextbox-list.md | Content-Length: 355 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationtextbox Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicypresentationtextbox-update.md | Content-Length: 294 "required": true, "maxLength": 9 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyuploadedpresentation Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicyuploadedpresentation-create.md | Content-Length: 213 "id": "6480cc5a-cc5a-6480-5acc-80645acc8064", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyuploadedpresentation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicyuploadedpresentation-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/groupPolicyConfiguratio 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 Grouppolicy Grouppolicyuploadedpresentation List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicyuploadedpresentation-list.md | Content-Length: 262 } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyuploadedpresentation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-grouppolicyuploadedpresentation-update.md | Content-Length: 213 "id": "6480cc5a-cc5a-6480-5acc-80645acc8064", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00" }-``` +``` |
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 | 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 [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) object. +Create a new [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] The following table shows the properties that are required when you create the a ## Response-If successful, this method returns a `201 Created` response code and a [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) object in the response body. ## Example |
v1.0 | Intune Mam Androidmanagedappprotection Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-androidmanagedappprotection-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 [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md). +Deletes a [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Mam Androidmanagedappprotection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-androidmanagedappprotection-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 [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) object. +Read properties and relationships of the [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) object in the response body. +If successful, this method returns a `200 OK` response code and [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) object in the response body. ## Example |
v1.0 | Intune Mam Androidmanagedappprotection List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-androidmanagedappprotection-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 [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) objects. +List properties and relationships of the [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceAppManagement/androidManagedAppProtections Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) objects in the response body. ## Example |
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 | 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 [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) object. +Update the properties of a [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtec |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) object. +In the request body, supply a JSON representation for the [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) object. -The following table shows the properties that are required when you create the [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md). +The following table shows the properties that are required when you create the [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.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 [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) object in the response body. ## Example |
v1.0 | Intune Mam Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-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-mam-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-mam-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Mam Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-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-mam-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-mam-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-mam-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-mam-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettingcollectiondefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationchoicesettingcollectiondefinition-create.md | Content-Length: 19168 "maximumCount": 12, "minimumCount": 12 }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettingcollectiondefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationchoicesettingcollectiondefinition-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/targetedManagedAppCo 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 Mam Devicemanagementconfigurationchoicesettingcollectiondefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationchoicesettingcollectiondefinition-update.md | Content-Length: 19168 "maximumCount": 12, "minimumCount": 12 }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettingdefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationchoicesettingdefinition-create.md | Content-Length: 19112 ], "defaultOptionId": "Default Option Id value" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettingdefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationchoicesettingdefinition-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/targetedManagedAppCo 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 Mam Devicemanagementconfigurationchoicesettingdefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationchoicesettingdefinition-update.md | Content-Length: 19112 ], "defaultOptionId": "Default Option Id value" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationredirectsettingdefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationredirectsettingdefinition-create.md | Content-Length: 1445 "redirectMessage": "Redirect Message value", "redirectReason": "Redirect Reason value" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationredirectsettingdefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationredirectsettingdefinition-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/targetedManagedAppCo 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 Mam Devicemanagementconfigurationredirectsettingdefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationredirectsettingdefinition-update.md | Content-Length: 1445 "redirectMessage": "Redirect Message value", "redirectReason": "Redirect Reason value" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsettingdefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsettingdefinition-create.md | Content-Length: 1309 "displayName": "Display Name value", "version": "Version value" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsettingdefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsettingdefinition-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/targetedManagedAppCo 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 Mam Devicemanagementconfigurationsettingdefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsettingdefinition-update.md | Content-Length: 1309 "displayName": "Display Name value", "version": "Version value" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsettinggroupcollectiondefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsettinggroupcollectiondefinition-create.md | Content-Length: 1836 "maximumCount": 12, "minimumCount": 12 }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsettinggroupcollectiondefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsettinggroupcollectiondefinition-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/targetedManagedAppCo 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 Mam Devicemanagementconfigurationsettinggroupcollectiondefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsettinggroupcollectiondefinition-update.md | Content-Length: 1836 "maximumCount": 12, "minimumCount": 12 }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsettinggroupdefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsettinggroupdefinition-create.md | Content-Length: 1780 } ] }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsettinggroupdefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsettinggroupdefinition-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/targetedManagedAppCo 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 Mam Devicemanagementconfigurationsettinggroupdefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsettinggroupdefinition-update.md | Content-Length: 1780 } ] }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettingcollectiondefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsimplesettingcollectiondefinition-create.md | Content-Length: 18018 "maximumCount": 12, "minimumCount": 12 }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettingcollectiondefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsimplesettingcollectiondefinition-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/targetedManagedAppCo 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 Mam Devicemanagementconfigurationsimplesettingcollectiondefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsimplesettingcollectiondefinition-update.md | Content-Length: 18018 "maximumCount": 12, "minimumCount": 12 }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettingdefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsimplesettingdefinition-create.md | Content-Length: 17962 } ] }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettingdefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsimplesettingdefinition-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/targetedManagedAppCo 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 Mam Devicemanagementconfigurationsimplesettingdefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-devicemanagementconfigurationsimplesettingdefinition-update.md | Content-Length: 17962 } ] }-``` +``` |
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 | 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 [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) object. +Create a new [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] The following table shows the properties that are required when you create the i |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`.| |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.| The following table shows the properties that are required when you create the i ## Response-If successful, this method returns a `201 Created` response code and a [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) object in the response body. ## Example Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceAppManagement/iosManagedAppProtections Content-type: application/json-Content-length: 3838 +Content-length: 3883 { "@odata.type": "#microsoft.graph.iosManagedAppProtection", Content-length: 3838 "minimumWipeSdkVersion": "Minimum Wipe Sdk Version value", "allowedIosDeviceModels": "Allowed Ios Device Models value", "appActionIfIosDeviceModelNotAllowed": "wipe",+ "appActionIfAccountIsClockedOut": "wipe", "thirdPartyKeyboardsBlocked": true, "filterOpenInToOnlyManagedApps": true, "disableProtectionOfManagedOutboundOpenInData": 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: 4010 +Content-Length: 4055 { "@odata.type": "#microsoft.graph.iosManagedAppProtection", Content-Length: 4010 "minimumWipeSdkVersion": "Minimum Wipe Sdk Version value", "allowedIosDeviceModels": "Allowed Ios Device Models value", "appActionIfIosDeviceModelNotAllowed": "wipe",+ "appActionIfAccountIsClockedOut": "wipe", "thirdPartyKeyboardsBlocked": true, "filterOpenInToOnlyManagedApps": true, "disableProtectionOfManagedOutboundOpenInData": true, |
v1.0 | Intune Mam Iosmanagedappprotection Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-iosmanagedappprotection-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 [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md). +Deletes a [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Mam Iosmanagedappprotection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-iosmanagedappprotection-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 [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) object. +Read properties and relationships of the [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) object in the response body. +If successful, this method returns a `200 OK` response code and [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) object in the response body. ## Example 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: 4213 +Content-Length: 4260 { "value": { Content-Length: 4213 "minimumWipeSdkVersion": "Minimum Wipe Sdk Version value", "allowedIosDeviceModels": "Allowed Ios Device Models value", "appActionIfIosDeviceModelNotAllowed": "wipe",+ "appActionIfAccountIsClockedOut": "wipe", "thirdPartyKeyboardsBlocked": true, "filterOpenInToOnlyManagedApps": true, "disableProtectionOfManagedOutboundOpenInData": true, |
v1.0 | Intune Mam Iosmanagedappprotection List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-iosmanagedappprotection-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 [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) objects. +List properties and relationships of the [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceAppManagement/iosManagedAppProtections Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) objects in the response body. ## Example 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: 4411 +Content-Length: 4460 { "value": [ Content-Length: 4411 "minimumWipeSdkVersion": "Minimum Wipe Sdk Version value", "allowedIosDeviceModels": "Allowed Ios Device Models value", "appActionIfIosDeviceModelNotAllowed": "wipe",+ "appActionIfAccountIsClockedOut": "wipe", "thirdPartyKeyboardsBlocked": true, "filterOpenInToOnlyManagedApps": true, "disableProtectionOfManagedOutboundOpenInData": true, |
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 | 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 [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) object. +Update the properties of a [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtectionId} |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) object. +In the request body, supply a JSON representation for the [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) object. -The following table shows the properties that are required when you create the [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md). +The following table shows the properties that are required when you create the [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md). |Property|Type|Description| |:|:|:| 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.| |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`.| |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.| 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 [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) object in the response body. ## Example Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtectionId} Content-type: application/json-Content-length: 3838 +Content-length: 3883 { "@odata.type": "#microsoft.graph.iosManagedAppProtection", Content-length: 3838 "minimumWipeSdkVersion": "Minimum Wipe Sdk Version value", "allowedIosDeviceModels": "Allowed Ios Device Models value", "appActionIfIosDeviceModelNotAllowed": "wipe",+ "appActionIfAccountIsClockedOut": "wipe", "thirdPartyKeyboardsBlocked": true, "filterOpenInToOnlyManagedApps": true, "disableProtectionOfManagedOutboundOpenInData": 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: 4010 +Content-Length: 4055 { "@odata.type": "#microsoft.graph.iosManagedAppProtection", Content-Length: 4010 "minimumWipeSdkVersion": "Minimum Wipe Sdk Version value", "allowedIosDeviceModels": "Allowed Ios Device Models value", "appActionIfIosDeviceModelNotAllowed": "wipe",+ "appActionIfAccountIsClockedOut": "wipe", "thirdPartyKeyboardsBlocked": true, "filterOpenInToOnlyManagedApps": true, "disableProtectionOfManagedOutboundOpenInData": true, |
v1.0 | Intune Mam Managedapplogcollectionrequest Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-managedapplogcollectionrequest-create.md | The following table shows the properties that are required when you create the m |Property|Type|Description| |:|:|:| |id|String|The unique identifier of the managed app log collection request. This id is assigned during request creation time. Read-only.|-|managedAppRegistrationId|String|The unique identifier of the app instance for which diagnostic was collected.| +|managedAppRegistrationId|String|The unique identifier of the app instance for which diagnostic logs were collected. Read-only.| |status|String|Indicates the status for the app log collection request - pending, completed or failed. Default is pending.|-|requestedBy|String|The user principal name associated with the request for the managed application log collection.| +|requestedBy|String|The user principal name associated with the request for the managed application log collection. Read-only.| +|requestedByUserPrincipalName|String|The user principal name associated with the request for the managed application log collection. Read-only.| |requestedDateTime|DateTimeOffset|DateTime of when the log upload request was received. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.| |completedDateTime|DateTimeOffset|DateTime of when the log upload request was completed. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.|-|userLogUploadConsent|[managedAppLogUploadConsent](../resources/intune-mam-managedapploguploadconsent.md)|Indicates whether the user associated with the device provided consent for the log collection. Possible values are: `default`, `declined`, `accepted`, `unknownFutureValue`.| -|uploadedLogs|[managedAppLogUpload](../resources/intune-mam-managedapplogupload.md) collection|The collection of log upload results as reported by each component on the device. Such components can be the application itself, the Mobile Application Management (MAM) SDK, and other on-device components that are requested to upload diagnostic logs.| +|userLogUploadConsent|[managedAppLogUploadConsent](../resources/intune-mam-managedapploguploadconsent.md)|Indicates whether the user associated with the device provided consent for the log collection. The user must consent before the diagnostic logs can be collected. accepted means the user consented. declined means the user declined. unknown is the default value. The Log Collection Request must be completed within 24 hours or it will be abandoned and deleted. Read-only. Possible values are: `unknown`, `declined`, `accepted`, `unknownFutureValue`.| +|uploadedLogs|[managedAppLogUpload](../resources/intune-mam-managedapplogupload.md) collection|The collection of log upload results as reported by each component on the device. Such components can be the application itself, the Mobile Application Management (MAM) SDK, and other on-device components that are requested to upload diagnostic logs. Read-only.| |version|String|Version of the entity.| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceAppManagement/managedAppRegistrations/{managedAppRegistrationId}/managedAppLogCollectionRequests Content-type: application/json-Content-length: 646 +Content-length: 799 { "@odata.type": "#microsoft.graph.managedAppLogCollectionRequest", "managedAppRegistrationId": "Managed App Registration Id value", "status": "Status value", "requestedBy": "Requested By value",+ "requestedByUserPrincipalName": "Requested By User Principal Name value", "requestedDateTime": "2017-01-01T00:01:49.2071853-08:00", "completedDateTime": "2016-12-31T23:58:52.3534526-08:00", "userLogUploadConsent": "declined", Content-length: 646 { "@odata.type": "microsoft.graph.managedAppLogUpload", "managedAppComponent": "Managed App Component value",- "status": "partiallyCompleted", + "managedAppComponentDescription": "Managed App Component Description value", + "status": "inProgress", "referenceId": "Reference Id 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: 695 +Content-Length: 848 { "@odata.type": "#microsoft.graph.managedAppLogCollectionRequest", Content-Length: 695 "managedAppRegistrationId": "Managed App Registration Id value", "status": "Status value", "requestedBy": "Requested By value",+ "requestedByUserPrincipalName": "Requested By User Principal Name value", "requestedDateTime": "2017-01-01T00:01:49.2071853-08:00", "completedDateTime": "2016-12-31T23:58:52.3534526-08:00", "userLogUploadConsent": "declined", Content-Length: 695 { "@odata.type": "microsoft.graph.managedAppLogUpload", "managedAppComponent": "Managed App Component value",- "status": "partiallyCompleted", + "managedAppComponentDescription": "Managed App Component Description value", + "status": "inProgress", "referenceId": "Reference Id value" } ], |
v1.0 | Intune Mam Managedapplogcollectionrequest Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-managedapplogcollectionrequest-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: 748 +Content-Length: 905 { "value": { Content-Length: 748 "managedAppRegistrationId": "Managed App Registration Id value", "status": "Status value", "requestedBy": "Requested By value",+ "requestedByUserPrincipalName": "Requested By User Principal Name value", "requestedDateTime": "2017-01-01T00:01:49.2071853-08:00", "completedDateTime": "2016-12-31T23:58:52.3534526-08:00", "userLogUploadConsent": "declined", Content-Length: 748 { "@odata.type": "microsoft.graph.managedAppLogUpload", "managedAppComponent": "Managed App Component value",- "status": "partiallyCompleted", + "managedAppComponentDescription": "Managed App Component Description value", + "status": "inProgress", "referenceId": "Reference Id value" } ], |
v1.0 | Intune Mam Managedapplogcollectionrequest List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-managedapplogcollectionrequest-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: 796 +Content-Length: 957 { "value": [ Content-Length: 796 "managedAppRegistrationId": "Managed App Registration Id value", "status": "Status value", "requestedBy": "Requested By value",+ "requestedByUserPrincipalName": "Requested By User Principal Name value", "requestedDateTime": "2017-01-01T00:01:49.2071853-08:00", "completedDateTime": "2016-12-31T23:58:52.3534526-08:00", "userLogUploadConsent": "declined", Content-Length: 796 { "@odata.type": "microsoft.graph.managedAppLogUpload", "managedAppComponent": "Managed App Component value",- "status": "partiallyCompleted", + "managedAppComponentDescription": "Managed App Component Description value", + "status": "inProgress", "referenceId": "Reference Id value" } ], |
v1.0 | Intune Mam Managedapplogcollectionrequest Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-managedapplogcollectionrequest-update.md | The following table shows the properties that are required when you create the [ |Property|Type|Description| |:|:|:| |id|String|The unique identifier of the managed app log collection request. This id is assigned during request creation time. Read-only.|-|managedAppRegistrationId|String|The unique identifier of the app instance for which diagnostic was collected.| +|managedAppRegistrationId|String|The unique identifier of the app instance for which diagnostic logs were collected. Read-only.| |status|String|Indicates the status for the app log collection request - pending, completed or failed. Default is pending.|-|requestedBy|String|The user principal name associated with the request for the managed application log collection.| +|requestedBy|String|The user principal name associated with the request for the managed application log collection. Read-only.| +|requestedByUserPrincipalName|String|The user principal name associated with the request for the managed application log collection. Read-only.| |requestedDateTime|DateTimeOffset|DateTime of when the log upload request was received. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.| |completedDateTime|DateTimeOffset|DateTime of when the log upload request was completed. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.|-|userLogUploadConsent|[managedAppLogUploadConsent](../resources/intune-mam-managedapploguploadconsent.md)|Indicates whether the user associated with the device provided consent for the log collection. Possible values are: `default`, `declined`, `accepted`, `unknownFutureValue`.| -|uploadedLogs|[managedAppLogUpload](../resources/intune-mam-managedapplogupload.md) collection|The collection of log upload results as reported by each component on the device. Such components can be the application itself, the Mobile Application Management (MAM) SDK, and other on-device components that are requested to upload diagnostic logs.| +|userLogUploadConsent|[managedAppLogUploadConsent](../resources/intune-mam-managedapploguploadconsent.md)|Indicates whether the user associated with the device provided consent for the log collection. The user must consent before the diagnostic logs can be collected. accepted means the user consented. declined means the user declined. unknown is the default value. The Log Collection Request must be completed within 24 hours or it will be abandoned and deleted. Read-only. Possible values are: `unknown`, `declined`, `accepted`, `unknownFutureValue`.| +|uploadedLogs|[managedAppLogUpload](../resources/intune-mam-managedapplogupload.md) collection|The collection of log upload results as reported by each component on the device. Such components can be the application itself, the Mobile Application Management (MAM) SDK, and other on-device components that are requested to upload diagnostic logs. Read-only.| |version|String|Version of the entity.| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceAppManagement/managedAppRegistrations/{managedAppRegistrationId}/managedAppLogCollectionRequests/{managedAppLogCollectionRequestId} Content-type: application/json-Content-length: 646 +Content-length: 799 { "@odata.type": "#microsoft.graph.managedAppLogCollectionRequest", "managedAppRegistrationId": "Managed App Registration Id value", "status": "Status value", "requestedBy": "Requested By value",+ "requestedByUserPrincipalName": "Requested By User Principal Name value", "requestedDateTime": "2017-01-01T00:01:49.2071853-08:00", "completedDateTime": "2016-12-31T23:58:52.3534526-08:00", "userLogUploadConsent": "declined", Content-length: 646 { "@odata.type": "microsoft.graph.managedAppLogUpload", "managedAppComponent": "Managed App Component value",- "status": "partiallyCompleted", + "managedAppComponentDescription": "Managed App Component Description value", + "status": "inProgress", "referenceId": "Reference 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: 695 +Content-Length: 848 { "@odata.type": "#microsoft.graph.managedAppLogCollectionRequest", Content-Length: 695 "managedAppRegistrationId": "Managed App Registration Id value", "status": "Status value", "requestedBy": "Requested By value",+ "requestedByUserPrincipalName": "Requested By User Principal Name value", "requestedDateTime": "2017-01-01T00:01:49.2071853-08:00", "completedDateTime": "2016-12-31T23:58:52.3534526-08:00", "userLogUploadConsent": "declined", Content-Length: 695 { "@odata.type": "microsoft.graph.managedAppLogUpload", "managedAppComponent": "Managed App Component value",- "status": "partiallyCompleted", + "managedAppComponentDescription": "Managed App Component Description value", + "status": "inProgress", "referenceId": "Reference Id value" } ], |
v1.0 | Intune Mam Managedapppolicydeploymentsummary Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-managedapppolicydeploymentsummary-get.md | One of the following permissions is required to call this API. To learn more, in ``` http GET /deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtectionId}/deploymentSummary GET /deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtectionId}/deploymentSummary+GET /deviceAppManagement/windowsManagedAppProtections/{windowsManagedAppProtectionId}/deploymentSummary GET /deviceAppManagement/defaultManagedAppProtections/{defaultManagedAppProtectionId}/deploymentSummary GET /deviceAppManagement/targetedManagedAppConfigurations/{targetedManagedAppConfigurationId}/deploymentSummary ``` |
v1.0 | Intune Mam Managedapppolicydeploymentsummary Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-managedapppolicydeploymentsummary-update.md | One of the following permissions is required to call this API. To learn more, in ``` http PATCH /deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtectionId}/deploymentSummary PATCH /deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtectionId}/deploymentSummary+PATCH /deviceAppManagement/windowsManagedAppProtections/{windowsManagedAppProtectionId}/deploymentSummary PATCH /deviceAppManagement/defaultManagedAppProtections/{defaultManagedAppProtectionId}/deploymentSummary PATCH /deviceAppManagement/targetedManagedAppConfigurations/{targetedManagedAppConfigurationId}/deploymentSummary ``` |
v1.0 | Intune Mam Mdmwindowsinformationprotectionpolicy Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-mdmwindowsinformationprotectionpolicy-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 [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) object. +Create a new [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) object in the response body. ## Example |
v1.0 | Intune Mam Mdmwindowsinformationprotectionpolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-mdmwindowsinformationprotectionpolicy-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 [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md). +Deletes a [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Mam Mdmwindowsinformationprotectionpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-mdmwindowsinformationprotectionpolicy-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 [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) object. +Read properties and relationships of the [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) object in the response body. +If successful, this method returns a `200 OK` response code and [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) object in the response body. ## Example |
v1.0 | Intune Mam Mdmwindowsinformationprotectionpolicy List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-mdmwindowsinformationprotectionpolicy-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 [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) objects. +List properties and relationships of the [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceAppManagement/mdmWindowsInformationProtectionPolicies Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) objects in the response body. ## Example |
v1.0 | Intune Mam Mdmwindowsinformationprotectionpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-mdmwindowsinformationprotectionpolicy-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 [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) object. +Update the properties of a [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement/mdmWindowsInformationProtectionPolicies/{mdmWindowsIn |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) object. +In the request body, supply a JSON representation for the [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) object. -The following table shows the properties that are required when you create the [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md). +The following table shows the properties that are required when you create the [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.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 [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) object in the response body. ## Example |
v1.0 | Intune Mam Targetedmanagedappconfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-targetedmanagedappconfiguration-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 [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) object. +Create a new [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] The following table shows the properties that are required when you create the t ## Response-If successful, this method returns a `201 Created` response code and a [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) object in the response body. ## Example |
v1.0 | Intune Mam Targetedmanagedappconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-targetedmanagedappconfiguration-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 [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md). +Deletes a [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Mam Targetedmanagedappconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-targetedmanagedappconfiguration-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 [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) object. +Read properties and relationships of the [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) object in the response body. +If successful, this method returns a `200 OK` response code and [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) object in the response body. ## Example |
v1.0 | Intune Mam Targetedmanagedappconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-targetedmanagedappconfiguration-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 [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) objects. +List properties and relationships of the [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceAppManagement/targetedManagedAppConfigurations Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) objects in the response body. ## Example |
v1.0 | Intune Mam Targetedmanagedappconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-targetedmanagedappconfiguration-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 [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) object. +Update the properties of a [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement/targetedManagedAppConfigurations/{targetedManagedAppC |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) object. +In the request body, supply a JSON representation for the [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) object. -The following table shows the properties that are required when you create the [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md). +The following table shows the properties that are required when you create the [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.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 [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) object in the response body. ## Example |
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 | Content-length: 582 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 Mam User Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-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-mam-user.md) object. +Create a new [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-mam-user.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [user](../resources/intune-shared-user.md) object in the response body. ## Example |
v1.0 | Intune Mam User Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-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-mam-user.md). +Deletes a [user](../resources/intune-shared-user.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Mam User Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-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-mam-user.md) object. +Read properties and relationships of the [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-mam-user.md) object in the response body. +If successful, this method returns a `200 OK` response code and [user](../resources/intune-shared-user.md) object in the response body. ## Example |
v1.0 | Intune Mam User List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-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-mam-user.md) objects. +List properties and relationships of the [user](../resources/intune-shared-user.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-mam-user.md) objects in the response body. +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. ## Example |
v1.0 | Intune Mam User Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-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-mam-user.md) object. +Update the properties of a [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /users/{usersId} |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [user](../resources/intune-mam-user.md) object. +In the request body, supply a JSON representation for the [user](../resources/intune-shared-user.md) object. -The following table shows the properties that are required when you create the [user](../resources/intune-mam-user.md). +The following table shows the properties that are required when you create the [user](../resources/intune-shared-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-mam-user.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [user](../resources/intune-shared-user.md) object in the response body. ## Example |
v1.0 | Intune Mam User Wipeandblockmanagedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-user-wipeandblockmanagedapps.md | Blocks the managed app user from app check-in. [!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). +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). In addition to the listed permissions, an authenticated user must be assigned the Managed apps/Wipe permission in an Intune Role. Your automation must use delegated permissions as only granting application permissions as listed in the table are insufficient to complete the wipe action. |Permission type|Permissions (from least to most privileged)| |:|:| |
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 | Content-length: 582 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 Mstunnel Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-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-mstunnel-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-mstunnel-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Mstunnel Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-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-mstunnel-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-mstunnel-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-mstunnel-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-mstunnel-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
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 Notification Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-notification-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-notification-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-notification-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Notification Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-notification-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-notification-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-notification-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-notification-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-notification-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Odj Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-odj-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-odj-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-odj-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Odj Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-odj-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-odj-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-odj-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-odj-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-odj-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
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 Onboarding Deviceappmanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-deviceappmanagement-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 [deviceAppManagement](../resources/intune-onboarding-deviceappmanagement.md) object. +Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceAppManagement](../resources/intune-onboarding-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
v1.0 | Intune Onboarding Deviceappmanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-deviceappmanagement-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 [deviceAppManagement](../resources/intune-onboarding-deviceappmanagement.md) object. +Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-onboarding-deviceappmanagement.md) object. +In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. -The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-onboarding-deviceappmanagement.md). +The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.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 [deviceAppManagement](../resources/intune-onboarding-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
v1.0 | Intune Onboarding Devicecategory Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-devicecategory-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 [deviceCategory](../resources/intune-onboarding-devicecategory.md) object. +Create a new [deviceCategory](../resources/intune-shared-devicecategory.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] The following table shows the properties that are required when you create the d ## Response-If successful, this method returns a `201 Created` response code and a [deviceCategory](../resources/intune-onboarding-devicecategory.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [deviceCategory](../resources/intune-shared-devicecategory.md) object in the response body. ## Example |
v1.0 | Intune Onboarding Devicecategory Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-devicecategory-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 [deviceCategory](../resources/intune-onboarding-devicecategory.md). +Deletes a [deviceCategory](../resources/intune-shared-devicecategory.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Onboarding Devicecategory Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-devicecategory-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 [deviceCategory](../resources/intune-onboarding-devicecategory.md) object. +Read properties and relationships of the [deviceCategory](../resources/intune-shared-devicecategory.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceCategory](../resources/intune-onboarding-devicecategory.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceCategory](../resources/intune-shared-devicecategory.md) object in the response body. ## Example |
v1.0 | Intune Onboarding Devicecategory List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-devicecategory-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 [deviceCategory](../resources/intune-onboarding-devicecategory.md) objects. +List properties and relationships of the [deviceCategory](../resources/intune-shared-devicecategory.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceManagement/deviceCategories Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [deviceCategory](../resources/intune-onboarding-devicecategory.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [deviceCategory](../resources/intune-shared-devicecategory.md) objects in the response body. ## Example |
v1.0 | Intune Onboarding Devicecategory Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-devicecategory-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 [deviceCategory](../resources/intune-onboarding-devicecategory.md) object. +Update the properties of a [deviceCategory](../resources/intune-shared-devicecategory.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement/deviceCategories/{deviceCategoryId} |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceCategory](../resources/intune-onboarding-devicecategory.md) object. +In the request body, supply a JSON representation for the [deviceCategory](../resources/intune-shared-devicecategory.md) object. -The following table shows the properties that are required when you create the [deviceCategory](../resources/intune-onboarding-devicecategory.md). +The following table shows the properties that are required when you create the [deviceCategory](../resources/intune-shared-devicecategory.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 [deviceCategory](../resources/intune-onboarding-devicecategory.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceCategory](../resources/intune-shared-devicecategory.md) object in the response body. ## Example |
v1.0 | Intune Onboarding Deviceenrollmentconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-deviceenrollmentconfiguration-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 [deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) object. +Read properties and relationships of the [deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) object in the response body. ## Example |
v1.0 | Intune Onboarding Deviceenrollmentconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-deviceenrollmentconfiguration-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 [deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) objects. +List properties and relationships of the [deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceManagement/deviceEnrollmentConfigurations Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) objects in the response body. ## Example |
v1.0 | Intune Onboarding Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-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-onboarding-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-onboarding-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Onboarding Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-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-onboarding-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-onboarding-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-onboarding-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-onboarding-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Onboarding Devicemanagement Verifywindowsenrollmentautodiscovery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-devicemanagement-verifywindowsenrollmentautodiscovery.md | Content-Length: 21 { "value": true }-``` +``` |
v1.0 | Intune Onboarding Sideloadingkey Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-sideloadingkey-create.md | Content-Length: 295 "totalActivation": 15, "lastUpdatedDateTime": "Last Updated Date Time value" }-``` +``` |
v1.0 | Intune Onboarding Sideloadingkey Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-sideloadingkey-delete.md | DELETE https://graph.microsoft.com/beta/deviceAppManagement/sideLoadingKeys/{sid 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 Onboarding Sideloadingkey Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-sideloadingkey-get.md | Content-Length: 328 "lastUpdatedDateTime": "Last Updated Date Time value" } }-``` +``` |
v1.0 | Intune Onboarding Sideloadingkey List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-sideloadingkey-list.md | Content-Length: 356 } ] }-``` +``` |
v1.0 | Intune Onboarding Sideloadingkey Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-sideloadingkey-update.md | Content-Length: 295 "totalActivation": 15, "lastUpdatedDateTime": "Last Updated Date Time value" }-``` +``` |
v1.0 | Intune Onboarding User Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-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-onboarding-user.md) object. +Create a new [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-onboarding-user.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [user](../resources/intune-shared-user.md) object in the response body. ## Example |
v1.0 | Intune Onboarding User Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-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-onboarding-user.md). +Deletes a [user](../resources/intune-shared-user.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Onboarding User Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-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-onboarding-user.md) object. +Read properties and relationships of the [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-onboarding-user.md) object in the response body. +If successful, this method returns a `200 OK` response code and [user](../resources/intune-shared-user.md) object in the response body. ## Example |
v1.0 | Intune Onboarding User Geteffectivedeviceenrollmentconfigurations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-user-geteffectivedeviceenrollmentconfigurations.md | GET /users/{usersId}/getEffectiveDeviceEnrollmentConfigurations Do not supply a request body for this method. ## Response-If successful, this function returns a `200 OK` response code and a [deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) collection in the response body. +If successful, this function returns a `200 OK` response code and a [deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) collection in the response body. ## Example |
v1.0 | Intune Onboarding User List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-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-onboarding-user.md) objects. +List properties and relationships of the [user](../resources/intune-shared-user.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-onboarding-user.md) objects in the response body. +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. ## Example |
v1.0 | Intune Onboarding User Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-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-onboarding-user.md) object. +Update the properties of a [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /users/{usersId} |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [user](../resources/intune-onboarding-user.md) object. +In the request body, supply a JSON representation for the [user](../resources/intune-shared-user.md) object. -The following table shows the properties that are required when you create the [user](../resources/intune-onboarding-user.md). +The following table shows the properties that are required when you create the [user](../resources/intune-shared-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-onboarding-user.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [user](../resources/intune-shared-user.md) object in the response body. ## Example |
v1.0 | Intune Onboarding Vpptoken Getlicensesforapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-onboarding-vpptoken-getlicensesforapp.md | Content-Length: 298 } ] }-``` +``` |
v1.0 | Intune Osprovisioninggraphservice Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-osprovisioninggraphservice-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-osprovisioninggraphservice-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-osprovisioninggraphservice-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Osprovisioninggraphservice Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-osprovisioninggraphservice-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-osprovisioninggraphservice-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-osprovisioninggraphservice-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-osprovisioninggraphservice-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-osprovisioninggraphservice-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
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 | Content-Length: 612 } ] }-``` +``` |
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 | DELETE https://graph.microsoft.com/beta/deviceManagement/managedDeviceWindowsOSI 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 Osprovisioninggraphservice Manageddevicewindowsoperatingsystemimage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage-get.md | Content-Length: 671 ] } }-``` +``` |
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 | Content-Length: 725 } ] }-``` +``` |
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 | Content-Length: 725 } ] }-``` +``` |
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 | Content-Length: 612 } ] }-``` +``` |
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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | Content-Length: 396 "mobileAppType": "Mobile App Type value", "version": "Version value" }-``` +``` |
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 | Content-Length: 276 "enforcedDeviceCount": 3 } }-``` +``` |
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 | 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 [deviceAppManagement](../resources/intune-partnerintegration-deviceappmanagement.md) object. +Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceAppManagement](../resources/intune-partnerintegration-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
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 | 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 [deviceAppManagement](../resources/intune-partnerintegration-deviceappmanagement.md) object. +Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-partnerintegration-deviceappmanagement.md) object. +In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. -The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-partnerintegration-deviceappmanagement.md). +The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.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 [deviceAppManagement](../resources/intune-partnerintegration-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
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." ++localization_priority: Normal ++++# 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-shared-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, 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| ++## 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-shared-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: 301 ++{ + "value": { + "@odata.type": "#microsoft.graph.deviceManagement", + "id": "0b283420-3420-0b28-2034-280b2034280b", + "organizationalMessageFeatureOnboarding": { + "@odata.type": "microsoft.graph.organizationalMessageFeatureOnboarding", + "hasRequiredLicense": true + } + } +} +``` |
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." ++localization_priority: Normal ++++# 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-shared-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, DeviceManagementApps.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All, 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-shared-devicemanagement.md) object. ++The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-devicemanagement.md). ++|Property|Type|Description| +|:|:|:| +|id|String|Key of the entity.| +|organizationalMessageFeatureOnboarding|[organizationalMessageFeatureOnboarding](../resources/intune-partnerintegration-organizationalmessagefeatureonboarding.md)|OrganizationalMessageFeatureOnboarding| ++++## 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. ++## Example ++### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/deviceManagement +Content-type: application/json +Content-length: 221 ++{ + "@odata.type": "#microsoft.graph.deviceManagement", + "organizationalMessageFeatureOnboarding": { + "@odata.type": "microsoft.graph.organizationalMessageFeatureOnboarding", + "hasRequiredLicense": true + } +} +``` ++### 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: 270 ++{ + "@odata.type": "#microsoft.graph.deviceManagement", + "id": "0b283420-3420-0b28-2034-280b2034280b", + "organizationalMessageFeatureOnboarding": { + "@odata.type": "microsoft.graph.organizationalMessageFeatureOnboarding", + "hasRequiredLicense": true + } +} +``` |
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 | 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 | 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 | 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 | 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 | 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 | Namespace: microsoft.graph 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). |
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 | Namespace: microsoft.graph 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). |
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 | Namespace: microsoft.graph 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). |
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 | Namespace: microsoft.graph 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). |
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 | Namespace: microsoft.graph 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). |
v1.0 | Intune Policylistingservice Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policylistingservice-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-policylistingservice-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-policylistingservice-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Policylistingservice Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policylistingservice-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-policylistingservice-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-policylistingservice-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-policylistingservice-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-policylistingservice-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Policyset Deviceandappmanagementassignmentfilter Getplatformsupportedproperties | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policyset-deviceandappmanagementassignmentfilter-getplatformsupportedproperties.md | Content-Length: 407 } ] }-``` +``` |
v1.0 | Intune Policyset Deviceappmanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policyset-deviceappmanagement-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 [deviceAppManagement](../resources/intune-policyset-deviceappmanagement.md) object. +Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceAppManagement](../resources/intune-policyset-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
v1.0 | Intune Policyset Deviceappmanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policyset-deviceappmanagement-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 [deviceAppManagement](../resources/intune-policyset-deviceappmanagement.md) object. +Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-policyset-deviceappmanagement.md) object. +In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. -The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-policyset-deviceappmanagement.md). +The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.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 [deviceAppManagement](../resources/intune-policyset-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
v1.0 | Intune Policyset Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policyset-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-policyset-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-policyset-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Policyset Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policyset-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-policyset-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-policyset-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-policyset-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-policyset-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Raimportcerts Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-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-raimportcerts-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-raimportcerts-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Raimportcerts Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-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-raimportcerts-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-raimportcerts-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-raimportcerts-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-raimportcerts-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Raimportcerts Onpremencryptedpayload Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-onpremencryptedpayload-create.md | Content-Length: 781 "eTag": "ETag value", "isDeleted": true }-``` +``` |
v1.0 | Intune Raimportcerts Onpremencryptedpayload Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-onpremencryptedpayload-delete.md | DELETE https://graph.microsoft.com/beta/onPremEncryptedPayloads/{onPremEncrypted 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 Raimportcerts Onpremencryptedpayload Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-onpremencryptedpayload-get.md | Content-Length: 834 "isDeleted": true } }-``` +``` |
v1.0 | Intune Raimportcerts Onpremencryptedpayload List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-onpremencryptedpayload-list.md | Content-Length: 882 } ] }-``` +``` |
v1.0 | Intune Raimportcerts Onpremencryptedpayload Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-onpremencryptedpayload-update.md | Content-Length: 781 "eTag": "ETag value", "isDeleted": true }-``` +``` |
v1.0 | Intune Raimportcerts Pfxrecryptionrequest Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-pfxrecryptionrequest-create.md | Content-Length: 574 "isDeleted": true, "eTag": "ETag value" }-``` +``` |
v1.0 | Intune Raimportcerts Pfxrecryptionrequest Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-pfxrecryptionrequest-delete.md | DELETE https://graph.microsoft.com/beta/pfxRecryptionRequests/{pfxRecryptionRequ 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 Raimportcerts Pfxrecryptionrequest Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-pfxrecryptionrequest-get.md | Content-Length: 619 "eTag": "ETag value" } }-``` +``` |
v1.0 | Intune Raimportcerts Pfxrecryptionrequest List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-pfxrecryptionrequest-list.md | Content-Length: 659 } ] }-``` +``` |
v1.0 | Intune Raimportcerts Pfxrecryptionrequest Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-pfxrecryptionrequest-update.md | Content-Length: 574 "isDeleted": true, "eTag": "ETag value" }-``` +``` |
v1.0 | Intune Raimportcerts Pfxusercertificate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-pfxusercertificate-create.md | Content-Length: 789 "lastModifiedTime": "2017-01-01T00:03:18.5958204-08:00", "eTag": "ETag value" }-``` +``` |
v1.0 | Intune Raimportcerts Pfxusercertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-pfxusercertificate-delete.md | DELETE https://graph.microsoft.com/beta/pfxUserCertificates/{pfxUserCertificates 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 Raimportcerts Pfxusercertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-pfxusercertificate-get.md | Content-Length: 844 "eTag": "ETag value" } }-``` +``` |
v1.0 | Intune Raimportcerts Pfxusercertificate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-pfxusercertificate-list.md | Content-Length: 894 } ] }-``` +``` |
v1.0 | Intune Raimportcerts Pfxusercertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-raimportcerts-pfxusercertificate-update.md | Content-Length: 789 "lastModifiedTime": "2017-01-01T00:03:18.5958204-08:00", "eTag": "ETag value" }-``` +``` |
v1.0 | Intune Rapolicy Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-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-rapolicy-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-rapolicy-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Rapolicy Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-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-rapolicy-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-rapolicy-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-rapolicy-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-rapolicy-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialsettings Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-devicemanagementderivedcredentialsettings-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 [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) object. +Create a new [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] The following table shows the properties that are required when you create the d ## Response-If successful, this method returns a `201 Created` response code and a [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object in the response body. ## Example |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialsettings Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-devicemanagementderivedcredentialsettings-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 [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md). +Deletes a [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-devicemanagementderivedcredentialsettings-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 [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) object. +Read properties and relationships of the [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object in the response body. ## Example |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialsettings List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-devicemanagementderivedcredentialsettings-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 [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) objects. +List properties and relationships of the [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] GET /deviceManagement/derivedCredentials Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) objects in the response body. ## Example |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialsettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-devicemanagementderivedcredentialsettings-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 [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) object. +Update the properties of a [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement/derivedCredentials/{deviceManagementDerivedCredentialSet |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) object. +In the request body, supply a JSON representation for the [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object. -The following table shows the properties that are required when you create the [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md). +The following table shows the properties that are required when you create the [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.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 [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object in the response body. ## Example |
v1.0 | Intune Rapolicy Devicemanagementresourceaccessprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-devicemanagementresourceaccessprofilebase-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: 453 +Content-Length: 713 { "value": { Content-Length: 453 "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "roleScopeTagIds": [ "Role Scope Tag Ids value"+ ], + "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.osVersionApplicabilityRule", + "filterType": "include", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value" + } ] } } |
v1.0 | Intune Rapolicy Devicemanagementresourceaccessprofilebase List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-devicemanagementresourceaccessprofilebase-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: 487 +Content-Length: 763 { "value": [ Content-Length: 487 "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "roleScopeTagIds": [ "Role Scope Tag Ids value"+ ], + "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.osVersionApplicabilityRule", + "filterType": "include", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value" + } ] } ] |
v1.0 | Intune Rapolicy Devicemanagementresourceaccessprofilebase Querybyplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-devicemanagementresourceaccessprofilebase-querybyplatformtype.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: 487 +Content-Length: 763 { "value": [ Content-Length: 487 "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "roleScopeTagIds": [ "Role Scope Tag Ids value"+ ], + "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.osVersionApplicabilityRule", + "filterType": "include", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value" + } ] } ] |
v1.0 | Intune Rapolicy Windows10xcertificateprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xcertificateprofile-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: 440 +Content-Length: 595 { "value": { Content-Length: 440 "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "roleScopeTagIds": [ "Role Scope Tag Ids value"+ ], + "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } ] } } |
v1.0 | Intune Rapolicy Windows10xcertificateprofile List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xcertificateprofile-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: 474 +Content-Length: 641 { "value": [ Content-Length: 474 "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", "roleScopeTagIds": [ "Role Scope Tag Ids value"+ ], + "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } ] } ] |
v1.0 | Intune Rapolicy Windows10xscepcertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xscepcertificateprofile-create.md | The following table shows the properties that are required when you create the w |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Possible values are: `days`, `months`, `years`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-rapolicy-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings.| |hashAlgorithm|[hashAlgorithms](../resources/intune-shared-hashalgorithms.md) collection|SCEP Hash Algorithm. Possible values are: `sha1`, `sha2`.| |keySize|[keySize](../resources/intune-shared-keysize.md)|SCEP Key Size. Possible values are: `size1024`, `size2048`, `size4096`.| |keyStorageProvider|[keyStorageProviderOption](../resources/intune-shared-keystorageprovideroption.md)|Key Storage Provider (KSP). Possible values are: `useTpmKspOtherwiseUseSoftwareKsp`, `useTpmKspOtherwiseFail`, `usePassportForWorkKspOtherwiseFail`, `useSoftwareKsp`.| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/resourceAccessProfiles Content-type: application/json-Content-length: 1178 +Content-length: 1321 { "@odata.type": "#microsoft.graph.windows10XSCEPCertificateProfile", Content-length: 1178 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "certificateStore": "machine", "certificateValidityPeriodScale": "months", "certificateValidityPeriodValue": 14, 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: 1291 +Content-Length: 1434 { "@odata.type": "#microsoft.graph.windows10XSCEPCertificateProfile", Content-Length: 1291 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "certificateStore": "machine", "certificateValidityPeriodScale": "months", "certificateValidityPeriodValue": 14, |
v1.0 | Intune Rapolicy Windows10xscepcertificateprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xscepcertificateprofile-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: 1388 +Content-Length: 1543 { "value": { Content-Length: 1388 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "certificateStore": "machine", "certificateValidityPeriodScale": "months", "certificateValidityPeriodValue": 14, |
v1.0 | Intune Rapolicy Windows10xscepcertificateprofile List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xscepcertificateprofile-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: 1480 +Content-Length: 1647 { "value": [ Content-Length: 1480 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "certificateStore": "machine", "certificateValidityPeriodScale": "months", "certificateValidityPeriodValue": 14, |
v1.0 | Intune Rapolicy Windows10xscepcertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xscepcertificateprofile-update.md | The following table shows the properties that are required when you create the [ |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Possible values are: `days`, `months`, `years`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-rapolicy-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings.| |hashAlgorithm|[hashAlgorithms](../resources/intune-shared-hashalgorithms.md) collection|SCEP Hash Algorithm. Possible values are: `sha1`, `sha2`.| |keySize|[keySize](../resources/intune-shared-keysize.md)|SCEP Key Size. Possible values are: `size1024`, `size2048`, `size4096`.| |keyStorageProvider|[keyStorageProviderOption](../resources/intune-shared-keystorageprovideroption.md)|Key Storage Provider (KSP). Possible values are: `useTpmKspOtherwiseUseSoftwareKsp`, `useTpmKspOtherwiseFail`, `usePassportForWorkKspOtherwiseFail`, `useSoftwareKsp`.| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/resourceAccessProfiles/{deviceManagementResourceAccessProfileBaseId} Content-type: application/json-Content-length: 1178 +Content-length: 1321 { "@odata.type": "#microsoft.graph.windows10XSCEPCertificateProfile", Content-length: 1178 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "certificateStore": "machine", "certificateValidityPeriodScale": "months", "certificateValidityPeriodValue": 14, 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: 1291 +Content-Length: 1434 { "@odata.type": "#microsoft.graph.windows10XSCEPCertificateProfile", Content-Length: 1291 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "certificateStore": "machine", "certificateValidityPeriodScale": "months", "certificateValidityPeriodValue": 14, |
v1.0 | Intune Rapolicy Windows10xtrustedrootcertificate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xtrustedrootcertificate-create.md | The following table shows the properties that are required when you create the w |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |trustedRootCertificate|Binary|Trusted Root Certificate| |certFileName|String|File name to display in UI.| |destinationStore|[certificateDestinationStore](../resources/intune-shared-certificatedestinationstore.md)|Destination store location for the Trusted Root Certificate. Possible values are: `computerCertStoreRoot`, `computerCertStoreIntermediate`, `userCertStoreIntermediate`.| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/resourceAccessProfiles Content-type: application/json-Content-length: 456 +Content-length: 599 { "@odata.type": "#microsoft.graph.windows10XTrustedRootCertificate", Content-length: 456 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value", "destinationStore": "computerCertStoreIntermediate" 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: 569 +Content-Length: 712 { "@odata.type": "#microsoft.graph.windows10XTrustedRootCertificate", Content-Length: 569 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value", "destinationStore": "computerCertStoreIntermediate" |
v1.0 | Intune Rapolicy Windows10xtrustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xtrustedrootcertificate-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: 614 +Content-Length: 769 { "value": { Content-Length: 614 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value", "destinationStore": "computerCertStoreIntermediate" |
v1.0 | Intune Rapolicy Windows10xtrustedrootcertificate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xtrustedrootcertificate-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: 654 +Content-Length: 821 { "value": [ Content-Length: 654 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value", "destinationStore": "computerCertStoreIntermediate" |
v1.0 | Intune Rapolicy Windows10xtrustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xtrustedrootcertificate-update.md | The following table shows the properties that are required when you create the [ |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |trustedRootCertificate|Binary|Trusted Root Certificate| |certFileName|String|File name to display in UI.| |destinationStore|[certificateDestinationStore](../resources/intune-shared-certificatedestinationstore.md)|Destination store location for the Trusted Root Certificate. Possible values are: `computerCertStoreRoot`, `computerCertStoreIntermediate`, `userCertStoreIntermediate`.| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/resourceAccessProfiles/{deviceManagementResourceAccessProfileBaseId} Content-type: application/json-Content-length: 456 +Content-length: 599 { "@odata.type": "#microsoft.graph.windows10XTrustedRootCertificate", Content-length: 456 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value", "destinationStore": "computerCertStoreIntermediate" 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: 569 +Content-Length: 712 { "@odata.type": "#microsoft.graph.windows10XTrustedRootCertificate", Content-Length: 569 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", "certFileName": "Cert File Name value", "destinationStore": "computerCertStoreIntermediate" |
v1.0 | Intune Rapolicy Windows10xvpnconfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xvpnconfiguration-create.md | The following table shows the properties that are required when you create the w |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |authenticationCertificateId|Guid|ID to the Authentication Certificate| |customXmlFileName|String|Custom Xml file name.| |customXml|Binary|Custom XML commands that configures the VPN connection. (UTF8 byte encoding)| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/resourceAccessProfiles Content-type: application/json-Content-length: 446 +Content-length: 589 { "@odata.type": "#microsoft.graph.windows10XVpnConfiguration", Content-length: 446 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" 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: 559 +Content-Length: 702 { "@odata.type": "#microsoft.graph.windows10XVpnConfiguration", Content-Length: 559 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" |
v1.0 | Intune Rapolicy Windows10xvpnconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xvpnconfiguration-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: 604 +Content-Length: 759 { "value": { Content-Length: 604 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" |
v1.0 | Intune Rapolicy Windows10xvpnconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xvpnconfiguration-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: 644 +Content-Length: 811 { "value": [ Content-Length: 644 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" |
v1.0 | Intune Rapolicy Windows10xvpnconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xvpnconfiguration-update.md | The following table shows the properties that are required when you create the [ |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |authenticationCertificateId|Guid|ID to the Authentication Certificate| |customXmlFileName|String|Custom Xml file name.| |customXml|Binary|Custom XML commands that configures the VPN connection. (UTF8 byte encoding)| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/resourceAccessProfiles/{deviceManagementResourceAccessProfileBaseId} Content-type: application/json-Content-length: 446 +Content-length: 589 { "@odata.type": "#microsoft.graph.windows10XVpnConfiguration", Content-length: 446 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" 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: 559 +Content-Length: 702 { "@odata.type": "#microsoft.graph.windows10XVpnConfiguration", Content-Length: 559 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" |
v1.0 | Intune Rapolicy Windows10xwificonfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xwificonfiguration-create.md | The following table shows the properties that are required when you create the w |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |authenticationCertificateId|Guid|ID to the Authentication Certificate| |customXmlFileName|String|Custom Xml file name.| |customXml|Binary|Custom XML commands that configures the VPN connection. (UTF8 byte encoding)| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/resourceAccessProfiles Content-type: application/json-Content-length: 447 +Content-length: 590 { "@odata.type": "#microsoft.graph.windows10XWifiConfiguration", Content-length: 447 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" 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: 560 +Content-Length: 703 { "@odata.type": "#microsoft.graph.windows10XWifiConfiguration", Content-Length: 560 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" |
v1.0 | Intune Rapolicy Windows10xwificonfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xwificonfiguration-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: 605 +Content-Length: 760 { "value": { Content-Length: 605 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" |
v1.0 | Intune Rapolicy Windows10xwificonfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xwificonfiguration-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: 645 +Content-Length: 812 { "value": [ Content-Length: 645 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" |
v1.0 | Intune Rapolicy Windows10xwificonfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rapolicy-windows10xwificonfiguration-update.md | The following table shows the properties that are required when you create the [ |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |authenticationCertificateId|Guid|ID to the Authentication Certificate| |customXmlFileName|String|Custom Xml file name.| |customXml|Binary|Custom XML commands that configures the VPN connection. (UTF8 byte encoding)| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/resourceAccessProfiles/{deviceManagementResourceAccessProfileBaseId} Content-type: application/json-Content-length: 447 +Content-length: 590 { "@odata.type": "#microsoft.graph.windows10XWifiConfiguration", Content-length: 447 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" 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: 560 +Content-Length: 703 { "@odata.type": "#microsoft.graph.windows10XWifiConfiguration", Content-Length: 560 "roleScopeTagIds": [ "Role Scope Tag Ids value" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "include" + } + ], "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439", "customXmlFileName": "Custom Xml File Name value", "customXml": "Y3VzdG9tWG1s" |
v1.0 | Intune Rbac Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-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-rbac-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-rbac-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Rbac Devicemanagement Getrolescopetagsbyids | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-devicemanagement-getrolescopetagsbyids.md | Content-Length: 257 } ] }-``` +``` |
v1.0 | Intune Rbac Devicemanagement Getrolescopetagsbyresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-devicemanagement-getrolescopetagsbyresource.md | Content-Length: 257 } ] }-``` +``` |
v1.0 | Intune Rbac Devicemanagement Scopedforresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-devicemanagement-scopedforresource.md | Content-Length: 21 { "value": true }-``` +``` |
v1.0 | Intune Rbac Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-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-rbac-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-rbac-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-rbac-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-rbac-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Rbac Operationapprovalrequest Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-operationapprovalrequest-create.md | The following table shows the properties that are required when you create the o |status|[operationApprovalRequestStatus](../resources/intune-rbac-operationapprovalrequeststatus.md)|The current approval status of the request. Possible values are: `unknown`, `needsApproval`, `approved`, `rejected`, `cancelled`, `completed`, `expired`. Default value is `unknown`. Read-only. This property is read-only. Possible values are: `unknown`, `needsApproval`, `approved`, `rejected`, `cancelled`, `completed`, `expired`, `unknownFutureValue`.| |requestJustification|String|Indicates the justification for creating the request. Maximum length of justification is 1024 characters. For example: 'Needed for Feb 2023 application baseline updates.' Read-only. This property is read-only.| |approvalJustification|String|Indicates the justification for approving or rejecting the request. Maximum length of justification is 1024 characters. For example: 'Approved per Change 23423 - needed for Feb 2023 application baseline updates.' Read-only. This property is read-only.|-|operationApprovalPolicies|String|The operational approval policies used in the request. Indicates the policy and platform combinations that are required for this request to be approved or rejected. Read-only. This property is read-only.| |requiredOperationApprovalPolicyTypes|[operationApprovalPolicyType](../resources/intune-rbac-operationapprovalpolicytype.md) collection|Indicates the approval policy types required by the request in order for the request to be approved or rejected. Read-only. This property is read-only. Possible values are: `unknown`, `deviceAction`, `deviceWipe`, `deviceRetire`, `deviceRetireNonCompliant`, `deviceDelete`, `deviceLock`, `deviceErase`, `deviceDisableActivationLock`, `windowsEnrollment`, `compliancePolicy`, `configurationPolicy`, `appProtectionPolicy`, `policySet`, `filter`, `endpointSecurityPolicy`, `apps`, `script`, `role`, `deviceResetPasscode`, `customOrganizationalMessage`, `unknownFutureValue`.| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/operationApprovalRequests Content-type: application/json-Content-length: 1486 +Content-length: 1417 { "@odata.type": "#microsoft.graph.operationApprovalRequest", Content-length: 1486 "status": "needsApproval", "requestJustification": "Request Justification value", "approvalJustification": "Approval Justification value",- "operationApprovalPolicies": "Operation Approval Policies value", "requiredOperationApprovalPolicyTypes": [ "deviceAction" ] 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: 1599 +Content-Length: 1530 { "@odata.type": "#microsoft.graph.operationApprovalRequest", Content-Length: 1599 "status": "needsApproval", "requestJustification": "Request Justification value", "approvalJustification": "Approval Justification value",- "operationApprovalPolicies": "Operation Approval Policies value", "requiredOperationApprovalPolicyTypes": [ "deviceAction" ] |
v1.0 | Intune Rbac Operationapprovalrequest Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-operationapprovalrequest-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: 1714 +Content-Length: 1643 { "value": { Content-Length: 1714 "status": "needsApproval", "requestJustification": "Request Justification value", "approvalJustification": "Approval Justification value",- "operationApprovalPolicies": "Operation Approval Policies value", "requiredOperationApprovalPolicyTypes": [ "deviceAction" ] |
v1.0 | Intune Rbac Operationapprovalrequest List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-operationapprovalrequest-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: 1824 +Content-Length: 1751 { "value": [ Content-Length: 1824 "status": "needsApproval", "requestJustification": "Request Justification value", "approvalJustification": "Approval Justification value",- "operationApprovalPolicies": "Operation Approval Policies value", "requiredOperationApprovalPolicyTypes": [ "deviceAction" ] |
v1.0 | Intune Rbac Operationapprovalrequest Retrievemyrequestbyid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-operationapprovalrequest-retrievemyrequestbyid.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: 1714 +Content-Length: 1643 { "value": { Content-Length: 1714 "status": "needsApproval", "requestJustification": "Request Justification value", "approvalJustification": "Approval Justification value",- "operationApprovalPolicies": "Operation Approval Policies value", "requiredOperationApprovalPolicyTypes": [ "deviceAction" ] } }-``` +``` |
v1.0 | Intune Rbac Operationapprovalrequest Retrievemyrequests | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-operationapprovalrequest-retrievemyrequests.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: 1824 +Content-Length: 1751 { "value": [ Content-Length: 1824 "status": "needsApproval", "requestJustification": "Request Justification value", "approvalJustification": "Approval Justification value",- "operationApprovalPolicies": "Operation Approval Policies value", "requiredOperationApprovalPolicyTypes": [ "deviceAction" ] |
v1.0 | Intune Rbac Operationapprovalrequest Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-operationapprovalrequest-update.md | The following table shows the properties that are required when you create the [ |status|[operationApprovalRequestStatus](../resources/intune-rbac-operationapprovalrequeststatus.md)|The current approval status of the request. Possible values are: `unknown`, `needsApproval`, `approved`, `rejected`, `cancelled`, `completed`, `expired`. Default value is `unknown`. Read-only. This property is read-only. Possible values are: `unknown`, `needsApproval`, `approved`, `rejected`, `cancelled`, `completed`, `expired`, `unknownFutureValue`.| |requestJustification|String|Indicates the justification for creating the request. Maximum length of justification is 1024 characters. For example: 'Needed for Feb 2023 application baseline updates.' Read-only. This property is read-only.| |approvalJustification|String|Indicates the justification for approving or rejecting the request. Maximum length of justification is 1024 characters. For example: 'Approved per Change 23423 - needed for Feb 2023 application baseline updates.' Read-only. This property is read-only.|-|operationApprovalPolicies|String|The operational approval policies used in the request. Indicates the policy and platform combinations that are required for this request to be approved or rejected. Read-only. This property is read-only.| |requiredOperationApprovalPolicyTypes|[operationApprovalPolicyType](../resources/intune-rbac-operationapprovalpolicytype.md) collection|Indicates the approval policy types required by the request in order for the request to be approved or rejected. Read-only. This property is read-only. Possible values are: `unknown`, `deviceAction`, `deviceWipe`, `deviceRetire`, `deviceRetireNonCompliant`, `deviceDelete`, `deviceLock`, `deviceErase`, `deviceDisableActivationLock`, `windowsEnrollment`, `compliancePolicy`, `configurationPolicy`, `appProtectionPolicy`, `policySet`, `filter`, `endpointSecurityPolicy`, `apps`, `script`, `role`, `deviceResetPasscode`, `customOrganizationalMessage`, `unknownFutureValue`.| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/operationApprovalRequests/{operationApprovalRequestId} Content-type: application/json-Content-length: 1486 +Content-length: 1417 { "@odata.type": "#microsoft.graph.operationApprovalRequest", Content-length: 1486 "status": "needsApproval", "requestJustification": "Request Justification value", "approvalJustification": "Approval Justification value",- "operationApprovalPolicies": "Operation Approval Policies value", "requiredOperationApprovalPolicyTypes": [ "deviceAction" ] 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: 1599 +Content-Length: 1530 { "@odata.type": "#microsoft.graph.operationApprovalRequest", Content-Length: 1599 "status": "needsApproval", "requestJustification": "Request Justification value", "approvalJustification": "Approval Justification value",- "operationApprovalPolicies": "Operation Approval Policies value", "requiredOperationApprovalPolicyTypes": [ "deviceAction" ] |
v1.0 | Intune Rbac Rbacapplicationmultiple Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-rbacapplicationmultiple-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: 137 +Content-Length: 86 { "value": {- "@odata.type": "#microsoft.graph.rbacApplicationMultiple", - "id": "ee4797e5-97e5-ee47-e597-47eee59747ee" + "@odata.type": "#microsoft.graph.rbacApplicationMultiple" } } ``` |
v1.0 | Intune Rbac Rbacapplicationmultiple Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-rbacapplicationmultiple-update.md | The following table shows the properties that are required when you create the [ |Property|Type|Description| |:|:|:|-|id|String|| 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: 114 +Content-Length: 65 {- "@odata.type": "#microsoft.graph.rbacApplicationMultiple", - "id": "ee4797e5-97e5-ee47-e597-47eee59747ee" + "@odata.type": "#microsoft.graph.rbacApplicationMultiple" } ``` |
v1.0 | Intune Rbac Resourceoperation Getscopesforuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-resourceoperation-getscopesforuser.md | Content-Length: 56 "Get Scopes For User value" ] }-``` +``` |
v1.0 | Intune Rbac Rolescopetagautoassignment Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-rolescopetagautoassignment-create.md | Content-Length: 447 "entraObjectId": "Entra Object Id value" } }-``` +``` |
v1.0 | Intune Rbac Rolescopetagautoassignment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-rolescopetagautoassignment-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/roleDefinitions/{roleDe 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 Rbac Rolescopetagautoassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-rolescopetagautoassignment-get.md | Content-Length: 484 } } }-``` +``` |
v1.0 | Intune Rbac Rolescopetagautoassignment List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-rolescopetagautoassignment-list.md | Content-Length: 516 } ] }-``` +``` |
v1.0 | Intune Rbac Rolescopetagautoassignment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-rolescopetagautoassignment-update.md | Content-Length: 447 "entraObjectId": "Entra Object Id value" } }-``` +``` |
v1.0 | Intune Remoteassistance Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-remoteassistance-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-remoteassistance-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-remoteassistance-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Remoteassistance Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-remoteassistance-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-remoteassistance-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-remoteassistance-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-remoteassistance-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-remoteassistance-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Reporting Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-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-reporting-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-reporting-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Reporting Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-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-reporting-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-reporting-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-reporting-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-reporting-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Reporting Devicemanagementreports Getsettingcomplianceaggreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getsettingcomplianceaggreport.md | Content-Length: 95 { "value": "Z2V0U2V0dGluZ0NvbXBsaWFuY2VBZ2dSZXBvcnQgSW50dW5lIERvYyBTYW1wbGUgMTAwOTk1NjE2" }-``` +``` |
v1.0 | Intune Reporting Devicemanagementreportschedule Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreportschedule-create.md | Content-Length: 588 ], "format": "pdf" }-``` +``` |
v1.0 | Intune Reporting Devicemanagementreportschedule Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreportschedule-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/reports/reportSchedules 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 Reporting Devicemanagementreportschedule Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreportschedule-get.md | Content-Length: 647 "format": "pdf" } }-``` +``` |
v1.0 | Intune Reporting Devicemanagementreportschedule List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreportschedule-list.md | Content-Length: 701 } ] }-``` +``` |
v1.0 | Intune Reporting Devicemanagementreportschedule Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreportschedule-update.md | Content-Length: 588 ], "format": "pdf" }-``` +``` |
v1.0 | Intune Servicenowconnectorservice Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-servicenowconnectorservice-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-servicenowconnectorservice-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-servicenowconnectorservice-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Servicenowconnectorservice Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-servicenowconnectorservice-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-servicenowconnectorservice-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-servicenowconnectorservice-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-servicenowconnectorservice-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-servicenowconnectorservice-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Shared Deviceappmanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-deviceappmanagement-get.md | GET /deviceAppManagement ## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData Query Parameters](https://developer.microsoft.com/graph/docs/concepts/query_parameters) to help customize the response. ## Request headers |
v1.0 | Intune Shared Deviceappmanagement Syncmicrosoftstoreforbusinessapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-deviceappmanagement-syncmicrosoftstoreforbusinessapps.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. Syncs Intune account with Microsoft Store For Business+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Deviceappmanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-deviceappmanagement-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 [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions The following table shows the properties that are required when you create the [ |microsoftStoreForBusinessLastSuccessfulSyncDateTime|DateTimeOffset|The last time the apps from the Microsoft Store for Business were synced successfully for the account.| |microsoftStoreForBusinessPortalSelection|[microsoftStoreForBusinessPortalSelectionOptions](../resources/intune-onboarding-microsoftstoreforbusinessportalselectionoptions.md)|The end user portal information is used to sync applications from the Microsoft Store for Business to Intune Company Portal. There are three options to pick from \['Company portal only', 'Company portal and private store', 'Private store only'\]. Possible values are: `none`, `companyPortal`, `privateStore`.| -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData Query Parameters](https://developer.microsoft.com/graph/docs/concepts/query_parameters) to help customize the response. ## Response If successful, this method returns a `200 OK` response code and an updated [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. |
v1.0 | Intune Shared Devicecategory Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-devicecategory-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 [deviceCategory](../resources/intune-shared-devicecategory.md).+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Devicecategory Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-devicecategory-get.md | GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceR ## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData Query Parameters](https://developer.microsoft.com/graph/docs/concepts/query_parameters) to help customize the response. ## Request headers |
v1.0 | Intune Shared Devicecategory List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-devicecategory-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 [deviceCategory](../resources/intune-shared-devicecategory.md) objects.+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-devicemanagement-get.md | GET /deviceManagement ## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData Query Parameters](https://developer.microsoft.com/graph/docs/concepts/query_parameters) to help customize the response. ## Request headers |Header|Value| |
v1.0 | Intune Shared Devicemanagement Getassignedroleidsforloggedinuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-devicemanagement-getassignedroleidsforloggedinuser.md | Content-Length: 263 ] } }-``` +``` |
v1.0 | Intune Shared Devicemanagement Getrolescopetagsbyids | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-devicemanagement-getrolescopetagsbyids.md | Content-Length: 231 } ] }-``` +``` |
v1.0 | Intune Shared Devicemanagement Getrolescopetagsbyresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-devicemanagement-getrolescopetagsbyresource.md | Content-Length: 231 } ] }-``` +``` |
v1.0 | Intune Shared Devicemanagement Verifywindowsenrollmentautodiscovery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-devicemanagement-verifywindowsenrollmentautodiscovery.md | Content-Length: 21 { "value": true }-``` +``` |
v1.0 | Intune Shared Mobileapp Getmobileappcount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-mobileapp-getmobileappcount.md | Content-Length: 18 { "value": 1 }-``` +``` |
v1.0 | Intune Shared Mobileapp Getrelatedappstates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-mobileapp-getrelatedappstates.md | Content-Length: 481 } ] }-``` +``` |
v1.0 | Intune Shared Mobileapp Gettopmobileapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-mobileapp-gettopmobileapps.md | Content-Length: 1013 } ] }-``` +``` |
v1.0 | Intune Shared Reportroot Deviceconfigurationdeviceactivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-reportroot-deviceconfigurationdeviceactivity.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. Metadata for the device configuration device activity report+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Reportroot Deviceconfigurationuseractivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-reportroot-deviceconfigurationuseractivity.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. Metadata for the device configuration user activity report+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Reportroot Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-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.+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions GET /reports ``` ## Optional query parameters-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData Query Parameters](https://developer.microsoft.com/graph/docs/concepts/query_parameters) to help customize the response. ## Request headers |Header|Value| |:|:| |
v1.0 | Intune Shared Reportroot Manageddeviceenrollmentabandonmentdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-reportroot-manageddeviceenrollmentabandonmentdetails.md | Content-Length: 123 "content": "<Unknown Primitive Type Edm.Stream>" } }-``` +``` |
v1.0 | Intune Shared Reportroot Manageddeviceenrollmentabandonmentsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-reportroot-manageddeviceenrollmentabandonmentsummary.md | Content-Length: 123 "content": "<Unknown Primitive Type Edm.Stream>" } }-``` +``` |
v1.0 | Intune Shared Reportroot Manageddeviceenrollmentfailuretrends | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-reportroot-manageddeviceenrollmentfailuretrends.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. Metadata for the enrollment failure trends report+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Reportroot Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-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.+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared User Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-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).+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared User Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-user-get.md | GET /users/{usersId} ## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData Query Parameters](https://developer.microsoft.com/graph/docs/concepts/query_parameters) to help customize the response. ## Request headers |
v1.0 | Intune Shared User Getmanagedappdiagnosticstatuses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-user-getmanagedappdiagnosticstatuses.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. Gets diagnostics validation status for a given user.+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared User Getmanageddeviceswithappfailures | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-user-getmanageddeviceswithappfailures.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. Retrieves the list of devices with failed apps+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared User Removealldevicesfrommanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-user-removealldevicesfrommanagement.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. Retire all devices from management for this user+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Windowsdomainjoinconfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object.+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Windowsdomainjoinconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md).+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Windowsdomainjoinconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-windowsdomainjoinconfiguration-get.md | GET /deviceManagement/windowsAutopilotDeviceIdentities/{windowsAutopilotDeviceId ## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData Query Parameters](https://developer.microsoft.com/graph/docs/concepts/query_parameters) to help customize the response. ## Request headers |
v1.0 | Intune Shared Windowsdomainjoinconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) objects.+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Windowsdomainjoinconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-windowsdomainjoinconfiguration-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 [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object.+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Intune Shared Windowsupdatestate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-windowsupdatestate-create.md | Content-Length: 553 "lastScanDateTime": "2016-12-31T23:59:18.0955018-08:00", "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" }-``` +``` |
v1.0 | Intune Shared Windowsupdatestate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-windowsupdatestate-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 Shared Windowsupdatestate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-windowsupdatestate-get.md | Content-Length: 594 "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" } }-``` +``` |
v1.0 | Intune Shared Windowsupdatestate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-windowsupdatestate-list.md | Content-Length: 630 } ] }-``` +``` |
v1.0 | Intune Shared Windowsupdatestate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-shared-windowsupdatestate-update.md | Content-Length: 553 "lastScanDateTime": "2016-12-31T23:59:18.0955018-08:00", "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" }-``` +``` |
v1.0 | Intune Softwareupdate Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-softwareupdate-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-softwareupdate-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-softwareupdate-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Softwareupdate Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-softwareupdate-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-softwareupdate-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-softwareupdate-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-softwareupdate-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-softwareupdate-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
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-troubleshooting-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-troubleshooting-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-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-troubleshooting-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-troubleshooting-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-troubleshooting-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-troubleshooting-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
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-troubleshooting-mobileapptroubleshootingevent.md) object. +Create a new [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-troubleshooting-mobileapptroubleshootingevent.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [mobileAppTroubleshootingEvent](../resources/intune-shared-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-troubleshooting-mobileapptroubleshootingevent.md). +Deletes a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
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-troubleshooting-mobileapptroubleshootingevent.md) object. +Read properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-troubleshooting-mobileapptroubleshootingevent.md) object in the response body. +If successful, this method returns a `200 OK` response code and [mobileAppTroubleshootingEvent](../resources/intune-shared-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-troubleshooting-mobileapptroubleshootingevent.md) objects. +List properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-troubleshooting-mobileapptroubleshootingevent.md) objects in the response body. +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. ## 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-troubleshooting-mobileapptroubleshootingevent.md) object. +Update the properties of a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /users/{usersId}/mobileAppTroubleshootingEvents/{mobileAppTroubleshootingE |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object. +In the request body, supply a JSON representation for the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. -The following table shows the properties that are required when you create the [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md). +The following table shows the properties that are required when you create the [mobileAppTroubleshootingEvent](../resources/intune-shared-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-troubleshooting-mobileapptroubleshootingevent.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [mobileAppTroubleshootingEvent](../resources/intune-shared-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-troubleshooting-reportroot.md) object. +Read properties and relationships of the [reportRoot](../resources/intune-shared-reportroot.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-troubleshooting-reportroot.md) object in the response body. +If successful, this method returns a `200 OK` response code and [reportRoot](../resources/intune-shared-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 | 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-troubleshooting-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-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 | 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-troubleshooting-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-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 | 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-troubleshooting-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-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 | 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-troubleshooting-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-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 | 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-troubleshooting-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-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-troubleshooting-reportroot.md) object. +Update the properties of a [reportRoot](../resources/intune-shared-reportroot.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /reports |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [reportRoot](../resources/intune-troubleshooting-reportroot.md) object. +In the request body, supply a JSON representation for the [reportRoot](../resources/intune-shared-reportroot.md) object. -The following table shows the properties that are required when you create the [reportRoot](../resources/intune-troubleshooting-reportroot.md). +The following table shows the properties that are required when you create the [reportRoot](../resources/intune-shared-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-troubleshooting-reportroot.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [reportRoot](../resources/intune-shared-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-troubleshooting-user.md) object. +Create a new [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-troubleshooting-user.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [user](../resources/intune-shared-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-troubleshooting-user.md). +Deletes a [user](../resources/intune-shared-user.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
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-troubleshooting-user.md) object. +Read properties and relationships of the [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-troubleshooting-user.md) object in the response body. +If successful, this method returns a `200 OK` response code and [user](../resources/intune-shared-user.md) object in the response body. ## Example |
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-troubleshooting-user.md) objects. +List properties and relationships of the [user](../resources/intune-shared-user.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-troubleshooting-user.md) objects in the response body. +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. ## Example |
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-troubleshooting-user.md) object. +Update the properties of a [user](../resources/intune-shared-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /users/{usersId} |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [user](../resources/intune-troubleshooting-user.md) object. +In the request body, supply a JSON representation for the [user](../resources/intune-shared-user.md) object. -The following table shows the properties that are required when you create the [user](../resources/intune-troubleshooting-user.md). +The following table shows the properties that are required when you create the [user](../resources/intune-shared-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-troubleshooting-user.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [user](../resources/intune-shared-user.md) object in the response body. ## Example |
v1.0 | Intune Unlock Deviceappmanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-deviceappmanagement-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 [deviceAppManagement](../resources/intune-unlock-deviceappmanagement.md) object. +Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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 [deviceAppManagement](../resources/intune-unlock-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object in the response body. ## Example |
v1.0 | Intune Unlock Deviceappmanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-deviceappmanagement-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 [deviceAppManagement](../resources/intune-unlock-deviceappmanagement.md) object. +Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceAppManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-unlock-deviceappmanagement.md) object. +In the request body, supply a JSON representation for the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object. -The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-unlock-deviceappmanagement.md). +The following table shows the properties that are required when you create the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.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 [deviceAppManagement](../resources/intune-unlock-deviceappmanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceAppManagement](../resources/intune-shared-deviceappmanagement.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 | Intune Wip Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-wip-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-wip-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] 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-wip-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Wip Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-wip-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-wip-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-wip-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-wip-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-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-wip-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. ## Example |
v1.0 | Itemanalytics Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/itemanalytics-get.md | GET /sites/{site-id}/analytics GET /sites/{site-id}/lists/{list-id}/items/{item-id}/analytics ``` +> [!NOTE] +> The value for `{item-id}` in the `/sites/{site-id}/lists/{list-id}/items/{item-id}` request is the `listItemUniqueId`. To get the `listItemUniqueId` of an item, call the `/sites/{site-id}/lists/{list-id}/items/{item-id}?$select=sharepointIds` endpoint. For details, see [sharePointIds](/graph/api/resources/sharepointids). + ## Optional query parameters This method supports the [OData query parameters](/graph/query-parameters) to help customize the response. |
v1.0 | Learningcontent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/learningcontent-get.md | Content-type: application/json "numberOfPages": 10, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": [ Content-type: application/json "numberOfPages": 10, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": [ |
v1.0 | Learningcontent Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/learningcontent-update.md | PATCH /employeeExperience/learningProviders/{learningProviderId}/learningContent |duration|Duration|The duration of the learning content in seconds. The value is represented in ISO 8601 format for durations. Optional.| |externalId|String|Unique external content ID for the learning content. Required.| |format|String|The format of the learning content. For example, `Course`, `Video`, `Book`, `Book Summary`, `Audiobook Summary`. Optional.|+|level|Level|The difficulty level of the learning content. Possible values are: `Beginner`, `Intermediate`, `Advanced`. Optional.| |isActive|Boolean|Indicates whether the content is active or not. Inactive content doesn't show up in the UI. The default value is `true`. Optional.| |isPremium|Boolean|Indicates whether the learning content requires the user to sign-in on the learning provider platform or not. The default value is `false`. Optional.| |isSearchable|Boolean|Indicates whether the learning content is searchable or not. The default value is `true`. Optional.| Content-Type: application/json "numberOfPages": 9, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00Z", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": ["Scott Simpson"], Content-Type: application/json "numberOfPages": 9, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": [ Content-Type: application/json "numberOfPages": 9, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributor": "Scott Simpson", Content-Type: application/json "numberOfPages": 9, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": [ |
v1.0 | Learningprovider List Learningcontents | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/learningprovider-list-learningcontents.md | Content-type: application/json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#learningProviders('13727311-e7bb-470d-8b20-6a23d9030d70')/learningContents",+ "@odata.nextLink": "https://graph.microsoft.com/beta/$metadata#learningProviders('13727311-e7bb-470d-8b20-6a23d9030d70')/learningContents?skip=2&top=2", + "@odata.count": 10, "value": [ { "id": "99029577-a660-46b6-ba58-3ce4d21d5f50", |
v1.0 | Listitem Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/listitem-delta.md | description: "Get newly created, updated, or deleted list items without having to perform a full read of the entire items collection." Title: "lisItem: delta" + Title: "listItem: delta" ms.localizationpriority: "medium" doc_type: apiPageType + # listItem: delta Namespace: microsoft.graph Your app begins by calling `delta` without any parameters. The service starts enumerating the hierarchy of the list, returning pages of items, and either an **@odata.nextLink** or an **@odata.deltaLink**. Your app should continue calling with the **@odata.nextLink** until you see an **@odata.deltaLink** returned. -After you have received all the changes, you might apply them to your local state. +After you received all the changes, you can apply them to your local state. To check for changes in the future, call `delta` again with the **@odata.deltaLink** from the previous response. -The delta feed shows the latest state for each item, not each change. If an item were renamed twice, it will only show up once, with its latest name. +The delta feed shows the latest state for each item, not each change. If an item was renamed twice, it only shows up once, with its latest name. The same item might appear more than once in a delta feed, for various reasons. You should use the last occurrence you see. -Deleted items are returned with the [deleted facet](../resources/deleted.md). Deleted indicates that the item is deleted and cannot be restored. +Deleted items are returned with the [deleted](../resources/deleted.md) facet. `Deleted` indicates that the item is deleted and can't be restored. Items with this property should be removed from your local state. > **Note:** You should only delete a folder locally if it's empty after syncing all the changes. In the request URL, you can include the following optional query parameter. | Parameter | Type | Description | |:-|:-|:-|-| token | string | Optional. If unspecified, enumerates the current state of the hierarchy. If `latest`, returns an empty response with the latest delta token. If a previous delta token, returns a new state since that token.| +| token | String | If unspecified, enumerates the current state of the hierarchy. If `latest`, returns an empty response with the latest delta token. If a previous delta token, returns a new state since that token.| -This method supports the `$select`, `$expand`, and `$top` [OData query parameters](/graph/query-parameters) to customize the response. +This method also supports the `$select`, `$expand`, and `$top` [OData query parameters](/graph/query-parameters) to customize the response. ## 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 [listItem](../resources/listitem.md) objects in the response body. -In addition to a collection of **listItem** objects, the response will also include one of the following properties. +In addition to a collection of **listItem** objects, the response also includes one of the following properties. -| Name | Value | Description | -|:|:-|:-| -| **@odata.nextLink** | URL | A URL to retrieve the next available page of changes, if there are additional changes in the current set. | -| **@odata.deltaLink** | URL | A URL returned instead of **@odata.nextLink** after all current changes have been returned. Used to read the next set of changes in the future. | +| Name | Value | Description | +|:--|:-|:-| +| @odata.nextLink | URL | A URL to retrieve the next available page of changes, if there are more changes in the current set. | +| @odata.deltaLink | URL | A URL returned instead of **@odata.nextLink** after all current changes have been returned. Use this property to read the next set of changes in the future. | -In some cases, the service will return a `410 Gone` response code with an error response that contains one of the following error codes, and a `Location` header containing a new `nextLink` that starts a fresh delta enumeration. This occurs when the service can't provide a list of changes for a given token (for example, if a client tries to reuse an old token after being disconnected for a long time, or if the server state has changed and a new token is required). +In some cases, the service returns a `410 Gone` response code with an error response that contains one of the following error codes, and a `Location` header that contains a new `nextLink` that starts a fresh delta enumeration. This occurs when the service can't provide a list of changes for a given token; for example, if a client tries to reuse an old token after being disconnected for a long time, or if the server state has changed and a new token is required. After the full enumeration is completed, compare the returned items with your local state and follow the instructions based on the error type. | Error type | Instructions | |:|:-|-| `resyncChangesApplyDifferences` | Replace any local items with the versions from the server (including deletes) if you're sure that the service was up to date with your local changes when you last synchronized. Upload any local changes that the server doesn't know about. | -| `resyncChangesUploadDifferences` | Upload any local items that the service did not return, and upload any items that differ from the versions from the server (keep both copies if you're not sure which one is more up-to-date). | +| `resyncChangesApplyDifferences` | Replace any local items with the versions from the server (including deletes) if you're sure that the service was up-to-date with your local changes when you last synchronized. Upload any local changes that the server doesn't know about. | +| `resyncChangesUploadDifferences` | Upload any local items that the service didn't return and upload any items that differ from the versions from the server. Keep both copies if you're not sure which one is more up-to-date. | -In addition to the resync errors and for more details about how errors are returned, see [Microsoft Graph error responses and resource types][error-response]. +In addition to the resync errors and for more details about how errors are returned, see [Microsoft Graph error responses and resource types](/graph/errors). ## Examples ### Example 1: Initial request -The following is an example of the initial request that shows how to call this API to establish your local state. +The following example shows an initial request and how to call this API to establish your local state. #### Request -The following is an example of the initial request. -+The following example shows an initial request. # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_listItem_delta_first", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE", "22e03ef3-6ef4-424d-a1d3-92a337807c30"] } --> GET https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370- #### Response -The following is an example of the response that includes the first page of changes and the **@odata.nextLink** property that indicates that no more items are available in the current set of items. Your app should continue to request the URL value of **@odata.nextLink** until all pages of items have been retrieved. +The following example shows the response that includes the first page of changes and the **@odata.nextLink** property that indicates that no more items are available in the current set of items. Your app should continue to request the URL value of **@odata.nextLink** until all pages of items have been retrieved. -<!-- { "blockType": "response", "name": "get_listItem_delta_first", "@odata.type": "microsoft.graph.listItem", "isCollection": true, "truncated": true, "scope": "site.read" } --> +<!-- { "blockType": "response", "name": "get_listItem_delta_first", "@odata.type": "Collection(microsoft.graph.listItem)", "truncated": true, "scope": "site.read" } --> ```http HTTP/1.1 200 OK Content-type: application/json {- "value": [ - { - "createdDateTime": "2020-06-02T22:46:58Z", - "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"", - "id": "1", - "lastModifiedDateTime": "2021-10-14T23:27:27Z", - "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder", - "createdBy": { - "user": { - "displayName": "John doe", - } - }, - "parentReference": { - "id": "1", - "path": "Shared%20Documents", - "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" - }, - "contentType": { - "id": "0x00123456789abc", - "name": "Folder" - } - }, - { - "createdDateTime": "2020-06-02T22:46:58Z", - "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC067},756\"", - "id": "2", - "lastModifiedDateTime": "2021-10-14T23:27:27Z", - "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemA.txt", - "createdBy": { - "user": { - "displayName": "John doe", - } - }, - "parentReference": { - "id": "2", - "path": "Shared%20Documents", - "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" - }, - "contentType": { - "id": "0x00123456789abc", - "name": "Document" - } - }, - { - "createdDateTime": "2020-06-02T22:46:58Z", - "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC068},756\"", - "id": "3", - "lastModifiedDateTime": "2021-10-14T23:27:27Z", - "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemB.txt", - "createdBy": { - "user": { - "displayName": "John doe", - } - }, - "parentReference": { - "id": "3", - "path": "Shared%20Documents", - "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" - }, - "contentType": { - "id": "0x00123456789abc", - "name": "Document" - } + "value": [ + { + "createdDateTime": "2020-06-02T22:46:58Z", + "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"", + "id": "1", + "lastModifiedDateTime": "2021-10-14T23:27:27Z", + "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder", + "createdBy": { + "user": { + "displayName": "John doe" + } + }, + "parentReference": { + "id": "1", + "path": "Shared%20Documents", + "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" + }, + "contentType": { + "id": "0x00123456789abc", + "name": "Folder" + } + }, + { + "createdDateTime": "2020-06-02T22:46:58Z", + "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC067},756\"", + "id": "2", + "lastModifiedDateTime": "2021-10-14T23:27:27Z", + "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemA.txt", + "createdBy": { + "user": { + "displayName": "John doe" + } + }, + "parentReference": { + "id": "2", + "path": "Shared%20Documents", + "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" + }, + "contentType": { + "id": "0x00123456789abc", + "name": "Document" + } + }, + { + "createdDateTime": "2020-06-02T22:46:58Z", + "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC068},756\"", + "id": "3", + "lastModifiedDateTime": "2021-10-14T23:27:27Z", + "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemB.txt", + "createdBy": { + "user": { + "displayName": "John doe" }- ], - "@odata.nextLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka" + }, + "parentReference": { + "id": "3", + "path": "Shared%20Documents", + "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" + }, + "contentType": { + "id": "0x00123456789abc", + "name": "Document" + } + } + ], + "@odata.nextLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka" } ``` The following example shows a request that gets the last page in a set and how t The following example shows a request after the initial request. - # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-listItem-delta-last", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE","22e03ef3-6ef4-424d-a1d3-92a337807c30"] }--> GET https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370- #### Response -The following is an example of the response that indicates that the item named `TestItemB.txt` was deleted and the item `TestFolder` was either added or modified between the initial request and this request to update the local state. --The final page of items will include the **@odata.deltaLink** property, which provides the URL that can be used later to retrieve changes since the current set of items. +The following example shows the response that indicates that the item named `TestItemB.txt` was deleted and the item `TestFolder` was either added or modified between the initial request and this request to update the local state. +The final page of items includes the **@odata.deltaLink** property that provides the URL that can be used later to retrieve changes since the current set of items. -<!-- { "blockType": "response", "name": "get-listItem-delta-last", "truncated": true, "@odata.type": "microsoft.graph.listItem", "isCollection": true, "scope": "site.read" } --> +<!-- { "blockType": "response", "name": "get-listItem-delta-last", "truncated": true, "@odata.type": "Collection(microsoft.graph.listItem)", "scope": "site.read" } --> ```http HTTP/1.1 200 OK Content-type: application/json {- "value": [ - { - "createdDateTime": "2020-06-02T22:46:58Z", - "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"", - "id": "1", - "lastModifiedDateTime": "2016-03-21T20:01:37Z", - "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder", - "createdBy": { - "user": { - "displayName": "John doe", - } - }, - "parentReference": { - "id": "1", - "path": "Shared%20Documents", - "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" - }, - "contentType": { - "id": "0x00123456789abc", - "name": "Folder" - } - }, - { - "id": "3", - "parentReference": { - "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" - }, - "contentType": { - "id": "0x00123456789abc", - "name": "Document" - }, - "deleted": {"state": "deleted"} + "value": [ + { + "createdDateTime": "2020-06-02T22:46:58Z", + "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"", + "id": "1", + "lastModifiedDateTime": "2016-03-21T20:01:37Z", + "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder", + "createdBy": { + "user": { + "displayName": "John doe" }- ], - "@odata.deltaLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka" + }, + "parentReference": { + "id": "1", + "path": "Shared%20Documents", + "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" + }, + "contentType": { + "id": "0x00123456789abc", + "name": "Folder" + } + }, + { + "id": "3", + "parentReference": { + "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" + }, + "contentType": { + "id": "0x00123456789abc", + "name": "Document" + }, + "deleted": { + "state": "deleted" + } + } + ], + "@odata.deltaLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka" } ``` ### Example 3: Delta link request -In some scenarios, it might be useful to request the current `deltaLink` value without first enumerating all of the items in the list already. This can be useful if your app only wants to know about changes and doesn't need to know about existing items. +In some scenarios, you might want to request the current `deltaLink` value without first enumerating all of the items in the list already. This can be useful if your app only wants to know about changes and doesn't need to know about existing items. To retrieve the latest `deltaLink`, call `delta` with the query string parameter `?token=latest`. #### Request The following example shows a request. - # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-delta-latest_datalink_tokenislatest", "scope": "sites.read", "target": "action", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE","22e03ef3-6ef4-424d-a1d3-92a337807c30"] } --> ```msgraph-interactive-GET /sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=latest +GET https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=latest ``` # [C#](#tab/csharp) GET /sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3- The following example shows the response. -<!-- { "blockType": "response", "name": "get-delta-latest_datalink_tokenislatest", "isEmpty": true, "@odata.type": "microsoft.graph.listItem", "isCollection": true } --> +<!-- { "blockType": "response", "name": "get-delta-latest_datalink_tokenislatest", "isEmpty": true, "@odata.type": "Collection(microsoft.graph.listItem)" } --> ```http HTTP/1.1 200 OK Content-type: application/json {- "value": [ ], - "@odata.deltaLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka" + "value": [ ], + "@odata.deltaLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka" } ``` ## Related content-[Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) -[Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance) -[error-response]: /graph/errors +- [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) +- [Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance) <!-- { "type": "#page.annotation", |
v1.0 | Mailfolder Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mailfolder-get.md | This method supports the [OData Query Parameters](/graph/query-parameters) to he ## Request headers -| Name | Type | Description | -|:--|:-|:--| -| Authorization | string | Bearer {token}. Required. | +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Managedtenants Managedtenant List Tenantscustomizedinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenantscustomizedinformation.md | GET /tenantRelationships/managedTenants/tenantsCustomizedInformation This method supports the [OData query parameters](/graph/query-parameters) to help customize the response, including `$apply`, `$count`, `$filter`, `$orderby`, `$select`, `$skip`, and `$top`. ## Request headers-|Name|Description| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +| 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. Content-Type: application/json "email": "hector@fourthcoffee.com", "phone": "5558009732" }+ ], + "businessRelationship": "Managed", + "complianceRequirements": [ + "NIST", + "HIPPA" + ], + "managedServicesPlans": [ + "Microsoft Entra ID P1" + ], + "note": "This is a test note.", + "noteLastModifiedDateTime": "2024-04-03 00:10:21.1989208", + "partnerRelationshipManagerUserIds": [ + "3c23994c-711b-46f6-ab1e-0aeef19413f3" ] }, { Content-Type: application/json "email": "timothy@consolidatedmessenger.com", "phone": "5558001379" }+ ], + "businessRelationship": "Managed", + "complianceRequirements": [ + "CMMC" + ], + "managedServicesPlans": [ + "Microsoft 365 Business Premium" + ], + "note": "This is another test note", + "noteLastModifiedDateTime": "2024-04-01 18:15:23.00", + "partnerRelationshipManagerUserIds": [ + "8c6881ca-8968-4650-adeb-6ec34180098c" ] } ] |
v1.0 | Meetingattendancereport Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingattendancereport-get.md | GET /me/onlineMeetings/{meetingId}/meetingAttendanceReport GET /users/{userId}/onlineMeetings/{meetingId}/meetingAttendanceReport ``` -To get an attendance report for a webinar session by ID: +To get an attendance report for a webinar session by ID with delegated and app permission: <!-- { "blockType": "ignored" }--> ``` http GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports/{reportId} |
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 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] > GET /me/onlineMeetings/{meetingId}/attendanceReports GET /users/{userId}/onlineMeetings/{meetingId}/attendanceReports ``` -To get all attendance reports for a webinar session: +To get all attendance reports for a webinar session with delegated and app permission: <!-- { "blockType": "ignored" } --> ``` http GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports |
v1.0 | Mobileappmanagementpolicies Delete Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-delete-includedgroups.md | Namespace: microsoft.graph Delete a group from the list of groups included in a mobile app management policy. ## Permissions DELETE https://graph.microsoft.com/beta/policies/mobileAppManagementPolicies/ab9 [!INCLUDE [sample-code](../includes/snippets/php/delete-group-groupid-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-group-groupid-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Mobileappmanagementpolicies Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-delete.md | Delete a [mobilityManagementPolicy](../resources/mobilitymanagementpolicy.md) ob > [!NOTE] > This operation is only supported when the policy is no longer valid; that is, when the **isValid** property is false, which indicates that the service principal associated with the application for this policy has been deleted. ## Permissions |
v1.0 | Mobileappmanagementpolicies Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-get.md | Namespace: microsoft.graph Read the properties and relationships of a [mobilityManagementPolicy](../resources/mobilitymanagementpolicy.md) object. ## Permissions |
v1.0 | Mobileappmanagementpolicies List Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-list-includedgroups.md | Namespace: microsoft.graph Get the list of groups that are included in a mobile app management policy. ## Permissions |
v1.0 | Mobileappmanagementpolicies List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-list.md | Namespace: microsoft.graph Get a list of the [mobilityManagementPolicy](../resources/mobilitymanagementpolicy.md) objects and their properties. ## Permissions |
v1.0 | Mobileappmanagementpolicies Post Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-post-includedgroups.md | Namespace: microsoft.graph Add groups to be included in a mobile app management policy. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Mobileappmanagementpolicies Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-update.md | Namespace: microsoft.graph Update the properties of a [mobilityManagementPolicy](../resources/mobilitymanagementpolicy.md) object. ## Permissions |
v1.0 | Mobiledevicemanagementpolicies Delete Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-delete-includedgroups.md | Namespace: microsoft.graph Delete a group from the list of groups included in a mobile device management policy. ## Permissions DELETE https://graph.microsoft.com/beta/policies/mobileDeviceManagementPolicies/ [!INCLUDE [sample-code](../includes/snippets/php/delete-group-included-groups-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-group-included-groups-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Mobiledevicemanagementpolicies Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-delete.md | Delete a [mobilityManagementPolicy](../resources/mobilitymanagementpolicy.md) ob > [!NOTE] > This operation is only supported when the policy is no longer valid; that is, when the **isValid** property is false, which indicates that the service principal associated with the application for this policy has been deleted. ## Permissions |
v1.0 | Mobiledevicemanagementpolicies Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-get.md | Namespace: microsoft.graph Read the properties and relationships of a [mobilityManagementPolicy](../resources/mobilitymanagementpolicy.md) object. ## Permissions |
v1.0 | Mobiledevicemanagementpolicies List Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-list-includedgroups.md | Namespace: microsoft.graph Get the list of groups that are included in a mobile device management policy. ## Permissions |
v1.0 | Mobiledevicemanagementpolicies List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-list.md | Namespace: microsoft.graph Get a list of the [mobilityManagementPolicy](../resources/mobilitymanagementpolicy.md) objects and their properties. ## Permissions |
v1.0 | Mobiledevicemanagementpolicies Post Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-post-includedgroups.md | Namespace: microsoft.graph Add groups to be included in a mobile app management policy. ## Permissions |
v1.0 | Mobiledevicemanagementpolicies Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-update.md | Namespace: microsoft.graph Update the properties of a [mobilityManagementPolicy](../resources/mobilitymanagementpolicy.md) object. ## Permissions |
v1.0 | Monthlyuserinsightmetricsroot List Activeusersbreakdown | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/monthlyuserinsightmetricsroot-list-activeusersbreakdown.md | - Title: "List monthly activeUsersBreakdown (deprecated)" -description: "Get a list of monthly activeUsersBreakdown objects on apps registered in your tenant configured for Microsoft Entra External ID for customers." ---doc_type: apiPageType ---# List monthly activeUsersBreakdown (deprecated) -Namespace: microsoft.graph ---> [!CAUTION] -> This API is deprecated and will stop returning data on March 9, 2024. Use the [List monthly activeUsers](../api/monthlyuserinsightmetricsroot-list-activeusers.md) API instead. --Get a list of monthly [activeUsersBreakdown](../resources/activeusersbreakdownmetric.md) objects on apps registered in your tenant configured for Microsoft Entra External ID for customers. ---## Permissions -Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "monthlyuserinsightmetricsroot_list_activeusersbreakdown" } --> ---## HTTP request -<!-- { - "blockType": "ignored" -} >-``` http -GET /reports/userInsights/monthly/activeUsersBreakdown -``` --## Optional query parameters -This method supports the `$filter` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). --## Request headers -|Name|Description| -|:|:| -|Authorization|Bearer {token}. Required. 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 [activeUsersBreakdownMetric](../resources/activeusersbreakdownmetric.md) objects in the response body. --## Examples --### Request -The following example shows a request. -# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "list_monthlyctiveusersbreakdownmetric" -} >-``` http -GET https://graph.microsoft.com/beta/reports/userInsights/monthly/activeUsersBreakdown -``` --# [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.activeUsersBreakdownMetric)" -} >-``` http -HTTP/1.1 200 OK -Content-Type: application/json --{ - "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.activeUsersBreakdownMetric)", - "value": [ - { - "id": "2", - "appId": "Groceries API", - "appName": "b97b956d-e881-43b9-9384-5dd684cd7f57", - "count": 3, - "factDate": "2023-07-01", - "os": "Windows" - }, - { - "id": "2", - "appId": "Groceries", - "appName": "10e90284-3cc4-4d82-d641-55ff4068c633", - "count": 9, - "factDate": "2023-07-01", - "os": "MacOs" - } - ] -} -``` |
v1.0 | Multitenantorganization Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/multitenantorganization-update.md | 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/update-multitenantorganization-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 | Networkaccess Branchconnectivityconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchconnectivityconfiguration-get.md | Title: "Get branchConnectivityConfiguration" + Title: "Get branchConnectivityConfiguration (deprecated)" description: "Retrieve the IPSec tunnel configuration required to establish a bidirectional communication link between your organization's router and Microsoft's gateway." ms.localizationpriority: medium-# Get branchConnectivityConfiguration +# Get branchConnectivityConfiguration (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetworkConnectivityConfiguration resource type](../resources/networkaccess-remotenetworkconnectivityconfiguration.md) and its associated methods instead. + Retrieve the IPSec tunnel configuration required to establish a bidirectional communication link between your organization's router and the Microsoft gateway. This information is vital for configuring your router (customer premise equipment) after creating a [deviceLink](../resources/networkaccess-devicelink.md). [!INCLUDE [national-cloud-support](../../includes/global-only.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 | Title: "Delete deviceLink" -description: "Removes the link between the branch and the CPE device, effectively removing the connection and associated configuration between them." + Title: "Delete deviceLink (deprecated)" +description: "Removes the link between the branch or remote network and the CPE device, effectively removing the connection and associated configuration between them." ms.localizationpriority: medium doc_type: apiPageType -# Delete deviceLink +# Delete deviceLink (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Removes the link between the branch and the CPE device, effectively removing the connection and associated configuration between them. +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. ++Removes the link between the branch or remote network and the CPE device, effectively removing the connection and associated configuration between them. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "delete_devicelink" + "name": "delete_devicelink_deprecated" } --> ``` http DELETE https://graph.microsoft.com/beta/networkAccess/connectivity/branches/{bra ``` # [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)] # [Python](#tab/python) [!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 | Title: "Delete branchSite" + Title: "Delete branchSite (deprecated)" description: "Delete a specific branch." ms.localizationpriority: medium-# Delete branchSite +# Delete branchSite (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. + Delete a specific branch. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] |
v1.0 | Networkaccess Branchsite Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-get.md | Title: "Get branchSite" + Title: "Get branchSite (deprecated)" description: "Retrieve information about a specific branch." ms.localizationpriority: medium-# Get branchSite +# Get branchSite (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. + Retrieve information about a specific branch. [!INCLUDE [national-cloud-support](../../includes/global-only.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 | Title: "List deviceLinks" + Title: "List deviceLinks (deprecated)" description: "Retrieve a list of device links associated with a specific branch." ms.localizationpriority: medium-# List deviceLinks +# List deviceLinks (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. + Retrieve a list of device links associated with a specific branch. [!INCLUDE [national-cloud-support](../../includes/global-only.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 | Title: "List forwardingProfiles (for a branch)" + Title: "List forwardingProfiles (deprecated)" description: "Retrieve a list of traffic forwarding profiles associated with a branch." ms.localizationpriority: medium-# List forwardingProfiles (for a branch) +# List forwardingProfiles (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. + Retrieve a list of traffic forwarding profiles associated with a branch. [!INCLUDE [national-cloud-support](../../includes/global-only.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 | Title: "Create deviceLink" + Title: "Create deviceLink (deprecated)" description: "Create a branch site with associated device links." ms.localizationpriority: medium-# Create deviceLink +# Create deviceLink (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. + Create a branch site with associated device links. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] |
v1.0 | Networkaccess Branchsite Post Forwardingprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-post-forwardingprofiles.md | Title: "Assign a forwardingProfile to a branchSite" + Title: "Assign a forwardingProfile (deprecated)" description: "Create a new branch and assign a forwarding profile." ms.localizationpriority: medium-# Create forwardingProfile +# Create forwardingProfile (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. + Create a new branch and assign a forwarding profile. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] |
v1.0 | Networkaccess Branchsite Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-update.md | Title: "Update branch" + Title: "Update branch (deprecated)" description: "Update the configuration or properties of a specific branch." ms.localizationpriority: medium-# Update branchSite +# Update branchSite (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. + Update the configuration or properties of a specific branch. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] |
v1.0 | Networkaccess Connectivity Delete Remotenetworks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-connectivity-delete-remotenetworks.md | + + Title: "Delete remoteNetwork" +description: "Delete a specific remote network." ++ms.localizationpriority: medium ++++# Delete remoteNetwork +Namespace: microsoft.graph.networkaccess +++Delete a specific remote network. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "networkaccess-connectivity-delete-remotenetworks-permissions" +} +--> +++## HTTP request ++``` http +DELETE /networkAccess/connectivity/remoteNetworks/{remoteNetworkId}/$ref +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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 is an example of a request. ++### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` ++ |
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 | Title: "List branches" + Title: "List branches (deprecated)" description: "Retrieve a list of branches within a tenant connected to the Global Secure Access services." ms.localizationpriority: medium-# List branches +# List branches (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. + Retrieve a list of branches within a tenant connected to the Global Secure Access services. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] |
v1.0 | Networkaccess Connectivity List Remotenetworks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-connectivity-list-remotenetworks.md | + + Title: "List remoteNetworks" +description: "Retrieve a list of remote networks within a tenant connected to the Global Secure Access." ++ms.localizationpriority: medium ++++# List remoteNetworks +Namespace: microsoft.graph.networkaccess +++Retrieve a list of remote networks within a tenant connected to the Global Secure Access services. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "networkaccess-connectivity-list-remotenetworks-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /networkAccess/connectivity/remoteNetworks +``` ++## Optional query parameters +This method supports the `$expand` and `$select` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) objects in the response body. ++## Examples ++### Request +The following is an example of a request. ++``` http +GET https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks +``` ++### 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.networkaccess.remoteNetwork)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET networkAccess/connectivity/remoteNetworks?$select=bandwidthCapacity,connectivityState", + "value": [ + { + "id": "dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04", + "name": "Test branch", + "region": "canadaEast", + "version": "1.0.0", + "lastModifiedDateTime": "2023-12-12T14:26:24Z", + "forwardingProfiles@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04')/forwardingProfiles", + "forwardingProfiles": [ + { + "trafficForwardingType": "m365", + "priority": 0, + "id": "1adaf535-1e31-4e14-983f-2270408162bf", + "name": "Microsoft 365 traffic forwarding profile", + "description": "Default traffic forwarding profile for Microsoft 365 traffic acquisition. Assign the profile to client or branch offices to acquire Microsoft 365 traffic for Zero Trust Network Access.", + "state": "disabled", + "version": "1.0.0", + "lastModifiedDateTime": "2024-01-22T12:10:49Z", + "associations": [ + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "9ffbc1a5-2916-4fb4-b277-76cdc89cc491" + }, + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04" + }, + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "43c7a0d3-1072-4da1-9e30-e513b02bb559" + }, + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "4ecfc62c-ec85-42fd-af37-5a93c7deb1d9" + } + ] + } + ], + "deviceLinks@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04')/deviceLinks", + "deviceLinks": [ + { + "id": "47aab2e9-7f5c-42ba-bbfc-1b049193126a", + "name": "name", + "ipAddress": "1.2.3.1", + "bandwidthCapacityInMbps": "mbps500", + "deviceVendor": "barracudaNetworks", + "lastModifiedDateTime": "2023-12-12T14:26:24Z", + "bgpConfiguration": { + "localIpAddress": "10.1.1.1", + "peerIpAddress": "10.2.2.1", + "asn": 899 + }, + "redundancyConfiguration": { + "zoneLocalIpAddress": null, + "redundancyTier": "noRedundancy" + }, + "tunnelConfiguration": { + "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default", + "preSharedKey": "dcf" + } + } + ] + }, + { + "id": "43c7a0d3-1072-4da1-9e30-e513b02bb559", + "name": "USA branch 1", + "region": "eastUS", + "version": "1.0.0", + "lastModifiedDateTime": "2024-01-17T19:23:32Z", + "forwardingProfiles@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('43c7a0d3-1072-4da1-9e30-e513b02bb559')/forwardingProfiles", + "forwardingProfiles": [ + { + "trafficForwardingType": "m365", + "priority": 0, + "id": "1adaf535-1e31-4e14-983f-2270408162bf", + "name": "Microsoft 365 traffic forwarding profile", + "description": "Default traffic forwarding profile for Microsoft 365 traffic acquisition. Assign the profile to client or branch offices to acquire Microsoft 365 traffic for Zero Trust Network Access.", + "state": "disabled", + "version": "1.0.0", + "lastModifiedDateTime": "2024-01-22T12:10:49Z", + "associations": [ + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "9ffbc1a5-2916-4fb4-b277-76cdc89cc491" + }, + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04" + }, + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "43c7a0d3-1072-4da1-9e30-e513b02bb559" + }, + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "4ecfc62c-ec85-42fd-af37-5a93c7deb1d9" + } + ] + } + ], + "deviceLinks@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('43c7a0d3-1072-4da1-9e30-e513b02bb559')/deviceLinks", + "deviceLinks": [ + { + "id": "6833faf3-b4ea-4cd4-a256-3ee71985e51d", + "name": "Cisco device 1", + "ipAddress": "20.1.1.1", + "bandwidthCapacityInMbps": "mbps1000", + "deviceVendor": "ciscoMeraki", + "lastModifiedDateTime": "2024-01-17T19:23:32Z", + "bgpConfiguration": { + "localIpAddress": "10.1.1.2", + "peerIpAddress": "10.2.2.2", + "asn": 65533 + }, + "redundancyConfiguration": { + "zoneLocalIpAddress": null, + "redundancyTier": "noRedundancy" + }, + "tunnelConfiguration": { + "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default", + "preSharedKey": "test123" + } + } + ] + } + ] +} +``` + |
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 | Title: "Create branch" + Title: "Create branch (deprecated)" description: "Create a new branch." ms.localizationpriority: medium-# Create branch +# Create branch (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. + Create a new branch. [!INCLUDE [national-cloud-support](../../includes/global-only.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 | + + Title: "Create remoteNetwork" +description: "Create a new remote network." ++ms.localizationpriority: medium ++++# Create remoteNetwork +Namespace: microsoft.graph.networkaccess +++Create a new remote network. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "networkaccess-connectivity-post-remotenetworks-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /networkAccess/connectivity/remoteNetworks +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) object. ++You can specify the following properties when creating a **remote network**. ++|Property|Type|Description| +|:|:|:| +|name|String|Name of the remote network. Required.| +|region|String|Specify the region closest to the remote network location. Required.| +++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) object in the response body. ++## Example 1: Create a remote network with just name and region ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_remoteNetwork_basic" +} +--> +``` http +POST https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks +Content-Type: application/json ++{ + "name": "Bellevue branch", + "region": "canadaEast" +} +``` ++# [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.networkaccess.remoteNetwork" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks/$entity", + "id": "8a273997-b84d-422f-8dec-e1dd82a4035b", + "name": "Bellevue branch", + "region": "canadaEast", + "version": "1.0.0", + "lastModifiedDateTime": "2024-02-01T00:41:48Z" +} +``` ++## Example 2: Create a remote network with forwarding profile +To get the ID of forwarding profiles of your organization, refer to this article - [List forwardingProfiles](networkaccess-networkaccessroot-list-forwardingprofiles.md). ++### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_remoteNetwork_with_forwardingProfile" +} +--> +``` http +POST https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks +Content-Type: application/json ++{ + "name": "Bellevue branch w/ fwd profile", + "region": "canadaEast", + "forwardingProfiles": [ + { + "id": "1adaf535-1e31-4e14-983f-2270408162bf" + } + ] +} +``` ++# [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.networkaccess.remoteNetwork" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks/$entity", + "id": "6542b28c-5ba7-4b50-9576-e63a6210e481", + "name": "Bellevue branch w/ fwd profile", + "region": "canadaEast", + "version": "1.0.0", + "lastModifiedDateTime": "2024-02-01T00:54:45Z" +} +``` ++## Example 3: Create a remote network with device link and forwarding profile +To get the ID of forwarding profiles of your organization, refer to this article - [List forwardingProfiles](networkaccess-networkaccessroot-list-forwardingprofiles.md). ++### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_remoteNetwork_with_forwardingProfile_deviceLink" +} +--> +``` http +POST https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks +Content-Type: application/json ++{ + "name": "Bellevue branch w/ device link", + "region": "canadaEast", + "forwardingProfiles": [ + { + "id": "1adaf535-1e31-4e14-983f-2270408162bf" + } + ], + "deviceLinks": [ + { + "name": "CPE1", + "ipAddress": "52.13.21.25", + "bandwidthCapacityInMbps": "mbps500", + "deviceVendor": "barracudaNetworks", + "bgpConfiguration": { + "localIpAddress": "192.168.1.2", + "peerIpAddress": "10.1.1.2", + "asn": 65533 + }, + "redundancyConfiguration": { + "zoneLocalIpAddress": null, + "redundancyTier": "noRedundancy" + }, + "tunnelConfiguration": { + "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default", + "preSharedKey": "test123" + } + } + ] +} +``` ++# [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.networkaccess.remoteNetwork" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks/$entity", + "id": "5d2f5061-4876-4c1c-ba2d-5acc6a73742d", + "name": "Bellevue branch w/ device link", + "region": "canadaEast", + "version": "1.0.0", + "lastModifiedDateTime": "2024-02-01T01:02:25Z" +} +``` |
v1.0 | Networkaccess Devicelink Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-devicelink-delete.md | + + Title: "Delete deviceLink" +description: "Removes the link between the remote network and the CPE device, effectively removing the connection and associated configuration between them." ++ms.localizationpriority: medium ++++# Delete deviceLink +Namespace: microsoft.graph.networkaccess +++Removes the link between the branch or remote network and the CPE device, effectively removing the connection and associated configuration between them. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "networkaccess_devicelink_delete" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /networkAccess/connectivity/remotenetworks/{remoteNetworkId}/deviceLinks/{deviceLinkId} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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 is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_devicelink" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/335d3a94-b5a9-41fd-b6dd-ae9a8d31a002/deviceLinks/17cb9017-4a33-424b-85fa-e62ff19531a9 +``` ++# [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 | Networkaccess Devicelink Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-devicelink-get.md | Title: "Get deviceLink" -description: "Retrieve the device link associated with a specific branch." -+description: "Retrieve the device link associated with a specific branch or remote network." + ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve the device link associated with a specific branch. +Retrieves a specific device link associated with a remote network. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [rbac-global-secure-access-apis-read](../includes/rbac-for-apis/rbac-global-secure-access-apis-read.md)] ## HTTP request-+> [!NOTE] +> The `/branches/{branchSiteId}/...` path will be retired soon. Use the `/remoteNetworks/{remoteNetworkId}/...` path instead. <!-- { "blockType": "ignored" } --> ``` http GET /networkAccess/connectivity/branches/{branchSiteId}/deviceLinks/{deviceLinkId}+GET /networkAccess/connectivity/remoteNetworks/{remoteNetworkId}/deviceLinks/{deviceLinkId} ``` ## Optional query parameters If successful, this method returns a `200 OK` response code and a [microsoft.gra ### 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/networkAccess/connectivity/branches/{branchSiteId}/deviceLinks/{deviceLinkId} +GET https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04/deviceLinks/47aab2e9-7f5c-42ba-bbfc-1b049193126a ``` # [C#](#tab/csharp) HTTP/1.1 200 OK Content-Type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/branches('047d69c4-2448-45cc-8c0a-40f3ad93c86c')/deviceLinks/$entity", - "id": "1030ca77-40e9-4cd3-bf71-b5d74c2f3cb0", - "name": "Backup Link", - "ipAddress": "24.123.22.168", - "version": "1.0.0", - "deviceVendor": "checkPoint", - "lastModifiedDateTime": "2023-05-23T09:19:30Z", + "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04')/deviceLinks/$entity", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET networkAccess/connectivity/remoteNetworks('<guid>')/deviceLinks('<guid>')?$select=bandwidthCapacityInMbps,bgpConfiguration", + "id": "47aab2e9-7f5c-42ba-bbfc-1b049193126a", + "name": "name", + "ipAddress": "1.2.3.1", + "bandwidthCapacityInMbps": "mbps500", + "deviceVendor": "barracudaNetworks", + "lastModifiedDateTime": "2024-01-27T07:09:17Z", "bgpConfiguration": {- "ipAddress": "1.128.24.22", - "asn": 4 + "localIpAddress": "1.2.1.1", + "peerIpAddress": "1.2.3.1", + "asn": 899 + }, + "redundancyConfiguration": { + "zoneLocalIpAddress": null, + "redundancyTier": "noRedundancy" }, "tunnelConfiguration": { "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default",- "preSharedKey": "342342342342342342342342" + "preSharedKey": "dcf" } } ``` |
v1.0 | Networkaccess Devicelink Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-devicelink-update.md | Title: "Update deviceLink" -description: "Update the device link associated with a specific branch." +description: "Update the device link associated with a specific branch or remote network." ms.localizationpriority: medium Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the device link associated with a specific branch. +Update the device link associated with a specific branch or remote network. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [rbac-global-secure-access-apis-write](../includes/rbac-for-apis/rbac-global-secure-access-apis-write.md)] ## HTTP request-+> [!NOTE] +> The `/branches/{branchSiteId}/...` path will be retired soon. Use the `/remoteNetworks/{remoteNetworkId}/...` path instead. <!-- { "blockType": "ignored" } --> ``` http PATCH /networkAccess/connectivity/branches/{branchSiteId}/deviceLinks/{deviceLinkId}+PATCH /networkAccess ``` ## Request headers |
v1.0 | Networkaccess Remotenetwork Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-remotenetwork-get.md | + + Title: "Get remoteNetwork" +description: "Retrieve information about a specific remote network." ++ms.localizationpriority: medium ++++# Get remoteNetwork +Namespace: microsoft.graph.networkaccess +++Retrieve information about a specific remote network. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "networkaccess-remotenetwork-get-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /networkAccess/connectivity/remoteNetworks/{remoteNetworkId} +``` ++## Optional query parameters +This method supports the `$expand` and `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [microsoft.graph.networkaccess.remoteNetworks](../resources/networkaccess-remotenetwork.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++``` http +GET https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04 +``` ++### Response +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.networkaccess.remoteNetwork" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks/$entity", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET networkAccess/connectivity/remoteNetworks('<guid>')?$select=bandwidthCapacity,connectivityState", + "id": "dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04", + "name": "Test branch", + "region": "canadaEast", + "version": "1.0.0", + "lastModifiedDateTime": "2023-12-12T14:26:24Z", + "forwardingProfiles@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04')/forwardingProfiles", + "forwardingProfiles": [ + { + "trafficForwardingType": "m365", + "priority": 0, + "id": "1adaf535-1e31-4e14-983f-2270408162bf", + "name": "Microsoft 365 traffic forwarding profile", + "description": "Default traffic forwarding profile for Microsoft 365 traffic acquisition. Assign the profile to client or branch offices to acquire Microsoft 365 traffic for Zero Trust Network Access.", + "state": "disabled", + "version": "1.0.0", + "lastModifiedDateTime": "2024-01-22T12:10:49Z", + "associations": [ + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "9ffbc1a5-2916-4fb4-b277-76cdc89cc491" + }, + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04" + }, + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "43c7a0d3-1072-4da1-9e30-e513b02bb559" + }, + { + "@odata.type": "#microsoft.graph.networkaccess.associatedBranch", + "branchId": "4ecfc62c-ec85-42fd-af37-5a93c7deb1d9" + } + ] + } + ], + "deviceLinks@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04')/deviceLinks", + "deviceLinks": [ + { + "id": "47aab2e9-7f5c-42ba-bbfc-1b049193126a", + "name": "name", + "ipAddress": "1.2.3.1", + "bandwidthCapacityInMbps": "mbps500", + "deviceVendor": "barracudaNetworks", + "lastModifiedDateTime": "2023-12-12T14:26:24Z", + "bgpConfiguration": { + "localIpAddress": "1.2.1.1", + "peerIpAddress": "1.2.3.1", + "asn": 899 + }, + "redundancyConfiguration": { + "zoneLocalIpAddress": null, + "redundancyTier": "noRedundancy" + }, + "tunnelConfiguration": { + "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default", + "preSharedKey": "dcf" + } + } + ] +} +``` |
v1.0 | Networkaccess Remotenetwork List Devicelinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-remotenetwork-list-devicelinks.md | + + Title: "List deviceLinks" +description: "Retrieve a list of device links associated with a specific remote network." ++ms.localizationpriority: medium ++++# List deviceLinks +Namespace: microsoft.graph.networkaccess +++Retrieve a list of device links associated with a specific remote network. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "networkaccess-remotenetwork-list-devicelinks-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /networkAccess/connectivity/remoteNetworks/{remoteNetworkId}/deviceLinks +``` ++## Optional query parameters ++This method supports the `$expand` [OData query parameter](/graph/query-parameters) to help customize the response. +++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) objects in the response body. ++## Examples ++### Request +The following is an example of a request. ++``` http +GET hhttps://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/4ecfc62c-ec85-42fd-af37-5a93c7deb1d9/deviceLinks +``` ++### 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.networkaccess.deviceLink)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('4ecfc62c-ec85-42fd-af37-5a93c7deb1d9')/deviceLinks", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET networkAccess/connectivity/remoteNetworks('<guid>')/deviceLinks?$select=bandwidthCapacityInMbps,bgpConfiguration", + "value": [ + { + "id": "109376bf-6dc7-4183-ab11-4a1206fb5e90", + "name": "VNG", + "ipAddress": "20.172.65.16", + "bandwidthCapacityInMbps": "mbps500", + "deviceVendor": "other", + "lastModifiedDateTime": "2024-01-17T20:59:13Z", + "bgpConfiguration": { + "localIpAddress": "192.168.1.2", + "peerIpAddress": "10.0.2.5", + "asn": 65533 + }, + "redundancyConfiguration": { + "zoneLocalIpAddress": "192.168.1.3", + "redundancyTier": "zoneRedundancy" + }, + "tunnelConfiguration": { + "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default", + "preSharedKey": "test123" + } + } + ] +} +``` |
v1.0 | Networkaccess Remotenetwork List Forwardingprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-remotenetwork-list-forwardingprofiles.md | + + Title: "List forwardingProfiles (for a remote network)" +description: "Retrieve a list of traffic forwarding profiles associated with a remote network." ++ms.localizationpriority: medium ++++# List forwardingProfiles (for a remote network) +Namespace: microsoft.graph.networkaccess +++Retrieve a list of traffic forwarding profiles associated with a remote network. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "networkaccess-remotenetwork-list-forwardingprofiles-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /networkAccess/connectivity/remoteNetworks/{remoteNetworkId}/forwardingProfiles +``` ++## Optional query parameters +This method does not support any OData query parameters. ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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 [forwardingProfile](../resources/networkaccess-forwardingprofile.md) objects in the response body. ++## Examples ++### Request +The following is an example of a request. ++``` http +GET https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04/forwardingProfiles +``` ++### 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.networkaccess.forwardingProfile)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "http://graph.microsoft.com/beta/networkAccess/$metadata#forwardingProfiles", + "value": [ + { + "id": "19a92090-c14e-4cea-a933-27d38f72c4d1", + "name": "forwardingProfile 1", + "description": "some description", + "state": "disabled", + "version": "13", + "lastModifiedDate": "2022-06-13T08:22:14Z", + "trafficForwardingType": "m365", + "priority": 500, + "associations" : [ + { + "@odata.type": "microsoft.graph.networkAccess.AssociatedBranch", + "branchId": "19a92090-c14e-4cea-a933-27d38f72c64s" + } + ], + } + ] +} +``` + |
v1.0 | Networkaccess Remotenetwork Post Devicelinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-remotenetwork-post-devicelinks.md | + + Title: "Create deviceLink" +description: "Create device link for a remote network" ++ms.localizationpriority: medium ++++# Create deviceLink +Namespace: microsoft.graph.networkaccess +++Create device link for a remote network. To create a remote network and device link in the same request, refer to [Create remote network](networkaccess-connectivity-post-remotenetworks.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": "networkaccess-remotenetwork-post-devicelinks-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /networkAccess/connectivity/remoteNetworks/{remoteNetworkId}/deviceLinks +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) object. ++You can specify the following properties when creating a **deviceLink**. ++|Property|Type|Description| +|:|:|:| +|name|String|The name or identifier associated with a device link. Required.| +|ipAddress|String|The IP address associated with a device link. Required.| +|deviceVendor|microsoft.graph.networkaccess.deviceVendor|The vendor or manufacturer of the device associated with a device link. The possible values are: `barracudaNetworks`, `checkPoint`, `ciscoMeraki`, `citrix`, `fortinet`, `hpeAruba`, `netFoundry`, `nuage`, `openSystems`, `paloAltoNetworks`, `riverbedTechnology`, `silverPeak`, `vmWareSdWan`, `versa`, `other`. Required.| +|tunnelConfiguration|[microsoft.graph.networkaccess.tunnelConfiguration](../resources/networkaccess-tunnelconfiguration.md)|The tunnel configuration settings associated with a device link. Required.| +|bgpConfiguration|[microsoft.graph.networkaccess.bgpConfiguration](../resources/networkaccess-bgpconfiguration.md)|The Border Gateway Protocol (BGP) configuration settings associated with a device link. Required.| +|redundancyConfiguration|[microsoft.graph.networkaccess.redundancyConfiguration](../resources/networkaccess-redundancyconfiguration.md)|The redundancy option for a device link specifies the specific details and configuration settings related to redundancy. Required.| +++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) object in the response body. ++## Example 1: Add a device link with default IKE policy ++### Request +The following example shows a request. ++``` http +POST https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04/deviceLinks +Content-Type: application/json +{ + "name": "CPE3", + "ipAddress": "20.55.91.42", + "deviceVendor": "ciscoMeraki", + "bandwidthCapacityInMbps": "mbps1000", + "bgpConfiguration": { + "localIpAddress": "192.168.1.2", + "peerIpAddress": "10.2.2.2", + "asn": 65533 + }, + "redundancyConfiguration": { + "redundancyTier": "zoneRedundancy", + "zoneLocalIpAddress": "192.168.1.3" + }, + "tunnelConfiguration": { + "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default", + "preSharedKey": "test123" + } +} +``` +### 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.networkaccess.deviceLink" +} +--> +``` http +HTTP/1.1 204 No Content ++``` ++## Example 2: Add a device link with custom IKE policy ++### Request +The following example shows a request. ++``` http +POST https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04/deviceLinks +Content-Type: application/json ++{ + "name": "custom link", + "ipAddress": "114.20.4.14", + "deviceVendor": "ciscoMeraki", + "tunnelConfiguration": { + "saLifeTimeSeconds": 300, + "ipSecEncryption": "gcmAes128", + "ipSecIntegrity": "gcmAes128", + "ikeEncryption": "aes128", + "ikeIntegrity": "sha256", + "dhGroup": "ecp384", + "pfsGroup": "ecp384", + "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Custom", + "preSharedKey": "SHAREDKEY" + }, + "bgpConfiguration": { + "localIpAddress": "10.1.1.11", + "peerIpAddress": "10.6.6.6", + "asn": 65000 + }, + "redundancyConfiguration": { + "redundancyTier": "zoneRedundancy", + "zoneLocalIpAddress": "10.1.1.12" + }, + "bandwidthCapacityInMbps": "mbps250" +} +``` ++### 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.networkaccess.deviceLink" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{} +``` |
v1.0 | Networkaccess Remotenetwork Post Forwardingprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-remotenetwork-post-forwardingprofiles.md | + + Title: "Assign forwardingProfile" +description: "Assign a forwarding profile to a remote network" ++ms.localizationpriority: medium ++++# Assign forwardingProfile +Namespace: microsoft.graph.networkaccess +++Assign a forwarding profile to an existing remote network. To create a remote network with traffic forwarding profile, see [Create remoteNetwork](networkaccess-connectivity-post-remotenetworks.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": "networkaccess-remotenetwork-post-forwardingprofiles-permissions" +} +--> ++++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /networkAccess/connectivity/remoteNetworks/{remoteNetworkId}/forwardingProfiles +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [microsoft.graph.networkaccess.forwardingProfile](../resources/networkaccess-forwardingprofile.md) object. ++You can specify the following properties when associating a **forwardingProfile** to a remote network. ++|Property|Type|Description| +|:|:|:| +|id|String|ID of the forwarding profile. Inherited from [microsoft.graph.networkaccess.profile](../resources/networkaccess-profile.md). Required.| ++## Response ++If successful, this method returns a `OK 200` response code. ++## Examples +To get the id of forwarding profiles of your organization, refer to this article - [List forwardingProfiles](networkaccess-networkaccessroot-list-forwardingprofiles.md). ++### Request +The following example shows a request. ++``` http +PATCH https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/{remoteNetworkId}/forwardingProfiles +Content-Type: application/json ++{ + "@context": "#$delta", + "value": [ + { + "id": "1adaf535-1e31-4e14-983f-2270408162bf" + } + ] +} +``` ++### 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 200 OK +``` + |
v1.0 | Networkaccess Remotenetwork Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-remotenetwork-update.md | + + Title: "Update remoteNetwork" +description: "Update the configuration or properties of a specific remote etwork." ++ms.localizationpriority: medium ++++# Update remoteNetwork +Namespace: microsoft.graph.networkaccess +++Update the configuration or properties of a specific remote network. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "networkaccess-remotenetwork-update-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /networkAccess/connectivity/remoteNetworks/{remoteNetworkId} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|name|String|Name of the remote network.| ++## Response ++If successful, this method returns a `200 OK` response code and a [microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++``` http +PATCH https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04 +Content-Type: application/json ++{ + "name": "Test Redmond branch" +} +``` +++### 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.networkaccess.remoteNetwork" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks/$entity", + "id": "dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04", + "name": "Test Redmond branch", + "region": "canadaEast", + "version": "1.0.0", + "lastModifiedDateTime": "2024-01-27T06:16:14Z", + "forwardingProfiles@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04')/forwardingProfiles", + "forwardingProfiles": [], + "deviceLinks@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04')/deviceLinks", + "deviceLinks": [ + { + "id": "47aab2e9-7f5c-42ba-bbfc-1b049193126a", + "name": "name", + "ipAddress": "1.2.3.1", + "bandwidthCapacityInMbps": "mbps500", + "deviceVendor": "barracudaNetworks", + "lastModifiedDateTime": "2024-01-27T06:16:14Z", + "bgpConfiguration": { + "localIpAddress": "1.2.1.1", + "peerIpAddress": "1.2.3.1", + "asn": 899 + }, + "redundancyConfiguration": { + "zoneLocalIpAddress": null, + "redundancyTier": "noRedundancy" + }, + "tunnelConfiguration": { + "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default", + "preSharedKey": "dcf" + } + } + ] +} +``` ++ |
v1.0 | Networkaccess Remotenetworkconnectivityconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-remotenetworkconnectivityconfiguration-get.md | + + Title: "Get remoteNetworkConnectivityConfiguration" +description: "Retrieve the IPSec tunnel configuration required to establish a bidirectional communication link between your organization's router and Microsoft's gateway." ++ms.localizationpriority: medium ++++# Get remoteNetworkConnectivityConfiguration +Namespace: microsoft.graph.networkaccess +++Retrieve the IPSec tunnel configuration required to establish a bidirectional communication link between your organization's router and the Microsoft gateway. This information is vital for configuring your router (customer premise equipment) after creating a [deviceLink](../resources/networkaccess-devicelink.md). Refer to [Configure customer premises equipment for Global Secure Access](/entra/global-secure-access/how-to-configure-customer-premises-equipment?tabs=microsoft-entra-admin-center) to understand how to use this information to set up your router. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "networkaccess-remotenetworkconnectivityconfiguration-get-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /networkAccess/connectivity/remoteNetworks/{remoteNetworkId}/connectivityConfiguration +``` ++## Optional query parameters +This method does not supports OData query parameters. ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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.networkaccess.remoteNetworkConnectivityConfiguration](../resources/networkaccess-remotenetworkconnectivityconfiguration.md) object in the response body. ++## Examples ++### Request +The following example shows a request. ++``` http +GET https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/dc6a7efd-6b2b-4c6a-84e7-5dcf97e62e04/connectivityConfiguration +``` ++### 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.networkaccess.remoteNetworkConnectivityConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('4ecfc62c-ec85-42fd-af37-5a93c7deb1d9')/connectivityConfiguration/$entity", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET networkAccess/connectivity/remoteNetworks('<guid>')/connectivityConfiguration?$select=remoteNetworkId,remoteNetworkName", + "remoteNetworkId": "4ecfc62c-ec85-42fd-af37-5a93c7deb1d9", + "remoteNetworkName": "Abhijeet Azure VNG", + "links@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('4ecfc62c-ec85-42fd-af37-5a93c7deb1d9')/connectivityConfiguration/links", + "links": [ + { + "id": "109376bf-6dc7-4183-ab11-4a1206fb5e90", + "displayName": "VNG", + "localConfigurations": [ + { + "endpoint": "20.245.111.21", + "asn": 65476, + "bgpAddress": "192.168.1.2", + "region": "westUS" + }, + { + "endpoint": "20.245.111.77", + "asn": 65476, + "bgpAddress": "192.168.1.3", + "region": "westUS" + } + ], + "peerConfiguration": { + "endpoint": "20.172.65.16", + "asn": 65533, + "bgpAddress": "10.0.2.5" + } + } + ] +} +``` + |
v1.0 | Onattributecollectionexternalusersselfservicesignup Delete Attributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onattributecollectionexternalusersselfservicesignup-delete-attributes.md | DELETE https://graph.microsoft.com/beta/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 | Onauthenticationmethodloadstartexternalusersselfservicesignup List Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a new [identityProviders](../resources/identityprovider.md) object in the response body. +If successful, this method returns a `200 OK` response code and a collection of [identityProviderBase](../resources/identityproviderbase.md) objects in the response body. ## Examples |
v1.0 | Onlinemeeting Getallrecordings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onlinemeeting-getallrecordings.md | Title: "onlineMeeting: getAllRecordings" description: "Get recordings from all online meetings that a user is an organizer of."-+ ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get all recordings from scheduled [onlineMeeting](../resources/onlinemeeting.md) instances for which the specified user is the organizer. This API currently does not support getting call recordings from channel meetings. +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 are added for **onlineMeeting** instances organized by the specified user. +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. -Delta query supports both full synchronization that gets all the recordings for online meetings organized by the user, and incremental synchronization that gets recordings that have been 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 would 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 additional examples, see [callRecording: delta](callrecording-delta.md). +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). [!INCLUDE [national-cloud-support](../../includes/global-only.md)] +### 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). +- [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. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 request <!-- { "blockType": "ignored" } -->-```http -GET /users/{id}/onlineMeetings/getAllRecordings?$filter=meetingOrganizerId%20eq%20'{id}' +``` 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. ++## Function parameters +In the request URL, provide the following query parameters with values. ->**Note:** If you don't specify a filter on **meetingOrganizerId**, the request fails. +|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.| ++## Supported query patterns ++| Pattern | Supported | Syntax | Notes | +| - | :-: | - | | +| Page size | Γ£ô | `top` | Allows caller to specify max number of objects per page. | ## Request headers+ | Header | Value | |:|:--| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| GET /users/{id}/onlineMeetings/getAllRecordings?$filter=meetingOrganizerId%20eq% If successful, this method returns a `200 OK` response code and a list of [callRecording](../resources/callrecording.md) objects in the response body. -## Example +## Examples ++### Example 1: Get all recordings ++The following example shows a request to get all the recordings of a given meeting organizer. -### Request +#### Request # [HTTP](#tab/http) <!-- { If successful, this method returns a `200 OK` response code and a list of [callR "name": "get_allrecordings" }--> ```msgraph-interactive-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeeting/getAllRecordings?$filter=meetingOrganizerId%20eq%20'8b081ef6-4792-4def-b2c9-c363a1bf41d5' +GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5') ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/get-allrecordings-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) + -### Response +++#### Response >**Note:** The response object shown here might be shortened for readability. <!-- { HTTP/1.1 200 OK Content-type: application/json {- "@odata.context":"https://graph.microsoft.com/beta/$metadata#Collection(callRecording)", - "@odata.count":10, - "@odata.nextLink":"https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeeting/getAllRecordings?$skiptoken=GGXvkS7mbjFAe9Uidm2D70e58K-BOnoJadAqkZEJmoLprr5eSP1hQPlb3dJ1AVz3xCYKxov6hSEJhsasyg", - "value":[ - { + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)", + "@odata.nextLink": "https://graph.microsoft.com/beta/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", + "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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 with 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 ++# [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/beta/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 ++>**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 +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)", + "@odata.nextLink": "https://graph.microsoft.com/beta/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",- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl/content", - "createdDateTime": "2023-08-03T22:29:42.6514074Z", - "id": "MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl" - } - ] + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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" + } + } + } + ] } ``` Content-type: application/json [Microsoft Graph service-specific throttling limits](/graph/throttling-limits#microsoft-teams-service-limits) -[Delta query overview](/graph/delta-query-overview) +[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 | Title: "onlineMeeting: getAllTranscripts" description: "Get transcripts from all online meetings that a user is an organizer of."-+ ms.localizationpriority: medium doc_type: apiPageType 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 are added for **onlineMeeting** instances organized by the specified user. +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 that gets all the transcripts for online meetings organized by the user, and incremental synchronization that gets transcripts that have been 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 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. -Find more information in the [delta query](/graph/delta-query-overview) documentation. For additional examples, see [callTranscript: delta](calltranscript-delta.md). +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). [!INCLUDE [national-cloud-support](../../includes/global-only.md)] +### 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). + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 request <!-- { "blockType": "ignored" } -->-```http -GET /users/{id}/onlineMeetings/getAllTranscripts?$filter=meetingOrganizerId%20eq%20'{id}' +``` 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. ++## 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.| ++## Supported query patterns ++| Pattern | Supported | Syntax | Notes | +| - | :-: | - | | +| Page size | Γ£ô | `top` | Allows the caller to specify the maximum number of objects per page. | ->**Note:** If you don't specify a filter on **meetingOrganizerId**, the request fails. ## 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. +If successful, this method returns a `200 OK` response code and a list of [callTranscript](../resources/calltranscript.md) objects in the response body. -## Example +## Examples -### Request +### Example 1: Get all transcripts -The following example shows a request. +The following example shows a request to get all the transcripts of a given meeting organizer. ++#### Request # [HTTP](#tab/http) <!-- { "blockType": "request", "sampleKeys": ["8b081ef6-4792-4def-b2c9-c363a1bf41d5"],- "name": "get_alltranscipts" + "name": "get_alltranscripts" }--> ```msgraph-interactive-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$filter=meetingOrganizerId%20eq%20'8b081ef6-4792-4def-b2c9-c363a1bf41d5' +GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5') ``` # [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 ++>**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 +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)", + "@odata.nextLink": "https://graph.microsoft.com/beta/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", + "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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 with 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 ++# [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/beta/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) ++++ -The following example shows the response. +#### Response >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true,- "name": "get_alltranscipts", + "name": "get_alltranscripts_with_dates", "@odata.type": "microsoft.graph.callTranscript", "isCollection": true } --> HTTP/1.1 200 OK Content-type: application/json {- "@odata.context":"https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)", - "@odata.count":10, - "@odata.nextLink":"https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$skiptoken=GGXvkS7mbjFAe9Uidm2D70e58K-BOnoJadAqkZEJmoLprr5eSP1hQPlb3dJ1AVz3xCYKxov6hSEJhsasyg", - "value":[ - { + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)", + "@odata.nextLink": "https://graph.microsoft.com/beta/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",- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl/content", - "createdDateTime": "2023-08-03T22:29:42.6514074Z", - "id": "MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl" - } - ] + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/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)+[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 | Onpremisesagentgroup Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onpremisesagentgroup-post.md | The following example shows a request. ```http POST https://graph.microsoft.com/beta/onPremisesPublishingProfiles/provisioning/agentGroups++{ + "displayName": "New Group" +} ``` # [C#](#tab/csharp) POST https://graph.microsoft.com/beta/onPremisesPublishingProfiles/provisioning/ -In the request body, supply a JSON representation of [onPremisesAgentGroup](../resources/onpremisesagentgroup.md) object. --```json -{ - "displayName": "New Group" -} -``` - ### Response The following example shows the response. |
v1.0 | Openawssecuritygroupfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/openawssecuritygroupfinding-get.md | description: "Read the properties and relationships of an openAwsSecurityGroupFi ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Openawssecuritygroupfinding List Assignedcomputeinstancesdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/openawssecuritygroupfinding-list-assignedcomputeinstancesdetails.md | description: "Get a list of the assignedComputeInstanceDetails objects and their ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Openawssecuritygroupfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/openawssecuritygroupfinding-list.md | description: "Get a list of the openAwsSecurityGroupFinding objects and their pr ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Opennetworkazuresecuritygroupfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/opennetworkazuresecuritygroupfinding-get.md | description: "Read the properties and relationships of an openNetworkAzureSecuri ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Opennetworkazuresecuritygroupfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/opennetworkazuresecuritygroupfinding-list.md | description: "Get a list of the openNetworkAzureSecurityGroupFinding objects and ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Openshiftchangerequest Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/openshiftchangerequest-post.md | Create instance of an [openShiftChangeRequest](../resources/openshiftchangereque ## Permissions -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) | Group.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "openshiftchangerequest_post" } --> ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and ins't available for public use. ## HTTP request |
v1.0 | Opentypeextension Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/opentypeextension-delete.md | description: "Delete an open extension (openTypeExtension object) from the speci ms.localizationpriority: medium doc_type: apiPageType+ # Delete openTypeExtension |
v1.0 | Opentypeextension Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/opentypeextension-get.md | description: "Get an open extension (openTypeExtension object) identified by nam ms.localizationpriority: medium doc_type: apiPageType+ # Get openTypeExtension |
v1.0 | Opentypeextension Post Opentypeextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/opentypeextension-post-opentypeextension.md | description: "Create an open extension (openTypeExtension object) and add custom ms.localizationpriority: medium doc_type: apiPageType+ # Create openTypeExtension |
v1.0 | Opentypeextension Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/opentypeextension-update.md | description: "Update an open extension (openTypeExtension object) with the prope ms.localizationpriority: medium doc_type: apiPageType+ # Update openTypeExtension |
v1.0 | Organizationsettings List Iteminsights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/organizationsettings-list-iteminsights.md | Title: "List itemInsights" + Title: "List itemInsights (deprecated)" description: "Retrieve properties of insightsSettings object for displaying or returning item insights in an organization." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Get the properties of an [insightsSettings](../resources/insightssettings.md) object for displaying or returning item insights in an organization. To learn how to customize the privacy of item insights in an organization, see [Customize item insights privacy](/graph/insights-customize-item-insights-privacy). - [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Outboundshareduserprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/outboundshareduserprofile-get.md | Title: "Get outboundSharedUserProfile" description: "Get the details of an outboundSharedUserProfile."-++ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Outboundshareduserprofile List Tenants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/outboundshareduserprofile-list-tenants.md | Title: "Get tenantReferences" description: "List the tenant references of an outboundSharedUserProfile."-++ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Outlookcategory Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/outlookcategory-update.md | Title: "Update Outlook category" -description: "Update the writable property, **color**, of the specified outlookCategory object. You can't modify the **displayName** property " + Title: "Update outlookCategory" +description: "Update the writable property, **color**, of the specified outlookCategory object." ms.localizationpriority: medium doc_type: apiPageType -# Update Outlook category +# Update outlookCategory Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the writable property, **color**, of the specified [outlookCategory](../resources/outlookcategory.md) object. You can't modify the **displayName** property -once you have created the category. +Update the writable property, **color**, of the specified [outlookCategory](../resources/outlookcategory.md) object. You can't modify the **displayName** property once you have created the category. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] maintains their previous values or be recalculated based on changes to other pro ## Response -If successful, this method returns a `200 OK` response code and updated [outlookCategory](../resources/outlookcategory.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [outlookCategory](../resources/outlookcategory.md) object in the response body. ## Example-##### Request +### Request The following example shows a request. # [HTTP](#tab/http) Content-type: application/json -##### 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. +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, |
v1.0 | Outlooktaskgroup Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/outlooktaskgroup-delete.md | The following example shows a request. "sampleKeys": ["AAMkADIyAAAhrbe-AAA="] }--> ```http-DELETE https://graph.microsoft.com/beta/me/outlook/taskgroups/AAMkADIyAAAhrbe-AAA= +DELETE https://graph.microsoft.com/beta/me/outlook/taskGroups/AAMkADIyAAAhrbe-AAA= ``` # [C#](#tab/csharp) |
v1.0 | Outlooktaskgroup Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/outlooktaskgroup-update.md | The following example changes the name of a task group to "Personal Tasks". "sampleKeys": ["AAMkADIyAAAhrbe-AAA="] }--> ```http-PATCH https://graph.microsoft.com/beta/me/outlook/taskgroups/AAMkADIyAAAhrbe-AAA= +PATCH https://graph.microsoft.com/beta/me/outlook/taskGroups/AAMkADIyAAAhrbe-AAA= Content-type: application/json { |
v1.0 | Outlookuser List Mastercategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/outlookuser-list-mastercategories.md | Title: "List Outlook categories" -description: "Get all the categories that have been defined for the user." + Title: "List masterCategories" +description: "Get all the categories that have been defined for a user." ms.localizationpriority: medium doc_type: apiPageType -# List Outlook categories +# List masterCategories Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get all the categories that have been defined for the user. +Get all the categories that have been defined for a user. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Overprovisionedawsresourcefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisionedawsresourcefinding-get.md | description: "Read the properties and relationships of an overprovisionedAwsReso ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisionedawsresourcefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisionedawsresourcefinding-list.md | description: "Get a list of the overprovisionedAwsResourceFinding objects and th ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisionedawsrolefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisionedawsrolefinding-get.md | description: "Read the properties and relationships of an overprovisionedAwsRole ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisionedawsrolefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisionedawsrolefinding-list.md | description: "Get a list of the overprovisionedAwsRoleFinding objects and their ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisionedazureserviceprincipalfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisionedazureserviceprincipalfinding-get.md | description: "Read the properties and relationships of an overprovisionedAzureSe ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisionedazureserviceprincipalfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisionedazureserviceprincipalfinding-list.md | description: "Get a list of the overprovisionedAzureServicePrincipalFinding obje ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisionedgcpserviceaccountfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisionedgcpserviceaccountfinding-get.md | description: "Read the properties and relationships of an overprovisionedGcpServ ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisionedgcpserviceaccountfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisionedgcpserviceaccountfinding-list.md | description: "Get a list of the overprovisionedGcpServiceAccountFinding objects ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisionedserverlessfunctionfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisionedserverlessfunctionfinding-get.md | description: "Read the properties and relationships of an overprovisionedServerl ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisionedserverlessfunctionfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisionedserverlessfunctionfinding-list.md | description: "Get a list of the overprovisionedServerlessFunctionFinding objects ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisioneduserfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisioneduserfinding-get.md | description: "Read the properties and relationships of an overprovisionedUserFin ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Overprovisioneduserfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/overprovisioneduserfinding-list.md | description: "Get a list of the overprovisionedUserFinding objects and their pro ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Partner Security Partnersecurityalert Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partner-security-partnersecurityalert-get.md | + + Title: "Get partnerSecurityAlert" +description: "Read the properties of a partnerSecurityAlert object." ++ms.localizationpriority: medium ++++# Get partnerSecurityAlert ++Namespace: microsoft.graph.partner.security +++Read the properties and relationships of a [partnerSecurityAlert](../resources/partner-security-partnersecurityalert.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_partnersecurityalert_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/partner/securityAlerts/{partnerSecurityAlertId} +``` ++## Optional query parameters ++This method supports the `$count`, `$filter`, and `$select` 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.partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_partnersecurityalert" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/partner/securityAlerts/d8b202fc-a216-3404-69ef-bdffa445eff6 +``` ++# [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.partner.security.partnerSecurityAlert" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "id": "d8b202fc-a216-3404-69ef-bdffa445eff6", + "displayName": "Action Required: Virtual machine connecting to crypto currency mining pool Detected", + "description": "Analysis of Azure resource network activity detected the resource was connecting to a crypto currency mining pool. This would often be an indication that your Azure resource is compromised.", + "alertType": "networkConnectionsToCryptoMiningPools", + "status": "active", + "severity": "high", + "confidenceLevel": "medium", + "customerTenantId": "1889e718-414b-4bad-8bbe-c1135bd39a41", + "subscriptionId": "5f6e6521-6e5f-4b0b-80aa-bd44fad7a398", + "valueAddedResellerTenantId": "c296b2ce-8cd1-4346-9e82-d8eccca70d65", + "catalogOfferId": "MS-AZR-0017G", + "detectedDateTime": "2024-01-23T16:03:33.05Z", + "firstObservedDateTime": "2024-01-23T16:03:33.05Z", + "lastObservedDateTime": "2024-01-23T16:03:33.05Z", + "resolvedReason": "fraud", + "resolvedOnDateTime": "2024-02-23T16:03:33.05Z", + "resolvedBy": "danas@contoso.com", + "isTest": false, + "affectedResources": [ + { + "resourceId": "/subscriptions/subscription-id/resourceGroups/resourcegroup-name/providers/Microsoft.Compute/virtualMachines/vm-name", + "resourceType": "AzureResource" + } + ], + "activityLogs": [ + { + "statusFrom": "active", + "statusTo": "investigating", + "updatedBy": "samanthab@contoso.com", + "updatedDateTime": "2023-08-10T08:47:10.8454142Z" + }, + { + "statusFrom": "investigating", + "statusTo": "resolved", + "updatedBy": "samanthab@contoso.com", + "updatedDateTime": "2023-08-10T08:47:25.2089246Z" + } + ], + "additionalDetails": { + "VM_IP": "[ \"vm-ip\"]", + "MiningPool_IP": "[ \"mining-pool-ip\"]", + "ConnectionCount": "5", + "CryptoCurrencyMiningPoolDomainName": "pool-name.com" + } +} +``` + |
v1.0 | Partner Security Partnersecurityalert List Securityalerts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partner-security-partnersecurityalert-list-securityalerts.md | + + Title: "List securityAlerts" +description: "Get a list of the partnerSecurityAlert objects and their properties." ++ms.localizationpriority: medium ++++# List securityAlerts ++Namespace: microsoft.graph.partner.security +++Get a list of the [partnerSecurityAlert](../resources/partner-security-partnersecurityalert.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_partnersecurityalert_list_securityalerts" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/partner/securityAlerts +``` ++## Optional query parameters ++This method supports the `$count`, `$filter`, and `$select` 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.partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_partnersecurityalert" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/partner/securityAlerts +``` ++# [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.partner.security.partnerSecurityAlert)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "id": "d8b202fc-a216-3404-69ef-bdffa445eff6", + "displayName": "Action Required: Virtual machine connecting to crypto currency mining pool Detected", + "description": "Analysis of Azure resource network activity detected the resource was connecting to a crypto currency mining pool. This would often be an indication that your Azure resource is compromised.", + "alertType": "networkConnectionsToCryptoMiningPools", + "status": "active", + "severity": "high", + "confidenceLevel": "medium", + "customerTenantId": "1889e718-414b-4bad-8bbe-c1135bd39a41", + "subscriptionId": "5f6e6521-6e5f-4b0b-80aa-bd44fad7a398", + "valueAddedResellerTenantId": "c296b2ce-8cd1-4346-9e82-d8eccca70d65", + "catalogOfferId": "MS-AZR-0017G", + "detectedDateTime": "2024-01-23T16:03:33.05Z", + "firstObservedDateTime": "2024-01-23T16:03:33.05Z", + "lastObservedDateTime": "2024-01-23T16:03:33.05Z", + "resolvedReason": "fraud", + "resolvedOnDateTime": "2024-02-23T16:03:33.05Z", + "resolvedBy": "danas@contoso.com", + "isTest": false, + "affectedResources": [ + { + "resourceId": "/subscriptions/subscription-id/resourceGroups/resourcegroup-name/providers/Microsoft.Compute/virtualMachines/vm-name", + "resourceType": "AzureResource" + } + ], + "activityLogs": [ + { + "statusFrom": "active", + "statusTo": "investigating", + "updatedBy": "samanthab@contoso.com", + "updatedDateTime": "2023-08-10T08:47:10.8454142Z" + }, + { + "statusFrom": "investigating", + "statusTo": "resolved", + "updatedBy": "samanthab@contoso.com", + "updatedDateTime": "2023-08-10T08:47:25.2089246Z" + } + ], + "additionalDetails": { + "VM_IP": "[ \"vm-ip\"]", + "MiningPool_IP": "[ \"mining-pool-ip\"]", + "ConnectionCount": "5", + "CryptoCurrencyMiningPoolDomainName": "pool-name.com" + } + }, + { + "id": "5f6e6521-6e5f-4b0b-80aa-bd44fad7a398-758e2259-f00b-4dec-8087-0950afe6d6a4", + "displayName": "Action Required: Subscription Usage Anomaly Detected", + "description": "Analysis of Azure resource detected anomalies in: Anomalous increase in Machine Learning General purpose CPU deployment regions compared to trend in the last 30 days Subscription is part of a cluster of subscriptions that are controlled from the same login session IP Address.", + "alertType": "usageAnomalyDetection", + "status": "investigating", + "severity": "high", + "confidenceLevel": "medium", + "customerTenantId": "1889e718-414b-4bad-8bbe-c1135bd39a41", + "subscriptionId": "5f6e6521-6e5f-4b0b-80aa-bd44fad7a398", + "valueAddedResellerTenantId": "c296b2ce-8cd1-4346-9e82-d8eccca70d65", + "catalogOfferId": null, + "detectedDateTime": "2024-01-23T16:03:33.05Z", + "firstObservedDateTime": "2024-01-23T16:03:33.05Z", + "lastObservedDateTime": "2024-01-23T16:03:33.05Z", + "resolvedReason": null, + "resolvedOnDateTime": null, + "resolvedBy": "danas@contoso.com", + "isTest": false, + "affectedResources": [ + { + "resourceId": "/subscriptions/subscription-id/resourceGroups/resourcegroup-name/providers/Microsoft.Compute/virtualMachines/vm-name", + "resourceType": "AzureResource" + } + ], + "activityLogs": [ + { + "statusFrom": "active", + "statusTo": "investigating", + "updatedBy": "samanthab@contoso.com", + "updatedDateTime": "2023-08-10T08:47:10.8454142Z" + } + ], + "additionalDetails": { + "VM_IP": "[ \"vm-ip\"]", + "MiningPool_IP": "[ \"mining-pool-ip\"]", + "ConnectionCount": "5", + "CryptoCurrencyMiningPoolDomainName": "pool-name.com" + } + } + ] +} +``` + |
v1.0 | Partner Security Partnersecurityalert Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partner-security-partnersecurityalert-update.md | + + Title: "Update partnerSecurityAlert" +description: "Update the properties of a partnerSecurityAlert object." ++ms.localizationpriority: medium ++++# Update partnerSecurityAlert ++Namespace: microsoft.graph.partner.security +++Update the properties of a [partnerSecurityAlert](../resources/partner-security-partnersecurityalert.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_partnersecurityalert_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /security/partner/securityAlerts/{partnerSecurityAlertId} +``` ++## 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.partner.security.securityAlertStatus|The status of the alert. The possible values are: `active`, `resolved`, `investigating`, `unknownFutureValue`. Required.| +|resolvedReason|microsoft.graph.partner.security.securityAlertResolvedReason|The reason provided by the partner for addressing the alert. The possible values are: `legitimate`, `ignore`, `fraud`, `unknownFutureValue`. Optional.| +++## Response ++If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.partner.security.partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_partnersecurityalert" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/security/partner/securityAlerts/d8b202fc-a216-3404-69ef-bdffa445eff6 +Content-Type: application/json ++{ + "status": "resolved", + "resolvedReason": "fraud" +} +``` ++# [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.partner.security.partnerSecurityAlert" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++ { + "id": "d8b202fc-a216-3404-69ef-bdffa445eff6", + "displayName": "Action Required: Virtual machine connecting to crypto currency mining pool Detected", + "description": "Analysis of Azure resource network activity detected the resource was connecting to a crypto currency mining pool. This would often be an indication that your Azure resource is compromised.", + "alertType": "networkConnectionsToCryptoMiningPools", + "status": "active", + "severity": "high", + "confidenceLevel": "medium", + "customerTenantId": "1889e718-414b-4bad-8bbe-c1135bd39a41", + "subscriptionId": "5f6e6521-6e5f-4b0b-80aa-bd44fad7a398", + "valueAddedResellerTenantId": "c296b2ce-8cd1-4346-9e82-d8eccca70d65", + "catalogOfferId": "MS-AZR-0017G", + "detectedDateTime": "2024-01-23T16:03:33.05Z", + "firstObservedDateTime": "2024-01-23T16:03:33.05Z", + "lastObservedDateTime": "2024-01-23T16:03:33.05Z", + "resolvedReason": "fraud", + "resolvedOnDateTime": "2024-02-23T16:03:33.05Z", + "resolvedBy": "danas@contoso.com", + "isTest": false, + "affectedResources": [ + { + "resourceId": "/subscriptions/subscription-id/resourceGroups/resourcegroup-name/providers/Microsoft.Compute/virtualMachines/vm-name", + "resourceType": "AzureResource" + } + ], + "activityLogs": [ + { + "statusFrom": "active", + "statusTo": "investigating", + "updatedBy": "samanthab@contoso.com", + "updatedDateTime": "2023-08-10T08:47:10.8454142Z" + }, + { + "statusFrom": "investigating", + "statusTo": "resolved", + "updatedBy": "samanthab@contoso.com", + "updatedDateTime": "2023-08-10T08:47:25.2089246Z" + } + ], + "additionalDetails": { + "VM_IP": "[ \"vm-ip\"]", + "MiningPool_IP": "[ \"mining-pool-ip\"]", + "ConnectionCount": "5", + "CryptoCurrencyMiningPoolDomainName": "pool-name.com" + } +} +``` + |
v1.0 | Partners Billing Billedreconciliation Export | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partners-billing-billedreconciliation-export.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/billedreconciliationthisexport-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/billedreconciliationthisexport-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Pendingexternaluserprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pendingexternaluserprofile-get.md | description: "Get a pendingExternalUserProfile object." ms.localizationpriority: medium doc_type: apiPageType + GET https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles/{id} [!INCLUDE [sample-code](../includes/snippets/php/get-pendingexternaluserprofile-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-pendingexternaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Pendingexternaluserprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pendingexternaluserprofile-update.md | Title: "Update pendingExternalUserProfile" description: "Update the properties of a pendingExternalUserProfile object." + ms.localizationpriority: medium doc_type: apiPageType Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-pendingexternaluserprofile-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-pendingexternaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Peopleadminsettings List Iteminsights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/peopleadminsettings-list-iteminsights.md | + + Title: "List insightsSettings" +description: "Retrieve properties of insightsSettings object for displaying or returning item insights in an organization." ++ms.localizationpriority: medium ++++# List insightsSettings ++Namespace: microsoft.graph +++Get the properties of an [insightsSettings](../resources/insightssettings.md) object for displaying or returning item insights in an organization. ++To learn how to customize the privacy of item insights in an organization, see [Customize item insights privacy](/graph/insights-customize-item-insights-privacy). +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_iteminsights" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /admin/people/itemInsights +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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 [insightsSettings](../resources/insightssettings.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_iteminsights" +} +--> +``` http +GET https://graph.microsoft.com/beta/admin/people/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. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.insightsSettings", + "name": "list_iteminsights" +}--> ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "isEnabledInOrganization": true, + "disabledForGroup": "edbfe4fb-ec70-4300-928f-dbb2ae86c981" +} +``` |
v1.0 | Permissionsanalytics List Permissionscreepindexdistributions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/permissionsanalytics-list-permissionscreepindexdistributions.md | description: "Get a list of the permissionsCreepIndexDistribution objects and th ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Permissionscreepindexdistribution Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/permissionscreepindexdistribution-get.md | description: "Read the properties and relationships of a permissionsCreepIndexDi ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Permissionsmanagement List Permissionsrequestchanges | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/permissionsmanagement-list-permissionsrequestchanges.md | description: "List the permissionsRequestChange objects and their properties." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Permissionsmanagement Post Scheduledpermissionsrequests | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/permissionsmanagement-post-scheduledpermissionsrequests.md | description: "Create a new scheduledPermissionsRequest object." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Planner Post Plans | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/planner-post-plans.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new [plannerPlan](../resources/plannerplan.md). +Create a new [plannerPlan](../resources/plannerplan.md) object. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] The following table lists the properties that are required when you create a [pl |container|[plannerPlanContainer](../resources/plannerplancontainer.md)|Identifies the container of the plan. Specify only the **url**, the **containerId** and **type**, or all properties. You can only change this property by moving a plan from one container to another using [plan move to container](../api/plannerplan-movetocontainer.md).| |title|String|The title of the plan.| ->**Note:** If the container is a Microsoft 365 group, the user who is creating the plan must be a member of the group that will contain the plan. When you create a new group by using [Create group](../api/group-post-groups.md), you are not added to the group as a member. After the group is created, add yourself as a member by using [group post members](../api/group-post-members.md). +>**Note:** If the container is a Microsoft 365 group, the user who creates the plan must be a member of the group that contains the plan. When you create a new group by using [Create group](../api/group-post-groups.md), you aren't added to the group as a member. After the group is created, add yourself as a member by using [group post members](../api/group-post-members.md). ## Response |
v1.0 | Plannertask Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/plannertask-update.md | PATCH /planner/tasks/{id} | Property | Type |Description| |:|:--|:-|-|appliedCategories|[plannerAppliedCategories](../resources/plannerappliedcategories.md)|specifies the categories to which the planner task has been applied. See [applied Categories](../resources/plannerappliedcategories.md) for possible values.| -|assigneePriority|String|Hint used to order items of this type in a list view. The format is defined as outlined [here](../resources/planner-order-hint-format.md).| +|appliedCategories|[plannerAppliedCategories](../resources/plannerappliedcategories.md)|Specifies the categories to which the Planner task was applied. See [applied Categories](../resources/plannerappliedcategories.md) for possible values.| +|assigneePriority|String|Hint used to order items of this type in a list view. The format is defined in [Using order hints in Planner](../resources/planner-order-hint-format.md).| |assignments|[plannerAssignments](../resources/plannerassignments.md)|The set of users the task is assigned to.|-|bucketId|String|Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. [Format validation](../resources/tasks-identifiers-disclaimer.md) is done on the service. | +|bucketId|String|Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. This value 28 characters long and case-sensitive. [Format validation](../resources/tasks-identifiers-disclaimer.md) is done on the service. | |conversationThreadId|String|Thread ID of the conversation on the task and is the ID of the conversation thread object created in the group.| |dueDateTime|DateTimeOffset|Date and time at which the task is due. 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|Hint used to order items of this type in a list view. The format is defined as outlined [here](../resources/planner-order-hint-format.md).| PATCH /planner/tasks/{id} |startDateTime|DateTimeOffset|Date and time at which the task starts. 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`.| |title|String|Title of the task.| +> [!NOTE] +> For Project tasks that are replicated to Planner, only the **percentComplete** property can be updated. + ## Response -If successful, this method returns a `204 No Content` response code and an empty content. If the request specifies the `Prefer` header with a `return=representation` preference, then this method returns a `200 OK` response code and an updated [plannerTask](../resources/plannertask.md) object in the response body. +If successful, this method returns a `204 No Content` response code and an empty content. If the request specifies the `Prefer` header with a `return=representation` preference, this method returns a `200 OK` response code and an updated [plannerTask](../resources/plannertask.md) object in the response body. This method can return any of the [HTTP status codes](/graph/errors). The most common errors that apps should handle for this method are the 400, 403, 404, 409, and 412 responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions). |
v1.0 | Planneruser List Mydaytasks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/planneruser-list-mydaytasks.md | + + Title: "List myDayTasks" +description: "Retrieve a list of planner tasks to be shown in the user's My Day view.My Day is a view within planner app which will show all the tasks, a user has to focus today based on either user adds the task to the view or the due date of the task is today." +ms.localizationpriority: medium ++++# List myDayTasks ++Namespace: microsoft.graph +++Retrieve a list of [plannerTask](../resources/plannertask.md) objects to be shown in the user's My Day view within Planner. This method returns the list of tasks that the user added to the My Day view or that are due today. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "planneruser_list_mydaytasks" } --> ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +GET /me/planner/myDayTasks +GET /users/{id}/planner/myDayTasks +``` ++## 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 collection of [plannerTask](../resources/plannertask.md) objects in the response body. ++This method can return any of the [HTTP status codes](/graph/errors). The most common errors that apps should handle for this method are the 403 and 404 responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions). ++## Examples +### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "planneruser_get_mydaytasks" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/me/planner/myDayTasks +``` ++# [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.plannerTask", + "isCollection": true +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "value": [ + { + "createdBy": { + "user": { + "id": "6463a5ce-2119-4198-9f2a-628761df4a62" + } + }, + "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM", + "bucketId": "gcrYAaAkgU2EQUvpkNNXLGQAGTtu", + "title": "title-value", + "orderHint": "9223370609546166567W", + "assigneePriority": "90057581\"", + "createdDateTime": "2015-03-25T18:36:49.2407981Z", + "isOnMyDay": true, + "id":"01gzSlKkIUSUl6DF_EilrmQAKDhh" + } + ] +} +``` |
v1.0 | Policyroot List Federatedtokenvalidationpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/policyroot-list-federatedtokenvalidationpolicy.md | Namespace: microsoft.graph Get a list of the [federatedTokenValidationPolicy](../resources/federatedtokenvalidationpolicy.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). Choose the permission or permissions marked as least privileged for this API. Us --> [!INCLUDE [permissions-table](../includes/permissions/policyroot-list-federatedtokenvalidationpolicy-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Printershare Delete Allowedgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/printershare-delete-allowedgroup.md | DELETE https://graph.microsoft.com/beta/print/shares/{id}/allowedGroups/{id}/$re [!INCLUDE [sample-code](../includes/snippets/php/delete-allowedgroup-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-allowedgroup-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Printershare Delete Alloweduser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/printershare-delete-alloweduser.md | DELETE https://graph.microsoft.com/beta/print/printerShares/{id}/allowedUsers/{i [!INCLUDE [sample-code](../includes/snippets/php/delete-alloweduser-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-alloweduser-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Privilegeescalationawsresourcefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/privilegeescalationawsresourcefinding-get.md | description: "Read the properties and relationships of a privilegeEscalationAwsR ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Privilegeescalationawsresourcefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/privilegeescalationawsresourcefinding-list.md | description: "Get a list of the privilegeEscalationAwsResourceFinding objects an ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Privilegeescalationawsrolefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/privilegeescalationawsrolefinding-get.md | description: "Read the properties and relationships of a privilegeEscalationAwsR ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Privilegeescalationawsrolefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/privilegeescalationawsrolefinding-list.md | description: "Get a list of the privilegeEscalationAwsRoleFinding objects and th ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Privilegeescalationgcpserviceaccountfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/privilegeescalationgcpserviceaccountfinding-get.md | description: "Read the properties and relationships of a privilegeEscalationGcpS ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Privilegeescalationgcpserviceaccountfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/privilegeescalationgcpserviceaccountfinding-list.md | description: "Get a list of the privilegeEscalationGcpServiceAccountFinding obje ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Privilegeescalationuserfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/privilegeescalationuserfinding-get.md | description: "Read the properties and relationships of a privilegeEscalationUser ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Privilegeescalationuserfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/privilegeescalationuserfinding-list.md | description: "Get a list of the privilegeEscalationUserFinding objects and their ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Profilephoto Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/profilephoto-delete.md | Delete the photo for the signed-in user or the specified group. > > The delete operation supports only user or group photos, but _not Outlook contact nor Teams photos_. + ## 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 the 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). The following example shows a request. DELETE https://graph.microsoft.com/beta/me/photo/$value ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/delete-profilephoto-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [Python](#tab/python) + ### Response |
v1.0 | Projectrome Delete Historyitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/projectrome-delete-historyitem.md | Title: "Delete a historyItem" + Title: "Delete an activityHistoryItem" description: "Delete an existing history item for an existing user activity." ms.localizationpriority: medium doc_type: apiPageType -# Delete a historyItem +# Delete an activityHistoryItem Namespace: microsoft.graph HTTP/1.1 204 No Content "section": "documentation", "tocPath": "", "suppressions": [- + ] } --> |
v1.0 | Projectrome Get Recent Activities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/projectrome-get-recent-activities.md | Title: "Get recent user activities" -description: " API. The service queries for the most recent historyItems, and then pull those related activities. Activities are sorted according to the most recent **lastModified** on the **historyItem**. This means that activities without **historyItems** won't be included in the response. The UserActivity.ReadWrite.CreatedByApp permission will also apply extra filtering to the response, so that only activities created by your application are returned. This server-side filtering might result in empty pages if the user is active and other applications have created more recent activities. To get your application's activities, use the **nextLink** property to paginate." +description: Get recent activities for a given user. ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get recent activities for a given user. This OData function has some default behaviors included to make it operate like a "most recently used" API. The service queries for the most recent [historyItems](../resources/projectrome-historyitem.md), and then pull those related activities. Activities are sorted according to the most recent **lastModified** on the **historyItem**. This means that activities without **historyItems** won't be included in the response. The UserActivity.ReadWrite.CreatedByApp permission will also apply extra filtering to the response, so that only activities created by your application are returned. This server-side filtering might result in empty pages if the user is active and other applications have created more recent activities. To get your application's activities, use the **nextLink** property to paginate. +Get recent activities for a given user. This OData function has some default behaviors included to make it operate like a "most recently used" API. The service queries for the most recent [activityHistoryItems](../resources/projectrome-historyitem.md), and then pull those related activities. Activities are sorted according to the most recent **lastModified** on the **activityHistoryItem**. This means that activities without **activityHistoryItems** won't be included in the response. The UserActivity.ReadWrite.CreatedByApp permission will also apply extra filtering to the response, so that only activities created by your application are returned. This server-side filtering might result in empty pages if the user is active and other applications have created more recent activities. To get your application's activities, use the **nextLink** property to paginate. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] |
v1.0 | Projectrome Put Activity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/projectrome-put-activity.md | Title: "Create or replace an activity" -description: "Create a new or replace an existing user activity for your app. If you'd like to create a user activity and its related **historyItems** in one request, you can use deep insert." +description: "Create a new or replace an existing user activity for your app." ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new or replace an existing user activity for your app. If you'd like to create a user activity and its related **historyItems** in one request, you can use [deep insert](#example-2-deep-insert). +Create a new or replace an existing user activity for your app. If you'd like to create a user activity and its related **activityHistoryItems** in one request, you can use [deep insert](#example-2-deep-insert). ## Permissions |
v1.0 | Projectrome Put Historyitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/projectrome-put-historyitem.md | Title: "Create or replace a historyItem" + Title: "Create or replace an activityHistoryItem" description: "Create a new or replace an existing history item for an existing user activity." ms.localizationpriority: medium doc_type: apiPageType -# Create or replace a historyItem +# Create or replace an activityHistoryItem Namespace: microsoft.graph PUT /me/activities/{id}/historyItems/{id} ## Request body -In the request body, supply a JSON representation of a [historyItem](../resources/projectrome-historyitem.md) object. +In the request body, supply a JSON representation of a [activityHistoryItem](../resources/projectrome-historyitem.md) object. ## Response -If successful, this method returns a `201 Created` response code if the **historyItem** was created or `200 OK` if the **historyItem** was replaced. +If successful, this method returns a `201 Created` response code if the **activityHistoryItem** was created or `200 OK` if the **activityHistoryItem** was replaced. ## Example The following example shows the response. <!-- { "blockType": "ignored", "truncated": true,- "@odata.type": "microsoft.graph.historyItem" + "@odata.type": "microsoft.graph.activityHistoryItem" } --> ```http |
v1.0 | Publishedresource Post Agentgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/publishedresource-post-agentgroups.md | If successful, this method returns a `201 Created` response code and a [publishe ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_onpremisesagentgroup_from_onpremisespublishingprofile" The following example shows a request. POST https://graph.microsoft.com/beta/onPremisesPublishingProfiles/provisioning/publishedResources/1234b780-965f-4149-85c5-a8c73e58b67d/agentGroups/$ref Content-type: application/json -```http { "@odata.id": "https://graph.microsoft.com/beta/onPremisesPublishingProfiles/provisioning/agentGroups/2B032383-897C-42BA-917E-700B6890BDC3/" } ``` +# [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-HTTP/1.1 204 +HTTP/1.1 201 Created +Content-type: application/json ++{ + "publishingType": "provisioning", + "displayName": "Demo provisioning", + "id": "aed0b780-965f-4149-85c5-a8c73e58b67d", + "resourceName": "domain1.contoso.com", + "agentGroups": [ + { + "id": "2d55ed41-1619-4848-92bb-0576d3038682", + "displayName": "Group 1" + } + ] +} ``` <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 |
v1.0 | Rbacapplication List Roleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rbacapplication-list-roleassignments.md | One of the following permissions is required to call this API. To learn more, in <!-- { "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) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | +|Delegated (work or school account) | RoleManagement.Read.Directory, RoleManagement.Read.All, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | +|Application | RoleManagement.Read.Directory, RoleManagement.Read.All, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | ### For entitlement management provider <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> |
v1.0 | Regionalandlanguagesettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/regionalandlanguagesettings-get.md | Title: "Get regionalAndLanguageSettings resource" description: "Retrieve the properties of a user's regionalAndLanguageSettings" ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Regionalandlanguagesettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/regionalandlanguagesettings-update.md | Title: "Update regionalAndLanguageSettings" description: "Update the regional and language settings of a user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Remotedesktopsecurityconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/remotedesktopsecurityconfiguration-get.md | Namespace: microsoft.graph Read the properties and relationships of a [remoteDesktopSecurityConfiguration](../resources/remotedesktopsecurityconfiguration.md) object on a servicePrincipal. Use this configuration to view the Microsoft Entra ID [Remote Desktop Services (RDS) authentication protocol](/openspecs/windows_protocols/ms-rdpbcgr/dc43f040-d75d-49a9-90c6-0c9999281136) to authenticate a user to [Microsoft Entra joined](/azure/active-directory/devices/concept-directory-join) or [Microsoft Entra hybrid joined](/azure/active-directory/devices/concept-hybrid-join) devices. Additionally you can view any targetDeviceGroups that have been configured for SSO. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Remotedesktopsecurityconfiguration List Targetdevicegroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/remotedesktopsecurityconfiguration-list-targetdevicegroups.md | Namespace: microsoft.graph Get a list of the [targetDeviceGroup](../resources/targetdevicegroup.md) objects and their properties on the remoteDesktopSecurityConfiguration resource on the servicePrincipal. Any user authenticating using the Microsoft Entra ID [Remote Desktop Services (RDS) authentication protocol](/openspecs/windows_protocols/ms-rdpbcgr/dc43f040-d75d-49a9-90c6-0c9999281136) to a [Microsoft Entra joined](/azure/active-directory/devices/concept-directory-join) or [Microsoft Entra hybrid joined](/azure/active-directory/devices/concept-hybrid-join) device that belongs to the targetDeviceGroup will get SSO. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "remotedesktopsecurityconfiguration_list_targetdevicegroups" } --> +<!-- { "blockType": "ignored", "name": "remotedesktopsecurityconfiguration_list_targetdevicegroups" } --> [!INCLUDE [permissions-table](../includes/permissions/remotedesktopsecurityconfiguration-list-targetdevicegroups-permissions.md)] [!INCLUDE [rbac-remote-desktop-security-config-apis](../includes/rbac-for-apis/rbac-remote-desktop-security-config-apis.md)] |
v1.0 | Remotedesktopsecurityconfiguration Post Targetdevicegroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/remotedesktopsecurityconfiguration-post-targetdevicegroups.md | Namespace: microsoft.graph Create a new [targetDeviceGroup](../resources/targetdevicegroup.md) object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. You can configure a maximum of 10 target device groups for the remoteDesktopSecurityConfiguraiton object on the servicePrincipal. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Remotedesktopsecurityconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/remotedesktopsecurityconfiguration-update.md | Namespace: microsoft.graph Update the properties of a [remoteDesktopSecurityConfiguration](../resources/remotedesktopsecurityconfiguration.md) object on the servicePrincipal. Use this configuration to enable or disable the Microsoft Entra ID [Remote Desktop Services (RDS) authentication protocol](/openspecs/windows_protocols/ms-rdpbcgr/dc43f040-d75d-49a9-90c6-0c9999281136) to authenticate a user to [Microsoft Entra joined](/azure/active-directory/devices/concept-directory-join) or [Microsoft Entra hybrid joined](/azure/active-directory/devices/concept-hybrid-join) devices. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Samlorwsfedexternaldomainfederation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/samlorwsfedexternaldomainfederation-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-delete-permissions.md)] -The work or school account needs to belong to one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/samlorwsfedexternaldomainfederation-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_get" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-get-permissions.md)] -The work or school account needs to belong to one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation List Domains | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/samlorwsfedexternaldomainfederation-list-domains.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_list_domains" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-list-domains-permissions.md)] -The work or school account needs to belong to one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/samlorwsfedexternaldomainfederation-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_list" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-list-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation Post Domains | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/samlorwsfedexternaldomainfederation-post-domains.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_post_domains" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-post-domains-permissions.md)] -The work or school account needs to belong to one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/samlorwsfedexternaldomainfederation-post.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_post" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-post-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/samlorwsfedexternaldomainfederation-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_update" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-update-permissions.md)] -The work or school account needs to belong to one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
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]( ## Permissions -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) | Group.Read.All, Group.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.Read.All*, Schedule.ReadWrite.All* | +This API supports admin permissions. Global admins can access groups that they aren't a member of. ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +<!-- { "blockType": "permissions", "name": "schedule_list_timeoffreasons" } --> -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> [!NOTE] +> The Schedule.Read.All and Schedule.ReadWrite.All application permissions are currently in private preview only and are not available for public use. ## 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. + |Permission type | Permissions (from least to most privileged) | |:--|:| |Delegated (work or school account) | Group.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. | |Application | Schedule.ReadWrite.All* | ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. --> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and isn't available for public use. ## HTTP request |
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 ## Permissions -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) | Group.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +This API supports admin permissions. Global admins can access groups that they aren't a member of. ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +<!-- { "blockType": "permissions", "name": "schedule_post_timesoff" } --> -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and isn't available for public use. ## HTTP request |
v1.0 | Scheduledpermissionsrequest Cancelall | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/scheduledpermissionsrequest-cancelall.md | description: "Cancel a scheduled permission request." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Schemaextension Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/schemaextension-delete.md | description: "Delete the definition of a schema extension." ms.localizationpriority: medium doc_type: apiPageType+ # Delete schemaExtension |
v1.0 | Schemaextension Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/schemaextension-get.md | description: "Get the properties of the specified schemaExtension definition." ms.localizationpriority: medium doc_type: apiPageType+ # Get schemaExtension |
v1.0 | Schemaextension List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/schemaextension-list.md | description: "Get a list of schemaExtension objects created by any apps you own ms.localizationpriority: medium doc_type: apiPageType+ # List schemaExtensions |
v1.0 | Schemaextension Post Schemaextensions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/schemaextension-post-schemaextensions.md | description: "Create a new schemaExtension definition to extend a supporting res ms.localizationpriority: medium doc_type: apiPageType+ # Create schemaExtension |
v1.0 | Schemaextension Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/schemaextension-update.md | description: "Update properties in the definition of the specified schemaExtensi ms.localizationpriority: medium doc_type: apiPageType+ # Update schemaExtension |
v1.0 | Search Query | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/search-query.md | Content-type: application/json - Search [mail messages](/graph/search-concept-messages) - Search [calendar events](/graph/search-concept-events) - Search [person](/graph/search-concept-person)-- Search content in SharePoint and OneDrive ([files, lists and sites](/graph/search-concept-files))+- Search content in SharePoint and OneDrive ([files, lists, and sites](/graph/search-concept-files)) - Search [custom types (Graph Connectors)](/graph/search-concept-custom-types) data - Search with [queryTemplate](/graph/search-concept-query-template) - [Sort](/graph/search-concept-sort) search results |
v1.0 | Search Searchentity Post Bookmarks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/search-searchentity-post-bookmarks.md | Content-Type: application/json "description": "Try or buy Contoso for Home or Business and view product information", "keywords": { "keywords": ["Contoso", "install"],- "reservedKeywords": ["Contoso"], + "reservedKeywords": ["Unique keyword"], "matchSimilarKeywords": true }, "availabilityStartDateTime": null, |
v1.0 | Secretinformationaccessawsresourcefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/secretinformationaccessawsresourcefinding-get.md | description: "Read the properties and relationships of a secretInformationAccess ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Secretinformationaccessawsresourcefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/secretinformationaccessawsresourcefinding-list.md | description: "Get a list of the secretInformationAccessAwsResourceFinding object ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Secretinformationaccessawsrolefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/secretinformationaccessawsrolefinding-get.md | description: "Read the properties and relationships of a secretInformationAccess ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Secretinformationaccessawsrolefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/secretinformationaccessawsrolefinding-list.md | description: "Get a list of the secretInformationAccessAwsRoleFinding objects an ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Secretinformationaccessawsserverlessfunctionfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/secretinformationaccessawsserverlessfunctionfinding-get.md | description: "Read the properties and relationships of a secretInformationAccess ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Secretinformationaccessawsserverlessfunctionfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/secretinformationaccessawsserverlessfunctionfinding-list.md | description: "Get a list of the secretInformationAccessAwsServerlessFunctionFind ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Secretinformationaccessawsuserfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/secretinformationaccessawsuserfinding-get.md | description: "Read the properties and relationships of a secretInformationAccess ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Secretinformationaccessawsuserfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/secretinformationaccessawsuserfinding-list.md | description: "Get a list of the secretInformationAccessAwsUserFinding objects an ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Security Analyzedemail Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-analyzedemail-get.md | Namespace: microsoft.graph.security Read the properties and relationships of an [analyzedEmail](../resources/security-analyzedemail.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). Choose the permission or permissions marked as least privileged for this API. Us GET /security/collaboration/analyzedEmails/{analyzedEmailId} ``` - ## Request headers |Name|Description| Content-Type: application/json { "value": { "@odata.type": "#microsoft.graph.security.analyzedEmail",- "id": "3570a93a-82b1-ffb9-8c26-a9a2ca002a17", - "loggedDateTime": "String (timestamp)", + "id": "String", + "loggedDateTime": "Datetime", "networkMessageId": "String", "internetMessageId": "String", "senderDetail": { "@odata.type": "microsoft.graph.security.analyzedEmailSenderDetail" },- "recipientEmailAddresses": [ - "String" - ], + "recipientEmailAddress": "String", "distributionList": "String", "subject": "String", "returnPath": "String",- "directionality": "String", + "directionality": "microsoft.graph.security.antispamDirectionality", "originalDelivery": { "@odata.type": "microsoft.graph.security.analyzedEmailDeliveryDetail" }, Content-Type: application/json "overrideSources": [ "String" ],- "threatType": "String", + "threatTypes": [ + "microsoft.graph.security.threatType" + ], "detectionMethods": [ "String" ], Content-Type: application/json } } ```- |
v1.0 | Security Analyzedemail Remediate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-analyzedemail-remediate.md | Remove a potential threat from end users' mailboxes. Remediation means to take prescribed action against a threat. This API can trigger email purge actions like move to junk, move to deleted items, soft delete, hard delete, or move to Inbox. This API enables scenarios and use cases such as SOAR integration, playbooks, and automations. For more information read [email remediation, trigger action and track actions](/microsoft-365/security/office-365-security/remediate-malicious-email-delivered-office-365?view=o365-worldwide&preserve-view=true). If there is false positives admins can take move to inbox action. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 table lists the parameters that are required when you call this ac |description|String| The description of the remediation. | |severity|microsoft.graph.security.remediationSeverity| The severity of the remediation. The possible values are: `low`, `medium`, `high`, `unknownFutureValue`.| |action|microsoft.graph.security.remediationAction|The types of move and delete actions that are supported. The possible values are: `moveToJunk`, `moveToInbox`, `hardDelete`, `softDelete`, `moveToDeletedItems`, `unknownFutureValue`.|-|approverUpn|String| Tracks who approved the action. | |remediateSendersCopy|Boolean| For internal or outbound email, indicates whether to remediate the sender's copy of an email. |-|analyzedEmails|[microsoft.graph.security.analyzedEmail](../resources/security-analyzedemail.md) collection|The unique ID of the analyzed email. The ID can be found from the analyzedemails, analyzedemails/Id or runHuntingQuery/reportId. +|analyzedEmails|[microsoft.graph.security.analyzedEmail](../resources/security-analyzedemail.md) collection| Contains the **networkMessageId** and **recipientEmailAddress** values of the analyzed emails. | ## Response Content-Type: application/json "severity": "medium", "action": "softDelete", "remediateSendersCopy": "false",- "analyzedEmails": [ - { - "id": "73ca4154-58d8-43d0-a890-08dc18c52e6d-1311265001240363512-1" - }, - { - "id": "73ca4154-58d8-43d0-a890-08dc18c52e6d-13805748846361900678-1" - } + "analyzedEmails": [ + { + "networkMessageId": "73ca4154-58d8-43d0-a890-08dc18c52e6d", + "recipientEmailAddress": "hannah.jarvis@contoso.com" + }, + { + "networkMessageId": "73ca4154-58d8-43d0-a890-08dc18c52e6d", + "recipientEmailAddress": "preston.morales@contoso.com" + } ] } ``` Location: https://security.microsoft.com/action-center/history?filters={"bulkId" Content-Type: application/json;text/plain Content-Length: 0 ```---- |
v1.0 | Security Authoritytemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-authoritytemplate-get.md | The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/security/labels/authorities/{authorityTemplateId} +GET https://graph.microsoft.com/beta/security/labels/authorities/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [C#](#tab/csharp) GET https://graph.microsoft.com/beta/security/labels/authorities/{authorityTempl ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "value": { "@odata.type": "#microsoft.graph.security.authorityTemplate",- "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", - "displayName": "String", + "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5", + "displayName": "Business", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` |
v1.0 | Security Categorytemplate Delete Subcategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-categorytemplate-delete-subcategories.md | Title: "Delete subCategoryTemplate" -description: "Delete a subCategoryTemplate object." + Title: "Delete subcategoryTemplate" +description: "Delete a subcategoryTemplate object." ms.localizationpriority: medium doc_type: apiPageType -# Delete subCategoryTemplate +# Delete subcategoryTemplate Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Delete a [subCategoryTemplate](../resources/security-subcategorytemplate.md) object. +Delete a [subcategoryTemplate](../resources/security-subcategorytemplate.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). Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId}/$ref +DELETE /security/labels/categories/{categoryTemplateId}/subcategories/{subcategoryTemplateId}/$ref ``` ## Request headers The following example shows a request. } --> ``` http-DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +DELETE https://graph.microsoft.com/beta/security/labels/categories/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5/subcategories/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/delete-subcategorytemplate-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) + ### Response-The following example shows the response. +Here's an example of the response. > <!-- { "blockType": "response", |
v1.0 | Security Categorytemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-categorytemplate-get.md | GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemp ``` ## Optional query parameters-This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports some of the OData query parameters to help customize the response. For example, to retrieve the **subcategories** property associated with this particular category, you can use the `expand` parameter:`$expand=subcategories`. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers |Name|Description| The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId} +GET https://graph.microsoft.com/beta/security/labels/categories/e2c79762-34a9-75ba-b6f0-a7c9a57978ef ``` # [C#](#tab/csharp) GET https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplat ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef",- "displayName": "String", + "displayName": "Accounts payable", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` |
v1.0 | Security Categorytemplate List Subcategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-categorytemplate-list-subcategories.md | Title: "List subCategories" -description: "Get the subCategoryTemplate resources from the subCategories navigation property." + Title: "List subcategories" +description: "Get a list of subcategoryTemplate resources associated with a category template." ms.localizationpriority: medium doc_type: apiPageType -# List subCategories +# List subcategories Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a list of subcategories [subCategoryTemplate](../resources/security-subcategorytemplate.md) associated with a category template. +Get a list of [subcategoryTemplate](../resources/security-subcategorytemplate.md) objects associated with a category template. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +GET /security/labels/categories/{categoryTemplateId}/subcategories ``` ## Optional query parameters 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.subCategoryTemplate](../resources/security-subcategorytemplate.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) objects in the response body. ## Examples The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +GET https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId}/subcategories ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/list-subcategorytemplate-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) + ### Response The following example shows the response. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "Collection(microsoft.graph.security.subCategoryTemplate)" + "@odata.type": "Collection(microsoft.graph.security.subcategoryTemplate)" } --> ``` http Content-Type: application/json { "value": [ {- "@odata.type": "#microsoft.graph.security.subCategoryTemplate", + "@odata.type": "#microsoft.graph.security.subcategoryTemplate", "id": "2ac39915-dbeb-e933-82e2-92b981835fa0",- "displayName": "String", + "displayName": "Vendor Invoice", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" } ] } |
v1.0 | Security Categorytemplate Post Subcategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-categorytemplate-post-subcategories.md | Title: "Create subCategoryTemplate" -description: "Create a new subCategoryTemplate object." + Title: "Create subcategoryTemplate" +description: "Create a new subcategoryTemplate object." ms.localizationpriority: medium doc_type: apiPageType -# Create subCategoryTemplate +# Create subcategoryTemplate Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new [subCategoryTemplate](../resources/security-subcategorytemplate.md) object. +Create a new [subcategoryTemplate](../resources/security-subcategorytemplate.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). Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-POST /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +POST /security/labels/categories/{categoryTemplateId}/subcategories ``` ## Request headers POST /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTem |Content-Type|application/json. Required.| ## Request body-In the request body, supply a JSON representation of the [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object. +In the request body, supply a JSON representation of the [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object. -You can specify the following properties when creating a **subCategoryTemplate**. +You can specify the following properties when creating a **subcategoryTemplate**. |Property|Type|Description| |:|:|:|-|displayName|String| Unique string that defines a sub-category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md). Optional.| +|displayName|String| Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md). Optional.| ## Response--If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body. ## Examples The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +POST https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId}/subcategories Content-Type: application/json {- "@odata.type": "#microsoft.graph.security.subCategoryTemplate", - "displayName": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - } + "@odata.type": "#microsoft.graph.security.subcategoryTemplate", + "displayName": "Vendor Invoice", } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/create-subcategorytemplate-from--javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) + ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.security.subCategoryTemplate" + "@odata.type": "microsoft.graph.security.subcategoryTemplate" } --> ``` http HTTP/1.1 201 Created Content-Type: application/json {- "@odata.type": "#microsoft.graph.security.subCategoryTemplate", + "@odata.type": "#microsoft.graph.security.subcategoryTemplate", "id": "2ac39915-dbeb-e933-82e2-92b981835fa0",- "displayName": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" -} + "displayName": "Vendor Invoice", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } ``` |
v1.0 | Security Citationtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-citationtemplate-get.md | The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/security/labels/citations/{citationTemplateId} +GET https://graph.microsoft.com/beta/security/labels/citations/c0475d01-d532-8a53-6e26-14ea58c640bf ``` # [C#](#tab/csharp) GET https://graph.microsoft.com/beta/security/labels/citations/{citationTemplate ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf",- "displayName": "String", + "displayName": "Contoso Company Policy", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)", - "citationUrl": "String", - "citationJurisdiction": "String" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" } } ``` |
v1.0 | Security Collaborationroot List Analyzedemails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-collaborationroot-list-analyzedemails.md | Get a list of [analyzedEmail](../resources/security-analyzedemail.md) objects an This API allows Security Operations teams to have direct access to hunt (query) for threats, IOCs, attack vectors, and evidences for a tenant. It is a powerful, near real-time tool to help Security Operations teams investigate and respond to threats. It consists of email metadata, verdict information, related underlying entities (attachments/URL), filters, and more. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). In the request URL, provide the following required query parameters with values. ### OData 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 following OData query parameters to help customize the response: `$count`, `$filter`, `$skiptoken`, `$top`. For general information, see [OData query parameters](/graph/query-parameters). The following example shows how to use the `$filter` parameter to customize the response. <!-- { The following example shows how to use the `$filter` parameter to customize the } --> ``` http-GET /security/collaboration/analyzedemails?startTime=2024-02-18&endTime=2024-02-20&filter=NetworkMessageId eq 'bde1f764-bbf4-5673-fbba-0asdhsgfhf1' +GET /security/collaboration/analyzedemails?startTime=2024-02-18&endTime=2024-02-20&filter=networkMessageId eq 'bde1f764-bbf4-5673-fbba-0asdhsgfhf1' +GET /security/collaboration/analyzedemails?startTime=2024-02-18&endTime=2024-02-20&filter=networkMessageId eq 'bde1f764-bbf4-5673-fbba-0asdhsgfhf1' and recipientEmailAddress eq 'tomas.richardson@contoso.com' ``` ## Request headers The following example shows a request. GET https:security/collaboration/analyzedemails?startTime=2024-02-18&endTime=2024-02-20 ``` - ### Response The following example shows the response. Content-Type: application/json "value": [ { "@odata.type": "#microsoft.graph.security.analyzedEmail",- "id": "3570a93a-82b1-ffb9-8c26-a9a2ca002a17", - "loggedDateTime": "String (timestamp)", + "id": "String", + "loggedDateTime": "Datetime", "networkMessageId": "String", "internetMessageId": "String", "senderDetail": { "@odata.type": "microsoft.graph.security.analyzedEmailSenderDetail" },- "recipientEmailAddresses": [ - "String" - ], + "recipientEmailAddress": "String", "distributionList": "String", "subject": "String", "returnPath": "String",- "directionality": "String", + "directionality": "microsoft.graph.security.antispamDirectionality", "originalDelivery": { "@odata.type": "microsoft.graph.security.analyzedEmailDeliveryDetail" }, Content-Type: application/json "@odata.type": "microsoft.graph.security.analyzedEmailDeliveryDetail" }, "attachmentsCount": "Integer",- "attachments": [ - { - "@odata.type": "microsoft.graph.security.analyzedEmailAttachment" - } - ], "urlsCount": "Integer",- "urls": [ - { - "@odata.type": "microsoft.graph.security.analyzedEmailUrl" - } - ], "language": "String", "sizeInBytes": "Integer", "alertIds": [ Content-Type: application/json "overrideSources": [ "String" ],- "threatType": "String", + "threatTypes": [ + "microsoft.graph.security.threatType" + ], "detectionMethods": [ "String" ], Content-Type: application/json ] } ```- |
v1.0 | Security Departmenttemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-departmenttemplate-get.md | The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/security/labels/departments/{departmentTemplateId} +GET https://graph.microsoft.com/beta/security/labels/departments/11b44677-9f06-c85a-4a0b-766b66904bf8 ``` # [C#](#tab/csharp) GET https://graph.microsoft.com/beta/security/labels/departments/{departmentTemp ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8",- "displayName": "String", + "displayName": "Finance", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` |
v1.0 | Security Detectionrule Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-detectionrule-delete.md | DELETE https://graph.microsoft.com/beta/security/rules/detectionRules/302 [!INCLUDE [sample-code](../includes/snippets/php/delete-detectionrule-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-detectionrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Security Detectionrule Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-detectionrule-get.md | GET https://graph.microsoft.com/beta/security/rules/detectionRules/7506 [!INCLUDE [sample-code](../includes/snippets/php/get-detectionrule-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-detectionrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Security Detectionrule List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-detectionrule-list.md | GET https://graph.microsoft.com/beta/security/rules/detectionRules?$top=3 [!INCLUDE [sample-code](../includes/snippets/php/list-detectionrule-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-detectionrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Security Ediscoverysearch Exportreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/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. ++<!-- { + "blockType": "request", + "name": "export_report1" +} +--> +``` http +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 ++{ + "displayName": "Export 1", + "exportCriteria": "searchHits", + "additionalOptions": "none" +} +``` ++#### 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/beta/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 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. ++#### Request ++The following example shows a request. ++<!-- { + "blockType": "request", + "name": "export_report2" +} +--> +``` http +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 ++{ + "displayName": "Export 2", + "exportCriteria": "searchHits, partiallyIndexed", + "exportLocation": "responsiveLocations, nonresponsiveLocations", + "additionalOptions": "none" +} +``` ++#### 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/beta/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. ++<!-- { + "blockType": "request", + "truncated": true, + "name": "export_report3" +} +--> +``` http +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 ++{ + "displayName": "Export 3", + "exportCriteria": "searchHits, partiallyIndexed", + "exportLocation": "responsiveLocations", + "additionalOptions": "none" +} +``` ++#### 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/beta/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. ++<!-- { + "blockType": "request", + "name": "export_report4" +} +--> +``` http +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 ++{ + "displayName": "Export 4", + "exportCriteria": "partiallyIndexed", + "exportLocation": "responsiveLocations, nonresponsiveLocations", + "additionalOptions": "teamsAndYammerConversations, cloudAttachments, allDocumentVersions, subfolderContents, listAttachments" +} +``` ++#### 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/beta/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. ++<!-- { + "blockType": "request", + "name": "export_report5" +} +--> +``` http +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 ++{ + "displayName": "Export 5", + "exportCriteria": "partiallyIndexed", + "exportLocation": "responsiveLocations", + "additionalOptions": "cloudAttachments" +} +``` ++#### 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/beta/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/beta/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 be 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 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 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, excluding partially indexed items, with no additional options selected, as .pst files for each mailbox. ++#### Request ++The following example shows a request. ++<!-- { + "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" +} +``` ++#### 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. ++<!-- { + "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" +} +``` ++#### 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. ++<!-- { + "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" +} +``` ++#### 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. ++<!-- { + "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" +} +``` ++#### 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. ++<!-- { + "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" +} +``` ++#### 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 Fileplanreferencetemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-fileplanreferencetemplate-get.md | The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/security/labels/filePlanReferences/{filePlanReferenceTemplateId} +GET https://graph.microsoft.com/beta/security/labels/filePlanReferences/b1f7b518-a44f-1d4b-c6f1-ab8771d3907c ``` # [C#](#tab/csharp) GET https://graph.microsoft.com/beta/security/labels/filePlanReferences/{filePla ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c",- "displayName": "String", + "displayName": "FIN 01-02-001", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` |
v1.0 | Security Healthissue Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-healthissue-get.md | + + Title: "Get healthIssue" +description: "Read the properties and relationships of a healthIssue object." ++ms.localizationpriority: medium Last updated : 03/20/2024+++# 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} +``` +++## 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", + "sampleKeys": ["b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c"], + "name": "get_security_healthissue" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/identities/healthIssues/b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c +``` ++# [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", + "name": "get_security_healthissue" +} +--> +``` http +HTTP/1.1 200 OK +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", + "healthIssueType": "Global", + "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)" + ] +} +``` + |
v1.0 | Security Healthissue Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-healthissue-update.md | + + Title: "Update healthIssue" +description: "Update the properties of a healthIssue object." ++ms.localizationpriority: medium Last updated : 03/20/2024+++# 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", + "sampleKeys": ["b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c"], + "name": "update_healthissue" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/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, + "name": "update_healthissue" +} +--> +``` http +HTTP/1.1 200 OK +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", + "healthIssueType": "Global", + "issueTypeId": "1031", + "severity": "medium", + "status": "closed", + "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)" + ] +} +``` + |
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 | + + Title: "List healthIssues" +description: "Get a list of health issue objects and their properties." ++ms.localizationpriority: medium Last updated : 03/20/2024+++# List healthIssues ++Namespace: microsoft.graph.security +++Get a list of [health issue](../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 following OData query parameters to help customize the response: `$count`, `$filter`, `$skip`, `$top`. For general information, see [OData query parameters](/graph/query-parameters). ++The following 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' +``` ++See open global health alerts that domain name \ sensor DNS name ends with spesific value (name=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 [healthIssue](../resources/security-healthissue.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_healthIssues" +} +--> +``` http +GET https://graph.microsoft.com/beta/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)", + "name": "get_healthIssues" +} +--> +``` http +HTTP/1.1 200 OK +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", + "healthIssueType": "Global", + "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)" + ] + } + ] +} +``` + |
v1.0 | Security Labelsroot Delete Authorities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-delete-authorities.md | The following example shows a request. } --> ``` http-DELETE https://graph.microsoft.com/beta/security/labels/authorities/{authorityTemplateId} +DELETE https://graph.microsoft.com/beta/security/labels/authorities/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [C#](#tab/csharp) DELETE https://graph.microsoft.com/beta/security/labels/authorities/{authorityTe ### Response-The following example shows the response. +Here's an example of the response. > <!-- { "blockType": "response", |
v1.0 | Security Labelsroot Delete Categories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-delete-categories.md | The following example shows a request. } --> ``` http-DELETE https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId} +DELETE https://graph.microsoft.com/beta/security/labels/categories/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [C#](#tab/csharp) DELETE https://graph.microsoft.com/beta/security/labels/categories/{categoryTemp ### Response-The following example shows the response. +Here's an example of the response. > <!-- { "blockType": "response", |
v1.0 | Security Labelsroot Delete Citations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-delete-citations.md | The following example shows a request. } --> ``` http-DELETE https://graph.microsoft.com/beta/security/labels/citations/{citationTemplateId} -``` +DELETE https://graph.microsoft.com/beta/security/labels/citations/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/delete-citationtemplate-csharp-snippets.md)] DELETE https://graph.microsoft.com/beta/security/labels/citations/{citationTempl ### Response-The following example shows the response. +Here's an example of the response. > <!-- { "blockType": "response", |
v1.0 | Security Labelsroot Delete Departments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-delete-departments.md | The following example shows a request. } --> ``` http-DELETE https://graph.microsoft.com/beta/security/labels/departments/{departmentTemplateId} +DELETE https://graph.microsoft.com/beta/security/labels/departments/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [C#](#tab/csharp) DELETE https://graph.microsoft.com/beta/security/labels/departments/{departmentT ### Response-The following example shows the response. +Here's an example of the response. > <!-- { "blockType": "response", |
v1.0 | Security Labelsroot Delete Fileplanreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-delete-fileplanreferences.md | The following example shows a request. } --> ``` http-DELETE https://graph.microsoft.com/beta/security/labels/filePlanReferences/{filePlanReferenceTemplateId} +DELETE https://graph.microsoft.com/beta/security/labels/filePlanReferences/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [C#](#tab/csharp) DELETE https://graph.microsoft.com/beta/security/labels/filePlanReferences/{file ### Response-The following example shows the response. +Here's an example of the response. > <!-- { "blockType": "response", |
v1.0 | Security Labelsroot List Authorities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-authorities.md | GET https://graph.microsoft.com/beta/security/labels/authorities ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.authorityTemplate", "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc",- "displayName": "String", + "displayName": "Business", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" + }, + { + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5", + "displayName": "Legal", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" } ] } |
v1.0 | Security Labelsroot List Categories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-categories.md | GET https://graph.microsoft.com/beta/security/labels/categories ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef",- "displayName": "String", + "displayName": "Accounts Payable", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)" - } + "createdDateTime": "2021-03-24T02:09:08Z" + }, + { + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5", + "displayName": "Accounts", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } ] } ``` |
v1.0 | Security Labelsroot List Citations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-citations.md | GET https://graph.microsoft.com/beta/security/labels/citations ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf",- "displayName": "String", + "displayName": "Contoso Company Policy", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)", - "citationUrl": "String", - "citationJurisdiction": "String" + "createdDateTime": "2021-03-24T02:09:08Z", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" } ] } |
v1.0 | Security Labelsroot List Departments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-departments.md | GET https://graph.microsoft.com/beta/security/labels/departments ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8",- "displayName": "String", + "displayName": "Finance", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" } ] } |
v1.0 | Security Labelsroot List Fileplanreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-fileplanreferences.md | GET https://graph.microsoft.com/beta/security/labels/filePlanReferences ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c",- "displayName": "String", + "displayName": "FIN 01-02-001", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" } ] } |
v1.0 | Security Labelsroot List Retentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-retentionlabel.md | If successful, this method returns a `200 OK` response code and a collection of ## Examples ### Request-+Here's an example of a request. # [HTTP](#tab/http) <!-- { "blockType": "request", GET https://graph.microsoft.com/beta/security/labels/retentionLabels ### Response+Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.retentionLabel", "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",- "displayName": "String", - "behaviorDuringRetentionPeriod": "String", - "actionAfterRetentionPeriod": "String", - "retentionTrigger": "String", + "displayName": "Retention Schedule 10004", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "relabel", + "retentionTrigger": "dateCreated", "retentionDuration": {- "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": "730" },- "isInUse": "Boolean", - "descriptionForAdmins": "String", - "descriptionForUsers": "String", + "isInUse": true, + "descriptionForAdmins": "creation based retention label for schedule 10004", + "descriptionForUsers": "retains for 2 years then relabeled", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)", + "createdDateTime": "2017-11-27T02:10:12Z", "lastModifiedBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Records Manager" + } },- "lastModifiedDateTime": "String (timestamp)", - "labelToBeApplied": "String", - "defaultRecordBehavior": "String" + "lastModifiedDateTime": "2020-08-28T22:13:09Z", + "labelToBeApplied": "Retention schedule 10005", + "defaultRecordBehavior": "startLocked" } ] } |
v1.0 | Security Labelsroot Post Authorities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-authorities.md | You can specify the following properties when creating a **authorityTemplate**. |Property|Type|Description| |:|:|:|-|displayName|String|Unique string that defines an authortiy name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| +|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| Content-Type: application/json { "@odata.type": "#microsoft.graph.security.authorityTemplate",- "displayName": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - } + "displayName": "Business", } ``` Content-Type: application/json ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.authorityTemplate", "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc",- "displayName": "String", + "displayName": "Business", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` |
v1.0 | Security Labelsroot Post Categories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-categories.md | Content-Type: application/json { "@odata.type": "#microsoft.graph.security.categoryTemplate",- "displayName": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - } + "displayName": "Accounts Payable", } ``` Content-Type: application/json ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef",- "displayName": "String", + "displayName": "Accounts Payable", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` |
v1.0 | Security Labelsroot Post Citations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-citations.md | Content-Type: application/json { "@odata.type": "#microsoft.graph.security.citationTemplate",- "displayName": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "citationUrl": "String", - "citationJurisdiction": "String" + "displayName": "Contoso Company Policy", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" } ``` Content-Type: application/json ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf",- "displayName": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "displayName": "Contoso Company Policy", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },+ "createdDateTime" : "2021-03-24T02:09:08Z", "createdDateTime": "String (timestamp)",- "citationUrl": "String", + "citationUrl": "www.citationUrl.com", "citationJurisdiction": "String" } ``` |
v1.0 | Security Labelsroot Post Departments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-departments.md | Content-Type: application/json { "@odata.type": "#microsoft.graph.security.departmentTemplate",- "displayName": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - } + "displayName": "Finance", } ``` Content-Type: application/json ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8",- "displayName": "String", + "displayName": "Finance", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` |
v1.0 | Security Labelsroot Post Fileplanreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-fileplanreferences.md | Content-Type: application/json { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate",- "displayName": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - } + "displayName": "FIN 01-02-001", } ``` Content-Type: application/json ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c",- "displayName": "String", + "displayName": "FIN 01-02-001", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } },- "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` |
v1.0 | Security Labelsroot Post Retentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-retentionlabel.md | Specify the following properties when you create a **retentionLabel**. |dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained. | |retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content. | |retentionTrigger|microsoft.graph.security.retentionTrigger|Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`, `unknownFutureValue`. |-|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created.The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`. | +|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it's created. The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`. | |labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. | If successful, this method returns a `201 Created` response code and a [microsof ## Examples ### Request+Here's an example of a request. # [HTTP](#tab/http) <!-- { Content-length: 555 { "@odata.type": "#microsoft.graph.security.retentionLabel",- "displayName": "String", - "behaviorDuringRetentionPeriod": "String", - "actionAfterRetentionPeriod": "String", - "retentionTrigger": "String", + "displayName": "Retention Schedule 10005", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "startDispositionReview", + "retentionTrigger": "dateOfEvent", + "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')", "retentionDuration": {- "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": 2555 },- "isInUse": "Boolean", - "descriptionForAdmins": "String", - "descriptionForUsers": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "labelToBeApplied": "String", - "defaultRecordBehavior": "String", + "dispositionReviewStages": [ + { + "stageNumber" : 1, + "name": "Stage1", + "reviewersEmailAddresses ": [ + "Admin@contoso.onmicrosoft.com" + ] + } + ], + "descriptionForAdmins": "retain for 7 years", + "descriptionForUsers": "retain for 7 years", "descriptors": { "authorityTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/authorities('fie3f4fc-b966-4c40-94de-fb8a383658e4')", "categoryTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/categories('0bjk8-b966-4c40-94de-fb8a383658e4')", Content-length: 555 "departmentTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/departments('p99ef4fc-b966-4c40-94de-fb8a383658e4')", "filePlanReferenceTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/filePlanReferences('e095f4fc-b966-4c40-94de-fb8a383658e4')" },+ "defaultRecordBehavior":"startLocked", } ``` Content-length: 555 [!INCLUDE [sample-code](../includes/snippets/php/create-retentionlabel-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-retentionlabel-from--python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-length: 555 ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json { "@odata.type": "#microsoft.graph.security.retentionLabel", "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",- "displayName": "String", - "behaviorDuringRetentionPeriod": "String", - "actionAfterRetentionPeriod": "String", - "retentionTrigger": "String", + "displayName": "Retention Schedule 10005", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "startDispositionReview", + "retentionTrigger": "dateOfEvent", "retentionDuration": {- "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": 2555 },- "isInUse": "Boolean", - "descriptionForAdmins": "String", - "descriptionForUsers": "String", + "dispositionReviewStages": [ + { + "stageNumber" : 1, + "name": "Stage1", + "reviewersEmailAddresses ": [ + "Admin@contoso.onmicrosoft.com" + ] + } + ], + "isInUse": true, + "descriptionForAdmins": "retain for 7 years", + "descriptionForUsers": "retain for 7 years", + "defaultRecordBehavior":"startLocked", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)", - "lastModifiedBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Admin" + } },- "lastModifiedDateTime": "String (timestamp)", - "labelToBeApplied": "String", - "defaultRecordBehavior": "String", + "createdDateTime": "2021-08-23T16:43:55Z", + "labelToBeApplied": " ", + "defaultRecordBehavior": "startLocked", "descriptors": { "authority": { "displayName": "Business" |
v1.0 | Security Retentionevent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionevent-get.md | If successful, this method returns a `200 OK` response code and a [microsoft.gra ## Examples ### Request-+Here's an example of a request. # [HTTP](#tab/http) <!-- { "blockType": "request", GET https://graph.microsoft.com/beta/security/triggers/retentionEvents/{retentio ### Response+Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "description": "String", "eventQueries": [ {- "@odata.type": "microsoft.graph.security.eventQueries" + "@odata.type": "microsoft.graph.security.eventQuery" } ], "eventTriggerDateTime": "String (timestamp)", |
v1.0 | Security Retentionevent List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionevent-list.md | If successful, this method returns a `200 OK` response code and a collection of ## Examples ### Request-+Here's an example of a request. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/beta/security/triggers/retentionEvents ### Response+Here's an example of a request. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "description": "String", "eventQueries": [ {- "@odata.type": "microsoft.graph.security.eventQueries" + "@odata.type": "microsoft.graph.security.eventQuery" } ], "eventTriggerDateTime": "String (timestamp)", |
v1.0 | Security Retentionevent Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionevent-post.md | Title: "Create retentionEvent" description: "Create a new retentionEvent object."-+ ms.localizationpriority: medium doc_type: apiPageType Specify the following properties when creating a **retentionEvent**. |:|:|:| |description|String|Optional information about the event.| |displayName|String|Name of the event.|-|eventQuery|[microsoft.graph.security.eventQueries](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| +|eventQuery|[microsoft.graph.security.eventQuery](../resources/security-eventquery.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| |eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| |retentionEventType|String|Name of the event type associated with the event.| If successful, this method returns a `201 Created` response code and a [microsof ## Examples ### Request+Here's an example of a request. # [HTTP](#tab/http) <!-- { Content-length: 616 "description": "String", "eventQueries": [ {- "@odata.type": "microsoft.graph.security.eventQueries" + "@odata.type": "microsoft.graph.security.eventQuery" } ], "eventTriggerDateTime": "String (timestamp)", Content-length: 616 ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "description": "String", "eventQueries": [ {- "@odata.type": "microsoft.graph.security.eventQueries" + "@odata.type": "microsoft.graph.security.eventQuery" } ], "eventTriggerDateTime": "String (timestamp)", |
v1.0 | Security Retentionlabel Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionlabel-delete.md | If successful, this method returns a `204 No Content` response code. ## Examples ### Request+Here's an example of a request. # [HTTP](#tab/http) <!-- { If successful, this method returns a `204 No Content` response code. } --> ``` http-DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId} +DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50 ``` # [C#](#tab/csharp) DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/{retenti ### Response+Here's an example of the response. + > <!-- { "blockType": "response", |
v1.0 | Security Retentionlabel Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionlabel-get.md | GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabel ``` ## Optional query parameters-This method supports the expand OData query parameters to help customize the response. For example, to retrieve the **retentionEventType** property, you can use the `expand` parameter:`$expand=retentionEventType`. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the expand OData query parameters to help customize the response. For example, to retrieve the **retentionEventType** property, you can use the `expand` parameter:`$expand=retentionEventType` or `$expand=descriptors`. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers |Name|Description| If successful, this method returns a `200 OK` response code and a [microsoft.gra ## Examples ### Request+Here's an example of a request. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retention ### Response+Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.retentionLabel", "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",- "displayName": "String", - "behaviorDuringRetentionPeriod": "String", - "actionAfterRetentionPeriod": "String", - "retentionTrigger": "String", - "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration" - }, - "isInUse": "Boolean", - "descriptionForAdmins": "String", - "descriptionForUsers": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)", - "lastModifiedBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "lastModifiedDateTime": "String (timestamp)", - "labelToBeApplied": "String", - "defaultRecordBehavior": "String" + "displayName": "Retention Schedule 10004", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "relabel", + "retentionTrigger": "dateCreated", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": 730 + }, + "isInUse": true, + "descriptionForAdmins": "creation based retention label for schedule 10004", + "descriptionForUsers": "retains for 2 years then relabeled", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2017-11-27T02:10:12Z", + "lastModifiedBy": { + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Records Manager" + } + }, + "lastModifiedDateTime": "2020-08-28T22:13:09Z", + "labelToBeApplied": "Retention schedule 10005", + "defaultRecordBehavior": "startLocked" } } ``` |
v1.0 | Security Retentionlabel Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionlabel-update.md | PATCH /security/labels/retentionLabels/{retentionLabelId} |descriptionForUsers|String|This is an optional property that provides the label information for the user.| |dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained.| |retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content.|-|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created.The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`.| +|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created. The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`.| |labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. | ## Response -If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) object in the response body. +If successful, this method returns a `204 No Content` response code. ## Examples ### Request+Here's an example of a request. # [HTTP](#tab/http) <!-- { If successful, this method returns a `200 OK` response code and an updated [micr } --> ``` http-PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId} +PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50 Content-Type: application/json Content-length: 555 { "@odata.type": "#microsoft.graph.security.retentionLabel", "retentionDuration": {- "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": 2555 },- "descriptionForAdmins": "String", - "descriptionForUsers": "String", - "labelToBeApplied": "String", - "defaultRecordBehavior": "String" } ``` Content-length: 555 ### Response->**Note:** The response object shown here might be shortened for readability. +Here's an example of the response. + <!-- {- "blockType": "response", - "truncated": true, - "@odata.type": "microsoft.graph.security.retentionLabel" + "blockType": "response" } --> ``` http-HTTP/1.1 200 OK -Content-Type: application/json --{ - "@odata.type": "#microsoft.graph.security.retentionLabel", - "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", - "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration" - }, - "descriptionForAdmins": "String", - "descriptionForUsers": "String", - "labelToBeApplied": "String", - "defaultRecordBehavior": "String" -} +HTTP/1.1 204 No Content ``` |
v1.0 | Security Security Runhuntingquery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-security-runhuntingquery.md | Title: "security: runHuntingQuery" -description: "Run Hunting query API" +description: "Query a specified set of event, activity, or entity data supported by Microsoft 365 Defender to proactively look for specific threats in your environment." ms.localizationpriority: medium Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Queries a specified set of event, activity, or entity data supported by Microsoft 365 Defender to proactively look for specific threats in your environment. +Query a specified set of event, activity, or entity data supported by Microsoft 365 Defender to proactively look for specific threats in your environment. -This is the method for advanced hunting in Microsoft 365 Defender. This method includes a query in Kusto Query Language (KQL). It specifies a data table in the [advanced hunting schema](/microsoft-365/security/defender/advanced-hunting-schema-tables?view=o365-worldwide&preserve-view=true) and a piped sequence of operators to filter or search that data, and format the query output in specific ways. +This method is for advanced hunting in Microsoft 365 Defender. This method includes a query in Kusto Query Language (KQL). It specifies a data table in the [advanced hunting schema](/microsoft-365/security/defender/advanced-hunting-schema-tables?view=o365-worldwide&preserve-view=true) and a piped sequence of operators to filter or search that data, and format the query output in specific ways. Find out more about [hunting for threats across devices, emails, apps, and identities](/microsoft-365/security/defender/advanced-hunting-query-emails-devices?view=o365-worldwide&preserve-view=true). Learn about [KQL](/azure/data-explorer/kusto/query/). If successful, this action returns a `200 OK` response code and a [huntingQueryR ### Request -This example specifies a KQL query which does the following: +This example specifies a KQL query that: - Looks into the [DeviceProcessEvents](/microsoft-365/security/defender/advanced-hunting-deviceprocessevents-table?view=o365-worldwide&preserve-view=true) table in the advanced hunting schema. - Filters on the condition that the event is initiated by the powershell.exe process.-- Specifies the output of 3 columns from the same table for each row: `Timestamp`, `FileName`, `InitiatingProcessFileName`.+- Specifies the output of three columns from the same table for each row: `Timestamp`, `FileName`, `InitiatingProcessFileName`. - Sorts the output by the `Timestamp` value.-- Limits the output to 2 records (2 rows).+- Limits the output to two records (two rows). # [HTTP](#tab/http) POST https://graph.microsoft.com/beta/security/runHuntingQuery >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",- "@odata.type": "microsoft.graph.security.huntingQueryResults" + "@odata.type": "microsoft.graph.security.huntingQueryResults", + "truncated": true } --> |
v1.0 | Security Subcategorytemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-subcategorytemplate-get.md | Title: "Get subCategoryTemplate" -description: "Read the properties and relationships of a subCategoryTemplate object." + Title: "Get subcategoryTemplate" +description: "Read the properties and relationships of a subcategoryTemplate object." ms.localizationpriority: medium doc_type: apiPageType -# Get subCategoryTemplate +# Get subcategoryTemplate Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Read the properties and relationships of a [subCategoryTemplate](../resources/security-subcategorytemplate.md) object. +Read the properties and relationships of a [subcategoryTemplate](../resources/security-subcategorytemplate.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). Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +GET /security/labels/categories/{categoryTemplateId}/subcategories/{subcategoryTemplateId} ``` ## Optional query parameters 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.subCategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body. ## Examples The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +GET https://graph.microsoft.com/beta/security/labels/categories/82d00422-1f60-46cd-9809-33ca0b4d2286/subcategories/2ac39915-dbeb-e933-82e2-92b981835fa0 ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/get-subcategorytemplate-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) + ### Response-The following example shows the response. +Here's an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.security.subCategoryTemplate" + "@odata.type": "microsoft.graph.security.subcategoryTemplate" } --> ``` http Content-Type: application/json { "value": {- "@odata.type": "#microsoft.graph.security.subCategoryTemplate", + "@odata.type": "#microsoft.graph.security.subcategoryTemplate", "id": "2ac39915-dbeb-e933-82e2-92b981835fa0",- "displayName": "String", + "displayName": "Vendor Invoice", "createdBy": {- "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} + } ``` |
v1.0 | Securitytoolawsresourceadministratorfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securitytoolawsresourceadministratorfinding-get.md | description: "Read the properties and relationships of a securityToolAwsResource ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Securitytoolawsresourceadministratorfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securitytoolawsresourceadministratorfinding-list.md | description: "Get a list of the securityToolAwsResourceAdministratorFinding obje ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Securitytoolawsroleadministratorfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securitytoolawsroleadministratorfinding-get.md | description: "Read the properties and relationships of a securityToolAwsRoleAdmi ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Securitytoolawsroleadministratorfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securitytoolawsroleadministratorfinding-list.md | description: "Get a list of the securityToolAwsRoleAdministratorFinding objects ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Securitytoolawsserverlessfunctionadministratorfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securitytoolawsserverlessfunctionadministratorfinding-get.md | description: "Read the properties and relationships of a securityToolAwsServerle ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Securitytoolawsserverlessfunctionadministratorfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securitytoolawsserverlessfunctionadministratorfinding-list.md | description: "Get a list of the securityToolAwsServerlessFunctionAdministratorFi ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Securitytoolawsuseradministratorfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securitytoolawsuseradministratorfinding-get.md | description: "Read the properties and relationships of a securityToolAwsUserAdmi ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Securitytoolawsuseradministratorfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securitytoolawsuseradministratorfinding-list.md | description: "Get a list of the securityToolAwsUserAdministratorFinding objects ms.localizationpriority: medium+ doc_type: apiPageType |
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 one of the following directory roles, which allow them to read sign-in reports: +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 Administrator + Global Reader + Reports Reader + Security Administrator + Security Operator + Security Reader -To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## 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 one of the following directory roles, which allow them to read sign-in reports: +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 Administrator + Global Reader + Reports Reader + Security Administrator + Security Operator + Security Reader -To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## 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 one of the following directory roles, which allow them to read sign-in reports: +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 Administrator + Global Reader + Reports Reader + Security Administrator + Security Operator + Security Reader -To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) - ## 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 one of the following directory roles, which allow them to read sign-in reports: +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 Administrator + Global Reader + Reports Reader + Security Administrator + Security Operator + Security Reader -To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). - ## 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 one of the following directory roles, which allow them to read sign-in reports: +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 Administrator + Global Reader + Reports Reader + Security Administrator + Security Operator + Security Reader -To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). - ## HTTP request <!-- { |
v1.0 | Serviceprincipal Addtokensigningcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-addtokensigningcertificate.md | All the objects have the same value of **customKeyIdentifier**. The **passwordCredential** is used to open the PFX file (private key). It and the associated private key object have the same value of **keyId**. Once set during creation through the **displayName** property, the subject of the certificate cannot be updated. The **startDateTime** is set to the same time the certificate is created using the action. The **endDateTime** can be up to three years after the certificate is created. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Serviceprincipal Createpasswordsinglesignoncredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-createpasswordsinglesignoncredentials.md | Namespace: microsoft.graph Create single sign-on credentials using a password for a user or group. ## Permissions |
v1.0 | Serviceprincipal Delete Approleassignedto | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete-approleassignedto.md | Namespace: microsoft.graph Deletes an [appRoleAssignment](../resources/approleassignment.md) that a user, group, or client service principal has been granted for a resource service principal. ## Permissions |
v1.0 | Serviceprincipal Delete Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete-approleassignments.md | Deletes an [appRoleAssignment](../resources/approleassignment.md) that a service App roles that are assigned to service principals are also known as [application permissions](/azure/active-directory/develop/v2-permissions-and-consent#permission-types). Deleting an app role assignment for a service principal is equivalent to revoking the app-only permission grant. ## Permissions |
v1.0 | Serviceprincipal Delete Claimsmappingpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete-claimsmappingpolicies.md | Namespace: microsoft.graph Remove a [claimsMappingPolicy](../resources/claimsmappingpolicy.md) from a [servicePrincipal](../resources/servicePrincipal.md). ## Permissions |
v1.0 | Serviceprincipal Delete Delegatedpermissionclassifications | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete-delegatedpermissionclassifications.md | Namespace: microsoft.graph Deletes a [delegatedPermissionClassification](../resources/delegatedPermissionClassification.md) which had previously been set for a delegated permission. ## Permissions |
v1.0 | Serviceprincipal Delete Homerealmdiscoverypolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete-homerealmdiscoverypolicies.md | Namespace: microsoft.graph Remove a [homeRealmDiscoveryPolicy](../resources/homerealmdiscoverypolicy.md) from a [servicePrincipal](../resources/servicePrincipal.md). ## Permissions |
v1.0 | Serviceprincipal Delete Owners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete-owners.md | Namespace: microsoft.graph Remove an owner from a [servicePrincipal](../resources/serviceprincipal.md) object. As a recommended best practice, service principals should have at least two owners. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Serviceprincipal Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete.md | Namespace: microsoft.graph Delete a [servicePrincipal](../resources/serviceprincipal.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). |
v1.0 | Serviceprincipal Deletepasswordsinglesignoncredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-deletepasswordsinglesignoncredentials.md | Namespace: microsoft.graph Delete single sign-on credentials using a password for a user or group. ## Permissions |
v1.0 | Serviceprincipal Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delta.md | Namespace: microsoft.graph Get newly created, updated, or deleted service principals without having to perform a full read of the entire resource collection. ## Permissions |
v1.0 | Serviceprincipal Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-get.md | Namespace: microsoft.graph Retrieve the properties and relationships of a [servicePrincipal](../resources/serviceprincipal.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). |
v1.0 | Serviceprincipal Getpasswordsinglesignoncredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-getpasswordsinglesignoncredentials.md | Namespace: microsoft.graph Get a list of single sign-on credentials using a password for a user or group. ## Permissions |
v1.0 | Serviceprincipal List Approleassignedto | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-approleassignedto.md | If the resource service principal is an application that has app roles granted t >**Note** This request might have replication delays for app role assignments that were recently granted or removed. ## Permissions |
v1.0 | Serviceprincipal List Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-approleassignments.md | App roles that are assigned to service principals are also known as [application >**Note** This request might have replication delays for app role assignments that were recently granted or removed. ## Permissions |
v1.0 | Serviceprincipal List Claimsmappingpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-claimsmappingpolicies.md | Namespace: microsoft.graph List the [claimsMappingPolicy](../resources/claimsmappingpolicy.md) objects that are assigned to a [servicePrincipal](../resources/servicePrincipal.md). ## Permissions |
v1.0 | Serviceprincipal List Createdobjects | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-createdobjects.md | Namespace: microsoft.graph Retrieve a list of directoryobject 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). |
v1.0 | Serviceprincipal List Delegatedpermissionclassifications | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-delegatedpermissionclassifications.md | Namespace: microsoft.graph Retrieve the list of [delegatedPermissionClassification](../resources/delegatedpermissionclassification.md) currently configured for the delegated permissions exposed by an API. ## Permissions |
v1.0 | Serviceprincipal List Homerealmdiscoverypolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-homerealmdiscoverypolicies.md | Namespace: microsoft.graph List the [homeRealmDiscoveryPolicy](../resources/homerealmdiscoverypolicy.md) objects that are assigned to a [servicePrincipal](../resources/servicePrincipal.md). ## Permissions |
v1.0 | Serviceprincipal List Memberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-memberof.md | Namespace: microsoft.graph Get the groups and directory roles that this [servicePrincipal](../resources/serviceprincipal.md) is a direct member of. This operation isn't transitive. ## Permissions |
v1.0 | Serviceprincipal List Oauth2permissiongrants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-oauth2permissiongrants.md | Namespace: microsoft.graph Retrieve a list of [oAuth2PermissionGrant](../resources/oAuth2PermissionGrant.md) entities, representing delegated permissions granted to the service principal (representing the client application) to access an API on behalf of a user. ## Permissions |
v1.0 | Serviceprincipal List Ownedobjects | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-ownedobjects.md | Namespace: microsoft.graph Retrieve a list of objects owned by the [servicePrincipal](../resources/serviceprincipal.md). This could include applications or 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). |
v1.0 | Serviceprincipal List Owners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-owners.md | Namespace: microsoft.graph Retrieve a list of owners of the [servicePrincipal](../resources/serviceprincipal.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). |
v1.0 | Serviceprincipal List Tokenlifetimepolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-tokenlifetimepolicies.md | Namespace: microsoft.graph List the [tokenLifetimePolicy](../resources/tokenlifetimepolicy.md) objects that are assigned to a [servicePrincipal](../resources/serviceprincipal.md). Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to a service principal. ## Permissions |
v1.0 | Serviceprincipal List Transitivememberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-transitivememberof.md | Namespace: microsoft.graph Get the groups and directory roles that this [servicePrincipal](../resources/serviceprincipal.md) is a member of. This operation is transitive and will include all groups that this service principal is a nested member of. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Serviceprincipal List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list.md | Namespace: microsoft.graph Retrieve a list of [servicePrincipal](../resources/serviceprincipal.md) objects. ## Permissions |
v1.0 | Serviceprincipal Post Approleassignedto | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-approleassignedto.md | To grant an app role assignment, you need three identifiers: - `resourceId`: The `id` of the resource **servicePrincipal** which has defined the app role. - `appRoleId`: The `id` of the **appRole** (defined on the resource service principal) to assign to a user, group, or service principal. ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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. -->-|Permission type | Permissions (from least to most privileged) | -|:--|:| -|Delegated (work or school account) | AppRoleAssignment.ReadWrite.All and Application.Read.All, AppRoleAssignment.ReadWrite.All and Directory.Read.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | AppRoleAssignment.ReadWrite.All and Application.Read.All, AppRoleAssignment.ReadWrite.All and Directory.Read.All | [!INCLUDE [rbac-approleassignments-apis-write](../includes/rbac-for-apis/rbac-approleassignments-apis-write.md)] |
v1.0 | Serviceprincipal Post Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-approleassignments.md | To grant an app role assignment to a client service principal, you need three id - `resourceId`: The `id` of the resource `servicePrincipal` (the API) which has defined the app role (the application permission). - `appRoleId`: The `id` of the `appRole` (defined on the resource service principal) to assign to the client service principal. ## Permissions |
v1.0 | Serviceprincipal Post Claimsmappingpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-claimsmappingpolicies.md | Namespace: microsoft.graph Assign a [claimsMappingPolicy](../resources/claimsmappingpolicy.md) to a [servicePrincipal](../resources/servicePrincipal.md). ## Permissions |
v1.0 | Serviceprincipal Post Delegatedpermissionclassifications | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-delegatedpermissionclassifications.md | Namespace: microsoft.graph Classify a delegated permission by adding a [delegatedPermissionClassification](../resources/delegatedpermissionclassification.md) to the [servicePrincipal](../resources/servicePrincipal.md) representing the API. ## Permissions |
v1.0 | Serviceprincipal Post Homerealmdiscoverypolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-homerealmdiscoverypolicies.md | Namespace: microsoft.graph Assign a [homeRealmDiscoveryPolicy](../resources/homerealmdiscoverypolicy.md) to a [servicePrincipal](../resources/servicePrincipal.md). ## Permissions |
v1.0 | Serviceprincipal Post Owners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-owners.md | Namespace: microsoft.graph Add an owner for the [servicePrincipal](../resources/serviceprincipal.md). Service principal owners can be users, the service principal itself, or other service principals. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Serviceprincipal Post Serviceprincipals | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-serviceprincipals.md | Create a new [servicePrincipal](../resources/serviceprincipal.md) object. > [!IMPORTANT] > Adding [**passwordCredential**](../resources/passwordcredential.md) when creating servicePrincipals is not supported. Use the [addPassword](serviceprincipal-addpassword.md) method to add passwords or secrets for a servicePrincipal. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 <!-- { "blockType": "permissions", "name": "serviceprincipal_post_serviceprincipals" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-post-serviceprincipals-permissions.md)] -For multitenant apps, 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): +For multitenant apps, 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): -+ Global Administrator + Application Administrator-+ Cloud Application Administrator roles ++ Cloud Application Administrator For single-tenant apps where the calling user is a nonadmin user but is the owner of the backing application, the user must have the *Application Developer* role. |
v1.0 | Serviceprincipal Put Claimspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-put-claimspolicy.md | + + Title: "Create or replace claimsPolicy" +description: "Create a new custom claims policy object if it doesn't exist, or replace an existing one." ++ms.localizationpriority: medium ++++# Create or replace claimsPolicy ++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). ++<!-- { "blockType": "permissions", "name": "serviceprincipal_put_customclaimspolicy" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PUT /servicePrincipals/{servicePrincipalsId}/claimsPolicy +``` ++## 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 [customClaimsPolicy](../resources/customclaimspolicy.md) object. ++You can specify the following properties when creating a **customClaimsPolicy**. ++|Property|Type|Description| +|:|:|:| +|includeBasicClaimSet|Boolean|Determines whether the basic claim set is included in tokens affected by this policy. If set to `true`, all claims in the basic claim set are emitted in tokens affected by the policy. By default the basic claim set isn't in the tokens, unless they're explicitly configured in this policy. Optional.| +|includeApplicationIdInIssuer|Boolean|Indicates whether the application ID is added to the claim. It is relevant only for SAML2.0 and if a custom signing key is used. the default value is `true`. Optional.| +|audienceOverride|String|If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols. A custom signing key must be used for audienceOverride to be applied, otherwise audienceOverride value is ignored. The value provided must be in the format of an absolute URI. Optional.| +|claims|[customClaimBase](../resources/customclaimbase.md) collection|Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set. Optional.| ++## Response ++If successful, this method returns a `204` response code and a [customClaimsPolicy](../resources/customclaimspolicy.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "create_customclaimspolicy_from_" +} +--> +``` http +PUT https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipalsId}/claimsPolicy +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.customClaimsPolicy", + "includeBasicClaimSet": "Boolean", + "includeApplicationIdInIssuer": "Boolean", + "audienceOverride": "String", + "claims": [ + { + "@odata.type": "microsoft.graph.customClaim" + } + ] +} +``` ++### 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.customClaimsPolicy" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.customClaimsPolicy", + "id": "f914f36d-167e-3fa7-cfa2-355cc5a36689", + "includeBasicClaimSet": "Boolean", + "includeApplicationIdInIssuer": "Boolean", + "audienceOverride": "String", + "claims": [ + { + "@odata.type": "microsoft.graph.customClaim" + } + ] +} +``` |
v1.0 | Serviceprincipal Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-update.md | Update the properties of [servicePrincipal](../resources/serviceprincipal.md) ob > [!IMPORTANT] > Using PATCH to set [**passwordCredential**](../resources/passwordcredential.md) is not supported. Use the [addPassword](./serviceprincipal-addpassword.md) and [removePassword](./serviceprincipal-removepassword.md) methods to update the password or secret for a servicePrincipal. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Serviceprincipal Updatepasswordsinglesignoncredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-updatepasswordsinglesignoncredentials.md | Namespace: microsoft.graph Update single sign-on credentials using a password for a user or group. ## Permissions |
v1.0 | Serviceprincipal Upsert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-upsert.md | Create a new [servicePrincipal](../resources/serviceprincipal.md) object if it d > [!IMPORTANT] > Adding [**passwordCredential**](../resources/passwordcredential.md) when creating servicePrincipals is not supported. Use the [addPassword](serviceprincipal-addpassword.md) method to add passwords or secrets for a servicePrincipal. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 <!-- { "blockType": "permissions", "name": "serviceprincipal_upsert" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-upsert-permissions.md)] -For multitenant apps, 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): +For multitenant apps, 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): -+ Global Administrator + Application Administrator-+ Cloud Application Administrator roles ++ Cloud Application Administrator For single-tenant apps where the calling user is a nonadmin user but is the owner of the backing application, the user must have the *Application Developer* role. |
v1.0 | Servicestoragequotabreakdown Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/servicestoragequotabreakdown-get.md | Namespace: microsoft.graph Read the properties and relationships of a [serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.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). If successful, this method returns a `200 OK` response code and a [serviceStorag ### Request Here's an example of a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_servicestoragequotabreakdown" Here's an example of a request. GET https://graph.microsoft.com/beta/me/settings/storage/quota/services/OneDrive ``` +# [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 Here's an example of the response |
v1.0 | Signin Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/signin-get.md | One of the following permissions is required to call this API. To learn more, in 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 one of the following directory roles that allow them to read sign-in reports. To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): -+ Global Administrator +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 |
v1.0 | Signin List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/signin-list.md | One of the following permissions is required to call this API. To learn more, in 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 one of the following directory roles that allow them to read sign-in reports. To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): -+ Global Administrator +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 |
v1.0 | Site Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/site-delta.md | Your application should continue making calls using the **@odata.nextLink** unti After you receive all the changes, you can apply them to your local state. To monitor future changes, call the **delta** API by using the **@odata.deltaLink** in the previous response. -Deleted sites are returned with the @removed annotation with the reason of removal. Any resources marked as deleted should be removed from your local state. +Any resources marked as deleted should be removed from your local state. + ## Permissions The following example shows the initial request and how to call this API to esta The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_sites_delta_first", "tags": "service.graph" } --> -```http +```msgraph-interactive GET https://graph.microsoft.com/beta/sites/delta ``` +# [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 that includes the first page of changes and the **@odata.nextLink** property that indicates that no more sites are available in the current set of sites. Your app should continue to request the URL value of **@odata.nextLink** until all pages of sites are retrieved. The following example shows a request that accesses the last page in a set and h The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-sites-delta-last", "tags": "service.graph" }--> -```http +```msgraph-interactive GET https://graph.microsoft.com/beta/sites/delta?token=1230919asd190410jlka ``` +# [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 that indicates that the site named `AllCompany` was deleted between the initial request and this request to update the local state. Content-type: application/json "displayName": "All Company", "isPersonalSite": false, "id": "bd565af7-7963-4658-9a77-26e11ac73186",- "@removed": { - "reason": "deleted" - }, "root": {} } ] To retrieve the latest `deltaLink`, call `delta` with the query string parameter The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-sites-delta-latest", "scopes": "sites.read", "tags": "service.graph", "target": "action" } --> -```http +```msgraph-interactive GET https://graph.microsoft.com/beta/sites/delta?token=latest ``` +# [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 | Site Follow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/site-follow.md | Namespace: microsoft.graph Follow a user's [site](../resources/site.md) or multiple sites. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 [!INCLUDE [sample-code](../includes/snippets/php/follow-site-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/follow-site-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Site Unfollow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/site-unfollow.md | Namespace: microsoft.graph Unfollow a user's [site](../resources/site.md) or multiple sites. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 [!INCLUDE [sample-code](../includes/snippets/php/unfollow-site-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/unfollow-site-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Sitepage Create Webpart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sitepage-create-webpart.md | Namespace: microsoft.graph Create a new [webPart] at a specified position in the [sitePage]. -[sitepage]: ../resources/sitePage.md +[sitePage]: ../resources/sitePage.md [webPart]: ../resources/webPart.md ## Permissions The following example shows how to create a new webpart. <!-- { "blockType": "ignored" } --> ```http-POST /sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts +POST /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts Content-Type: application/json { |
v1.0 | Sitepage Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sitepage-create.md | Namespace: microsoft.graph Create a new [sitePage][] in the site pages [list][] in a [site][]. -[sitePage]: ../resources/sitePage.md +[sitePage]: ../resources/sitepage.md [list]: ../resources/list.md [site]: ../resources/site.md The following example shows how to create a new page. <!-- { "blockType": "request", "name": "create-page", "scopes": "sites.readwrite.all" } --> ```http-POST https://graph.microsoft.com/beta/sites/{site-id}/pages +POST https://graph.microsoft.com/beta/sites/a69edae4-9208-4f60-9aa3-cd0911ff0ce1/pages Content-Type: application/json { Content-Type: application/json "showRecommendedPages": false, "titleArea": { "enableGradientEffect": true,- "imageWebUrl": "/_LAYOUTS/IMAGES/VISUALTEMPLATETITLEIMAGE.JPG", + "imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", "layout": "colorBlock", "showAuthor": true, "showPublishedDate": false, Content-type: application/json "@odata.type": "microsoft.graph.sitePage", "id": "0dd6ddd6-45bd-4acd-b683-de0e6e7231b7", "name": "test.aspx",- "webUrl": "https://a830edad9050849yd.sharepoint.com/SitePages/test.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/test.aspx", "title": "test", "pageLayout": "article", "showComments": true, Content-type: application/json }, "titleArea": { "enableGradientEffect": true,- "imageWebUrl": "/_LAYOUTS/IMAGES/VISUALTEMPLATETITLEIMAGE.JPG", + "imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", "layout": "colorBlock", "showAuthor": true, "showPublishedDate": false, Content-type: application/json [list]: ../resources/list.md [listitem]: ../resources/listitem.md [site]: ../resources/site.md-[sitepage]: ../resources/sitepage.md +[sitePage]: ../resources/sitepage.md <!-- { |
v1.0 | Sitepage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sitepage-get.md | Namespace: microsoft.graph Returns the metadata for a [sitePage][] in the site pages [list][] in a [site][]. -[sitePage]: ../resources/sitePage.md +[sitePage]: ../resources/sitepage.md [list]: ../resources/list.md [site]: ../resources/site.md If successful, this method returns a `200` and a [sitePage](../resources/sitepag <!-- { "blockType": "request", "name": "get-page", "scopes": "sites.read.all", "tags": "service.sharepoint" } --> ```msgraph-interactive-GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage ``` # [C#](#tab/csharp) Content-type: application/json "description": "Here's the page description", "id": "65e59907-59d5-44ff-a038-7c0bf3098c01", "name": "Home.aspx",- "webUrl": "https://a830edad9050849yd.sharepoint.com/SitePages/Home.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Home.aspx", "title": "Organization Home", "thumbnailWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/00210d24-bba0-42e6-9a31-1d452a95dd75/thumbnails/large.jpg?file=163352059.jpg", "promotionKind": "page", Content-type: application/json #### Request -With `select` and `expand` statements, you can retrieve sitePage metadata and page content in a single request. +With `$select` and `$expand` statements, you can retrieve sitePage metadata and page content in a single request. # [HTTP](#tab/http) <!-- { With `select` and `expand` statements, you can retrieve sitePage metadata and pa --> ```msgraph-interactive-GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage?$select=id,name ``` # [C#](#tab/csharp) Content-type: application/json { "@odata.etag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"",- "description": "Reiciendis placeat dolores.Mollitia veniam tempora tempora quidem voluptatum.Quos animi maiores facilis.Dolores officiis consequatur provident beatae deleniti accusamus magni quam tenetur.", - "eTag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"", "id": "f45354cb-d634-45df-8b88-2b4e96a1dc45",- "lastModifiedDateTime": "2023-04-16T10:01:41Z", - "name": "Electronic Convertible.aspx", - "webUrl": "https://a830edad9050849yd.sharepoint.com/SitePages/Electronic%20Convertible.aspx", - "title": "Electronic Convertible", - "pageLayout": "article", - "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/_layouts/15/images/sitepagethumbnail.png", - "promotionKind": "page", - "showComments": false, - "showRecommendedPages": true, - "contentType": { - "id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A", - "name": "Site Page" - }, - "createdBy": { - "user": { - "displayName": "admin_contoso", - "email": "admin@contoso.com" - } - }, - "lastModifiedBy": { - "user": { - "displayName": "admin_contoso", - "email": "admin@contoso.com" - } - }, - "parentReference": { - "siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3" - }, - "publishingState": { - "level": "draft", - "versionId": "0.4" - }, - "reactions": {} + "name": "Electronic Convertible.aspx" } ``` Content-type: application/json #### Request -To access the page with page content, append the `?expand=canvasLayout` query string. +You can expand references in your URL with the _$expand_ query parameter. To access the page with page content, append the `?$expand=canvasLayout` query string. ```http-GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage?expand=canvasLayout +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage?$expand=canvasLayout ``` #### Response GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage?expand=canvasLayou "id": "f45354cb-d634-45df-8b88-2b4e96a1dc45", "lastModifiedDateTime": "2023-04-16T10:01:41Z", "name": "autotest Electronic Convertible.aspx",- "webUrl": "https://a830edad9050849yd.sharepoint.com/SitePages/autotest Electronic Convertible.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/autotest Electronic Convertible.aspx", "title": "autotest Electronic Convertible", "pageLayout": "article", "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/sitepagethumbnail.png", |
v1.0 | Sitepage Getwebpartsbyposition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sitepage-getwebpartsbyposition.md | The following example shows a request. --> ```msgraph-interactive-GET https://graph.microsoft.com/beta/sites/{siteId}/pages/{sitePageId}/microsoft.graph.sitePage/getWebPartsByPosition?isInVerticalSection=true +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/getWebPartsByPosition?isInVerticalSection=true ``` # [JavaScript](#tab/javascript) |
v1.0 | Sitepage List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sitepage-list.md | If successful, this method returns a `200` and a list of [sitePage](../resources --> ```msgraph-interactive-GET /sites/{site-id}/pages/microsoft.graph.sitePage +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/microsoft.graph.sitePage ``` # [C#](#tab/csharp) Content-type: application/json { "id": "08f48aa6-02e3-407c-bbcb-ff61cec653fa", "name": "sample.aspx",- "webUrl": "https://a830edad9050849yd.sharepoint.com/SitePages/sample.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/sample.aspx", "title": "sample", "pageLayout": "article", "showComments": true, Content-type: application/json }, "titleArea": { "enableGradientEffect": true,- "imageWebUrl": "/_LAYOUTS/IMAGES/SLEEKTEMPLATEIMAGETILE.JPG", + "imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", "layout": "imageAndTitle", "showAuthor": false, "showPublishedDate": false, Content-type: application/json { "id": "7d87eee1-7c77-46b5-b2c4-ad6e4e432a8e", "name": "Home.aspx",- "webUrl": "https://a830edad9050849yd.sharepoint.com/SitePages/Home.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Home.aspx", "title": "Home", "pageLayout": "home", "showComments": true, Content-type: application/json }, "titleArea": { "enableGradientEffect": true,- "imageWebUrl": "/siteAssets/titleBackground.jpg", + "imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", "layout": "imageAndTitle", "showAuthor": true, "showPublishedDate": false, |
v1.0 | Sitepage Post Horizontalsection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sitepage-post-horizontalsection.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-POST https://graph.microsoft.com/beta/sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections +POST https://graph.microsoft.com/beta/sites/a69edae4-9208-4f60-9aa3-cd0911ff0ce1/pages/7f7a2740-2d74-47ba-af0c-71ed3a3384ca/microsoft.graph.sitePage/canvasLayout/horizontalSections Content-Type: application/json { |
v1.0 | Sitepage Post Verticalsection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sitepage-post-verticalsection.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-PUT https://graph.microsoft.com/beta/sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection +PUT https://graph.microsoft.com/beta/sites/a69edae4-9208-4f60-9aa3-cd0911ff0ce1/pages/7f7a2740-2d74-47ba-af0c-71ed3a3384ca/microsoft.graph.sitePage/canvasLayout/verticalSection Content-Type: application/json { |
v1.0 | Sitepage Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sitepage-update.md | The following example shows a request. --> ```http-PATCH https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage +PATCH https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage Content-Type: application/json { Content-Type: application/json "@odata.type": "#microsoft.graph.sitePage", "id": "0dd6ddd6-45bd-4acd-b683-de0e6e7231b7", "name": "sample.aspx",- "webUrl": "https://a830edad9050849yd.sharepoint.com/SitePages/sample.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/sample.aspx", "title": "sample", "pageLayout": "article", "showComments": true, Content-Type: application/json } }, "publishingState": {- "level": "checkout", - "versionId": "0.1", - "checkedOutBy": { - "user": { - "displayName": "Rahul Mittal", - "email": "rahmit@contoso.com" - } - } + "level": "draft", + "versionId": "0.1" }, "titleArea": { "enableGradientEffect": true,- "imageWebUrl": "/_LAYOUTS/IMAGES/VISUALTEMPLATETITLEIMAGE.JPG", + "imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", "layout": "colorBlock", "showAuthor": true, "showPublishedDate": false, |
v1.0 | Subscription Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subscription-delete.md | description: "Delete a subscription." ms.localizationpriority: medium doc_type: apiPageType+ # Delete subscription For the list of resources that support subscribing to change notifications, see Depending on the resource and the permission type (delegated or application) requested, the permission specified in the following table is the least privileged required to call this API. To learn more, including [taking caution](/graph/auth/auth-concepts#best-practices-for-requesting-permissions) before choosing more privileged permissions, search for the following permissions in [Permissions](/graph/permissions-reference). -> **Note**: -> +> [!NOTE] > Some resources support change notifications in multiple scenarios, each of which may require different permissions. In those cases, use the resource path to differentiate the scenarios.-> -> Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). | Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--| Depending on the resource and the permission type (delegated or application) req |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/recordings` <br /> Any recording becomes available for a specific meeting. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `users/{userId}/onlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting organized by a specific user. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All |+|[callRecording](../resources/callrecording.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/getAllTranscripts` <br /> Any transcript becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/transcripts` <br /> Any transcript becomes available for a specific meeting. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `users/{userId}/onlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting organized by a specific user. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All |+|[callTranscript](../resources/calltranscript.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat | |[channel](../resources/channel.md) <br />`/teams/getAllChannels` <br /> All channels in an organization. | Not supported. | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[channel](../resources/channel.md) <br />`/teams/{id}/channels` <br /> All channels in a particular team in an organization. | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[chat](../resources/chat.md) <br />`/chats` <br />All chats in an organization. | Not supported. | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[chat](../resources/chat.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats` <br />All chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled |-|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel. | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group*, ChannelMessage.Read.All | +|[chat](../resources/chat.md) <br />`/users/{id}/chats` <br /> All chats that a particular user is part of. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel. | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group, ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/teams/getAllMessages` <br />All channel messages in organization. | Not supported. | Not supported. | ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/{id}/messages` <br /> All messages in a chat. | Chat.Read, Chat.ReadWrite | Not supported. | Chat.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/getAllMessages` <br /> All chat messages in an organization. | Not supported. | Not supported. | Chat.Read.All | Depending on the resource and the permission type (delegated or application) req |[chatMessage](../resources/chatmessage.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages` <br />Chat messages for all chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled | |[contact](../resources/contact.md) | Contacts.Read | Contacts.Read | Contacts.Read | |[conversationMember](../resources/conversationmember.md) <br />`/chats/getAllMembers` <br /> Members of all chats in an organization. | Not supported. | Not supported. | ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat. | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat*, Chat.Manage.Chat*, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat. | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat, Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <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) <br />`/teams/getAllMembers` <br /> Members in all teams in an organization. | Not supported. | Not supported. | TeamMember.Read.All, TeamMember.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <br />`/teams/{id}/members` <br /> Members in a particular team. | TeamMember.Read.All | Not supported. | TeamMember.Read.All | Depending on the resource and the permission type (delegated or application) req |[virtualEventWebinar](../resources/virtualeventwebinar.md) | VirtualEvent.Read | Not supported. | VirtualEvent.Read.All | |[baseTask](../resources/todotask.md) (deprecated) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported. | +> [!NOTE] +> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): +> - OnlineMeetingRecording.Read.Chat +> - OnlineMeetingTranscript.Read.Chat +> - ChatSettings.Read.Chat +> - ChatSettings.ReadWrite.Chat +> - Chat.Manage.Chat +> - ChannelMessage.Read.Group +> - ChatMember.Read.Chat + [!INCLUDE [teams-subscription-notes](../../includes/teams-subscription-notes.md)] ### driveItem |
v1.0 | Subscription Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subscription-get.md | description: "Retrieve the properties and relationships of a subscription." ms.localizationpriority: medium doc_type: apiPageType+ # Get subscription See the table in the [Permissions](#permissions) section for the list of resourc Depending on the resource and the permission type (delegated or application) requested, the permission specified in the following table is the least privileged required to call this API. To learn more, including [taking caution](/graph/auth/auth-concepts#best-practices-for-requesting-permissions) before choosing more privileged permissions, search for the following permissions in [Permissions](/graph/permissions-reference). -> **Note**: -> +> [!NOTE] > Some resources support change notifications in multiple scenarios, each of which may require different permissions. In those cases, use the resource path to differentiate the scenarios.-> -> Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). | Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--| Depending on the resource and the permission type (delegated or application) req |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/recordings` <br /> Any recording becomes available for a specific meeting. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `users/{userId}/onlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting organized by a specific user. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All |+|[callRecording](../resources/callrecording.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/getAllTranscripts` <br /> Any transcript becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/transcripts` <br /> Any transcript becomes available for a specific meeting. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `users/{userId}/onlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting organized by a specific user. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All |+|[callTranscript](../resources/calltranscript.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts` <br /> A call recording that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat | |[channel](../resources/channel.md) <br />`/teams/getAllChannels` <br /> All channels in an organization. | Not supported. | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[channel](../resources/channel.md) <br />`/teams/{id}/channels` <br /> All channels in a particular team in an organization. | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[chat](../resources/chat.md) <br />`/chats` <br />All chats in an organization. | Not supported. | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat.| Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat.| Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[chat](../resources/chat.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats` <br />All chats in an organization where a particular Teams app is installed.| Not supported. | Not supported. | Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled |-|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel. | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group*, ChannelMessage.Read.All | +|[chat](../resources/chat.md) <br />`/users/{id}/chats` <br /> All chats that a particular user is part of. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel. | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group, ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/teams/getAllMessages` <br />All channel messages in organization. | Not supported. | Not supported. | ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/{id}/messages` <br /> All messages in a chat. | Chat.Read, Chat.ReadWrite | Not supported. | Chat.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/getAllMessages` <br /> All chat messages in an organization. | Not supported. | Not supported. | Chat.Read.All | Depending on the resource and the permission type (delegated or application) req |[chatMessage](../resources/chatmessage.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages` <br />Chat messages for all chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled | |[contact](../resources/contact.md) | Contacts.Read | Contacts.Read | Contacts.Read | |[conversationMember](../resources/conversationmember.md) <br />`/chats/getAllMembers` <br /> Members of all chats in an organization. | Not supported. | Not supported. | ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat. | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat*, Chat.Manage.Chat*, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat. | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat, Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <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) <br />`/teams/getAllMembers` <br /> Members in all teams in an organization. | Not supported. | Not supported. | TeamMember.Read.All, TeamMember.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <br />`/teams/{id}/members` <br /> Members in a particular team. | TeamMember.Read.All | Not supported. | TeamMember.Read.All | Depending on the resource and the permission type (delegated or application) req |[virtualEventWebinar](../resources/virtualeventwebinar.md) | VirtualEvent.Read | Not supported. | VirtualEvent.Read.All | |[baseTask](../resources/basetask.md) (deprecated) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported. | +> [!NOTE] +> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): +> - OnlineMeetingRecording.Read.Chat +> - OnlineMeetingTranscript.Read.Chat +> - ChatSettings.Read.Chat +> - ChatSettings.ReadWrite.Chat +> - Chat.Manage.Chat +> - ChannelMessage.Read.Group +> - ChatMember.Read.Chat + [!INCLUDE [teams-subscription-notes](../../includes/teams-subscription-notes.md)] ### driveItem |
v1.0 | Subscription List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subscription-list.md | description: "Retrieve a list of webhook subscriptions." ms.localizationpriority: medium doc_type: apiPageType+ # List subscriptions The content of the response depends on the context in which the app is calling; Depending on the resource and the permission type (delegated or application) requested, the permission specified in the following table is the least privileged required to call this API. To learn more, including [taking caution](/graph/auth/auth-concepts#best-practices-for-requesting-permissions) before choosing more privileged permissions, search for the following permissions in [Permissions](/graph/permissions-reference). -> **Note**: -> +> [!NOTE] > Some resources support change notifications in multiple scenarios, each of which may require different permissions. In those cases, use the resource path to differentiate the scenarios.-> -> Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). | Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--| Depending on the resource and the permission type (delegated or application) req |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/recordings` <br /> Any recording becomes available for a specific meeting. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `users/{userId}/onlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting organized by a specific user. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All |+|[callRecording](../resources/callrecording.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/getAllTranscripts` <br /> Any transcript becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/transcripts` <br /> Any transcript becomes available for a specific meeting. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `users/{userId}/onlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting organized by a specific user. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All |+|[callTranscript](../resources/calltranscript.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat | |[channel](../resources/channel.md) <br />`/teams/getAllChannels` <br /> All channels in an organization. | Not supported. | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[channel](../resources/channel.md) <br />`/teams/{id}/channels` <br /> All channels in a particular team in an organization. | Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[chat](../resources/chat.md) <br />`/chats` <br />All chats in an organization. | Not supported. | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All | Not supported. | ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All | Not supported. | ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[chat](../resources/chat.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats` <br />All chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled |-|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel.| ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All, Subscription.Read.All | Not supported. | ChannelMessage.Read.Group*, ChannelMessage.Read.All | +|[chat](../resources/chat.md) <br />`/users/{id}/chats` <br /> All chats that a particular user is part of. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel.| ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All, Subscription.Read.All | Not supported. | ChannelMessage.Read.Group, ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/teams/getAllMessages` <br />All channel messages in organization. | Not supported. | Not supported. | ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/{id}/messages` <br /> All messages in a chat.| Chat.Read, Chat.ReadWrite, Subscription.Read.All | Not supported. | Chat.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/getAllMessages` <br /> All chat messages in an organization. | Not supported. | Not supported. | Chat.Read.All | Depending on the resource and the permission type (delegated or application) req |[chatMessage](../resources/chatmessage.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages` <br />Chat messages for all chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled | |[contact](../resources/contact.md) | Contacts.Read, Subscription.Read.All | Contacts.Read, Subscription.Read.All | Contacts.Read | |[conversationMember](../resources/conversationmember.md) <br />`/chats/getAllMembers` <br /> Members of all chats in an organization.| Not supported. | Not supported. | ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat.| ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All | Not supported. | ChatMember.Read.Chat*, Chat.Manage.Chat*, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat.| ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All | Not supported. | ChatMember.Read.Chat, Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <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) <br />`/teams/getAllMembers` <br /> Members in all teams in an organization.| Not supported. | Not supported. | TeamMember.Read.All, TeamMember.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <br />`/teams/{id}/members` <br /> Members in a particular team.| TeamMember.Read.All, Subscription.Read.All | Not supported. | TeamMember.Read.All | Depending on the resource and the permission type (delegated or application) req |[user](../resources/user.md) | User.Read.All, Subscription.Read.All | User.Read.All | User.Read.All | |[baseTask](../resources/basetask.md) (deprecated) | Tasks.ReadWrite, Subscription.Read.All | Tasks.ReadWrite, Subscription.Read.All | Not supported. | +> [!NOTE] +> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): +> - OnlineMeetingRecording.Read.Chat +> - OnlineMeetingTranscript.Read.Chat +> - ChatSettings.Read.Chat +> - ChatSettings.ReadWrite.Chat +> - Chat.Manage.Chat +> - ChannelMessage.Read.Group +> - ChatMember.Read.Chat + Response results are based on the context of the calling app. The following sections describe the common scenarios. ### Basic scenarios |
v1.0 | Subscription Post Subscriptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subscription-post-subscriptions.md | description: "Subscribes a listener application to receive change notifications ms.localizationpriority: medium doc_type: apiPageType+ # Create subscription Creating a subscription requires read permission to the resource. For example, t Depending on the resource and the permission type (delegated or application) requested, the permission specified in the following table is the least privileged required to call this API. To learn more, including [taking caution](/graph/auth/auth-concepts#best-practices-for-requesting-permissions) before choosing the permissions, search for the following permissions in [Permissions](/graph/permissions-reference). -> **Note**: -> -> Due to security restrictions, Microsoft Graph subscriptions do not support write access permissions when only read access permissions are needed. -> -> Some resources support change notifications in multiple scenarios, each of which may require different permissions. In those cases, use the resource path to differentiate the scenarios. -> -> Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> - Due to security restrictions, Microsoft Graph subscriptions do not support write access permissions when only read access permissions are needed. +> - Some resources support change notifications in multiple scenarios, each of which may require different permissions. In those cases, use the resource path to differentiate the scenarios. | Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--| Depending on the resource and the permission type (delegated or application) req |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/recordings` <br /> Any recording becomes available for a specific meeting. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `users/{userId}/onlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting organized by a specific user. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All |+|[callRecording](../resources/callrecording.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/getAllTranscripts` <br /> Any transcript becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/transcripts` <br /> Any transcript becomes available for a specific meeting. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `users/{userId}/onlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting organized by a specific user. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All |+|[callTranscript](../resources/calltranscript.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat | |[channel](../resources/channel.md) <br />`/teams/getAllChannels` <br /> All channels in an organization. | Not supported. | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[channel](../resources/channel.md) <br />`/teams/{id}/channels` <br /> All channels in a particular team in an organization. | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[chat](../resources/chat.md) <br />`/chats` <br />All chats in an organization. | Not supported. | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat.| Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat.| Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[chat](../resources/chat.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats` <br />All chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled |-|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel. | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group*, ChannelMessage.Read.All | +|[chat](../resources/chat.md) <br />`/users/{id}/chats` <br /> All chats that a particular user is part of. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel. | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group, ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/teams/getAllMessages` <br />All channel messages in organization. | Not supported. | Not supported. | ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/{id}/messages` <br /> All messages in a chat. | Chat.Read, Chat.ReadWrite | Not supported. | Chat.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/getAllMessages` <br /> All chat messages in an organization. | Not supported. | Not supported. | Chat.Read.All | Depending on the resource and the permission type (delegated or application) req |[chatMessage](../resources/chatmessage.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages` <br />Chat messages for all chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled | |[contact](../resources/contact.md) | Contacts.Read | Contacts.Read | Contacts.Read | |[conversationMember](../resources/conversationmember.md) <br />`/chats/getAllMembers` <br /> Members of all chats in an organization. | Not supported. | Not supported. | ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat. | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat*, Chat.Manage.Chat*, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat. | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat, Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <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) <br />`/teams/getAllMembers` <br /> Members in all teams in an organization. | Not supported. | Not supported. | TeamMember.Read.All, TeamMember.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <br />`/teams/{id}/members` <br /> Members in a particular team. | TeamMember.Read.All | Not supported. | TeamMember.Read.All | Depending on the resource and the permission type (delegated or application) req |[virtualEventWebinar](../resources/virtualeventwebinar.md) | VirtualEvent.Read | Not supported. | VirtualEvent.Read.All | |[baseTask](../resources/basetask.md) (deprecated) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported. | +> [!NOTE] +> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): +> - OnlineMeetingRecording.Read.Chat +> - OnlineMeetingTranscript.Read.Chat +> - ChatSettings.Read.Chat +> - ChatSettings.ReadWrite.Chat +> - Chat.Manage.Chat +> - ChannelMessage.Read.Group +> - ChatMember.Read.Chat + [!INCLUDE [teams-subscription-notes](../../includes/teams-subscription-notes.md)] ### driveItem The following are valid values for the resource property. | Resource type | Examples | |: |:-- | |[callRecord](../resources/callrecords-callrecord.md)|`communications/callRecords`|-|[callRecording](../resources/callrecording.md)| `communications/onlineMeetings/getAllRecordings`, `communications/onlineMeetings/{onlineMeetingId}/recordings`, `users/{userId}/onlineMeetings/getAllRecordings`| -|[callTranscript](../resources/calltranscript.md) | `communications/onlineMeetings/getAllTranscripts`, `communications/onlineMeetings/{onlineMeetingId}/transcripts`, `users/{userId}/onlineMeetings/getAllTranscripts`| +|[callRecording](../resources/callrecording.md)| `communications/onlineMeetings/getAllRecordings`, `communications/onlineMeetings/{onlineMeetingId}/recordings`, `users/{userId}/onlineMeetings/getAllRecordings`, `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings`| +|[callTranscript](../resources/calltranscript.md) | `communications/onlineMeetings/getAllTranscripts`, `communications/onlineMeetings/{onlineMeetingId}/transcripts`, `users/{userId}/onlineMeetings/getAllTranscripts`, `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts`| |[channel](../resources/channel.md)|`/teams/getAllChannels`, `/teams/{id}/channels`| |[chat](../resources/chat.md)|`/chats`, `/chats/{id}`| |[chatMessage](../resources/chatmessage.md) | `chats/{id}/messages`, `chats/getAllMessages`, `teams/{id}/channels/{id}/messages`, `teams/getAllMessages` | The following are valid values for the resource property. |[security alert](../resources/alert.md)|`security/alerts?$filter=status eq 'NewAlert'`| |[baseTask](../resources/basetask.md) (deprecated) | `/me/tasks/lists/{Id}/tasks`| -> **Note:** Any path starting with `me` can also be used with `users/{id}` instead of `me` to target a specific user instead of the current user. +> [!NOTE] +> Any path starting with `me` can also be used with `users/{id}` instead of `me` to target a specific user instead of the current user. ### Response |
v1.0 | Subscription Reauthorize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subscription-reauthorize.md | Title: "subscription: reauthorize" description: "Reauthorize a subscription when you receive a reauthorizationRequired challenge." ms.localizationpriority: medium+ doc_type: apiPageType Reauthorize a subscription when you receive a **reauthorizationRequired** challe Depending on the resource and the permission type (delegated or application) requested, the permission specified in the following table is the least privileged required to call this API. To learn more, including [taking caution](/graph/auth/auth-concepts#best-practices-for-requesting-permissions) before choosing more privileged permissions, search for the following permissions in [Permissions](/graph/permissions-reference). -> **Note**: -> +> [!NOTE] > Some resources support change notifications in multiple scenarios, each of which may require different permissions. In those cases, use the resource path to differentiate the scenarios.-> -> Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). | Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--| Depending on the resource and the permission type (delegated or application) req |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/recordings` <br /> Any recording becomes available for a specific meeting. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `users/{userId}/onlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting organized by a specific user. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All |+|[callRecording](../resources/callrecording.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/getAllTranscripts` <br /> Any transcript becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/transcripts` <br /> Any transcript becomes available for a specific meeting. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `users/{userId}/onlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting organized by a specific user. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All |+|[callTranscript](../resources/calltranscript.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat | |[channel](../resources/channel.md) <br />`/teams/getAllChannels` <br /> All channels in an organization. | Not supported. | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[channel](../resources/channel.md) <br />`/teams/{id}/channels` <br /> All channels in a particular team in an organization. | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[chat](../resources/chat.md) <br />`/chats` <br />All chats in an organization. | Not supported. | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[chat](../resources/chat.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats` <br />All chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled |-|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel. | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group*, ChannelMessage.Read.All | +|[chat](../resources/chat.md) <br />`/users/{id}/chats` <br /> All chats a particular user is part of. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel. | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group, ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/teams/getAllMessages` <br />All channel messages in organization. | Not supported. | Not supported. | ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/{id}/messages` <br /> All messages in a chat. | Chat.Read, Chat.ReadWrite | Not supported. | Chat.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/getAllMessages` <br /> All chat messages in an organization. | Not supported. | Not supported. | Chat.Read.All | Depending on the resource and the permission type (delegated or application) req |[chatMessage](../resources/chatmessage.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages` <br />Chat messages for all chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled | |[contact](../resources/contact.md) | Contacts.Read | Contacts.Read | Contacts.Read | |[conversationMember](../resources/conversationmember.md) <br />`/chats/getAllMembers` <br /> Members of all chats in an organization. | Not supported. | Not supported. | ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat. | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat*, Chat.Manage.Chat*, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat. | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat, Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <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) <br />`/teams/getAllMembers` <br /> Members in all teams in an organization. | Not supported. | Not supported. | TeamMember.Read.All, TeamMember.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <br />`/teams/{id}/members` <br /> Members in a particular team. | TeamMember.Read.All | Not supported. | TeamMember.Read.All | Depending on the resource and the permission type (delegated or application) req |[user](../resources/user.md) | User.Read.All | User.Read.All | User.Read.All | |[baseTask](../resources/todotask.md) (deprecated) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported. | +> [!NOTE] +> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): +> - OnlineMeetingRecording.Read.Chat +> - OnlineMeetingTranscript.Read.Chat +> - ChatSettings.Read.Chat +> - ChatSettings.ReadWrite.Chat +> - Chat.Manage.Chat +> - ChannelMessage.Read.Group +> - ChatMember.Read.Chat + [!INCLUDE [teams-subscription-notes](../../includes/teams-subscription-notes.md)] ## HTTP request |
v1.0 | Subscription Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subscription-update.md | description: "Renew a subscription by extending its expiry time." ms.localizationpriority: medium doc_type: apiPageType+ # Update subscription Subscriptions expire after a length of time that varies by resource type. In ord Depending on the resource and the permission type (delegated or application) requested, the permission specified in the following table is the least privileged required to call this API. To learn more, including [taking caution](/graph/auth/auth-concepts#best-practices-for-requesting-permissions) before choosing more privileged permissions, search for the following permissions in [Permissions](/graph/permissions-reference). -> **Note**: -> +> [!NOTE] > Some resources support change notifications in multiple scenarios, each of which may require different permissions. In those cases, use the resource path to differentiate the scenarios.-> -> Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). | Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--| Depending on the resource and the permission type (delegated or application) req |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/recordings` <br /> Any recording becomes available for a specific meeting. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All | |[callRecording](../resources/callrecording.md) <br /> `users/{userId}/onlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting organized by a specific user. | OnlineMeetingRecording.Read.All | Not supported. | OnlineMeetingRecording.Read.All |+|[callRecording](../resources/callrecording.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings` <br /> A call recording that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/getAllTranscripts` <br /> Any transcript becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `communications/onlineMeetings/{onlineMeetingId}/transcripts` <br /> Any transcript becomes available for a specific meeting. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All | |[callTranscript](../resources/calltranscript.md) <br /> `users/{userId}/onlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting organized by a specific user. | OnlineMeetingTranscript.Read.All | Not supported. | OnlineMeetingTranscript.Read.All |+|[callTranscript](../resources/calltranscript.md) <br /> `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts` <br /> A call transcript that becomes available in a meeting where a particular Teams app is installed. | Not supported. | Not supported. | OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat | |[channel](../resources/channel.md) <br />`/teams/getAllChannels` <br /> All channels in an organization. | Not supported. | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[channel](../resources/channel.md) <br />`/teams/{id}/channels` <br /> All channels in a particular team in an organization. | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | |[chat](../resources/chat.md) <br />`/chats` <br />All chats in an organization. | Not supported. | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat.| Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chat](../resources/chat.md) <br />`/chats/{id}` <br /> A particular chat.| Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[chat](../resources/chat.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats` <br />All chats in an organization where a particular Teams app is installed.| Not supported. | Not supported. | Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled |-|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel. | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group*, ChannelMessage.Read.All | +|[chat](../resources/chat.md) <br />`/users/{id}/chats` <br /> All chats that a particular user is part of. | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chatMessage](../resources/chatmessage.md) <br />`/teams/{id}/channels/{id}/messages` <br /> All messages and replies in a particular channel. | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group, ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/teams/getAllMessages` <br />All channel messages in organization. | Not supported. | Not supported. | ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/{id}/messages` <br /> All messages in a chat. | Chat.Read, Chat.ReadWrite | Not supported. | Chat.Read.All | |[chatMessage](../resources/chatmessage.md) <br />`/chats/getAllMessages` <br /> All chat messages in an organization. | Not supported. | Not supported. | Chat.Read.All | Depending on the resource and the permission type (delegated or application) req |[chatMessage](../resources/chatmessage.md) <br />`/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages` <br />Chat messages for all chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled | |[contact](../resources/contact.md) | Contacts.Read | Contacts.Read | Contacts.Read | |[conversationMember](../resources/conversationmember.md) <br />`/chats/getAllMembers` <br /> Members of all chats in an organization. | Not supported. | Not supported. | ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |-|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat. | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat*, Chat.Manage.Chat*, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[conversationMember](../resources/conversationmember.md) <br />`/chats/{id}/members` <br /> Members of a particular chat. | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat, Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <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) <br />`/teams/getAllMembers` <br /> Members in all teams in an organization. | Not supported. | Not supported. | TeamMember.Read.All, TeamMember.ReadWrite.All | |[conversationMember](../resources/conversationmember.md) <br />`/teams/{id}/members` <br /> Members in a particular team. | TeamMember.Read.All | Not supported. | TeamMember.Read.All | Depending on the resource and the permission type (delegated or application) req |[virtualEventWebinar](../resources/virtualeventwebinar.md) | VirtualEvent.Read | Not supported. | VirtualEvent.Read.All | |[baseTask](../resources/basetask.md) (deprecated) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported. | +> [!NOTE] +> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): +> - OnlineMeetingRecording.Read.Chat +> - OnlineMeetingTranscript.Read.Chat +> - ChatSettings.Read.Chat +> - ChatSettings.ReadWrite.Chat +> - Chat.Manage.Chat +> - ChannelMessage.Read.Group +> - ChatMember.Read.Chat + [!INCLUDE [teams-subscription-notes](../../includes/teams-subscription-notes.md)] ### driveItem |
v1.0 | Superawsresourcefinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superawsresourcefinding-aggregatedsummary.md | description: "View the count of super AWS resources for the specified authorizat ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superawsresourcefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superawsresourcefinding-get.md | description: "Read the properties and relationships of a superAwsResourceFinding ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superawsresourcefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superawsresourcefinding-list.md | description: "Get a list of the superAwsResourceFinding objects and their proper ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superawsrolefinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superawsrolefinding-aggregatedsummary.md | description: View the count of super AWS roles in your authorization systems. ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superawsrolefinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superawsrolefinding-get.md | description: "Read the properties and relationships of a superAwsRoleFinding obj ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superawsrolefinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superawsrolefinding-list.md | description: "Get a list of the superAwsRoleFinding objects and their properties ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superazureserviceprincipalfinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superazureserviceprincipalfinding-aggregatedsummary.md | description: View the count of super Azure service principals in your authorizat ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superazureserviceprincipalfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superazureserviceprincipalfinding-get.md | description: "Read the properties and relationships of a superAzureServicePrinci ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superazureserviceprincipalfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superazureserviceprincipalfinding-list.md | description: "Get a list of the superAzureServicePrincipalFinding objects and th ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Supergcpserviceaccountfinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/supergcpserviceaccountfinding-aggregatedsummary.md | description: View the count of super GCP service accounts in your authorization ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Supergcpserviceaccountfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/supergcpserviceaccountfinding-get.md | description: "Read the properties and relationships of a superGcpServiceAccountF ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Supergcpserviceaccountfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/supergcpserviceaccountfinding-list.md | description: "Get a list of the superGcpServiceAccountFinding objects and their ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superserverlessfunctionfinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superserverlessfunctionfinding-aggregatedsummary.md | description: "View the raw count of super serverless functions in the specified ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superserverlessfunctionfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superserverlessfunctionfinding-get.md | description: "Read the properties and relationships of a superServerlessFunction ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superserverlessfunctionfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superserverlessfunctionfinding-list.md | description: "Get a list of the superServerlessFunctionFinding objects and their ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superuserfinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superuserfinding-aggregatedsummary.md | description: "View the raw count of super users in the specified AWS, Azure, or ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superuserfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superuserfinding-get.md | description: "Read the properties and relationships of a superUserFinding object ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Superuserfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/superuserfinding-list.md | description: "Get a list of the superUserFinding objects and their properties." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Swapshiftschangerequest Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/swapshiftschangerequest-get.md | Retrieve the properties and relationships of a [swapShiftsChangeRequest](../reso ## Permissions -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) | Group.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Schedule.Read.All*, Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "swapshiftschangerequest_get" } --> ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +> [!NOTE] +> The Schedule.Read.All and Schedule.ReadWrite.All application permissions are currently in private preview only and are not available for public use. ## HTTP request |
v1.0 | Swapshiftschangerequest List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/swapshiftschangerequest-list.md | Retrieve a list of [swapShiftsChangeRequest](../resources/swapshiftschangereques ## Permissions -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) | Group.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Schedule.Read.All*, Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "swapshiftschangerequest_list" } --> ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +> [!NOTE] +> The Schedule.Read.All and Schedule.ReadWrite.All application permissions are currently in private preview only and are not available for public use. ## HTTP request |
v1.0 | Swapshiftschangerequest Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/swapshiftschangerequest-post.md | Create an instance of a [swapShiftsChangeRequest](../resources/swapshiftschanger ## Permissions -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) | Group.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "swapshiftschangerequest_post" } --> ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and isn't available for public use. ## HTTP request |
v1.0 | Targetdevicegroup Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/targetdevicegroup-get.md | Namespace: microsoft.graph Read the properties and relationships of a [targetDeviceGroup](../resources/targetdevicegroup.md) object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Targetdevicegroup Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/targetdevicegroup-update.md | Namespace: microsoft.graph Update the properties of a [targetDeviceGroup](../resources/targetdevicegroup.md) object for remoteDesktopSecurityConfiguration object on the servicePrincipal. You can configure a maximum of 10 target device groups for the remoteDesktopSecurityConfiguraiton object on the servicePrincipal. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Team Clone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-clone.md | Cloning is a long-running operation. After the POST clone returns, you need to G ## Permissions -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) | Team.Create, Group.ReadWrite.All**, Directory.ReadWrite.All** | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Team.Create, Group.ReadWrite.All**, Directory.ReadWrite.All** | +<!-- { "blockType": "permissions", "name": "team_clone" } --> -> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ## HTTP request <!-- { "blockType": "ignored" } --> POST /teams/{id}/clone | Property | Type |Description| |:|:--|:-| |classification|String (optional)|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](../resources/directorysetting.md) value, based on the [template definition](../resources/directorysettingtemplate.md). If classification isn't specified, the classification is copied from the original team/group.|-|description|String (optional)|An optional description for the group. If this property isn't specified, it is left blank.| +|description|String (optional)|An optional description for the group. If this property isn't specified, it's left blank.| |displayName|String|The display name for the group. This property is required when a group is created and it can't be cleared during updates. Supports $filter and $orderby.| |mailNickname|String|The mail alias for the group, unique in the organization. This property must be specified when a group is created. Supports $filter. If this property isn't specified, it's computed from the displayName. Known issue: this property is currently ignored.| |partsToClone| [clonableTeamParts](../resources/clonableteamparts.md) |A comma-separated list of the parts to clone. Legal parts are "apps, tabs, settings, channels, members".| |
v1.0 | Team Delete Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-delete-installedapps.md | Uninstalls an [app](../resources/teamsappinstallation.md) from the specified [te ## Permissions -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) | TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam, Group.ReadWrite.All**, Directory.ReadWrite.All** | -|Delegated (personal Microsoft account) | Not supported. | -|Application | TeamsAppInstallation.ReadWriteSelfForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, Group.ReadWrite.All**, Directory.ReadWrite.All** | +<!-- { "blockType": "permissions", "name": "team_delete_installedapps" } --> -> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All and Directory.ReadWrite.All permission 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" } --> |
v1.0 | Team Get Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-get-installedapps.md | Retrieve the [app](../resources/teamsappinstallation.md) installed in the specif ## Permissions -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) | TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadForUser, TeamsAppInstallation.ReadForTeam, TeamsAppInstallation.ReadWriteForTeam, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam, TeamsAppInstallation.ReadWriteAndConsentForTeam, Group.Read.All<sup>1</sup>, Group.ReadWrite.All<sup>1</sup>, Directory.Read.All<sup>1</sup>, Directory.ReadWrite.All<sup>1</sup> | -|Delegated (personal Microsoft account) | Not supported. | -|Application | TeamsAppInstallation.Read.Group<sup>2</sup>, TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, TeamsAppInstallation.ReadWriteAndConsentForTeam.All, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam.All, Group.Read.All<sup>1</sup>, Group.ReadWrite.All<sup>1</sup>, Directory.Read.All<sup>1</sup>, Directory.ReadWrite.All<sup>1</sup> | +<!-- { "blockType": "permissions", "name": "team_get_installedapps" } --> +> [!NOTE] +> - The Group.Read.All, Group.ReadWrite.All, Directory.Read.All, and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. +> - The TeamsAppInstallation.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Team Get Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-get-members.md | Get a [conversationMember](../resources/conversationmember.md) from a [team](../ ## Permissions -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)| TeamMember.Read.All, TeamMember.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application| TeamMember.Read.Group*, TeamMember.Read.All, TeamMember.ReadWrite.All | +<!-- { "blockType": "permissions", "name": "team_get_members" } --> -> **Note**: Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamMember.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored"} --> GET /teams/{team-id}/members/{membership-id} ## Optional query parameters -This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers |
v1.0 | Team Get Primarychannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-get-primarychannel.md | Get the default [channel](../resources/channel.md), **General**, of a [team](../ [!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) | Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | ChannelSettings.Read.Group*, ChannelSettings.ReadWrite.Group*, Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All | +This API supports admin permissions. Global admins can access groups that they aren't a member of. -> **Note**: Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +<!-- { "blockType": "permissions", "name": "team_get_primarychannel" } --> -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> [!NOTE] +> The ChannelSettings.Read.Group and ChannelSettings.ReadWrite.Group permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Team List Allchannels | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-list-allchannels.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body. The response also includes the **@odata.id** property which can be used to access the channel and run other operations on the [channel](../resources/channel.md) object. +If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body. The response also includes the **@odata.id** property, which can be used to access the channel and run other operations on the [channel](../resources/channel.md) object. > [!Note]-> Currently, invoking the URL returned from the **@odata.id** property fails for cross-tenant shared channels. You can solve this issue if you remove the `/tenants/{tenant-id}` part from the URL before you call this API. For more details, see [Known issues with Microsoft Graph](https://developer.microsoft.com/en-us/graph/known-issues/?search=14971). +> Currently, invoking the URL returned from the **@odata.id** property fails for cross-tenant shared channels. You can solve this issue if you remove the `/tenants/{tenant-id}` part from the URL before you call this API. For more information, see [Known issues with Microsoft Graph](https://developer.microsoft.com/en-us/graph/known-issues/?search=14971). ## Examples Content-Type: application/json "displayName": "General", "description": "AutoTestTeam_20210311_150740.2550_fim3udfdjen9", "membershipType": "standard",+ "isArchived": false, "tenantId": "b3246f44-b4gb-4627-96c6-25b18fa2c910" }, { Content-Type: application/json "createdDateTime": "2020-05-27T19:22:25.692Z", "displayName": "Shared channel from Contoso", "membershipType": "shared",+ "isArchived": false, "tenantId": "b3246f44-b4gb-5678-96c6-25b18fa2c910" } ] Content-Type: application/json "membershipType": "shared", "tenantId": "b3246f44-b4gb-5678-96c6-25b18fa2c910", "email": "someperson@microsoft.com",- "moderationSettings": null + "moderationSettings": null, + "isArchived": false, + "tenantId": "b3246f44-b4gb-5678-96c6-25b18fa2c910" } ] } |
v1.0 | Team List Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-list-installedapps.md | Retrieve the list of [apps installed](../resources/teamsappinstallation.md) in 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) | TeamsAppInstallation.ReadForTeam, TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam, TeamsAppInstallation.ReadWriteAndConsentForTeam, Group.Read.All<sup>1</sup>, Group.ReadWrite.All<sup>1</sup>, Directory.Read.All<sup>1</sup>, Directory.ReadWrite.All<sup>1</sup> | -|Delegated (personal Microsoft account) | Not supported. | -|Application | TeamsAppInstallation.Read.Group<sup>2</sup>, TeamsAppInstallation.ReadWriteSelfForTeam.All, TeamsAppInstallation.ReadForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, TeamsAppInstallation.ReadWriteAndConsentForTeam.All, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam.All, Group.Read.All<sup>1</sup>, Group.ReadWrite.All<sup>1</sup>, Directory.Read.All<sup>1</sup>, Directory.ReadWrite.All<sup>1</sup> | +<!-- { "blockType": "permissions", "name": "team_list_installedapps" } --> +> [!NOTE] +> - The Group.Read.All, Group.ReadWrite.All, Directory.Read.All, and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. +> - The TeamsAppInstallation.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Team List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-list-members.md | Namespace: microsoft.graph Get the [conversationMember](../resources/conversationmember.md) collection of a [team](../resources/team.md). -The membership IDs returned by the server must be treated as opaque strings. The client should not try to parse or make assumptions about these resource IDs. +The membership IDs returned by the server must be treated as opaque strings. The client shouldn't try to parse or make assumptions about these resource IDs. -In the future, membership results may include users from various tenants, as indicated in the response. Clients should avoid assuming that all members exclusively belong to the current tenant. +In the future, membership results can include users from various tenants, as indicated in the response. Clients should avoid assuming that all members exclusively belong to the current tenant. > [!NOTE] > This API results in a 401 error when a newly created tenant calls this method. For more information, see [Known issues](https://developer.microsoft.com/en-us/graph/known-issues/?search=19164). In the future, membership results may include users from various tenants, as ind [!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)| TeamMember.Read.All, TeamMember.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application| TeamMember.Read.Group*, TeamMember.Read.All, TeamMember.ReadWrite.All | +<!-- { "blockType": "permissions", "name": "team_list_members" } --> -> **Note**: Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamMember.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Team List Permissiongrants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-list-permissiongrants.md | One of the following permissions is required to call this API. To learn more, in | :- | :-- | | Delegated (work or school account) | TeamsAppInstallation.ReadForTeam, TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam | | Delegated (personal Microsoft account) | Not supported. |-| Application | TeamsAppInstallation.Read.Group*, TeamsAppInstallation.ReadForTeam.All, TeamsAppInstallation.ReadWriteSelfForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, TeamsApp.Read.Group* | +| Application | TeamsAppInstallation.Read.Group*, TeamsAppInstallation.ReadForTeam.All, TeamsAppInstallation.ReadWriteSelfForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, TeamsApp.Read.Group | -> **Note**: Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsApp.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> GET /teams/{team-id}/permissionGrants ## Optional query parameters -This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers |
v1.0 | Team Post Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-post-installedapps.md | Install an [app](../resources/teamsapp.md) to the specified [team](../resources/ ## Permissions -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) | TeamsAppInstallation.ReadWriteSelfForTeam<sup>1</sup>, TeamsAppInstallation.ReadWriteForTeam<sup>1</sup>, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam, Group.ReadWrite.All<sup>2</sup>, Directory.ReadWrite.All<sup>2</sup> | -|Delegated (personal Microsoft account) | Not supported. | -|Application | TeamsAppInstallation.ReadWriteSelfForTeam.All<sup>1</sup>, TeamsAppInstallation.ReadWriteForTeam.All<sup>1</sup>, TeamsAppInstallation.ReadWriteAndConsentForTeam.All, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam.All, Group.ReadWrite.All<sup>2</sup>, Directory.ReadWrite.All<sup>2</sup> | +<!-- { "blockType": "permissions", "name": "team_post_installedapps" } --> -> **Note**: -<br><sup>1</sup> These permissions cannot be used to install apps that require consent to [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent) permissions -<br><sup>2</sup> These permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. +> [!NOTE] +> - The TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam, TeamsAppInstallation.ReadWriteSelfForTeam.All, and TeamsAppInstallation.ReadWriteForTeam.All permissions cannot be used to install apps that require consent to [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent) permissions. +> - The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. ## HTTP request <!-- { "blockType": "ignored" } --> POST /teams/{team-id}/installedApps The request body should contain the catalog app's generated app ID. For details, see [teamsApp properties](../resources/teamsapp.md#properties). -The following table lists additional properties that can be included in the request body. +The following table lists other properties that can be included in the request body. | Property | Type |Description| |:|:--|:-| |
v1.0 | Team Post Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-post-members.md | If successful, this method returns a `201 Created` response code and a [conversa For best results, stagger calls with a 2 second buffer. +> [!NOTE] +> The response code `404 Not Found` is returned when you attempt to add a disabled/blocked user. + ## Examples ### Example 1: Add a member to a team |
v1.0 | Team Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-post.md | Create a new [team](../resources/team.md). ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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) | Team.Create, Group.ReadWrite.All**, Directory.ReadWrite.All** | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Team.Create, Teamwork.Migrate.All, Group.ReadWrite.All**, Directory.ReadWrite.All** | +<!-- { "blockType": "permissions", "name": "team_post" } --> -> **Note**: The Teamwork.Migrate.All permission is *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. --> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Teamwork.Migrate.All permission is only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> - The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ## HTTP request If successful, this API returns a `202 Accepted` response that contains a link t ### Example 1: Delegated permissions -Here's an example of a minimal request. By omitting other properties, the client is implicitly taking defaults from the pre-defined template represented by `template`. +The following example shows a minimal request. By omitting other properties, the client is implicitly taking defaults from the pre-defined template represented by `template`. #### Request Content-Type: application/json { "template@odata.bind": "https://graph.microsoft.com/beta/teamsTemplates('standard')", "displayName": "My Sample Team",- "description": "My Sample TeamΓÇÖs Description" + "description": "My Sample Team's Description" } ``` Content-Length: 0 ### Example 2: Application permissions -Here's an example of a minimal request using application permissions. By omitting other properties, the client is implicitly taking defaults from the predefined template represented by `template`. When issuing a request with application permissions, a [user](../resources/user.md) must be specified in the `members` collection. +The following example shows a minimal request using application permissions. By omitting other properties, the client is implicitly taking defaults from the predefined template represented by `template`. When issuing a request with application permissions, a [user](../resources/user.md) must be specified in the `members` collection. ++>**Note:** You can only specify a single member as the owner in this scenario. #### Request <!-- markdownlint-disable MD025 --> To create a team from a non-standard base template, you want to change the `temp To learn more about supported base template types, see [Get started with Teams templates](/MicrosoftTeams/get-started-with-teams-templates). -> [!Note] +> [!NOTE] > It can take up to 24 hours for Teams users to see a custom template change in the gallery. #### Request |
v1.0 | Team Sendactivitynotification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-sendactivitynotification.md | Send an activity feed notification in the scope of a team. For more information, [!INCLUDE [national-cloud-support](../../includes/global-us.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)|TeamsActivity.Send| -|Delegated (personal Microsoft account)|Not Supported.| -|Application|TeamsActivity.Send.Group*, TeamsActivity.Send| +<!-- { "blockType": "permissions", "name": "team_sendactivitynotification" } --> ->**Note:** Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsActivity.Send.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Team Teamsappinstallation Upgrade | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-teamsappinstallation-upgrade.md | Title: "teamsAppInstallation: upgrade" -description: "Upgrade an app installation in a team" +description: "Upgrade an app installation in a team." ms.localizationpriority: medium Upgrade an [app installation](../resources/teamsappinstallation.md) in a [team]( ## Permissions -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) | TeamsAppInstallation.ReadWriteSelfForTeam<sup>1</sup>, TeamsAppInstallation.ReadWriteForTeam<sup>1</sup>, TeamsAppInstallation.ReadWriteAndConsentForTeam, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam, Group.ReadWrite.All<sup>2</sup>, Directory.ReadWrite.All<sup>2</sup> | -|Delegated (personal Microsoft account) | Not supported. | -|Application | TeamsAppInstallation.ReadWriteSelfForTeam.All<sup>1</sup>, TeamsAppInstallation.ReadWriteForTeam.All<sup>1</sup>, TeamsAppInstallation.ReadWriteAndConsentForTeam.All, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam.All, Group.ReadWrite.All<sup>2</sup>, Directory.ReadWrite.All<sup>2</sup> | +<!-- { "blockType": "permissions", "name": "team_teamsappinstallation_upgrade" } --> -> **Note**: -<br><sup>1</sup> These permissions cannot be used to install apps that require consent to [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent) permissions. -<br><sup>2</sup> These permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. +> [!NOTE] +> - The TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeampermissions, TeamsAppInstallation.ReadWriteSelfForTeam.All, and TeamsAppInstallation.ReadWriteForTeam.All permissions cannot be used to install apps that require consent to [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent) permissions. +> - The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. ## HTTP request <!-- { "blockType": "ignored" } --> POST /teams/{team-id}/installedApps/{app-installation-id}/upgrade In the request body, supply a JSON representation of the parameters. -The following table shows additional parameters that can be used with the upgrade action. +The following table shows more parameters that can be used with the upgrade action. |Parameter|Type|Description| |:|:|:| |
v1.0 | Teamsapp Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/teamsapp-delete.md | You can also use this API to remove a submitted app from the review process. ## Permissions -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). ->**Note:** Only global administrators can call this API. +>**Note:** Only global administrators can call this API. -| Permission Type | Permissions (from least to most privileged)| -|:- |:-| -| Delegated (work or school account) | AppCatalog.Submit, AppCatalog.ReadWrite.All, Directory.ReadWrite.All** | -| Delegated (personal Microsoft account) | Not supported.| -| Application | Not supported. | +<!-- { "blockType": "permissions", "name": "teamsapp_delete" } --> -> **Note:** -> -> * Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. -> * You can only use the `AppCatalog.Submit` permission to delete app definitions in review. +> [!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. ## HTTP request To delete an app from the app catalog: DELETE /appCatalogs/teamsApps/{id} ``` -To delete an app that has been submitted but has not been approved: +To delete an app that is submitted but isn't yet approved: ```http DELETE appCatalogs/teamsApps/{appId}/appDefinitions/{appDefinitionId} |
v1.0 | Teamsapp Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/teamsapp-publish.md | Title: "Publish teamsapp" + Title: "Publish teamsApp" description: "Publish an app to the Microsoft Teams app catalog." ms.localizationpriority: medium The **requiresReview** property allows any user to submit an app for review by 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). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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) | AppCatalog.Submit, AppCatalog.ReadWrite.All, Directory.ReadWrite.All** | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Not supported. | +<!-- { "blockType": "permissions", "name": "teamsapp_publish" } --> -> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!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. ## HTTP request POST /appCatalogs/teamsApps?requiresReview={Boolean} |Property|Type|Description| |-|-|-|-|requiresReview| Boolean | This optional query parameter triggers the app review process. Users with admin privileges can submit apps without triggering a review. If users want to request a review before publishing, they must set **requiresReview** to `true`. A user who has admin privileges can opt not to set **requiresReview** or set the value to `false` and the app will be considered approved and will publish instantly.| +|requiresReview| Boolean | This optional query parameter triggers the app review process. Users with admin privileges can submit apps without triggering a review. If users want to request a review before publishing, they must set **requiresReview** to `true`. A user who has admin privileges can opt not to set **requiresReview** or set the value to `false` and the app is approved and immediately published.| ## Request headers |
v1.0 | Teamsapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/teamsapp-update.md | This API specifically updates an app published to your organization's app catalo ## Permissions -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) | AppCatalog.Submit, AppCatalog.ReadWrite.All, Directory.ReadWrite.All** | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Not supported. | +Only Global Administrators can call this API. -> **Note:** -> * Only Global Administrators can call this API. -> * Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +<!-- { "blockType": "permissions", "name": "teamsapp_update" } --> ++> [!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. ## HTTP request POST /appCatalogs/teamsApps/{id}/appDefinitions |Property|Type|Description| |-|-|-|-|requiresReview| Boolean | This optional query parameter triggers the app review process. Users with admin privileges can submit apps without triggering a review. If users want to request a review before publishing, they must set **requiresReview** to `true`. A user who has admin privileges can opt not to set **requiresReview** or set the value to `false` and the app will be considered approved and will publish instantly.| +|requiresReview| Boolean | This optional query parameter triggers the app review process. Users with admin privileges can submit apps without triggering a review. If users want to request a review before publishing, they must set **requiresReview** to `true`. A user who has admin privileges can opt not to set **requiresReview** or set the value to `false` and the app is approved and immediately published.| ## Request headers If successful, this method returns a `204 No Content` response code. HTTP/1.1 204 No Content ``` -### Example 2: Update a new version of an existing app for admin review prior to publication in the current tenant catalog +### Example 2: Update a new version of an existing app for admin review before publication in the current tenant catalog #### Request |
v1.0 | Teamsasyncoperation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/teamsasyncoperation-get.md | Get the specified [Teams async operation](../resources/teamsasyncoperation.md) t [!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). The following permissions are for getting the operation on a chat: -| Permission type | Permissions (from least to most privileged)| -| :- | : | -| Delegated (work or school account) | Chat.ReadBasic, Chat.Read, Chat.ReadWrite| -| Delegated (personal Microsoft account) | Not supported. | -| Application | ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +<!-- { "blockType": "permissions", "name": "teamsasyncoperation_get" } --> -> **Note**: Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { |
v1.0 | Tenantreference Removepersonaldata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tenantreference-removepersonaldata.md | Title: "tenantReference: removePersonalData" description: "Create a request to remove the personal data for an outboundSharedUserProfile."-++ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Tenantrelationship Put Multitenantorganization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tenantrelationship-put-multitenantorganization.md | 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-multitenantorganization-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 | Timecard Clockin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timecard-clockin.md | Clock in to start a [timeCard](../resources/timeCard.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) | Schedule.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timecard_clockin" } --> ->\* **Important:** When you use application permissions, you must include the `MS-APP-ACTS-AS` header in the request. +> [!IMPORTANT] +> When you use the Schedule.ReadWrite.All application permission, you must include the `MS-APP-ACTS-AS` header in the request. ## HTTP request |
v1.0 | Timecard Clockout | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timecard-clockout.md | Clock out to end an open [timeCard](../resources/timeCard.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) | Schedule.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timecard_clockout" } --> ->\* **Important:** When you use application permissions, you must include the `MS-APP-ACTS-AS` header in the request. +> [!IMPORTANT] +> When you use the Schedule.ReadWrite.All application permission, you must include the `MS-APP-ACTS-AS` header in the request. ## HTTP request |
v1.0 | Timecard Confirm | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timecard-confirm.md | Confirm a specific [timeCard](../resources/timecard.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) | Schedule.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timecard_confirm" } --> ->\* **Important:** When you use application permissions, you must include the `MS-APP-ACTS-AS` header in the request. +> [!IMPORTANT] +> When you use the Schedule.ReadWrite.All application permission, you must include the `MS-APP-ACTS-AS` header in the request. ## HTTP request |
v1.0 | Timecard Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timecard-delete.md | Delete a [timeCard](../resources/timecard.md) instance in a [schedule](../resour ## Permissions -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) | Schedule.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timecard_delete" } --> ->\* **Important:** When you use application permissions, you must include the `MS-APP-ACTS-AS` header in the request. +> [!IMPORTANT] +> When you use the Schedule.ReadWrite.All application permission, you must include the `MS-APP-ACTS-AS` header in the request. ## HTTP request |
v1.0 | Timecard Endbreak | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timecard-endbreak.md | End the open break in a specific [timeCard](../resources/timeCard.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) | Schedule.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timecard_endbreak" } --> ->\* **Important:** When you use application permissions, you must include the `MS-APP-ACTS-AS` header in the request. +> [!IMPORTANT] +> When you use the Schedule.ReadWrite.All application permission, you must include the `MS-APP-ACTS-AS` header in the request. ## HTTP request |
v1.0 | Timecard Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timecard-get.md | Get the properties and relationships of a [timeCard](../resources/timecard.md) o ## Permissions -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) | Schedule.Read.All, Schedule.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.Read.All*, Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timecard_get" } --> ->\* **Important:** When you use application permissions, you must include the `MS-APP-ACTS-AS` header in the request. +> [!IMPORTANT] +> When you use the Schedule.Read.All and Schedule.ReadWrite.All application permissions, you must include the `MS-APP-ACTS-AS` header in the request. ## HTTP request GET /teams/{teamId}/schedule/timeCards/{timeCardId} ``` ## Optional query parameters-This method does not support [OData query parameters](/graph/query-parameters) to customize the response. +This method doesn't support [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers |
v1.0 | Timecard List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timecard-list.md | Retrieve a list of [timeCard](../resources/timecard.md) entries in a [schedule]( ## Permissions -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) | Schedule.Read.All, Schedule.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.Read.All*, Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timecard_list" } --> ->\* **Important:** When you use application permissions, you must include the `MS-APP-ACTS-AS` header in the request. +> [!IMPORTANT] +> When you use the Schedule.Read.All and Schedule.ReadWrite.All application permissions, you must include the `MS-APP-ACTS-AS` header in the request. ## HTTP request |
v1.0 | Timecard Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timecard-post.md | Create a [timeCard](../resources/timecard.md) instance in a [schedule](../resour ## Permissions -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) | Schedule.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timecard_post" } --> ->\* **Important:** When you use application permissions, you must include the `MS-APP-ACTS-AS` header in the request. +> [!IMPORTANT] +> When you use the Schedule.ReadWrite.All application permission, you must include the `MS-APP-ACTS-AS` header in the request. ## HTTP request |
v1.0 | Timecard Replace | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timecard-replace.md | Replace an existing [timeCard](../resources/timecard.md) with updated values. ## Permissions -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) | Schedule.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timecard_replace" } --> ->\* **Important:** When you use application permissions, you must include the `MS-APP-ACTS-AS` header in the request. +> [!IMPORTANT] +> When you use the Schedule.ReadWrite.All application permission, you must include the `MS-APP-ACTS-AS` header in the request. ## HTTP request |
v1.0 | Timecard Startbreak | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timecard-startbreak.md | Start a break in a specific [timeCard](../resources/timeCard.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) | Schedule.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timecard_startbreak" } --> ->\* **Important:** When you use application permissions, you must include the `MS-APP-ACTS-AS` header in the request. +> [!IMPORTANT] +> When you use Schedule.ReadWrite.All application permission, you must include the `MS-APP-ACTS-AS` header in the request. ## HTTP request |
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 ## Permissions -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) | Group.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +This API supports admin permissions. Global admins can access groups that they aren't a member of. ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +<!-- { "blockType": "permissions", "name": "timeoff_delete" } --> -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and isn't available for public use. ## HTTP request |
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 ## Permissions -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) | Group.Read.All, Group.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.Read.All*, Schedule.ReadWrite.All* | +This API supports admin permissions. Global admins can access groups that they aren't a member of. ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +<!-- { "blockType": "permissions", "name": "timeoff_get" } --> -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> [!NOTE] +> The Schedule.Read.All and Schedule.ReadWrite.All application permissions are currently in private preview only and aren't available for public use. ## HTTP request GET /teams/{teamId}/schedule/timesOff/{timeOffId} ## Optional query parameters -This method does not support OData query parameters to customize the response. +This method doesn't support OData query parameters to customize the response. ## Request headers |
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 ## Permissions -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) | Group.Read.All, Group.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +This API supports admin permissions. Global admins can access groups that they aren't a member of. ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +<!-- { "blockType": "permissions", "name": "timeoff_put" } --> -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and isn't available for public use. ## HTTP request |
v1.0 | Timeoffreason Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoffreason-delete.md | Namespace: microsoft.graph Mark a [timeOffReason](../resources/timeoffreason.md) as inactive by setting the **isActive** property. Every team must include at least one **timeOffReason**. -This method does not remove the specified **timeOffReason** instance. [timeOffItem](../resources/timeoffitem.md) instances that have been assigned this reason remain assigned to this reason. +This method doesn't remove the specified **timeOffReason** instance. [timeOffItem](../resources/timeoffitem.md) instances that were assigned this reason remain assigned to this reason. [!INCLUDE [national-cloud-support](../../includes/global-only.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) | Group.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +This API supports admin permissions. Global admins can access groups that they aren't a member of. ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +<!-- { "blockType": "permissions", "name": "timeoffreason_delete" } --> -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and isn't available for public use. ## HTTP request |
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 ## Permissions -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) | Group.Read.All, Group.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.Read.All*, Schedule.ReadWrite.All* | +This API supports admin permissions. Global admins can access groups that they aren't a member of. ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +<!-- { "blockType": "permissions", "name": "timeoffreason_get" } --> -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> [!NOTE] +> The Schedule.Read.All and Schedule.ReadWrite.All application permissions are currently in private preview only and aren't available for public use. ## HTTP request GET /teams/{teamId}/schedule/timeOffReasons/{timeOffReasonId} ## Optional query parameters -This method does not support OData query parameters to customize the response. +This method doesn't support OData query parameters to customize the response. ## Request headers |
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 ## Permissions -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) | Group.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +This API supports admin permissions. Global admins can access groups that they aren't a member of. ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +<!-- { "blockType": "permissions", "name": "timeoffreason_put" } --> -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and isn't available for public use. ## HTTP request |
v1.0 | Timeoffrequest Approve | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoffrequest-approve.md | Approve a [timeoffrequest](../resources/timeoffrequest.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) | Group.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timeoffrequest_approve" } --> ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and isn't available for public use. ## HTTP request In the request body, provide a JSON object with the following parameters. If successful, this method returns a `200, OK` response code. It doesn't return anything in the response body. -## Examples --The following is an example of how to call this API. +## Example ### Request |
v1.0 | Timeoffrequest Decline | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoffrequest-decline.md | Decline a [timeoffrequest](../resources/timeoffrequest.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). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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) | Group.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timeoffrequest_decline" } --> ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and isn't available for public use. ## HTTP request In the request body, provide a JSON object with the following parameters. If successful, this method returns a `200 OK` response code. It doesn't return anything in the response body. -## Examples --The following is an example of how to call this API. +## Example ### Request |
v1.0 | Timeoffrequest Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoffrequest-delete.md | Delete a [timeOffRequest](../resources/timeoffrequest.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). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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) | Group.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timeoffrequest_delete" } --> ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +> [!NOTE] +> The Schedule.ReadWrite.All application permission is currently in private preview only and isn't available for public use. ## HTTP request |
v1.0 | Timeoffrequest Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoffrequest-get.md | Retrieve the properties and relationships of a [timeoffrequest](../resources/tim ## Permissions -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) | Group.Read.All, Group.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.Read.All*, Schedule.ReadWrite.All* | +<!-- { "blockType": "permissions", "name": "timeoffrequest_get" } --> ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +> [!NOTE] +> The Schedule.Read.All and Schedule.ReadWrite.All application permissions are currently in private preview only and aren't available for public use. ## HTTP request GET /teams/{teamId}/schedule/timeOffRequests/{timeOffRequestId} ## Optional query parameters -This method does not support OData query parameters to customize the response. +This method doesn't support OData query parameters to customize the response. ## Request headers |
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 ## Permissions -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) | Schedule.Read.All, Group.Read.All, Schedule.ReadWrite.All, Group.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Schedule.Read.All*, Schedule.ReadWrite.All* | +This API supports admin permissions. Global admins can access groups that they aren't a member of. ->\* **Important:** Application permissions are currently in private preview only and are not available for public use. +<!-- { "blockType": "permissions", "name": "timeoffrequest_list" } --> -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> [!NOTE] +> The Schedule.Read.All and Schedule.ReadWrite.All application permissions are currently in private preview only and aren't available for public use. ## HTTP request |
v1.0 | Training Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/training-get.md | GET /security/attackSimulation/trainings/{trainingId} ## Optional query parameters -This method does not currently support the [OData query parameters](/graph/query-parameters) to customize the response. +This method doesn't currently support [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers Content-Type: application/json "email": "yibsu", "id": null, "displayName": null- } + }, + "customUrl" : null } ``` |
v1.0 | Trainingcampaign Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trainingcampaign-get.md | + + Title: "Get trainingCampaign" +description: "Read the properties and relationships of a trainingCampaign object." ++ms.localizationpriority: medium +++# Get trainingCampaign ++Namespace: microsoft.graph +++Read the properties and relationships of a [trainingCampaign](../resources/trainingcampaign.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": "trainingcampaign_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId} +``` ++## 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 [trainingCampaign](../resources/trainingcampaign.md) object in the response body. ++## Examples ++### Example 1: Get a training campaign ++The following example shows how to get an attack simulation campaign for a tenant. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name" : "get_trainingcampaign" +}--> ++``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a +``` ++# [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.trainingCampaign", + "name" : "get_trainingcampaign" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "id": "81c59451-2929-5b39-86f0-5a2b15f1314f", + "displayName": "graph toc update 2", + "description": "Graph Test", + "createdDateTime": "2024-02-18T08:36:07.6534871Z", + "lastModifiedDateTime": "2024-02-19T08:00:01.9417887Z", + "endUserNotificationSetting": null, + "includedAccountTarget": null, + "excludedAccountTarget": null, + "trainingSetting": null, + "report": null, + "campaignSchedule": { + "launchDateTime": "2024-02-18T08:37:44Z", + "completionDateTime": "2024-02-19T07:59:44Z", + "status": "completed" + }, + "createdBy": { + "email": "attacksim@a830edad9050849EQTPWBJZXODQ.onmicrosoft.com", + "id": "478a22cd-aecc-41df-b995-88c8de17aaf5", + "displayName": "attacksim" + }, + "lastModifiedBy": { + "email": "attacksim@a830edad9050849EQTPWBJZXODQ.onmicrosoft.com", + "id": "478a22cd-aecc-41df-b995-88c8de17aaf5", + "displayName": "attacksim" + } +} +``` ++### Example 2: Get included account targets ++The following example shows how to get included account targets (users) for a Training campaign for a tenant. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name" : "get_trainingcampaign_includedtargets" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/includedAccountTarget +``` ++# [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.accountTargetContent", + "name" : "get_trainingcampaign_includedtargets" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.addressBookAccountTargetContent", + "type": "addressBook", + "accountTargetEmails": [ + "john@contoso.com" + ] +} +``` ++### Example 3: Get excluded account targets ++The following example shows how to get the excluded account targets (users) for a Training campaign for a tenant. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name" : "get_trainingcampaign_excludedtargets" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/excludedAccountTarget +``` ++# [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.accountTargetContent", + "name" : "get_trainingcampaign_excludedtargets" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.addressBookAccountTargetContent", + "type": "addressBook", + "accountTargetEmails": [ + "alie@contoso.com" + ] +} +``` ++### Example 4: Get training setting ++The following example shows how to get training setting details for a training campaign. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name" : "get_trainingcampaign_training" +} +--> ++``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/trainingSetting +``` ++# [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.trainingSetting", + "name" : "get_trainingcampaign_training" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "trainingCompletionDuration": "0", + "completionDateTime": "2024-02-19T07:59:44Z", + "settingType": "microsoftManaged" +} +``` ++### Example 5: Get end user notification setting ++The following example shows how to get end user notification setting details for a training campaign. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name" : "get_trainingcampaign_eun" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/endUserNotificationSetting +``` ++# [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.endUserNotificationSetting", + "name" : "get_trainingcampaign_eun" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "settingType": "trainingSelected", + "positiveReinforcement": null, + "notificationPreference": "microsoft", + "trainingAssignment" : { + "deliveryFrequency": "unknown", + "defaultLanguage": "en", + "endUserNotification": { + "id": "36fb4dc1-7c37-4b96-9096-12e6d6014fae", + "displayName": "Microsoft default training only campaign-training assignment notification" + } + }, + "trainingReminder" : { + "deliveryFrequency": "weekly", + "defaultLanguage": "en", + "endUserNotification": { + "id": "fe521249-9901-4584-a987-026a9980c58e", + "displayName": "Microsoft default training only campaign-training reminder notification" + } + } +} +``` |
v1.0 | Trainingcampaign Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trainingcampaign-update.md | + + Title: "Update trainingCampaign" +description: "Update the properties of a trainingCampaign object." ++ms.localizationpriority: medium +++# Update trainingCampaign ++Namespace: microsoft.graph +++Update the properties of a [trainingCampaign](../resources/trainingcampaign.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": "trainingcampaign_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /security/attackSimulation/trainingCampaigns/{trainingCampaignId} +``` ++## 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| +|:|:|:| +|createdBy|[emailIdentity](../resources/emailidentity.md)|The identity of the user who created the training campaign. Optional.| +|createdDateTime|DateTimeOffset|The date and time of creation of the training campaign. Optional.| +|description|String|The description of the training campaign. Optional.| +|displayName|String|The display name of the training campaign. Required.| +|endUserNotificationSetting|[endUserNotificationSetting](../resources/endusernotificationsetting.md)|Details about the end user notification setting. Required.| +|excludedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|The users who are excluded from the training campaign. Optional.| +|includedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|The users who are targeted in the training campaign. Required.| +|lastModifiedDateTime|DateTimeOffset|The identity of the user who most recently modified the training campaign. Optional.| +|trainingSetting|[trainingSetting](../resources/trainingsetting.md)|Details about the training settings for a training campaign. Required.| +|campaignSchedule|[campaignSchedule](../resources/campaignschedule.md)|Details about the schedule and current status for a training campaign. Required.| ++## Response ++If successful, this method returns a `202 Accepted` response code and a tracking header named `location` in the response. ++## Example ++The following example shows how to update the status of the training campaign. In this case, a scheduled training campaign is canceled. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_trainingcampaign" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/{trainingCampaignId} +Content-Type: application/json ++{ + "displayName": "Graph Training Campaign", + "description": "Graph Training Campaign Description", + "createdBy": { + "email": "john@contoso.com" + }, + "lastModifiedBy": { + "email": "john@contoso.com" + }, + "includedAccountTarget": { + "type": "addressBook", + "accountTargetEmails": [ + "john@contoso.com" + ] + }, + "endUserNotificationSetting": { + "notificationPreference": "microsoft", + "settingType": "trainingSelected", + "trainingReminder": { + "deliveryFrequency": "weekly", + "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('fe521249-9901-4584-a987-026a9980c58e')", + "defaultLanguage": "en" + }, + "trainingAssignment": { + "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('36fb4dc1-7c37-4b96-9096-12e6d6014fae')", + "defaultLanguage": "en" + } + }, + "trainingSetting": { + "settingType": "microsoftCustom", + "trainingAssignmentMappings": [ + { + "assignedTo": [ + "allUsers" + ], + "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('40454905-dc26-4f36-b854-3042a5362cb3')" + }, + { + "assignedTo": [ + "allUsers" + ], + "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('ea70ae06-3859-4818-be9d-270ee81d80a4')" + }, + { + "assignedTo": [ + "allUsers" + ], + "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('d733d88c-1b5a-48e3-a588-9910e41ac21d')" + } + ] + }, + "campaignSchedule": { + "launchDateTime": "2024-02-15T07:59:44Z", + "completionDateTime": "2024-02-18T07:59:44Z", + "status": "Cancelled" + } +} +``` ++# [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. ++<!-- { + "blockType": "response", + "truncated": true +} +--> ++```http +HTTP/1.1 202 Accepted +``` + |
v1.0 | Trainingcampaignreportoverview Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trainingcampaignreportoverview-get.md | + + Title: "Get trainingCampaignReportOverview" +description: "Get an overview of a training campaign." ++ms.localizationpriority: medium +++# Get trainingCampaignReportOverview +Namespace: microsoft.graph +++Get an overview of a training campaign. ++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "trainingcampaignreportoverview_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/report/overview +``` ++## 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 [trainingCampaignReportOverview](../resources/trainingcampaignreportoverview.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/report/overview +``` ++++### 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.trainingCampaignReportOverview" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "trainingModuleCompletion": { + "trainingsAssignedUserCount": 1, + "assignedTrainingsInfos": [ + { + "assignedUserCount": 1, + "completedUserCount": 0, + "displayName": "Identity Theft" + }, + { + "assignedUserCount": 1, + "completedUserCount": 0, + "displayName": "Introduction to Information Security" + }, + { + "assignedUserCount": 1, + "completedUserCount": 0, + "displayName": "Malware" + } + ] + }, + "userCompletionStatus": { + "notStartedUsersCount": 0, + "completedUsersCount": 0, + "inProgressUsersCount": 1, + "notCompletedUsersCount": 0, + "previouslyAssignedUsersCount": 0 + }, + "trainingNotificationDeliveryStatus": { + "resolvedTargetsCount": 1, + "successfulMessageDeliveryCount": 1, + "failedMessageDeliveryCount": 0 + } +} +``` + |
v1.0 | Trustframework List Trustframeworkpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframework-list-trustframeworkpolicies.md | 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 be a global administrator of the tenant. +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 Trustframeworkpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframework-post-trustframeworkpolicy.md | 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 be a global administrator of the tenant. +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 | 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 be a global administrator of the tenant. +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 HTTP/1.1 200 OK Content-Type: application/xml <TrustFrameworkPolicy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/online/cpim/schemas/2013/06" PolicySchemaVersion="0.3.0.0" TenantId="contoso.com" PolicyId="B2C_1A_Test" PublicPolicyUri="http://contoso.com/B2C_1A_Test">- ..... - .... - <!PolicyContent--> - .... - .... + ..... + .... + <!PolicyContent--> + .... + .... </TrustFrameworkPolicy> ``` |
v1.0 | Trustframeworkkey_V2 Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkey_v2-get.md | + + Title: "Get trustFrameworkKey_v2" +description: "Read the properties and relationships of a trustFrameworkKey_v2 object." ++ms.localizationpriority: medium ++++# Get trustFrameworkKey_v2 ++Namespace: microsoft.graph +++Read the properties and relationships of a [trustFrameworkKey_v2](../resources/trustframeworkkey_v2.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": "trustframeworkkey_v2_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /trustFramework/keySets/{trustFrameworkKeySetId}/keys_v2/{trustFrameworkKey_v2Id} +``` ++## 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 [trustFrameworkKey_v2](../resources/trustframeworkkey_v2.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_trustframeworkkey_v2" +} +--> +``` http +GET https://graph.microsoft.com/beta/trustFramework/keySets/{trustFrameworkKeySetId}/keys_v2/{aTREvwojOB9ph3fr2r6eTf_5eD5fmQsfsapVMwYI3o} +``` ++# [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.trustFrameworkKey_v2" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.trustFrameworkKey_v2", + "k": "AQHF", + "x5c": [ + "MIICDTCCAXagAwIBAgIQAkiG9w0zWT5PduVXKynAjHTATBgNVHSUEDDAKBggrBgEFBQcDATANBgkqhkiG9w.." + ], + "x5t": "kr03PNLOFr9InfdsfbIyoC4KCKS8", + "kty": "oct", + "use": "sig", + "status": "enabled", + "exp": "1712952360", + "nbf": "1712952300", + "kid": "aTREvwojOB9ph3fr2r6eTf_5eD5fmQsfsapVMwYI3o", + "e": "AQHF", + "n": "oNuJk44jzFgZ9R26gfdgfgtR_9Btg8vRKh3Y0", + } +} ++``` |
v1.0 | Trustframeworkkey_V2 Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkey_v2-update.md | + + Title: "Update trustFrameworkKey_v2" +description: "Update the properties of a trustFrameworkKey_v2 object." ++ms.localizationpriority: medium ++++# Update trustFrameworkKey_v2 ++Namespace: microsoft.graph +++Update the properties of a [trustFrameworkKey_v2](../resources/trustframeworkkey_v2.md) object. Only Status Property is allowed to update from this 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": "trustframeworkkey_v2_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /trustFramework/keySets/{trustFrameworkKeySetId}/keys_v2/{trustFrameworkKey_v2Id} +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body +++|Property|Type|Description| +|:|:|:| +|status|trustFrameworkKeyStatus|Status of the key. The possible values are: `enabled`, `disabled`, `unknownFutureValue`. Optional.| ++## Response ++If successful, this method returns a `204 No Content` response code and an updated [trustFrameworkKey_v2](../resources/trustframeworkkey_v2.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_trustframeworkkey_v2" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/trustFramework/keySets/{trustFrameworkKeySetId}/keys_v2/aTREvwojOB9ph3fr2r6eTf_5eD5fmQsfsapVMwYI3o +Content-Type: application/json ++{ + "status": "enabled" +} +``` ++# [JavaScript](#tab/javascript) ++++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Trustframeworkpolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkpolicy-delete.md | 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 be a global administrator of the tenant. +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 | 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 be a global administrator of the tenant. +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 HTTP/1.1 200 OK Content-Type: application/xml <TrustFrameworkPolicy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/online/cpim/schemas/2013/06" PolicySchemaVersion="0.3.0.0" TenantId="contoso.com" PolicyId="B2C_1A_Test" PublicPolicyUri="http://contoso.com/B2C_1A_Test">- ..... - .... - <!PolicyContent--> - .... - .... + ..... + .... + <!PolicyContent--> + .... + .... </TrustFrameworkPolicy> ``` |
v1.0 | Unenforcedmfaawsuserfinding Aggregatedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/unenforcedmfaawsuserfinding-aggregatedsummary.md | description: View the count of AWS users with unenforced MFA in your authorizati ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Unenforcedmfaawsuserfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/unenforcedmfaawsuserfinding-get.md | description: "Read the properties and relationships of an unenforcedMfaAwsUserFi ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Unenforcedmfaawsuserfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/unenforcedmfaawsuserfinding-list.md | description: "Get a list of the unenforcedMfaAwsUserFinding objects and their pr ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Unifiedroleassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/unifiedroleassignment-get.md | One of the following permissions is required to call this API. To learn more, in <!-- { "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) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | +|Delegated (work or school account) | RoleManagement.Read.Directory, RoleManagement.Read.All, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | +|Application | RoleManagement.Read.Directory, RoleManagement.Read.All, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | ### For entitlement management provider <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> |
v1.0 | Unifiedroledefinition Assignedprincipals | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/unifiedroledefinition-assignedprincipals.md | Namespace: microsoft.graph Get the list of security principals (users, groups, and service principals) that are assigned to a specific role for different scopes either directly or transitively. You can use the `$count` query parameter to also get the count. +This API is supported for the directory (Microsoft Entra ID) provider only. + To list the direct and transitive role assignments for a specific principal, use the [List transitiveRoleAssignments](rbacapplication-list-transitiveroleassignments.md) API. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "unifiedroledefinition_assignedprincipals" } --> [!INCLUDE [permissions-table](../includes/permissions/unifiedroledefinition-assignedprincipals-permissions.md)] -If the caller doesn't have the permission to read properties for some of the objects included in the result set, the response follows the [limited information returned for inaccessible member objects](/graph/permissions-overview#limited-information-returned-for-inaccessible-member-objects) pattern. --To read the properties that may require permissions for the object, grant the permissions to retrieve information about the object. For more information, see permissions for [users](user-list.md#permissions), [groups](group-list.md#permissions), and [service principals](serviceprincipal-list.md#permissions). - ## HTTP request |
v1.0 | Unifiedstoragequota Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/unifiedstoragequota-get.md | Namespace: microsoft.graph Read the properties and relationships of a [unifiedStorageQuota](../resources/unifiedstoragequota.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). If successful, this method returns a `200 OK` response code and a [unifiedStorag ### Example 1: Get the unified quota information for the current user #### Request Here's an example of a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_unifiedstoragequota" Here's an example of a request. GET https://graph.microsoft.com/beta/me/settings/storage/quota ``` +# [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 Here's an example of the response Content-Type: application/json ### Example 2: Get the unified quota information for the current user #### Request Here's an example of a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_unifiedstoragequotabyuserid", Here's an example of a request. GET https://graph.microsoft.com/beta/users/1234BBS1121YY95/settings/storage/quota ``` +# [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 Here's an example of the response Content-Type: application/json ### Example 3: Get the unified quota information, along with the service breakdowns, for the current user #### Request Here's an example of a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_unifiedstoragequotaandservices" Here's an example of a request. GET https://graph.microsoft.com/beta/me/settings/storage/quota?$expand=services ``` +# [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 Here's an example of the response |
v1.0 | Unifiedstoragequota List Services | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/unifiedstoragequota-list-services.md | Namespace: microsoft.graph Get a list of [serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.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). If successful, this method returns a `200 OK` response code and a collection of ### Request Here's an example of a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_servicestoragequotabreakdown" Here's an example of a request. GET https://graph.microsoft.com/beta/me/settings/storage/quota/services ``` +# [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 Here's an example of the response |
v1.0 | User Assignlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-assignlicense.md | Title: "user: assignLicense" description: "Add or remove licenses for the user to enable or disable their use of Microsoft cloud offerings. " ms.localizationpriority: medium + doc_type: apiPageType 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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +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-- Global Administrator ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User Changepassword | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-changepassword.md | description: "Update your own password." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User Convertexternaltointernalmemberuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-convertexternaltointernalmemberuser.md | description: "Convert an external user to an internal member." ms.localizationpriority: medium+ doc_type: apiPageType Namespace: microsoft.graph Convert an externally authenticated user into an internal user. The user is able to sign into the host tenant as an internal user and access resources as a member. For more information about this conversion, see [Convert external users to internal users](/entra/identity/users/convert-external-users-internal). + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 [!INCLUDE [sample-code](../includes/snippets/php/userthisconvertexternaltointernalmemberuser-cloudonly-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/userthisconvertexternaltointernalmemberuser-cloudonly-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/php/userthisconvertexternaltointernalmemberuser-cloudonly-with-mail-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/userthisconvertexternaltointernalmemberuser-cloudonly-with-mail-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] POST https://graph.microsoft.com/beta/users/0b8cc234-ef87-4015-9785-cbb42000d41c [!INCLUDE [sample-code](../includes/snippets/php/userthisconvertexternaltointernalmemberuser-synceduser-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/userthisconvertexternaltointernalmemberuser-synceduser-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | User Delete Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-delete-approleassignments.md | Title: "Delete appRoleAssignment" description: "Delete an appRoleAssignment that has been granted to a user." ms.localizationpriority: medium doc_type: apiPageType+ |
v1.0 | User Delete Manager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-delete-manager.md | description: "Remove a user's manager." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User Delete Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-delete-sponsors.md | Title: "Remove sponsor" description: "Remove a user's sponsor." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-delete.md | description: "Describes the delete method of the user resource (entity) of the M ms.localizationpriority: medium+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored", "name": "user_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/user-delete-permissions.md)] -The calling user must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): +The calling user must be assigned at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): - User Administrator - Privileged Authentication Administrator-- Global Administrator To delete users with privileged administrator roles in delegated scenarios, the app must be assigned the *Directory.AccessAsUser.All* delegated permission, and the calling user must have a higher privileged administrator role as indicated in [Who can perform sensitive actions](../resources/users.md#who-can-perform-sensitive-actions). |
v1.0 | User Deletepasswordsinglesignoncredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-deletepasswordsinglesignoncredentials.md | Title: "user: deletePasswordSingleSignOnCredentials" description: "Delete password-based single sign-on credentials for a service principal that is associated to a user." ms.localizationpriority: medium+ doc_type: apiPageType Namespace: microsoft.graph Delete the password-based single sign-on credentials for a given user to a given service principal. ## Permissions |
v1.0 | User Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-delta.md | description: "Get newly created, updated, or deleted users without having to per ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User Exportpersonaldata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-exportpersonaldata.md | description: "Submits a data policy operation request, made by a Company Adminis ms.localizationpriority: medium + doc_type: apiPageType doc_type: apiPageType Namespace: microsoft.graph -Submit a data policy operation request from a company administrator or an application to export an organizational user's data. This data includes the user's data stored in OneDrive and their activity reports. For more guidance about exporting data while complying with regulations, see [Data Subject Requests and the GDPR and CCPA](/compliance/regulatory/gdpr-data-subject-requests). +Submit a data policy operation request from a company administrator or an application to export an organizational user's data. This data includes the user's data stored in OneDrive and their activity reports. For more information about exporting data while complying with regulations, see [Data Subject Requests and the GDPR and CCPA](/compliance/regulatory/gdpr-data-subject-requests). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] POST /users/{id}/exportPersonalData ## Request body In the request body, provide a JSON object with the following parameters. -| Parameter | Type |Description | +| Parameter | Type |Description | |:|:--|:-| |storageLocation|String|This is a shared access signature (SAS) URL to an Azure Storage account, to where data should be exported.| |
v1.0 | User Get Transitivereports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-get-transitivereports.md | description: "Get the count of transitive reports for a user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-get.md | description: "Retrieve the properties and relationships of user object." ms.localizationpriority: high+ doc_type: apiPageType |
v1.0 | User Getpasswordsinglesignoncredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-getpasswordsinglesignoncredentials.md | Title: "user: getPasswordSingleSignOnCredentials" description: "Get the list of password-based single sign-on credentials for a given user. This API returns the encrypted passwords as null or empty strings." ms.localizationpriority: medium+ doc_type: apiPageType Namespace: microsoft.graph Get the list of password-based single sign-on credentials for a given user. This API returns the encrypted passwords as null or empty strings. ## Permissions |
v1.0 | User Invalidateallrefreshtokens | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-invalidateallrefreshtokens.md | description: "Invalidates all of the user's refresh tokens issued to application ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User List Agreementacceptances | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-agreementacceptances.md | Title: "List agreementAcceptances" description: "Retrieve a list of a user's agreementAcceptance objects." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User List Approleassignedresources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-approleassignedresources.md | Title: "List appRoleAssignedResources" description: "Get the service principals to which the user has an app role assignment either directly or through group membership." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-approleassignments.md | Title: "List appRoleAssignments granted to a user" description: "Retrieve the list of app role assignments granted to a user." ms.localizationpriority: high doc_type: apiPageType+ |
v1.0 | User List Createdobjects | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-createdobjects.md | description: "Get a list of directory objects that were created by the user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Devices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-devices.md | description: "Get a list of user devices that support Project Rome capabilities. ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User List Directreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-directreports.md | description: "Get a user's direct reports." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User List Events | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-events.md | GET /me/calendarGroups/{id}/calendars/{id}/events GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events ``` ## Optional query parameters-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData query parameters](/graph/query-parameters) to help customize the response. ++> [!NOTE] +> You can't use the `$filter` parameter to filter on the **recurrence** property. + ## Request headers | Name | Type | Description| |:--|:|:-| Don't supply a request body for this method. ## Response If successful, this method returns a `200 OK` response code and collection of [event](../resources/event.md) objects in the response body.-## Example -##### Request 1 +## Examples +### Example 1: Get all user's events The first example gets all the user's events. It specifies the following: - A `Prefer: outlook.timezone` header to get date time values returned in Pacific Standard Time. The first example gets all the user's events. It specifies the following: The request does not specify any `Prefer: outlook.body-content-type` header to indicate a specific format for the returned event body. +#### Request # [HTTP](#tab/http) <!-- { Prefer: outlook.timezone="Pacific Standard Time" -##### Response 1 +#### Response The following example shows the response. Because no `Prefer: outlook.body-content-type` header was specified, the **body** property is returned in the default HTML format. <!-- { "blockType": "response", Preference-Applied: outlook.timezone="Pacific Standard Time" } ``` -##### Request 2 -The second example shows how to use a `Prefer: outlook.body-content-type="text"` header to get the **body** property of the specified message in text format. +### Example 2: Get the body propery of the message +The following example shows how to use a `Prefer: outlook.body-content-type="text"` header to get the **body** property of the specified message in text format. The request also uses a `$select` query parameter to return specific properties. Without a `$select` parameter, all of the event properties will be returned. +#### Request + # [HTTP](#tab/http) <!-- { "blockType": "request", Prefer: outlook.body-content-type="text" -##### Response 2 +#### Response The following example shows the response. The **body** property is returned in text format. <!-- { |
v1.0 | User List Invitedby | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-invitedby.md | + + Title: "List invitedBy" +description: "Get the user or service principal that invited the specified user into the tenant." ++ms.localizationpriority: medium ++++# List invitedBy ++Namespace: microsoft.graph +++Get the [user](../resources/user.md) or [servicePrincipal](../resources/serviceprincipal.md) that invited the specified user into the 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": "user-list-invitedby-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /me/invitedBy +GET /users/{userId}/invitedBy +``` ++## 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 single [directoryObject](../resources/directoryobject.md) in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "list_directoryobject" +} +--> +``` http +GET https://graph.microsoft.com/beta/users/37b16a99-97fe-47fe-9a58-4257059b3463/invitedBy +``` +++### 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.directoryObject" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.user", + "displayName": "Adele Vance", + "givenName": "Adele", + "jobTitle": "Retail Manager", + "mail": "AdeleV@contoso.com", + "mobilePhone": "+1 425 555 0109", + "officeLocation": "18/2111", + "preferredLanguage": "en-US", + "surname": "Vance", + "invitedBy": "93636d4a-4d22-4f76-841f-1d4c7ca7de9d", + "userPrincipalName": "AdeleV@contoso.com", + "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd" + } + ] +} +``` + |
v1.0 | User List Joinedteams | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-joinedteams.md | Get the [teams](../resources/team.md) in Microsoft Teams that the user is a dire [!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) | Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All, User.Read.All, User.ReadWrite.All, Directory.Read.All**, Directory.ReadWrite.All** | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All, User.Read.All, User.ReadWrite.All, Directory.Read.All**, Directory.ReadWrite.All** | +<!-- { "blockType": "permissions", "name": "user_list_joinedteams" } --> -> **Note:** Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ## HTTP request <!-- { "blockType": "ignored" } --> GET /users/{id | user-principal-name}/joinedTeams ``` ## Optional query parameters-This method does not currently support the [OData query parameters](/graph/query-parameters) to customize the response. +This method doesn't currently support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers | Header | Value | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [team](../resources/team.md) objects in the response body. -> [!Note] +> [!NOTE] > This API has a [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=13633) where it returns only the **id**, **displayName**, and **description** properties of a [team](../resources/team.md).To get all properties, use the [Get team](../api/team-get.md) operation. |
v1.0 | User List Licensedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-licensedetails.md | Title: "List licenseDetails" description: "Retrieve a list of licenseDetails objects." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Manager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-manager.md | description: "Get user's manager. Returns the user or contact assigned as the us ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User List Memberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-memberof.md | description: "Get groups, directory roles, and administrative units that the use ms.localizationpriority: medium + doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] +> [!TIP] +> - Calling the `/me/memberOf` endpoint requires a signed-in user and therefore a delegated permission. Application permissions are not supported when you use the `/me/memberOf` endpoint. +> - To list the members of a group with hidden membership, the `Member.Read.Hidden` permission is required. + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User List Owneddevices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-owneddevices.md | description: "Get the list of devices that are owned by the user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Ownedobjects | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-ownedobjects.md | description: "Get the list of directory objects that are owned by the user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Registereddevices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-registereddevices.md | description: "Get the list of user's registered devices." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User List Scopedrolememberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-scopedrolememberof.md | description: "Retrieve a list of scopedRoleMembership for the user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-sponsors.md | Title: "List sponsors" description: "Get a user's sponsors." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User List Transitivememberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-transitivememberof.md | description: "Get groups, directory roles, and administrative units that the use ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User List Trendingaround | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-trendingaround.md | description: "Calculated insight that returns the list of items trending around ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Usagerights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-usagerights.md | Title: "List user usageRights" description: "Retrieve a list of usageRights objects for a user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list.md | description: "Retrieve a list of user objects." ms.localizationpriority: high+ doc_type: apiPageType |
v1.0 | User Post Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-post-approleassignments.md | Title: "Grant an appRoleAssignment to a user" description: "Grant an app role assignment to a user." ms.localizationpriority: high doc_type: apiPageType+ |
v1.0 | User Post Manager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-post-manager.md | description: "Assign a user's manager." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User Post Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-post-sponsors.md | Title: "Add sponsor" description: "Assign a user a sponsor." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User Post Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-post-users.md | description: "Create a new user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User Reprocesslicenseassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-reprocesslicenseassignment.md | description: "Reprocess all group-based license assignments for the user." ms.localizationpriority: medium + doc_type: "apiPageType" 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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +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-- Global Administrator ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User Retryserviceprovisioning | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-retryserviceprovisioning.md | Title: "user: retryServiceProvisioning" description: "Retries user service provisioning." ms.localizationpriority: medium + doc_type: "apiPageType" |
v1.0 | User Revokesigninsessions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-revokesigninsessions.md | description: "Invalidates all the user's refresh tokens issued to applications ( ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-update.md | description: "Update the properties of a user object." ms.localizationpriority: medium+ doc_type: apiPageType 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. A global 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. 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.| | 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`| |
v1.0 | User Validatepassword | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-validatepassword.md | description: "Check a user's password against the organization's password valida ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Userflowlanguageconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/userflowlanguageconfiguration-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguageconfiguration_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguageconfiguration-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Userflowlanguageconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/userflowlanguageconfiguration-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguageconfiguration_get" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguageconfiguration-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Userflowlanguageconfiguration List Defaultpages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/userflowlanguageconfiguration-list-defaultpages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguageconfiguration_list_defaultpages" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguageconfiguration-list-defaultpages-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Userflowlanguageconfiguration List Overridespages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/userflowlanguageconfiguration-list-overridespages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguageconfiguration_list_overridespages" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguageconfiguration-list-overridespages-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Userflowlanguagepage Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/userflowlanguagepage-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguagepage_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguagepage-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request Here's an example of the request. DELETE https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_Customer/languages/en/overridesPages/phonefactor/$value ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/delete-userflowlanguagepage-beta-e1-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [Python](#tab/python) + ### Response |
v1.0 | Userflowlanguagepage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/userflowlanguagepage-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguagepage_get" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguagepage-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Userflowlanguagepage Put | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/userflowlanguagepage-put.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguagepage_put" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguagepage-put-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Usersettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/usersettings-get.md | description: "Read the user and organization settings object." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Usersettings List Windows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/usersettings-list-windows.md | Namespace: microsoft.graph Get a list of [windowsSetting](../resources/windowssetting.md) objects and their properties for the signed in 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). GET https://graph.microsoft.com/beta/me/settings/windows [!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting1-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-windowssetting1-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/beta/me/settings/windows?$filter=settingType eq [!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting2-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-windowssetting2-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/beta/me/settings/windows?$filter=settingType eq [!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting3-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-windowssetting3-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/beta/me/settings/windows?$filter=windowsDeviceId [!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting4-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-windowssetting4-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Usersettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/usersettings-update.md | description: "Update the properties of the settings object. " ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Usertrainingcampaigndetails List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/usertrainingcampaigndetails-list.md | + + Title: "List campaign users" +description: "List users of a tenant and their online actions in a training campaign." ++ms.localizationpriority: medium +++# List trainingCampaignUsers +Namespace: microsoft.graph +++List users of a tenant and their online actions in a training campaign. ++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "usertrainingcampaigndetails_list" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/report/campaignUsers +``` ++## Optional query parameters ++This method supports the `$count`, `$skipToken`, and `$top` [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. ++The following list shows some examples of requests that use the supported OData query parameters: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/report/campaignUsers?$count=true +GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/report/campaignUsers?$skipToken={skipToken} +GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/report/campaignUsers?$top=1 +``` ++## 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 [userSimulationDetails](../resources/usersimulationdetails.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_campaignusersdetails" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/report/campaignUsers +``` ++# [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.userSimulationDetails)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "isCompromised": true, + "compromisedDateTime": "2021-01-01T01:02:01.01Z", + "simulationEvents": [ + { + "eventName": "SuccessfullyDeliveredEmail", + "eventDateTime": "2021-01-01T01:01:01.01Z", + "ipAddress": "100.200.100.200", + "osPlatformDeviceDetails": "Sample OS", + "browser": "Sample Browser" + }, + { + "eventName": "EmailLinkClicked", + "eventDateTime": "2021-01-01T01:02:01.01Z", + "ipAddress": "100.200.100.200", + "osPlatformDeviceDetails": "Sample OS", + "browser": "Sample Browser" + } + ], + "trainingEvents": [ + { + "displayName": "Sample Training", + "latestTrainingStatus": "assigned", + "trainingAssignedProperties": { + "contentDateTime": "2021-01-01T01:03:01.01Z", + "ipAddress": "100.200.100.200", + "osPlatformDeviceDetails": "Sample OS", + "browser": "Sample Browser", + "potentialScoreImpact": 5.0 + }, + "trainingUpdatedProperties": { + "contentDateTime": "2021-01-01T01:04:01.01Z", + "ipAddress": "100.200.100.201", + "osPlatformDeviceDetails": "Sample OS-2", + "browser": "Sample Browser", + "potentialScoreImpact": 5.0 + }, + "trainingCompletedProperties": { + "contentDateTime": "2021-01-01T01:05:01.01Z", + "ipAddress": "100.200.100.202", + "osPlatformDeviceDetails": "Sample OS", + "browser": "Sample Browser-2", + "potentialScoreImpact": 5.0 + } + } + ], + "assignedTrainingsCount": 1, + "completedTrainingsCount": 0, + "inProgressTrainingsCount": 0, + "reportedPhishDateTime": "2021-01-01T01:01:01.01Z", + "simulationUser": { + "userId": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + } + } + ] +} +``` + |
v1.0 | Verticalsection Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/verticalsection-delete.md | DELETE /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/ve ## Request body -Do not supply a request body with this method. +Don't supply a request body with this method. ## Response If successful, this call returns a `204 No Content`. It doesn't return anything in the response body. -If the vertical section is not found, this method returns `404 Not Found`. +If the vertical section isn't found, this method returns `404 Not Found`. ## Example If the vertical section is not found, this method returns `404 Not Found`. <!-- { "blockType": "ignored" } --> ```http-DELETE https://graph.microsoft.com/beta/sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection +DELETE https://graph.microsoft.com/beta/sites/a69edae4-9208-4f60-9aa3-cd0911ff0ce1/pages/7f7a2740-2d74-47ba-af0c-71ed3a3384ca/microsoft.graph.sitePage/canvasLayout/verticalSection ``` ### Response |
v1.0 | Verticalsection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/verticalsection-get.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/verticalSection +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/verticalSection ``` #### Response Content-Type: application/json ### Example 2: Get a verticalSection object using select and expand #### Request -With `select` and `expand` statements, you can retrieve verticalSection metadata and associated webParts in a single request. +With `$select` and `$expand` statements, you can retrieve verticalSection metadata and associated webParts in a single request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/verticalSection?select=emphasis,expand=webparts +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/verticalSection?$select=emphasis&$expand=webparts ``` #### Response |
v1.0 | Verticalsection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/verticalsection-update.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-PATCH https://graph.microsoft.com/beta/sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection +PATCH https://graph.microsoft.com/beta/sites/a69edae4-9208-4f60-9aa3-cd0911ff0ce1/pages/7f7a2740-2d74-47ba-af0c-71ed3a3384ca/microsoft.graph.sitePage/canvasLayout/verticalSection Content-Type: application/json { |
v1.0 | Virtualendpoint List Auditevents | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-list-auditevents.md | Content-Type: application/json { "@odata.type": "#microsoft.graph.cloudPcAuditEvent", "id": "250473f5-029f-4037-813d-ba4768201d61",- "displayName": "Display Name value", - "componentName": "Component Name value",  - "activity": "Activity value",  - "activityDateTime": "2021-02-14T13:10:51.814636+08:00",  - "activityType": " Activity Type value",  - "activityOperationType": "Activity Operation Type value",  - "activityResult": "Activity Result value",  - "correlationId": "a5c71cc6-2271-4d5c-9bfe-d94781e83fe6",  - "category": "Category value", + "displayName": "Delete OnPremisesConnection", + "componentName": "CloudPcOnPremisesConnectionsController", + "activity": null, + "activityDateTime": "2021-02-14T13:10:51.814636+08:00", + "activityType": "Delete CloudPcOnPremisesConnection", + "activityOperationType": "Delete", + "activityResult": "Success", + "correlationId": "a5c71cc6-2271-4d5c-9bfe-d94781e83fe6", + "category": "Cloud PC", "actor": {- "@odata.type": "microsoft.graph.cloudPcAuditActor", - "type": "Type value", - "userPermissions": [ - "User Permissions value" - ], - "applicationId": "Application Id value", - "applicationDisplayName": "Application Display Name value", - "userPrincipalName": "User Principal Name value", - "servicePrincipalName": "Service Principal Name value", - "ipAddress": "Ip Address value", - "userId": "User Id value", - "userRoleScopeTags": [ - { - "@odata.type": "microsoft.graph.cloudPcUserRoleScopeTagInfo", - "displayName": "Display Name value", - "roleScopeTagId": "Role Scope Tag Id value" - } - ], - "remoteTenantId": "Remote Tenant Id value", - "remoteUserId": "Remote User Id value" + "@odata.type": "microsoft.graph.cloudPcAuditActor", + "type": "application", + "userPermissions": [], + "applicationId": "69cc3193-b6c4-4172-98e5-ed0f38ab3ff8", + "applicationDisplayName": "Cloud PC Ibiza", + "userPrincipalName": null, + "servicePrincipalName": null, + "ipAddress": null, + "userId": "ccaf0214-2d5c-4c72-b23f-191ff2c87313", + "userRoleScopeTags": [ + { + "@odata.type": "microsoft.graph.cloudPcUserRoleScopeTagInfo", + "displayName": "Europe", + "roleScopeTagId": "8ad48104-cb5c-497c-b144-6fc9927354ab" + } + ], + "remoteTenantId": "33c73c76-bf5d-45ba-ab4f-ee49c9a9be76", + "remoteUserId": "ccaf0214-2d5c-4c72-b23f-191ff2c87313" }, "resources": [ { "@odata.type": "microsoft.graph.cloudPcAuditResource",- "displayName": "Display Name value", + "displayName": "ecmadao-test-azureconnection-1", "modifiedProperties": [ { "@odata.type": "microsoft.graph.cloudPcAuditProperty",- "displayName": "Display Name value", - "oldValue": "Old Value value", - "newValue": "New Value value" + "displayName": "AdDomainUsername", + "oldValue": "12312", + "newValue": "new-adDomainUsername" } ],- "type": "Type value", - "resourceId": "Resource Id value" + "type": "CloudPcOnPremisesConnection", + "resourceType": "CloudPcOnPremisesConnection", + "resourceId": "a7508af8-d334-41ba-83a7-26cc88959724" }- ], + ] } ] } |
v1.0 | Virtualendpoint List Bulkactions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-list-bulkactions.md | + + Title: "List bulkActions" +description: "Get a list of the cloudPcBulkAction objects and their properties." ++ms.localizationpriority: medium ++++# List bulkActions +Namespace: microsoft.graph +++Get a list of the [cloudPcBulkAction](../resources/cloudpcbulkaction.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_bulkactions" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/virtualEndpoint/bulkActions +``` ++## Optional query parameters +This method supports the `$select`, `$filter`, `$orderby`, `$top` 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 collection of [cloudPcBulkAction](../resources/cloudpcbulkaction.md) objects in the response body. ++## Examples ++### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_cloudpcbulkaction" +} +--> +``` http +GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/bulkActions +``` ++# [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.cloudPcBulkAction)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "value": { + "@odata.type": "#microsoft.graph.cloudPcBulkAction", + "id": "231ad98f-41b3-872b-dd37-c70bf22cbdac", + "displayName": "Bulk Power Off by Andy", + "cloudPcIds": [ + "d6e0b8ee-8836-4b8d-b038-6130a97a3a9d", + "85994912-197b-4927-b569-447bd81350ec" + ], + "actionSummary": { + "failedCount": 1, + "inProgressCount": 0, + "notSupportedCount": 0, + "pendingCount": 1, + "successfulCount": 0 + }, + "scheduledDuringMaintenanceWindow": true, + "createdDateTime": "2024-02-05T10:29:57Z" + } + } + ] +} +``` |
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 "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy", "description": "Description value", "displayName": "Display Name value",- "domainJoinConfiguration": { - "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff", - "type": "hybridAzureADJoin" - }, "domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff", Content-Type: application/json ], "enableSingleSignOn": true, "id": "1d164206-bf41-4fd2-8424-a3192d39ffff",- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff", "imageDisplayName": "Image Display Name value", "imageId": "Image ID value", "imageType":"custom",- "windowsSettings": { - "language": "en-US" - }, "windowsSetting": { "locale": "en-US" }, |
v1.0 | Virtualendpoint Post Bulkactions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-post-bulkactions.md | + + Title: "Create cloudPcBulkAction" +description: "Create a new cloudPcBulkAction object." ++ms.localizationpriority: medium ++++# Create cloudPcBulkAction +Namespace: microsoft.graph +++Create a new [cloudPcBulkAction](../resources/cloudpcbulkaction.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": "virtualendpoint_post_bulkactions" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/virtualEndpoint/bulkActions +``` ++## 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 [cloudPcBulkAction](../resources/cloudpcbulkaction.md) object. ++You can specify the following properties when you create a **cloudPcBulkAction**. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Name of this bulk action. Required.| +|cloudPcIds|String collection|IDs of the Cloud PCs the bulk action applies to. Required.| +|scheduledDuringMaintenanceWindow|Boolean|Indicates whether the bulk actions can be initiated during maintenance window. When `true`, bulk action will use maintenance window to schedule action, When `false` means bulk action will not use the maintenance window. Default value is `false`.| ++## Response ++If successful, this method returns a `201 Created` response code and a [cloudPcBulkAction](../resources/cloudpcbulkaction.md) object in the response body. ++## Examples ++### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_cloudpcbulkaction_from_" +} +--> +``` http +POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/bulkActions +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.cloudPcBulkAction", + "displayName": "Bulk Power Off by Andy", + "cloudPcIds": [ + "d6e0b8ee-8836-4b8d-b038-6130a97a3a9d", + "85994912-197b-4927-b569-447bd81350ec" + ], + "scheduledDuringMaintenanceWindow": 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. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.cloudPcBulkAction" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.cloudPcBulkAction", + "id": "231ad98f-41b3-872b-dd37-c70bf22cbdac", + "displayName": "Bulk Power Off by Andy", + "cloudPcIds": [ + "d6e0b8ee-8836-4b8d-b038-6130a97a3a9d", + "85994912-197b-4927-b569-447bd81350ec" + ], + "actionSummary": { + "failedCount": 0, + "inProgressCount": 0, + "notSupportedCount": 0, + "pendingCount": 2, + "successfulCount": 0 + }, + "scheduledDuringMaintenanceWindow": true, + "createdDateTime": "2024-02-05T10:29:57Z" +} +``` |
v1.0 | Virtualendpoint Post Provisioningpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-post-provisioningpolicies.md | The following table lists the properties that are required when you create the [ |imageDisplayName|String|The display name for the OS image youΓÇÖre provisioning.| |imageId|String|The ID of the operating system image you want to provision on Cloud PCs. The format for a gallery type image is: {publisher_offer_sku}. Supported values for each of the parameters are as follows:<ul><li>publisher: `Microsoftwindowsdesktop`.</li> <li>offer: `windows-ent-cpc`.</li> <li>sku: `21h1-ent-cpc-m365`, `21h1-ent-cpc-os`, `20h2-ent-cpc-m365`, `20h2-ent-cpc-os`, `20h1-ent-cpc-m365`, `20h1-ent-cpc-os`, `19h2-ent-cpc-m365` and `19h2-ent-cpc-os`.</li></ul>| |imageType|cloudPcProvisioningPolicyImageType|The type of OS image (custom or gallery) you want to provision on Cloud PCs. Possible values are: `gallery`, `custom`.|-|provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|Specifies the type of license used when provisioning Cloud PCs using this policy. By default, the license type is `dedicated` if the **provisioningType** isn't specified when you create the **cloudPcProvisioningPolicy**. You can't change this property after the **cloudPcProvisioningPolicy** was created. Possible values are: `dedicated`, `shared`, `unknownFutureValue`.| +|provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|Specifies the type of license used when provisioning Cloud PCs using this policy. By default, the license type is `dedicated` if the **provisioningType** isn't specified when you create the **cloudPcProvisioningPolicy**. You can't change this property after the **cloudPcProvisioningPolicy** was created. Possible values are: `dedicated`, `shared`, `unknownFutureValue`, `sharedByUser`, `sharedByEntraGroup`. 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): `sharedByUser`, `sharedByEntraGroup`. The `shared` member is deprecated and will stop returning on April 30, 2027; going forward, use the `sharedByUser` member. | |windowsSetting|[cloudPcWindowsSettings](../resources/cloudpcwindowssetting.md)|Indicates a specific Windows setting to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. |-|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID.| -|onPremisesConnectionId (deprecated)|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service.| +|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID. The **domainJoinConfiguration** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.| +|onPremisesConnectionId (deprecated)|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network that the Cloud PC service validated it. The **onPremisesConnectionId** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.| |windowsSettings (deprecated)|[cloudPcWindowsSettings](../resources/cloudpcwindowssettings.md)|Specific Windows settings to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. The **windowsSettings** property is deprecated and will stop returning data on January 31, 2024. Going forward, use the **windowsSetting** property.| ## Response |
v1.0 | Virtualevent List Presenters | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualevent-list-presenters.md | + + Title: "List presenters" +description: "Get the list of all virtualEventPresenter objects of a virtual event." ++ms.localizationpriority: medium ++++# List presenters ++Namespace: microsoft.graph +++Get the list of all [virtualEventPresenter](../resources/virtualeventpresenter.md) objects associated with a virtual event. ++Currently the supported virtual event types are: [virtualEventTownhall](../resources/virtualeventtownhall.md), [virtualEventWebinar](../resources/virtualeventwebinar.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). ++<!-- { + "blockType": "permissions", + "name": "virtualevent-list-presenters-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +GET /solutions/virtualEvents/townhalls/{townhallId}/presenters +GET /solutions/virtualEvents/webinars/{webinarId}/presenters +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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 [virtualEventPresenter](../resources/virtualeventpresenter.md) objects in the response body. ++## Examples ++### Request ++The following example shows how to list all presenters of a **virtualEventTownhall**. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_virtualeventpresenter", + "sampleKeys": ["88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33/presenters +``` ++# [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.virtualEventPresenter)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "id": "831affc2-4c8a-9929-50e7-02964563b6e4", + "identity": { + "displayName": "Diane Demoss", + "id": "831affc2-4c8a-9929-50e7-02964563b6e4", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + }, + "email": "DianeDemoss@contoso.com", + "presenterDetails": null + }, + { + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "identity": { + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "displayName": "Kenneth Brown", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + }, + "email": "KennethBrown@contoso.com", + "presenterDetails": null + } + ] +} +``` |
v1.0 | Virtualevent List Sessions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualevent-list-sessions.md | Namespace: microsoft.graph Get a list of all [virtualEventSession](../resources/virtualeventsession.md) objects under a virtual event. +Currently, the following virtual event types are supported: [virtualEventTownhall](../resources/virtualeventtownhall.md) and [virtualEventWebinar](../resources/virtualeventwebinar.md). + [!INCLUDE [national-cloud-support](../../includes/global-only.md)] ## Permissions Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/virtualeventsession-list-permissions.md)] > [!NOTE]-> > To use application permissions for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and assign it to a user. This allows the authorized application to access registrants' information from virtual events created by that specific user. ## HTTP request Choose the permission or permissions marked as least privileged for this API. Us "blockType": "ignored" } -->+ To list all sessions of a webinar: ``` http GET /solutions/virtualEvents/webinars/{webinarId}/sessions ``` +To list all sessions of a town hall: ++``` http +GET /solutions/virtualEvents/townhalls/{townhallId}/sessions +``` + ## Optional query parameters This method doesn't support the OData query parameters. For general information, see [OData query parameters](/graph/query-parameters). |
v1.0 | Virtualevent Post Presenters | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualevent-post-presenters.md | + + Title: "Create virtualEventPresenter" +description: "Create a new virtualEventPresenter object to a virtual event." ++ms.localizationpriority: medium ++++# Create virtualEventPresenter ++Namespace: microsoft.graph +++Create a new [virtualEventPresenter](../resources/virtualeventpresenter.md) object on a virtual event. ++Currently the supported virtual event types are: [virtualEventTownhall](../resources/virtualeventtownhall.md), [virtualEventWebinar](../resources/virtualeventwebinar.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). ++<!-- { + "blockType": "permissions", + "name": "virtualevent-post-presenters-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +POST /solutions/virtualEvents/townhalls/{townhallId}/presenters +POST /solutions/virtualEvents/webinars/{webinarId}/presenters +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body ++In the request body, supply a JSON representation of the [virtualEventPresenter](../resources/virtualeventpresenter.md) object. ++You can specify the following properties when you create a presenter on a **virtualEventTownhall**: ++|Property|Type|Description| +|:|:|:| +|identity|[identity](../resources/identity.md)|Identity information of the presenter. The supported identities are: [communicationsGuestIdentity](../resources/communicationsguestidentity.md) and [communicationsUserIdentity](../resources/communicationsuseridentity.md). | ++You can specify the following properties when you create a presenter on a **virtualEventWebinar**: ++|Property|Type|Description| +|:|:|:| +|identity|[identity](../resources/identity.md)|Identity information of the presenter. The supported identities are: [communicationsGuestIdentity](../resources/communicationsguestidentity.md) and [communicationsUserIdentity](../resources/communicationsuseridentity.md). | +|presenterDetails|[virtualEventPresenterDetails](../resources/virtualeventpresenterdetails.md)|Other detail information of the presenter.| ++## Response ++If successful, this method returns a `201 Created` response code and a [virtualEventPresenter](../resources/virtualeventpresenter.md) object in the response body. ++## Examples ++### Example 1: Create an in-tenant presenter ++The following example shows how to create an internal user as a presenter on a **virtualEventTownhall**. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_virtualeventpresenter_internal_", + "sampleKeys": ["502dadea-b5d8-44aa-a851-a0ac496a36bf@09a21d49-f0f3-4b3f-96b6-f381e9430742"] +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/502dadea-b5d8-44aa-a851-a0ac496a36bf@09a21d49-f0f3-4b3f-96b6-f381e9430742/presenters +Content-Type: application/json ++{ + "identity": { + "@odata.type": "#microsoft.graph.communicationsUserIdentity", + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b" + } +} +``` ++# [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.virtualEventPresenter" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "email": "kenneth.brown@contoso.com", + "identity": { + "@odata.type": "#microsoft.graph.communicationsUserIdentity", + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "displayName": "Kennth Brown", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + }, + "presenterDetails": null +} +``` ++### Example 2: Create an out-of-tenant presenter ++The following example shows how to create a guest user as a presenter on a **virtualEventTownhall**. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_virtualeventpresenter_external", + "sampleKeys": ["502dadea-b5d8-44aa-a851-a0ac496a36bf@09a21d49-f0f3-4b3f-96b6-f381e9430742"] +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/502dadea-b5d8-44aa-a851-a0ac496a36bf@09a21d49-f0f3-4b3f-96b6-f381e9430742/presenters +Content-Type: application/json ++{ + "identity": { + "@odata.type": "#microsoft.graph.communicationsGuestIdentity", + "displayName": "Guest Speaker", + "email": "guest.speaker@fabrikam.com" + } +} +``` ++# [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.virtualEventPresenter" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "id": "184975c0-4096-4a02-b251-c48546691c42", + "email": "guest.speaker@fabrikam.com", + "presenterDetails": null, + "identity": { + "@odata.type": "#microsoft.graph.communicationsGuestIdentity", + "id": "184975c0-4096-4a02-b251-c48546691c42", + "displayName": "Guest Speaker", + "email": "guest.speaker@fabrikam.com" + } +} +``` |
v1.0 | Virtualeventpresenter Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventpresenter-delete.md | + + Title: "Delete virtualEventPresenter" +description: "Delete a virtualEventPresenter object." ++ms.localizationpriority: medium ++++# Delete virtualEventPresenter ++Namespace: microsoft.graph +++Delete a [virtualEventPresenter](../resources/virtualeventpresenter.md) from a virtual event. ++Currently the supported virtual event types are: [virtualEventTownhall](../resources/virtualeventtownhall.md), [virtualEventWebinar](../resources/virtualeventwebinar.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). ++<!-- { + "blockType": "permissions", + "name": "virtualeventpresenter-delete-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +DELETE /solutions/virtualEvents/townhalls/{townhallId}/presenters/{presenterId} +DELETE /solutions/virtualEvents/webinars/{webinarId}/presenters/{presenterId} +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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 how to delete a presenter from a **virtualEventTownhall**. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_presenters_from_virtualeventtownhall", + "sampleKeys": ["502dadea-b5d8-44aa-a851-a0ac496a36bf@09a21d49-f0f3-4b3f-96b6-f381e9430742", "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b"] +} +--> +``` http +DELETE https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/502dadea-b5d8-44aa-a851-a0ac496a36bf@09a21d49-f0f3-4b3f-96b6-f381e9430742/presenters/7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b +``` ++# [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 | Virtualeventpresenter Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventpresenter-get.md | + + Title: "Get virtualEventPresenter" +description: "Read the properties and relationships of a virtualEventPresenter object." ++ms.localizationpriority: medium ++++# Get virtualEventPresenter +Namespace: microsoft.graph +++Read the properties and relationships of a [virtualEventPresenter](../resources/virtualeventpresenter.md) object. ++Currently the supported virtual event types are: [virtualEventTownhall](../resources/virtualeventtownhall.md), [virtualEventWebinar](../resources/virtualeventwebinar.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": "virtualeventsession_get" } --> ++> [!NOTE] +> +> To use application permissions for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and assign it to a user. This allows the authorized application to access registrants' information from virtual events created by that specific user. ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +GET /solutions/virtualEvents/townhalls/{townhallId}/presenters/{presenterId} +GET /solutions/virtualEvents/webinars/{webinarId}/presenters/{presenterId} +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [virtualEventPresenter](../resources/virtualeventpresenter.md) object in the response body. ++## Examples ++### Request ++The following example shows how to get a presenter on a **virtualEventTownhall**. ++<!-- { + "blockType": "request", + "name": "get_virtualeventpresenter", + "sampleKeys": ["88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33", "831affc2-4c8a-9929-50e7-02964563b6e4"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33/presenters/831affc2-4c8a-9929-50e7-02964563b6e4 +``` ++### 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.virtualEventPresenter" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.virtualEventPresenter", + "id": "831affc2-4c8a-9929-50e7-02964563b6e4", + "identity": { + "@odata.type": "microsoft.graph.communicationsUserIdentity", + "displayName": "Diane Demoss", + "id": "831affc2-4c8a-9929-50e7-02964563b6e4", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + }, + "email": "DianeDemoss@contoso.com" + } +} +``` |
v1.0 | Virtualeventpresenter Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventpresenter-update.md | + + Title: "Update virtualEventPresenter" +description: "Update the properties of a virtualEventPresenter object." ++ms.localizationpriority: medium ++++# Update virtualEventPresenter ++Namespace: microsoft.graph +++Update the properties of a [virtualEventPresenter](../resources/virtualeventpresenter.md) object. ++Currently the supported virtual event type is [virtualEventWebinar](../resources/virtualeventwebinar.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). ++<!-- { "blockType": "permissions", "name": "virtualeventpresenter-update-permissions" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /solutions/virtualEvents/webinars/{webinarId}/presenters/{presenterId} +``` ++## 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| +|:|:|:| +| presenterDetails|[virtualEventPresenterDetails](../resources/virtualeventpresenterdetails.md) | Other detail information of the presenter. | ++## Response ++If successful, this method returns a `200 OK` response code and an updated [virtualEventPresenter](../resources/virtualeventpresenter.md) object in the response body. ++## Examples ++### Request ++The following example shows how to update a presenter on a **virtualEventWebinar**. +<!-- { + "blockType": "request", + "name": "update_virtualeventpresenter", + "sampleKeys": ["88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33", "831affc2-4c8a-9929-50e7-02964563b6e4"] +} +--> +``` http +PATCH https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33/presenters/831affc2-4c8a-9929-50e7-02964563b6e4 +Content-Type: application/json ++{ + "presenterDetails": { + "bio": { + "content": "Lead Product Manager of Contoso Sales department", + "contentType": "text" + }, + "company": "Contoso", + "jobTitle": "Product Manager", + "linkedInProfileWebUrl": "https://linkedin.com/in/DianeDemoss", + "personalSiteWebUrl": "https://DianeDemoss.com" + } +} +``` ++### 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.virtualEventPresenter" +} +--> +``` http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.virtualEventPresenter", + "id": "831affc2-4c8a-9929-50e7-02964563b6e4", + "identity": { + "@odata.type": "microsoft.graph.communicationsUserIdentity", + "displayName": "Diane Demoss", + "id": "831affc2-4c8a-9929-50e7-02964563b6e4", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + }, + "email": "DianeDemoss@contoso.com", + "presenterDetails": { + "company": "Contoso", + "jobTitle": "Product Manager", + "personalSiteWebUrl": "https://DianeDemoss.com", + "linkedInProfileWebUrl": "https://linkedin.com/in/DianeDemoss", + "twitterProfileWebUrl": null, + "bio": { + "content": "Lead Product Manager of Contoso Sales department", + "contentType": "text" + } + } +} +``` |
v1.0 | Virtualeventsession Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventsession-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Read the properties and relationships of a [virtualEventSession](../resources/virtualeventsession.md) object. +Read the properties and relationships of a [virtualEventSession](../resources/virtualeventsession.md) object. ++Currently, the following virtual event types are supported: [virtualEventTownhall](../resources/virtualeventtownhall.md) and [virtualEventWebinar](../resources/virtualeventwebinar.md). [!INCLUDE [national-cloud-support](../../includes/global-only.md)] Choose the permission or permissions marked as least privileged for this API. Us ## HTTP request +++To get a session of a webinar: + <!-- { "blockType": "ignored" } -->-To get a session of a webinar: - ``` http GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId} ``` +To get a session of a town hall: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/virtualEvents/townhalls/{townhallId}/sessions/{sessionId} +``` + ## Optional query parameters -This method does not support the OData query parameters. For general information, see [OData query parameters](/graph/query-parameters). +This method doesn't support the OData query parameters. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers |
v1.0 | Virtualeventsroot Post Townhalls | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventsroot-post-townhalls.md | + + Title: "Create virtualEventTownhall" +description: "Create a new virtualEventTownhall object in draft mode." ++ms.localizationpriority: medium ++++# Create virtualEventTownhall ++Namespace: microsoft.graph +++Create a new [virtualEventTownhall](../resources/virtualeventtownhall.md) object in draft mode. ++## Permissions ++One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++<!-- { + "blockType": "permissions", + "name": "virtualeventsroot-post-virtualevents-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/virtualEvents/townhalls +``` ++## 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 supported derived types of [virtualEventTownhall](../resources/virtualeventtownhall.md) object. ++You can specify the following properties when you create a [virtualEventTownhall](../resources/virtualeventtownhall.md). ++|Property|Type|Description| +|:|:|:| +| audience | [meetingAudience](../resources/virtualeventtownhall.md#meetingaudience-values) | The audience to whom the town hall is visible. | +| coOrganizers | [communicationsUserIdentity](../resources/communicationsuseridentity.md) collection | The identity information of coorganizers of the town hall. | +| description | [itemBody](../resources/itembody.md) | A description of the town hall. | +| displayName | String | Display name of the town hall. | +| 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`. | +| startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | The date and time when the town hall starts. | ++## Response ++If successful, this method returns a `201 Created` response code and a [virtualEventTownhall](../resources/virtualeventtownhall.md) object in the response body. ++## Examples ++### Request +The following example shows a request. +<!-- { + "blockType": "request", + "name": "create_virtualeventtownhall" +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls +Content-Type: application/json ++{     + "displayName": "The Impact of Tech on Our Lives", + "description": "Discusses how technology has changed the way we communicate.", + "startDateTime": { + "dateTime": "2023-03-30T10:00:00", + "timeZone": "Pacific Standard Time" + }, + "endDateTime": { + "dateTime": "2023-03-30T17:00:00", + "timeZone": "Pacific Standard Time" + }, + "audience": "organization", + "coOrganizers": [ + { + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + ] +} +``` ++### 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.virtualEventTownhall" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{  + "id": "bce9a3ca-a310-48fa-baf3-1cedcd04bb3f@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba", + "status": "draft", + "displayName": "The Impact of Tech on Our Lives", + "description": "Discusses how technology has changed the way we communicate.", + "startDateTime": { + "dateTime": "2023-03-30T10:00:00", + "timeZone": "Pacific Standard Time" + }, + "endDateTime": { + "dateTime": "2023-03-30T17:00:00", + "timeZone": "Pacific Standard Time" + }, + "audience": "organization", + "createdBy": { + "application": null, + "device": null, + "user": { + "id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68", + "displayName": "Diane Demoss", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + }, + "coOrganizers": [ + { + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "displayName": "Kenneth Brown", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + ], + "invitedAttendees": [], + "isInviteOnly": false +} +``` |
v1.0 | Virtualeventsroot Post Webinars | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventsroot-post-webinars.md | + + Title: "Create virtualEventWebinar" +description: "Create a new virtualEventWebinar object in draft mode." ++ms.localizationpriority: medium ++++# Create virtualEventWebinar ++Namespace: microsoft.graph +++Create a new [virtualEventWebinar](../resources/virtualeventwebinar.md) object in draft mode. ++## Permissions ++One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++<!-- { + "blockType": "permissions", + "name": "virtualeventsroot-post-virtualevents-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/virtualEvents/webinars +``` ++## 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 supported derived types of [virtualEventWebinar](../resources/virtualeventwebinar.md) object. ++You can specify the following properties when you create a [virtualEventWebinar](../resources/virtualeventwebinar.md). ++|Property|Type|Description| +|:|:|:| +| audience | [meetingAudience](../resources/virtualeventwebinar.md#meetingaudience-values) | The audience to whom the webinar is visible. | +| coOrganizers | [communicationsUserIdentity](../resources/communicationsuseridentity.md) collection | The identity information of coorganizers of the webinar. | +| 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. | +| startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | The date and time when the webinar starts. | ++## Response ++If successful, this method returns a `201 Created` response code and a [virtualEventWebinar](../resources/virtualeventwebinar.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "create_virtualeventwebinar" +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/virtualEvents/webinars +Content-Type: application/json ++{     + "displayName": "The Impact of Tech on Our Lives", + "description": "Discusses how technology has changed the way we communicate.", + "startDateTime": { + "dateTime": "2024-03-30T10:00:00", + "timeZone": "Pacific Standard Time" + }, + "endDateTime": { + "dateTime": "2024-03-30T17:00:00", + "timeZone": "Pacific Standard Time" + }, + "audience": "organization", + "coOrganizers": [ + { + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + ] +} +``` ++### 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.virtualEventWebinar" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{  + "id": "a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba", + "status": "draft", + "displayName": "The Impact of Tech on Our Lives", + "description": "Discusses how technology has changed the way we communicate.", + "startDateTime": { + "dateTime": "2024-03-30T10:00:00", + "timeZone": "Pacific Standard Time" + }, + "endDateTime": { + "dateTime": "2024-03-30T17:00:00", + "timeZone": "Pacific Standard Time" + }, + "audience": "organization", + "createdBy": { + "application": null, + "device": null, + "user": { + "id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68", + "displayName": "Diane Demoss", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + }, + "coOrganizers": [ + { + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "displayName": "Kenneth Brown", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + ] +} +``` |
v1.0 | Virtualeventtownhall Cancel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventtownhall-cancel.md | + + Title: "virtualEventTownhall: cancel" +description: "Cancel a virtual event town hall." ++ms.localizationpriority: medium ++++# virtualEventTownhall: cancel +Namespace: microsoft.graph +++Cancel a [virtualEventTownhall](../resources/virtualeventtownhall.md). A canceled town hall has its **status** set to `canceled` permanently. You can still get a canceled town hall by using the [Get virtualEventTownhall](../api/virtualeventtownhall-get.md) API. ++## Permissions ++One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++<!-- { + "blockType": "permissions", + "name": "virtualevent-cancel-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/virtualEvents/townhalls/{id}/cancel +``` ++## 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": "virtualeventtownhall.cancel", + "sampleKeys": ["bce9a3ca-a310-48fa-baf3-1cedcd04bb3f@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba"] +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/bce9a3ca-a310-48fa-baf3-1cedcd04bb3f@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba/cancel +``` ++# [JavaScript](#tab/javascript) ++++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Virtualeventtownhall Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventtownhall-get.md | + + Title: "Get virtualEventTownhall" +description: "Read the properties and relationships of a virtualEventTownhall object." ++ms.localizationpriority: medium ++++# Get virtualEventTownhall ++Namespace: microsoft.graph +++Read the properties and relationships of a [virtualEventTownhall](../resources/virtualeventtownhall.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": "virtualeventwebinar_get" } --> ++> [!NOTE] +> +> To use application permissions with this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and assign it to a user. This allows the authorized application to access registrants' information from virtual events created by that specific user. ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/virtualEvents/townhalls/{id} +``` ++## Optional query parameters ++This method doesn't support the OData query parameters. 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 [virtualEventTownhall](../resources/virtualeventtownhall.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "get_virtualeventtownhall" +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/fc6e8c15-2fd7-1dd5-caa0-87056e6a12be +``` ++### 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.virtualEventTownhall" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.virtualEventTownhall", + "id": "fc6e8c15-2fd7-1dd5-caa0-87056e6a12be", + "status": "published", + "displayName": "The Impact of Tech on Our Lives", + "description": { + "content": "Discusses how technology has changed the way we communicate, work, and interact with each other.", + "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" + } + ], + "isInviteOnly": false +} +``` |
v1.0 | Virtualeventtownhall Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventtownhall-publish.md | + + Title: "virtualEventTownhall: publish" +description: "Publish a virtual event town hall to make it visible to its audience." ++ms.localizationpriority: medium ++++# virtualEventTownhall: publish +Namespace: microsoft.graph +++Publish a [virtualEventTownhall](../resources/virtualeventtownhall.md) to make it visible to its audience. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++<!-- { + "blockType": "permissions", + "name": "virtualevent-publish-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/virtualEvents/townhalls/{id}/publish +``` ++## 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", + "name": "virtualeventtownhall.publish", + "sampleKeys": ["bce9a3ca-a310-48fa-baf3-1cedcd04bb3f@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba"] +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/bce9a3ca-a310-48fa-baf3-1cedcd04bb3f@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba/publish +``` ++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Virtualeventtownhall Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventtownhall-update.md | + + Title: "Update virtualEventTownhall" +description: "Update the properties of a virtualEventTownhall object." ++ms.localizationpriority: medium ++++# Update virtualEventTownhall +Namespace: microsoft.graph +++Update the properties of a v[virtualEventTownhall](../resources/virtualeventtownhall.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). ++<!-- { + "blockType": "permissions", + "name": "virtualevent-update-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /solutions/virtualEvents/townhalls/{id} +``` ++## 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| +|:|:|:| +| coOrganizers | [communicationsUserIdentity](../resources/communicationsuseridentity.md) collection | Identity information of coorganizers of the virtual event. | +| 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. | +| 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). | +| startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Date and time when the virtual event starts. | ++## Response ++If successful, this method returns a `200 OK` response code and an updated [virtualEventTownhall](../resources/virtualeventtownhall.md) object in the response body. ++## Examples ++### Request +The following example shows a request. +<!-- { + "blockType": "request", + "name": "update_virtualeventtownhall" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/fc6e8c15-2fd7-1dd5-caa0-87056e6a12be +Content-Type: application/json ++{ + "startDateTime": { + "dateTime": "2024-03-31T10:00:00", + "timeZone": "Pacific Standard Time" + }, + "endDateTime": { + "dateTime": "2024-03-31T17:00:00", + "timeZone": "Pacific Standard Time" + } +} +``` ++### 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.virtualEventTownhall" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.virtualEventTownhall", + "id": "a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba", + "status": "draft", + "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": "2024-03-31T10:00:00", + "timeZone": "Pacific Standard Time" + }, + "endDateTime": { + "dateTime": "2024-03-31T17:00:00", + "timeZone": "Pacific Standard Time" + }, + "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": "organization", + "isInviteOnly": false, + "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" + } + ] +} +``` |
v1.0 | Virtualeventwebinar Cancel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventwebinar-cancel.md | + + Title: "virtualEventWebinar: cancel" +description: "Cancel a virtual event webinar." ++ms.localizationpriority: medium ++++# virtualEventWebinar: cancel +Namespace: microsoft.graph +++Cancel a [virtualEventWebinar](../resources/virtualeventwebinar.md). A canceled webinar has its **status** set to `canceled` permanently. You can still get a canceled webinar by using the [Get virtualEventWebinar](../api/virtualeventwebinar-get.md) API. ++## Permissions ++One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++<!-- { + "blockType": "permissions", + "name": "virtualevent-cancel-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/virtualEvents/webinars/{id}/cancel +``` ++## 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", + "name": "virtualeventwebinar.cancel", + "sampleKeys": ["a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba"] +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba/cancel +``` ++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Virtualeventwebinar Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventwebinar-get.md | Title: "Get virtualEventWebinar" description: "Read the properties and relationships of a virtualEventWebinar object."-+ ms.localizationpriority: medium doc_type: apiPageType Read the properties and relationships of a [virtualEventWebinar](../resources/vi Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "virtualeventwebinar_get" } --> > [!NOTE] >-> To use application permissions for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and assign it to a user. This allows the authorized application to access registrants' information from virtual events created by that specific user. +> To use application permissions with this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and assign it to a user. This allows the authorized application to access registrants' information from virtual events created by that specific user. ## HTTP request Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /solutions/virtualEvents/webinars/{webinarId} +GET /solutions/virtualEvents/webinars/{id} ``` ## Optional query parameters -This method does not support the OData query parameters. For general information, see [OData query parameters](/graph/query-parameters). +This method doesn't support the OData query parameters. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/{webinarId} +GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33 ``` # [C#](#tab/csharp) |
v1.0 | Virtualeventwebinar Getbyuseridandrole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventwebinar-getbyuseridandrole.md | Title: "virtualEventWebinar: getByUserIdAndRole" -description: "List all webinars where the specified user is either the organizer or a coorganizer." +description: "Get a list of virtualEventWebinar objects where the specified user is either the organizer or a coorganizer." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a [virtualEventWebinar](../resources/virtualeventwebinar.md) collection where the specified user is either the organizer or a coorganizer. +Get a list of [virtualEventWebinar](../resources/virtualeventwebinar.md) objects where the specified user is either the organizer or a coorganizer. ## Permissions Don't supply a request body for this method. ## Response -If successful, this function returns a `200 OK` response code and a [virtualEventWebinar](../resources/virtualeventwebinar.md) collection in the response body. +If successful, this function returns a `200 OK` response code and a collection of [virtualEventWebinar](../resources/virtualeventwebinar.md) objects in the response body. ## Examples |
v1.0 | Virtualeventwebinar Getbyuserrole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventwebinar-getbyuserrole.md | Title: "virtualEventWebinar: getByUserRole" -description: "List all webinars where the signed-in user is either the organizer a coorganizer." +description: "Get a list of virtualEventWebinar objects where the signed-in user is either the organizer a coorganizer." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a [virtualEventWebinar](../resources/virtualeventwebinar.md) collection where the signed-in user is either the organizer or a coorganizer. +Get a list of [virtualEventWebinar](../resources/virtualeventwebinar.md) objects where the signed-in user is either the organizer or a coorganizer. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] Don't supply a request body for this method. ## Response -If successful, this function returns a `200 OK` response code and a [virtualEventWebinar](../resources/virtualeventwebinar.md) collection in the response body. +If successful, this function returns a `200 OK` response code and a collection of [virtualEventWebinar](../resources/virtualeventwebinar.md) objects in the response body. ## Examples |
v1.0 | Virtualeventwebinar Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventwebinar-publish.md | + + Title: "virtualEventWebinar: publish" +description: "Publish a virtual event webinar to make it visible to its audience." ++ms.localizationpriority: medium ++++# virtualEventWebinar: publish +Namespace: microsoft.graph +++Publish a [virtualEventWebinar](../resources/virtualeventwebinar.md) to make it visible to its audience. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++<!-- { + "blockType": "permissions", + "name": "virtualevent-publish-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/virtualEvents/webinars/{id}/publish +``` ++## 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", + "name": "virtualeventwebinar.publish", + "sampleKeys": ["a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba"] +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba/publish +``` ++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Virtualeventwebinar Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventwebinar-update.md | + + Title: "Update virtualEventWebinar" +description: "Update the properties of a virtualEventWebinar object." ++ms.localizationpriority: medium ++++# Update virtualEventWebinar +Namespace: microsoft.graph +++Update the properties of a [virtualEventWebinar](../resources/virtualeventwebinar.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). ++<!-- { + "blockType": "permissions", + "name": "virtualevent-update-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /solutions/virtualEvents/webinars/{id} +``` ++## 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| +|:|:|:| +| coOrganizers | [communicationsUserIdentity](../resources/communicationsuseridentity.md) collection | Identity information of coorganizers of the virtual event. | +| 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. | +| startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Date and time when the virtual event starts. | ++## Response ++If successful, this method returns a `200 OK` response code and an updated [virtualEventWebinar](../resources/virtualeventwebinar.md) object in the response body. ++## Examples ++### Request +The following example shows a request. +<!-- { + "blockType": "request", + "name": "update_virtualeventwebinar" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba +Content-Type: application/json ++{ + "startDateTime": { + "dateTime": "2024-03-31T10:00:00", + "timeZone": "Pacific Standard Time" + }, + "endDateTime": { + "dateTime": "2024-03-31T17:00:00", + "timeZone": "Pacific Standard Time" + } +} +``` ++### 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.virtualEventWebinar" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.virtualEventWebinar", + "id": "bce9a3ca-a310-48fa-baf3-1cedcd04bb3f@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba", + "status": "draft", + "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": "2024-03-31T10:00:00", + "timeZone": "Pacific Standard Time" + }, + "endDateTime": { + "dateTime": "2024-03-31T17:00:00", + "timeZone": "Pacific Standard Time" + }, + "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": "organization", + "coOrganizers": [ + { + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "displayName": "Kenneth Brown", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + ] +} +``` |
v1.0 | Virtualeventwebinarregistrationconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventwebinarregistrationconfiguration-get.md | + + Title: "Get virtualEventWebinarRegistrationConfiguration" +description: "Read the properties and relationships of a virtualEventWebinarRegistrationConfiguration object." ++ms.localizationpriority: medium ++++# Get virtualEventWebinarRegistrationConfiguration ++Namespace: microsoft.graph +++Read the properties and relationships of a [virtualEventWebinarRegistrationConfiguration](../resources/virtualeventwebinarregistrationconfiguration.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": "virtualeventwebinarregistrationconfiguration-get" } --> ++> [!NOTE] +> +> To use application permissions for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and assign it to a user. This allows the authorized application to access registrants' information from virtual events created by that specific user. ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/virtualEvents/webinars/{webinarId}/registrationConfiguration +``` ++## 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 [virtualEventWebinarRegistrationConfiguration](../resources/virtualeventwebinarregistrationconfiguration.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_virtualeventwebinarregistrationconfiguration", + "sampleKeys": ["88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33/registrationConfiguration +``` ++# [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.virtualEventWebinarRegistrationConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "registrationWebUrl": "https://events.teams.microsoft.com/event/88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33" +} +``` |
v1.0 | Virtualmachinewithawsstoragebucketaccessfinding Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualmachinewithawsstoragebucketaccessfinding-get.md | description: "Read the properties and relationships of a virtualMachineWithAwsSt ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Virtualmachinewithawsstoragebucketaccessfinding List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualmachinewithawsstoragebucketaccessfinding-list.md | description: "Get a list of the virtualMachineWithAwsStorageBucketAccessFinding ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Webpart Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/webpart-delete.md | If successful, this method returns a `204 No Content`. It doesn't return anythin <!-- { "blockType": "request", "name": "delete-webpart", "scopes": "sites.readwrite.all" } --> ```http-DELETE https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/webParts/{webPartId} +DELETE https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/webParts/58ce69a6-bcb0-4f35-b6cd-d757d95f1a8e ``` # [C#](#tab/csharp) |
v1.0 | Webpart Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/webpart-get.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/webParts/{webPartId} +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/webParts/58ce69a6-bcb0-4f35-b6cd-d757d95f1a8e ``` #### Response Content-Type: application/json } ``` -### Example 2: Get a webPart object using select and expand +### Example 2: Get a webPart object using select #### Request -With `select` statement, you can retrieve selected webpart metadata in a request. +With `$select` statement, you can retrieve selected webpart metadata in a request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/webParts/{webPartId}?select=id +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/webParts/58ce69a6-bcb0-4f35-b6cd-d757d95f1a8e?$select=id ``` #### Response |
v1.0 | Webpart Getposition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/webpart-getposition.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/webParts/{webPartId}/getPositionOfWebPart +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/7f50f45e-714a-4264-9c59-3bf43ea4db8f/microsoft.graph.sitePage/webParts/58ce69a6-bcb0-4f35-b6cd-d757d95f1a8e/getPositionOfWebPart ``` ### Response |
v1.0 | Webpart List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/webpart-list.md | The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId}/columns/{horizontalSectionColumnId}/webparts +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1/columns/1/webparts ``` ### Response |
v1.0 | Webpart Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/webpart-update.md | The following example shows how to update a webpart. <!-- { "blockType": "ignored" } --> ```http-PATCH /sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/webParts/{webpartId} +PATCH /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/webParts/58ce69a6-bcb0-4f35-b6cd-d757d95f1a8e Content-Type: application/json { |
v1.0 | Windowssetting Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowssetting-get.md | Namespace: microsoft.graph Read the properties and relationships of a [windowsSetting](../resources/windowssetting.md) object by passing the ID of the setting in the URL. This method gets the setting for the signed-in 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). GET https://graph.microsoft.com/beta/me/settings/windows/{windowsSettingId} [!INCLUDE [sample-code](../includes/snippets/php/get-windowssetting-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-windowssetting-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Windowssetting List Instances | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowssetting-list-instances.md | Namespace: microsoft.graph Get a list of [windowsSettingInstance](../resources/windowssettinginstance.md) objects and their properties for the signed-in 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). GET https://graph.microsoft.com/beta/me/settings/windows/{windowsSettingId}/inst [!INCLUDE [sample-code](../includes/snippets/php/list-windowssettinginstance-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-windowssettinginstance-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Windowssettinginstance Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowssettinginstance-get.md | Namespace: microsoft.graph Read the properties and relationships of a [windowsSettingInstance](../resources/windowssettinginstance.md) object by passing the Windows setting ID and Windows setting instance ID in the URL. This method gets a **windowsSettingInstance** for the signed-in 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). GET https://graph.microsoft.com/beta/me/settings/windows/{windowsSettingId}/inst [!INCLUDE [sample-code](../includes/snippets/php/get-windowssettinginstance-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-windowssettinginstance-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Windowsupdates Product Findbycatalogid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-product-findbycatalogid.md | Title: "product: findByCatalogId" description: "Find the product revisions associated with a catalog ID and the known issues directly or indirectly related to the catalog ID." ms.localizationpriority: medium-+ doc_type: apiPageType Namespace: microsoft.graph.windowsUpdates Find the product revisions associated with a catalog ID and the known issues directly or indirectly related to the catalog 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). 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": "windowsupdates.FindByCatalogId" The following example shows a request. GET https://graph.microsoft.com/beta/admin/windows/updates/products/FindByCatalogId(catalogID='10cb1ba292c5586e22c9991be3f12fbd39f2ebf231cb5d201c67f42fbaccc567')?expand=revisions($expand=catalogEntry,knowledgeBaseArticle),knownIssues($expand=originatingKnowledgeBaseArticle,resolvingKnowledgeBaseArticle) ``` +# [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 | 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 Namespace: microsoft.graph.windowsUpdates Find the product revisions associated with a knowledge base number and the known issues directly or indirectly related to the knowledge base number. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 a collection of The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "windowsupdates.findByCatalogId" The following example shows a request. GET https://graph.microsoft.com/beta/admin/windows/updates/products/FindByKbNumber(kbNumber=5029332)?expand=revisions($expand=catalogEntry,knowledgeBaseArticle),knownIssues ``` +# [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 | 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 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": "windowsupdates.GetKnownIssuesByTimeRange", The following example shows a request. GET https://graph.microsoft.com/beta/admin/windows/updates/products/1/GetKnownIssuesByTimeRange(daysInPast=70,includeAllActive=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. |
v1.0 | Workplace List Sensordevices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workplace-list-sensordevices.md | + + Title: "List sensorDevices" +description: "Get a list of all workplace sensor devices created for a tenant." ++ms.localizationpriority: medium +++# List sensorDevices +Namespace: microsoft.graph +++Get a list of all workplace sensor devices created 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": "workplace_list_sensordevices" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /workplace/sensorDevices +``` ++## Optional query parameters +This method supports the `$filter`, `$top`, `$select`, and `$skipToken` [OData query parameters](/graph/query-parameters) to help customize the response. You can use `$filter` on the **deviceId**, **displayName**, **description**, **macAddress**, **manufacturer**, **ipV4Address**, **ipV6Address**, and **tags** properties. ++### Supported query patterns ++| Pattern | Syntax | Notes | +| - | -- | -- | +| Server-side pagination | `@odata.nextLink` | You get a continuation token in the response, when a result set spans multiple pages. | +| Filter | `/workplace/sensorDevices?$filter=Tags/Any(x: cast(x, 'String') eq 'Building A')` | Filter devices based on the tags. | +| Filter | `/workplace/sensorDevices?$filter=cast(manufacturer, 'String') eq 'Contoso'` | Filter devices based on the manufacturer of the device. | +| Filter | `/workplace/sensorDevices?$filter=cast(deviceId, 'String') eq 'contoso_9D6816'` | Filter devices based on the user provided device identifier.| +| Page limit | `/workplace/sensorDevices?$top=20` | Get devices with a page size of 20. The default page size is 10. | +++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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 [workplaceSensorDevice](../resources/workplacesensordevice.md) objects in the response body. ++## Examples ++### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_workplacesensordevice" +} +--> +``` http +GET https://graph.microsoft.com/beta/workplace/sensorDevices +``` ++# [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.workplaceSensorDevice)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#workplace/sensorDevices", + "@odata.nextLink": "https://graph.microsoft.com/betY3ZWEwYTYnKS9DdXJyZW50Q29sbGVjdGlvbnMoJ0RldmljZXNDb2xsZWN0aW9uJykvSXRlbXM%2fJTI0dG9wPTEmJTI0c2tpcHRva2VuPU15WlJWa1pDVVZWR1FsRlZSWFpNZVRoMlRIazRka3g1T0haUFJVcENVVlZHUWxOR1RYWldNVnB1WWpBNVFrMUZkRlZTYmxKU1pHcENXV0V6UlRCa2VqQTU%3d", + "value": [ + { + "id": "ade7078f-4bf5-4239-bfde-95a7c4225df7", + "deviceId": "contoso_9D6816", + "displayName": "Contoso 9D6816 Device", + "description": "Contoso 9D6816 Device", + "macAddress": "00:0A:95:9D:68:16", + "manufacturer": "Contoso", + "ipV4Address": "192.168.1.100", + "ipV6Address": "2001:db8::ff00:42:8329", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671", + "tags": [ + "Building A", + "Floor 3", + "Room 301", + "Conference Room" + ], + "sensors": [ + { + "sensorId": "Occupancy", + "displayName": null, + "sensorType": "occupancy", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + }, + { + "sensorId": "PeopleCount", + "displayName": null, + "sensorType": "peopleCount", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + } + ] + } + ] +} +``` + |
v1.0 | Workplace Post Sensordevices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workplace-post-sensordevices.md | + + Title: "Create workplaceSensorDevice" +description: "Create a new workplace sensor device." ++ms.localizationpriority: medium +++# Create workplaceSensorDevice +Namespace: microsoft.graph +++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). ++<!-- { "blockType": "permissions", "name": "workplace_post_sensordevices" } --> ++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 ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /workplace/sensorDevices +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [workplaceSensorDevice](../resources/workplacesensordevice.md) object. ++You can specify the following properties when you create a **workplaceSensorDevice**. ++|Property|Type|Description| +|:|:|:| +|description|String|The description of the device. Optional.| +|deviceId|String|The user-defined unique identifier of the device provided at the time of creation. Required.| +|displayName|String|The display name of the device. Optional.| +|ipV4Address|String|The IPv4 address of the device. Optional.| +|ipV6Address|String|The IPv6 address of the device. Optional.| +|macAddress|String|The MAC address of the device. Optional.| +|manufacturer|String|The manufacturer of the device. Required.| +|placeId|String|The unique identifier of the place where the device is located. 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. Optional.| +|sensors|[workplaceSensor](../resources/workplacesensor.md) collection|A list of sensors associated with the device that collect and report data about physical or environmental conditions, such as occupancy, people count, inferred occupancy, temperature, and more. Required.| +|tags|String collection|A list of custom tags associated with the device. Supports `$filter`. Optional.| ++## Response ++If successful, this method returns a `201 Created` response code and a [workplaceSensorDevice](../resources/workplacesensordevice.md) object in the response body. ++## Examples ++### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_workplacesensordevice_from_" +} +--> +``` http +POST https://graph.microsoft.com/beta/workplace/sensorDevices +Content-Type: application/json ++{ + "deviceId": "contoso_9D6816", + "displayName": "Contoso 9D6816 Device", + "description": "Contoso 9D6816 Device", + "macAddress": "00:0A:95:9D:68:16", + "manufacturer": "Contoso", + "ipV4Address": "192.168.1.100", + "ipV6Address": "2001:db8::ff00:42:8329", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671", + "tags": [ + "Building A", + "Floor 3", + "Room 301", + "Conference Room" + ], + "sensors": [ + { + "sensorType": "occupancy" + }, + { + "sensorType": "peopleCount" + } + ] +} +``` ++# [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.workplaceSensorDevice" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#workplace/sensorDevices/$entity", + "id": "ade7078f-4bf5-4239-bfde-95a7c4225df7", + "deviceId": "contoso_9D6816", + "displayName": "Contoso 9D6816 Device", + "description": "Contoso 9D6816 Device", + "macAddress": "00:0A:95:9D:68:16", + "manufacturer": "Contoso", + "ipV4Address": "192.168.1.100", + "ipV6Address": "2001:db8::ff00:42:8329", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671", + "tags": [ + "Building A", + "Floor 3", + "Room 301", + "Conference Room" + ], + "sensors": [ + { + "sensorId": "Occupancy", + "displayName": null, + "sensorType": "occupancy", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + }, + { + "sensorId": "PeopleCount", + "displayName": null, + "sensorType": "peopleCount", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + } + ] +} +``` |
v1.0 | Workplacesensordevice Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workplacesensordevice-delete.md | + + Title: "Delete workplaceSensorDevice" +description: "Delete a workplace sensor device." ++ms.localizationpriority: medium +++# Delete workplaceSensorDevice +Namespace: microsoft.graph +++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). ++<!-- { "blockType": "permissions", "name": "workplacesensordevice_delete" } --> ++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 ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /workplace/sensorDevices/{id} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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_workplacesensordevice" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/workplace/sensorDevices/ade7078f-4bf5-4239-bfde-95a7c4225df7 +``` ++# [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 | Workplacesensordevice Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workplacesensordevice-get.md | + + Title: "Get workplaceSensorDevice" +description: "Get the properties of a workplace sensor device." ++ms.localizationpriority: medium +++# Get workplaceSensorDevice +Namespace: microsoft.graph +++Get the properties of a workplace sensor device, including tags, MAC address, sensors, and more. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "workplacesensordevice_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /workplace/sensorDevices/{id} +``` ++## Optional query parameters +This method supports the `$select` [OData query parameter](/graph/query-parameters) to customize the response. ++## Request headers +| Name | Description | +| : | : | +| Authorization | Bearer {token}. Required. | ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [workplaceSensorDevice](../resources/workplacesensordevice.md) object in the response body. ++## Examples ++### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_workplacesensordevice" +} +--> +``` http +GET https://graph.microsoft.com/beta/workplace/sensorDevices/ade7078f-4bf5-4239-bfde-95a7c4225df7 +``` ++# [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.workplaceSensorDevice" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#workplace/sensorDevices/$entity", + "id": "ade7078f-4bf5-4239-bfde-95a7c4225df7", + "deviceId": "contoso_9D6816", + "displayName": "Contoso 9D6816 Device", + "description": "Contoso 9D6816 Device", + "macAddress": "00:0A:95:9D:68:16", + "manufacturer": "Contoso", + "ipV4Address": "192.168.1.100", + "ipV6Address": "2001:db8::ff00:42:8329", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671", + "tags": [ + "Building A", + "Floor 3", + "Room 301", + "Conference Room" + ], + "sensors": [ + { + "sensorId": "Occupancy", + "displayName": null, + "sensorType": "occupancy", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + }, + { + "sensorId": "PeopleCount", + "displayName": null, + "sensorType": "peopleCount", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + } + ] +} +``` |
v1.0 | Workplacesensordevice Ingesttelemetry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workplacesensordevice-ingesttelemetry.md | + + Title: "workplaceSensorDevice: ingestTelemetry" +description: "Ingest sensor telemetry for a workplace sensor device." ++ms.localizationpriority: medium +++# workplaceSensorDevice: ingestTelemetry +Namespace: microsoft.graph +++Ingest sensor telemetry for 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). ++<!-- { "blockType": "permissions", "name": "workplacesensordevice_ingesttelemetry" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /workplace/sensorDevices/ingestTelemetry +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the parameters. ++The **sensorId** property may be omitted within the [workplaceSensorDeviceTelemetry](../resources/workplacesensordevicetelemetry.md) object for devices with unique sensor types. When this property is omitted, the [sensorType](../resources/workplacesensor.md#workplacesensortype-values) value serves as the default identifier, consistent with the behavior when you create a device without a specified **sensorId**. ++The following table shows the parameters that you can use with this action. ++|Parameter|Type|Description| +|:|:|:| +|telemetry|[workplaceSensorDeviceTelemetry](../resources/workplacesensordevicetelemetry.md) collection|A collection of the telemetry data collected and reported by a sensor on a device, such as occupancy, people count, inferred occupancy, temperature, and more.| ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples +### Example 1: Send sensor telemetry for a device with unique sensor types ++The following example shows how to send sensor telemetry for a device with unique sensor types. ++#### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "workplacesensordevicethis.ingesttelemetry.unique.sensor.type" +} +--> +``` http +POST https://graph.microsoft.com/beta/workplace/sensorDevices/ingestTelemetry +Content-Type: application/json ++{ + "telemetry": [ + { + "deviceId": "contoso_9D6816", + "sensorType": "occupancy", + "boolValue": false, + "timestamp": "2021-03-31T09:36:05.144Z" + } + ] +} +``` ++# [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 +``` ++### Example 2: Send sensor telemetry for a device that has multiple sensors of the same type ++The following example shows how to send sensor telemetry for a device that has multiple sensors of the same type. ++#### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "workplacesensordevicethis.ingesttelemetry.same.sensor.type" +} +--> +``` http +POST https://graph.microsoft.com/beta/workplace/sensorDevices/ingestTelemetry +Content-Type: application/json ++{ + "telemetry": [ + { + "deviceId": "contoso_9D6816", + "sensorId": "occupancy_1", + "sensorType": "occupancy", + "boolValue": false, + "timestamp": "2021-03-31T09:36:05.144Z" + }, + { + "deviceId": "contoso_9D6816", + "sensorId": "occupancy_2", + "sensorType": "occupancy", + "boolValue": false, + "timestamp": "2021-03-31T09:36:05.144Z" + } + ] +} +``` ++# [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 +``` ++### Example 3: Ingest telemetry for multiple devices ++The following example shows how to ingest telemetry for multiple devices. ++#### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "workplacesensordevicethis.ingesttelemetry.multiple.devices" +} +--> +``` http +POST https://graph.microsoft.com/beta/workplace/sensorDevices/ingestTelemetry +Content-Type: application/json ++{ + "telemetry": [ + { + "deviceId": "contoso_9D6816", + "sensorType": "occupancy", + "boolValue": false, + "timestamp": "2021-03-31T09:36:05.144Z" + }, + { + "deviceId": "contoso_9D6817", + "sensorType": "occupancy", + "boolValue": false, + "timestamp": "2021-03-31T09:36:05.144Z" + } + ] +} +``` ++# [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 | Workplacesensordevice Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workplacesensordevice-update.md | + + Title: "Update workplaceSensorDevice" +description: "Update the properties of a workplace sensor device." ++ms.localizationpriority: medium +++# Update workplaceSensorDevice +Namespace: microsoft.graph +++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). ++<!-- { "blockType": "permissions", "name": "workplacesensordevice_update" } --> ++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 ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /workplace/sensorDevices/{id} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body ++In the request body, provide the entire JSON for the [workplaceSensorDevice](../resources/workplacesensordevice.md) object with updated fields. Partial updates aren't supported. If any optional property is excluded, it's set to null. To add new sensors, append a new sensor object to the existing sensor collection. If a sensor object is removed from the collection, it's deleted from the device. ++The following table specifies the properties that can be updated. ++|Property|Type|Description| +|:|:|:| +|description|String|The description of the device. Optional.| +|deviceId|String|The user-defined unique identifier of the device provided at the time of creation. Required. Read-only.| +|displayName|String|The display name of the device. Optional.| +|ipV4Address|String|The IPv4 address of the device. Optional.| +|ipV6Address|String|The IPv6 address of the device. Optional.| +|macAddress|String|The MAC address of the device. Optional.| +|manufacturer|String|The manufacturer of the device. Required.| +|placeId|String|The unique identifier of the place where the device is located. 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. Optional.| +|sensors|[workplaceSensor](../resources/workplacesensor.md) collection|A list of sensors associated with the device that collect and report data about physical or environmental conditions, such as occupancy, people count, inferred occupancy, temperature, and more. Required.| +|tags|String collection|A list of custom tags associated with the device. Supports `$filter`. Optional.| +++## Response ++If successful, this method returns a `200 OK` response code and an updated [workplaceSensorDevice](../resources/workplacesensordevice.md) object in the response body. ++## Examples +### Example 1: Add a new tag ++The following example shows how to add a new tag to a workplace sensor device. ++#### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_workplacesensordevice_tags" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/workplace/sensorDevices/ade7078f-4bf5-4239-bfde-95a7c4225df7 +Content-Type: application/json ++{ + "deviceId": "contoso_9D6816", + "displayName": "Contoso 9D6816 Device", + "description": "Contoso 9D6816 Device", + "macAddress": "00:0A:95:9D:68:16", + "manufacturer": "Contoso", + "ipV4Address": "192.168.1.100", + "ipV6Address": "2001:db8::ff00:42:8329", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671", + "tags": [ + "Building A", + "Floor 3", + "Room 301", + "Conference Room", + "v1.0.7" + ], + "sensors": [ + { + "sensorType": "occupancy" + }, + { + "sensorType": "peopleCount" + } + ] +} +``` ++# [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.workplaceSensorDevice" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#workplace/sensorDevices/$entity", + "id": "ade7078f-4bf5-4239-bfde-95a7c4225df7", + "deviceId": "contoso_9D6816", + "displayName": "Contoso 9D6816 Device", + "description": "Contoso 9D6816 Device", + "macAddress": "00:0A:95:9D:68:16", + "manufacturer": "Contoso", + "ipV4Address": "192.168.1.100", + "ipV6Address": "2001:db8::ff00:42:8329", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671", + "tags": [ + "Building A", + "Floor 3", + "Room 301", + "Conference Room", + "v1.0.7" + ], + "sensors": [ + { + "sensorId": "Occupancy", + "displayName": null, + "sensorType": "occupancy", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + }, + { + "sensorId": "PeopleCount", + "displayName": null, + "sensorType": "peopleCount", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + } + ] +} +``` ++### Example 2: Add a new sensor ++The following example shows how to add a new sensor to a workplace sensor device. ++#### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_workplacesensordevice_new_sensor" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/workplace/sensorDevices/ade7078f-4bf5-4239-bfde-95a7c4225df7 +Content-Type: application/json ++{ + "deviceId": "contoso_9D6816", + "displayName": "Contoso 9D6816 Device", + "description": "Contoso 9D6816 Device", + "macAddress": "00:0A:95:9D:68:16", + "manufacturer": "Contoso", + "ipV4Address": "192.168.1.100", + "ipV6Address": "2001:db8::ff00:42:8329", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671", + "tags": [ + "Building A", + "Floor 3", + "Room 301", + "Conference Room" + ], + "sensors": [ + { + "sensorType": "occupancy" + }, + { + "sensorType": "peopleCount" + }, + { + "sensorType": "inferredOccupancy" + } + ] +} +``` ++# [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.workplaceSensorDevice" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#workplace/sensorDevices/$entity", + "id": "ade7078f-4bf5-4239-bfde-95a7c4225df7", + "deviceId": "contoso_9D6816", + "displayName": "Contoso 9D6816 Device", + "description": "Contoso 9D6816 Device", + "macAddress": "00:0A:95:9D:68:16", + "manufacturer": "Contoso", + "ipV4Address": "192.168.1.100", + "ipV6Address": "2001:db8::ff00:42:8329", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671", + "tags": [ + "Building A", + "Floor 3", + "Room 301", + "Conference Room" + ], + "sensors": [ + { + "sensorId": "Occupancy", + "displayName": null, + "sensorType": "occupancy", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + }, + { + "sensorId": "PeopleCount", + "displayName": null, + "sensorType": "peopleCount", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + }, + { + "sensorId": "InferredOccupancy", + "displayName": null, + "sensorType": "inferredOccupancy", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + } + ] +} +``` ++### Example 3: Remove a sensor ++The following example shows how to remove a sensor from a workplace sensor device. ++#### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_workplacesensordevice_remove_sensor" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/workplace/sensorDevices/ade7078f-4bf5-4239-bfde-95a7c4225df7 +Content-Type: application/json ++{ + "deviceId": "contoso_9D6816", + "displayName": "Contoso 9D6816 Device", + "description": "Contoso 9D6816 Device", + "macAddress": "00:0A:95:9D:68:16", + "manufacturer": "Contoso", + "ipV4Address": "192.168.1.100", + "ipV6Address": "2001:db8::ff00:42:8329", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671", + "tags": [ + "Building A", + "Floor 3", + "Room 301", + "Conference Room" + ], + "sensors": [ + { + "sensorType": "peopleCount" + } + ] +} +``` ++# [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.workplaceSensorDevice" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#workplace/sensorDevices/$entity", + "id": "ade7078f-4bf5-4239-bfde-95a7c4225df7", + "deviceId": "contoso_9D6816", + "displayName": "Contoso 9D6816 Device", + "description": "Contoso 9D6816 Device", + "macAddress": "00:0A:95:9D:68:16", + "manufacturer": "Contoso", + "ipV4Address": "192.168.1.100", + "ipV6Address": "2001:db8::ff00:42:8329", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671", + "tags": [ + "Building A", + "Floor 3", + "Room 301", + "Conference Room" + ], + "sensors": [ + { + "sensorId": "PeopleCount", + "displayName": null, + "sensorType": "peopleCount", + "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671" + } + ] +} +``` |
v1.0 | Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/overview.md | Title: "Microsoft Graph REST API beta endpoint reference" -description: "Documentation for the Microsoft Graph REST API beta endpoint, which includes APIs that are currently in preview and aren't yet generally available." +description: "Find reference content for the Microsoft Graph REST APIs in the beta endpoint, which includes APIs that are currently in preview and aren't yet generally available." ms.localizationpriority: high doc_type: conceptualPageType+ -The reference content in this section documents the Microsoft Graph beta endpoint. The beta endpoint includes APIs that are currently in preview and aren't yet generally available. We invite you to try these APIs and provide your feedback via the following channels: +The reference content in this section documents the Microsoft Graph REST APIs in the `beta` endpoint. The beta endpoint includes APIs that are currently in preview and aren't yet generally available. We invite you to try these APIs and provide your feedback. -- [GitHub](https://github.com/microsoftgraph/microsoft-graph-docs-contrib/issues) - For feedback on the Preview APIs. Tag with `beta`.-- [StackOverflow](https://stackoverflow.com/questions/tagged/microsoft-graph-api) - For questions or help with your code. Tag with `microsoft-graph-api`.--> [!NOTE] +> [!CAUTION] > The APIs in the beta endpoint are subject to change. We don't recommend that you use them in your production apps. ## Call the beta endpoint Microsoft Graph API requests to the beta endpoint use the following pattern: https://graph.microsoft.com/beta/{resource}?[query_parameters] ``` -For details, see [Use the Microsoft Graph API](/graph/use-the-api). +For more information about Microsoft Graph REST API calls, see [Use the Microsoft Graph API](/graph/use-the-api). ++## Microsoft Graph v1.0 endpoint ++Currently, two versions of Microsoft Graph REST APIs are available: v1.0 and beta. ++If you're interested in using APIs that are generally available, see [Microsoft Graph v1.0 endpoint reference](/graph/api/overview?view=graph-rest-1.0&preserve-view=true). ++To determine whether a beta API is available in v1.0, use the version selector in the left navigation. If the API is available in v1.0, you can switch to the v1.0 reference article. ++For more information, see [Versioning and support](/graph/versioning-and-support). ## What's new Find out [what's new](/graph/whats-new-overview) in the beta endpoint. -Explore the [API changelog](https://developer.microsoft.com/en-us/graph/changelog) for more details about changes to Microsoft Graph APIs. +For details about changes to Microsoft Graph APIs in beta, explore the [API changelog](https://developer.microsoft.com/en-us/graph/changelog/?filterby=beta). ## Related content |
v1.0 | Aadsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/aadsource.md | description: "Represents an authorization system identity sourced from Microsoft ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Accesspackage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackage.md | To assign a user to an access package, [create an accessPackageAssignmentRequest ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Accesspackageassignmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackageassignmentrequest.md | Title: "accessPackageAssignmentRequest resource type" -description: "An access package assignment request is created by a user who wants to obtain an access package assignment." +description: "An access package assignment request is created by a user who wants to get an access package assignment." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -In [Microsoft Entra Entitlement Management](entitlementmanagement-overview.md), an access package assignment request is created by or on behalf of a user who wants to obtain an access package assignment. If the request is successful, with any necessary approvals, the user receives an access package assignment, and is the subject of that resulting access package assignment. Microsoft Entra ID also creates access package assignment requests automatically for tracking access removal. +In [Microsoft Entra Entitlement Management](entitlementmanagement-overview.md), an access package assignment request is created by or on behalf of a user who wants to get an access package assignment. If the request is successful, with any necessary approvals, the user receives an access package assignment, and is the subject of that resulting access package assignment. Microsoft Entra ID also creates access package assignment requests automatically for tracking access removal. ## Methods In [Microsoft Entra Entitlement Management](entitlementmanagement-overview.md), | [Get accessPackageAssignmentRequest](../api/accesspackageassignmentrequest-get.md) | [accessPackageAssignmentRequest](accesspackageassignmentrequest.md) | Read properties and relationships of an **accessPackageAssignmentRequest** object. | | [Delete accessPackageAssignmentRequest](../api/accesspackageassignmentrequest-delete.md) |None | Delete an **accessPackageAssignmentRequest**. | |[filterByCurrentUser](../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 cancellable state.| +|[cancel](../api/accesspackageassignmentrequest-cancel.md)|[accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) collection|Cancel an **accessPackageAssignmentRequest** object that is in a cancelable state.| | [reprocess](../api/accesspackageassignmentrequest-reprocess.md) | None | Automatically retry a user's request for access to an access package.| | [List accessPackageAssignmentRequests](../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 accessPackageAssignmentRequest](../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.** | 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.| |customExtensionCalloutInstances|[customExtensionCalloutInstance](../resources/customextensioncalloutinstance.md) collection|Information about all the custom extension calls that were made during the access package assignment request workflow.| |customExtensionHandlerInstances|[customExtensionHandlerInstance](../resources/customextensionhandlerinstance.md) collection| A collection of [custom workflow extension](customaccesspackageworkflowextension.md) instances being run on an assignment request. Read-only.|+|expirationDateTime|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`| |id|String| Read-only.|-|isValidationOnly|Boolean|True if the request is not to be processed for assignment.| +|isValidationOnly|Boolean|True if the request isn't to be processed for assignment.| |justification|String|The requestor's supplied justification.|-|requestState|String|One of `PendingApproval`, `Canceled`, `Denied`, `Delivering`, `Delivered`, `PartiallyDelivered`, `DeliveryFailed`, `Submitted` or `Scheduled`. Read-only.| +|requestState|String|One of `PendingApproval`, `Canceled`, `Denied`, `Delivering`, `Delivered`, `PartiallyDelivered`, `DeliveryFailed`, `Submitted`, or `Scheduled`. Read-only.| |requestStatus|String|More information on the request processing status. Read-only.|-|requestType|String|One of `UserAdd`, `UserExtend`, `UserUpdate`, `UserRemove`, `AdminAdd`, `AdminRemove` or `SystemRemove`. A request from the user themselves would have requestType of `UserAdd`, `UserUpdate` or `UserRemove`. Read-only.| +|requestType|String|One of `UserAdd`, `UserExtend`, `UserUpdate`, `UserRemove`, `AdminAdd`, `AdminRemove`, or `SystemRemove`. A request from the user has a **requestType** of `UserAdd`, `UserUpdate`, or `UserRemove`. Read-only.| |schedule|[requestSchedule](requestschedule.md)| The range of dates that access is to be assigned to the requestor. Read-only.| |answers|[accessPackageAnswer](accesspackageanswer.md) collection|Answers provided by the requestor to [accessPackageQuestions](accesspackagequestion.md) asked of them at the time of request.|-|verifiedCredentialsData|[verifiedCredentialData](../resources/verifiedcredentialdata.md) collection| The details of the verifiable credential that was presented by the requestor, such as the issuer and claims. Read-only.| +|verifiedCredentialsData|[verifiedCredentialData](../resources/verifiedcredentialdata.md) collection| The details of the verifiable credential that the requestor presented, such as the issuer and claims. Read-only.| ## Relationships | Relationship | Type | Description | |:-|:|:| |accessPackage|[accessPackage](../resources/accesspackage.md)|The access package associated with the accessPackageAssignmentRequest. An access package defines the collections of resource roles and the policies for how one or more users can get access to those resources. Read-only. Nullable. Supports `$expand`.|-|accessPackageAssignment|[accessPackageAssignment](accesspackageassignment.md)| For a **requestType** of `UserAdd` or `AdminAdd`, this is an access package assignment requested to be created. For a **requestType** of `UserRemove`, `AdminRemove` or `SystemRemove`, this has the `id` property of an existing assignment to be removed. Supports `$expand`.| +|accessPackageAssignment|[accessPackageAssignment](accesspackageassignment.md)| For a **requestType** of `UserAdd` or `AdminAdd`, an access package assignment requested to be created. For a **requestType** of `UserRemove`, `AdminRemove`, or `SystemRemove`, this property has the `id` property of an existing assignment to be removed. Supports `$expand`.| |requestor|[accessPackageSubject](accesspackagesubject.md)| The subject who requested or, if a direct assignment, was assigned. Read-only. Nullable. Supports `$expand`.| ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Accesspackageassignmentrequestcallbackdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackageassignmentrequestcallbackdata.md | Inherits from [customExtensionData](../resources/customextensiondata.md). 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.accessPackageAssignmentRequestCallbackData" |
v1.0 | Accesspackageassignmentresourcerole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackageassignmentresourcerole.md | Title: "accessPackageAssignmentResourceRole resource type" -description: "An access package assignment resource role indicates the resource-specific role that a subject has been assigned through an access package assignment." +description: "Indicates the resource-specific role that a subject is assigned through an access package assignment." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -In [Microsoft Entra entitlement management](entitlementmanagement-overview.md), an access package assignment resource role indicates the resource-specific role that a subject has been assigned through an access package assignment. +In [Microsoft Entra entitlement management](entitlementmanagement-overview.md), an access package assignment resource role indicates the resource-specific role that a subject is assigned through an access package assignment. ## Methods In [Microsoft Entra entitlement management](entitlementmanagement-overview.md), |:-|:|:| |id|String| Read-only.| |originId|String|A unique identifier relative to the origin system, corresponding to the originId property of the [accessPackageResourceRole](accesspackageresourcerole.md). |-|originSystem|String|The system where the role assignment is to be created or has been created for an access package assignment, such as `SharePointOnline`, `AadGroup` or `AadApplication`, corresponding to the originSystem property of the [accessPackageResourceRole](accesspackageresourcerole.md).| -|status|String|The value is `PendingFulfillment` when the access package assignment hasn't yet been delivered to the origin system, and `Fulfilled` when the access package assignment has been delivered to the origin system.| +|originSystem|String|The system where the role assignment is to be created or has been created for an access package assignment, such as `SharePointOnline`, `AadGroup`, or `AadApplication`, corresponding to the originSystem property of the [accessPackageResourceRole](accesspackageresourcerole.md).| +|status|String|The value is `PendingFulfillment` before the access package assignment is delivered to the origin system, and `Fulfilled` after the access package assignment is delivered to the origin system.| ## Relationships In [Microsoft Entra entitlement management](entitlementmanagement-overview.md), ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Accesspackageassignmentworkflowextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackageassignmentworkflowextension.md | Inherits from [customCalloutExtension](../resources/customcalloutextension.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accesspackagelocalizedcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackagelocalizedcontent.md | A complex type used to represent a text in multiple localized forms. It includes 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.accessPackageLocalizedContent" |
v1.0 | Accesspackageresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackageresource.md | In [Microsoft Entra Entitlement Management](entitlementmanagement-overview.md), |displayName|String|The display name of the resource, such as the application name, group name, or site name.| |id|String| Read-only.| |isPendingOnboarding|Boolean|`True` if the resource is not yet available for assignment. Read-only. |-|originId|String|The unique identifier of the resource in the origin system. In the case of a Microsoft Entra group, originId is the identifier of the group. | -|originSystem|String|The type of the resource in the origin system, such as `SharePointOnline`, `AadApplication`, or `AadGroup`.| +|originId|String|The unique identifier of the resource in the origin system. In the case of a Microsoft Entra group, originId is the identifier of the group. Supports `$filter` (`eq`).| +|originSystem|String|The type of the resource in the origin system, such as `SharePointOnline`, `AadApplication`, or `AadGroup`. Supports `$filter` (`eq`).| |resourceType|String|The type of the resource, such as `Application` if it is a Microsoft Entra connected application, or `SharePoint Online Site` for a SharePoint Online site.| |url|String|A unique resource locator for the resource, such as the URL for signing a user into an application.| |
v1.0 | Accesspackageresourceattributesource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackageresourceattributesource.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An abstract type that exposes objects that define the properties the user configures with values that are passed to the end system or the request approver. It's used in the **attributeSource** property of an [accessPackageResourceAttribute](accesspackageresourceattribute.md). This type is inherited by [accessPackageResourceAttributeQuestion](../resources/accesspackageresourceattributequestion.md). +An abstract type that exposes objects that define the properties the user configures with values that are passed to the end system or the request approver. It's used in the **attributeSource** property of an [accessPackageResourceAttribute](accesspackageresourceattribute.md). This type is inherited by [accessPackageResourceAttributeQuestion](../resources/accesspackageresourceattributequestion.md). ## Properties None. None. 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.accessPackageResourceAttributeSource" |
v1.0 | Accesspackagesubject | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackagesubject.md | In [Microsoft Entra entitlement management](entitlementmanagement-overview.md), |email|String|The email address of the subject.| |id|String| Read-only. Key.| |objectId|String|The object identifier of the subject. `null` if the subject isn't yet a user in the tenant. Alternate key.|+|onPremisesSecurityIdentifier|String|A string representation of the principal's security identifier, if known, or `null` if the subject doesn't have a security identifier.| |principalName|String|The principal name, if known, of the subject.| |subjectLifecycle|accessPackageSubjectLifecycle|The lifecycle of the subject user, if a guest. The possible values are: `notDefined`, `notGoverned`, `governed`, `unknownFutureValue`.| |type|String|The resource type of the subject.| In [Microsoft Entra entitlement management](entitlementmanagement-overview.md), ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Accesspackagetextinputquestion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackagetextinputquestion.md | Inherits from [accessPackageQuestion](../resources/accesspackagequestion.md). 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.accessPackageTextInputQuestion" |
v1.0 | Accessreview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreview.md | Represents a Microsoft Entra [access review](accessreviews-root.md). |:-- |:- |:-- | | id | String | The feature-assigned unique identifier of an access review. | | displayName | String | The access review name. Required on create. |-| startDateTime | DateTimeOffset | The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. | -| endDateTime | DateTimeOffset | The DateTime when the review is scheduled to end. This must be at least one day later than the start date. Required on create. | +| startDateTime | DateTimeOffset | The date and time when the review is scheduled to be start. This date can be in the future. Required on create. | +| endDateTime | DateTimeOffset | The DateTime when the review is scheduled to end. This must be at least one day later than the start date. Required on create. | | status | String | This read-only field specifies the status of an accessReview. The typical states include `Initializing`, `NotStarted`, `Starting`,`InProgress`, `Completing`, `Completed`, `AutoReviewing`, and `AutoReviewed`. | | description | String | The description provided by the access review creator, to show to the reviewers. |-| businessFlowTemplateId | String | The business flow template identifier. Required on create. This value is case sensitive. | -| reviewerType | String | The relationship type of reviewer to the target object, one of `self`, `delegated` or `entityOwners`. Required on create. | +| businessFlowTemplateId | String | The business flow template identifier. Required on create. This value is case sensitive. | +| reviewerType | String | The relationship type of reviewer to the target object, one of: `self`, `delegated`, `entityOwners`. Required on create. | | createdBy | [userIdentity](useridentity.md) | The user who created this review. |-| reviewedEntity | [identity](identity.md) | The object for which the access reviews is reviewing the access rights assignments. This can be the group for the review of memberships of users in a group, or the app for a review of assignments of users to an application. Required on create. | +| reviewedEntity | [identity](identity.md) | The object for which the access review is reviewing the access rights assignments. This identity can be the group for the review of memberships of users in a group, or the app for a review of assignments of users to an application. Required on create. | | settings | [accessReviewSettings](accessreviewsettings.md) | The settings of an accessReview, see type definition below. | ## Relationships Represents a Microsoft Entra [access review](accessreviews-root.md). | reviewers | [userIdentity](useridentity.md) collection | The collection of reviewers for an access review, if access review reviewerType is of type `delegated`. | | decisions | [accessReviewDecision](accessreviewdecision.md) collection | The collection of decisions for this access review. | | myDecisions | [accessReviewDecision](accessreviewdecision.md) collection | The collection of decisions for the caller, if the caller is a reviewer. |-| instances | [accessReview](accessreview.md) collection | The collection of access reviews instances past, present and future, if this object is a recurring access review. | +| instances | [accessReview](accessreview.md) collection | The collection of access reviews instances past, present, and future, if this object is a recurring access review. | Whether these relationships are present on an object, depends upon whether the object is a one-time access review, the series of a recurring access review, or an instance of a recurring access review. Whether these relationships are present on an object, depends upon whether the o ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Accessreviewapplyaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewapplyaction.md | 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.accessReviewApplyAction" |
v1.0 | Accessreviewdecision | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewdecision.md | Namespace: microsoft.graph [!INCLUDE [accessreviews-disclaimer](../../includes/accessreviews-disclaimer.md)] -In the Microsoft Entra [access reviews](accessreviews-root.md) feature, the `accessReviewDecision` represents a Microsoft Entra access review decision of a particular entity's access. Within an access review, or an instance of a recurring access review, there's one `accessReviewDecision` per reviewed user. For example, if a group has two guests and one nonguest as members, and an access review of guests is performed for that group, then there will be two access review decision objects. If a reviewer changes their decision, or another reviewer overrides them, then the `accessReviewDecision` is updated. +In the Microsoft Entra [access reviews](accessreviews-root.md) feature, the `accessReviewDecision` represents a Microsoft Entra access review decision of a particular entity's access. Within an access review, or an instance of a recurring access review, there's one `accessReviewDecision` per reviewed user. For example, if a group has two guests and one nonguest as members, and an access review of guests is performed for that group, then there are two access review decision objects. If a reviewer changes their decision, or another reviewer overrides them, then the `accessReviewDecision` is updated. ## Methods -None. Objects of this type are automatically created by the feature when an access review initializes, and can't be deleted. They can be retrieved from an access review using the [decisions](../api/accessreview-listdecisions.md) and [mydecisions](../api/accessreview-listmydecisions.md) relationships. +None. Objects of this type are automatically created by the feature when an access review initializes, and can't be deleted. They can be retrieved from an access review using the [decisions](../api/accessreview-listdecisions.md) and [mydecisions](../api/accessreview-listmydecisions.md) relationships. ## Properties This table illustrates the base properties of objects of this type. | Property | Type | Description | | : | :-- | :-- |-| `id` |`String` | The ID of the decision within the access review. | -| `accessReviewId` |`String` | The feature-generated ID of the access review. | -| `reviewedBy` |[userIdentity](useridentity.md)| The identity of the reviewer. If the recommendation was used as the review, the userPrincipalName is empty. | -| `reviewedDate` |`DateTimeOffset` | The date and time the most recent review for this access right was supplied. | -| `reviewResult` |`String` | The result of the review, one of `NotReviewed`, `Deny`, `DontKnow` or `Approve`. | -| `justification` |`String` | The reviewer's business justification, if supplied. | -| `appliedBy` |[userIdentity](useridentity.md)| When the review completes, if the results were manually applied, the user identity of the user who applied the decision. If the review was autoapplied, the userPrincipalName is empty. | -| `appliedDateTime` |`DateTimeOffset` | The date and time when the review decision was applied. | -| `applyResult` |`String` | The outcome of applying the decision, one of `NotApplied`, `Success`, `Failed`, `NotFound` or `NotSupported`. | -| `accessRecommendation` |`String` | The feature- generated recommendation shown to the reviewer, one of `Approve`, `Deny` or `NotAvailable`. | +| `id` |`String` | The ID of the decision within the access review. | +| `accessReviewId` |`String` | The feature-generated ID of the access review. | +| `reviewedBy` |[userIdentity](useridentity.md)| The identity of the reviewer. If the recommendation was used as the review, the userPrincipalName is empty. | +| `reviewedDate` |`DateTimeOffset` | The date and time the most recent review for this access right was supplied. | +| `reviewResult` |`String` | The result of the review, one of `NotReviewed`, `Deny`, `DontKnow` or `Approve`. | +| `justification` |`String` | The reviewer's business justification, if supplied. | +| `appliedBy` |[userIdentity](useridentity.md)| When the review completes, if the results were manually applied, the user identity of the user who applied the decision. If the review was autoapplied, the userPrincipalName is empty. | +| `appliedDateTime` |`DateTimeOffset` | The date and time when the review decision was applied. | +| `applyResult` |`String` | The outcome of applying the decision, one of: `NotApplied`, `Success`, `Failed`, `NotFound`, `NotSupported`. | +| `accessRecommendation` |`String` | The feature- generated recommendation shown to the reviewer, one of: `Approve`, `Deny`, `NotAvailable`. | -In addition, more properties may be present depending on the object type of the object possessing the access that was decided upon. For example, if the access review decision is a particular user's group membership or application access, the user who is potentially going to have their access be removed is identified through these properties: +In addition, more properties can be present depending on the object type of the object possessing the access that was decided upon. For example, if the access review decision is a particular user's group membership or application access, the user who is potentially going to have their access be removed is identified through these properties: | Property | Type | Description | | : | :-- | :-- |-| `userId` |`String` | The ID of user whose access was reviewed. | -| `userDisplayName` |`String` | The display name of the user whose access was reviewed. | -| `userPrincipalName` |`String` | The user principal name of the user whose access was reviewed. | +| `userId` |`String` | The ID of user whose access was reviewed. | +| `userDisplayName` |`String` | The display name of the user whose access was reviewed. | +| `userPrincipalName` |`String` | The user principal name of the user whose access was reviewed. | ## Relationships -None. Objects of this type can be retrieved from an access review using the [decisions](../api/accessreview-listdecisions.md) and [mydecisions](../api/accessreview-listmydecisions.md) relationships of the [accessReview](accessreview.md) object. +None. Objects of this type can be retrieved from an access review using the [decisions](../api/accessreview-listdecisions.md) and [mydecisions](../api/accessreview-listmydecisions.md) relationships of the [accessReview](accessreview.md) object. ## Related content None. Objects of this type can be retrieved from an access review using the [de ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Accessreviewhistorydefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewhistorydefinition.md | An **accessReviewHistoryDefinition** contains a list of [accessReviewHistoryInst ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accessreviewhistoryinstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewhistoryinstance.md | Namespace: microsoft.graph ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accessreviewhistoryschedulesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewhistoryschedulesettings.md | Defines the settings of an [accessReviewHistoryDefinition](accessreviewhistoryde ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.accessReviewHistoryScheduleSettings" |
v1.0 | Accessreviewinstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewinstance.md | Every **accessReviewInstance** contains a list of [decisions](accessreviewinstan ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. { "@odata.type": "#microsoft.graph.accessReviewInstance", "id": "string (identifier)",- "displayName": "string", "startDateTime": "string (timestamp)", "endDateTime": "string (timestamp)", "status": "string", |
v1.0 | Accessreviewinstancedecisionitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewinstancedecisionitem.md | +toc.keywords: [ access review decisions ] # accessReviewInstanceDecisionItem resource type Namespace: microsoft.graph [!INCLUDE [accessreviews-disclaimer-v2](../../includes/accessreviews-disclaimer-v2.md)] -Represents a Microsoft Entra [access review](accessreviewsv2-overview.md) decision on an instance of a review. This decision represents the determination of a user or service principal's access for a given [access review instance](accessreviewinstance.md). This resource is an open type that allows other properties to be passed in. +Represents a Microsoft Entra [access review](accessreviewsv2-overview.md) decision on an instance of a review. This decision represents the determination of a user or service principal's access for a given [access review instance](accessreviewinstance.md). This resource is an open type that allows other properties to be passed in. ## Methods | Method | Return Type | Description | |:|:--|:-| |[List decisions](../api/accessreviewinstance-list-decisions.md) (from an access review instance) | [accessReviewInstanceDecisionItem](accessreviewinstancedecisionitem.md) collection | Get a list of the [accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) objects and their properties.|-|[List decisions](../api/accessreviewstage-list-decisions.md) (from a stage of an access review instance)|[accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) collection|Get a list of the [accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) objects for a stage of an acecss review instance.| +|[List decisions](../api/accessreviewstage-list-decisions.md) (from a stage of an access review instance)|[accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) collection|Get a list of the [accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) objects for a stage of an access review instance.| |[Get accessReviewInstanceDecisionItem](../api/accessreviewinstancedecisionitem-get.md)|[accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md)|Read the properties and relationships of an [accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) object.| |[Update accessReviewInstanceDecisionItem](../api/accessreviewinstancedecisionitem-update.md) | None. | For any accessReviewInstanceDecisionItems that the calling user is assigned a reviewer on, calling user can record a decision by patching the decision object. | |[filterByCurrentUser](../api/accessreviewinstancedecisionitem-filterbycurrentuser.md)|[accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) collection|Retrieves all [accessReviewInstanceDecisionItems](accessreviewinstancedecisionitem.md) objects where the calling use is the reviewer for a given [accessReviewInstance](accessreviewinstance.md).|-|[List accessReviewInstanceDecisionItems pending approval (deprecated)](../api/accessreviewinstancedecisionitem-listpendingapproval.md) | [accessReviewInstanceDecisionItem](accessreviewinstancedecisionitem.md) collection. | Get all accessReviewInstanceDecisionItems assigned to the calling user, for a specific accessReviewInstance. This method is being deprecated and replaced by [filterByCurrentUser](../api/accessreviewinstancedecisionitem-filterbycurrentuser.md). | +|[List accessReviewInstanceDecisionItems pending approval (deprecated)](../api/accessreviewinstancedecisionitem-listpendingapproval.md) | [accessReviewInstanceDecisionItem](accessreviewinstancedecisionitem.md) collection. | Get all accessReviewInstanceDecisionItems assigned to the calling user, for a specific accessReviewInstance. This method is deprecated and replaced by [filterByCurrentUser](../api/accessreviewinstancedecisionitem-filterbycurrentuser.md). | ## Properties | Property | Type | Description | | :| :- | :- | |accessReviewId|String|The identifier of the accessReviewInstance parent. Supports `$select`. Read-only.| |appliedBy|[userIdentity](../resources/useridentity.md)|The identifier of the user who applied the decision. `00000000-0000-0000-0000-000000000000` if the assigned reviewer hasn't applied the decision or it was automatically applied. Read-only.|-|appliedDateTime|DateTimeOffset|The timestamp when the approval decision was applied. 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`. Supports `$select`. Read-only.| -|applyResult|String|The result of applying the decision. Possible values: `New`, `AppliedSuccessfully`, `AppliedWithUnknownFailure`, `AppliedSuccessfullyButObjectNotFound` and `ApplyNotSupported`. Supports `$select`, `$orderby`, and `$filter` (`eq` only). Read-only.| +|appliedDateTime|DateTimeOffset|The timestamp when the approval decision was applied. 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`. Supports `$select`. Read-only.| +|applyResult|String|The result of applying the decision. Possible values: `New`, `AppliedSuccessfully`, `AppliedWithUnknownFailure`, `AppliedSuccessfullyButObjectNotFound`, and `ApplyNotSupported`. Supports `$select`, `$orderby`, and `$filter` (`eq` only). Read-only.| |decision|String|Result of the review. Possible values: `Approve`, `Deny`, `NotReviewed`, or `DontKnow`. Supports `$select`, `$orderby`, and `$filter` (`eq` only). | |id|String| The identifier of the decision. Inherited from [entity](../resources/entity.md). Supports `$select`. Read-only.| |justification|String|Justification left by the reviewer when they made the decision.|-| target | [accessReviewInstanceDecisionItemTarget](accessreviewinstancedecisionitemtarget.md) | The target of this specific decision. Decision targets can be of different types ΓÇô each one with its own specific properties. See [accessReviewInstanceDecisionItemTarget](accessreviewinstancedecisionitemtarget.md). Read-only. <br/> This property has been replaced by the `principal` and `resource` properties in v1.0.| +| target | [accessReviewInstanceDecisionItemTarget](accessreviewinstancedecisionitemtarget.md) | The target of this specific decision. Decision targets can be of different types ΓÇô each one with its own specific properties. See [accessReviewInstanceDecisionItemTarget](accessreviewinstancedecisionitemtarget.md). Read-only. <br/> This property is replaced by the `principal` and `resource` properties in v1.0.| |principal|[identity](../resources/identity.md)|Every decision item in an access review represents a principal's access to a resource. This property represents details of the principal. For example, if a decision item represents access of User "Bob" to Group "Sales" - The principal is "Bob" and the resource is "Sales". Principals can be of two types - userIdentity and servicePrincipalIdentity. Supports `$select`. Read-only.| |principalLink|String|Link to the principal object. For example: `https://graph.microsoft.com/v1.0/users/a6c7aecb-cbfd-4763-87ef-e91b4bd509d9`. Read-only.|-|recommendation|String|A system-generated recommendation for the approval decision based off last interactive sign-in to tenant. Recommend approve if sign-in is within thirty days of start of review. Recommend deny if sign-in is greater than thirty days of start of review. Recommendation not available otherwise. Possible values: `Approve`, `Deny`, or `NoInfoAvailable`. Supports `$select`, `$orderby`, and `$filter` (`eq` only). Read-only.| +|recommendation|String|A system-generated recommendation for the approval decision based off last interactive sign-in to tenant. Recommend approve if sign-in is within 30 days of start of review. Recommend deny if sign-in is greater than 30 days of start of review. Recommendation not available otherwise. Possible values: `Approve`, `Deny`, or `NoInfoAvailable`. Supports `$select`, `$orderby`, and `$filter` (`eq` only). Read-only.| |resource|[accessReviewInstanceDecisionItemResource](../resources/accessreviewinstancedecisionitemresource.md)|Every decision item in an access review represents a principal's access to a resource. This property represents details of the resource. For example, if a decision item represents access of User "Bob" to Group "Sales" - The principal is Bob and the resource is "Sales". Resources can be of multiple types. See [accessReviewInstanceDecisionItemResource](../resources/accessreviewinstancedecisionitemresource.md). Read-only.| |resourceLink|String|A link to the resource. For example, `https://graph.microsoft.com/v1.0/servicePrincipals/c86300f3-8695-4320-9f6e-32a2555f5ff8`. Supports `$select`. Read-only.| |reviewedBy|[userIdentity](../resources/useridentity.md)| The identifier of the reviewer. `00000000-0000-0000-0000-000000000000` if the assigned reviewer hasn't reviewed. Supports `$select`. Read-only.| Represents a Microsoft Entra [access review](accessreviewsv2-overview.md) decisi | Relationship | Type |Description| |:|:--|:-|-| instance |[accessReviewInstance](accessreviewinstance.md) | There is exactly one accessReviewInstance associated with each decision. The instance is the parent of the decision item, representing the recurrence of the access review the decision is made on. | +| instance |[accessReviewInstance](accessreviewinstance.md) | There's exactly one accessReviewInstance associated with each decision. The instance is the parent of the decision item, representing the recurrence of the access review the decision is made on. | | insights |[governanceInsight](governanceinsight.md) collection | Insights are recommendations to reviewers on whether to approve or deny a decision. There can be multiple insights associated with an **accessReviewInstanceDecisionItem**. | |
v1.0 | Accessreviewinstancedecisionitemserviceprincipaltarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewinstancedecisionitemserviceprincipaltarget.md | Inherits from [accessReviewInstanceDecisionItemTarget](../resources/accessreview ## Properties | Property | Type | Description | | : | : | :- |-| servicePrincipalID | String | The identifier of the service principal whose access is being reviewed. | +| servicePrincipalId | String | The identifier of the service principal whose access is being reviewed. | | servicePrincipalDisplayName | String | The display name of the service principal whose access is being reviewed. | | appId | String | The appId for the service principal entity being reviewed. | |
v1.0 | Accessreviewnotificationrecipientitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewnotificationrecipientitem.md | None. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Accessreviewnotificationrecipientscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewnotificationrecipientscope.md | Title: "accessreviewnotificationrecipientscope resource type" + Title: "accessReviewNotificationRecipientScope resource type" description: "Represents who will receive access review notifications." ms.localizationpriority: medium-# accessreviewnotificationrecipientscope resource type +# accessReviewNotificationRecipientScope resource type Namespace: microsoft.graph None. 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.accessReviewNotificationRecipientScope" |
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 is 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 such as Global Administrator or Azure subscription roles. This capability is included in [Microsoft Entra Privileged Identity Management](privilegedidentitymanagement-root.md). 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). The following table lists the methods that you can use to interact with access r The following directory roles are required for a calling user to manage access reviews, programs, and controls. -| Target resource | Operation | Application permissions | Required directory role of the calling user | +| Target resource | Operation | Application permissions | Least privileged directory roles of the calling user | |:-|:|:|:--|-|[accessReview](accessreview.md) of a Microsoft Entra role | Read | AccessReview.Read.All or AccessReview.ReadWrite.All | Global Administrator, Global Reader, Security Administrator, Security Reader or Privileged Role Administrator | -|[accessReview](accessreview.md) of a Microsoft Entra role | Create, Update or Delete | AccessReview.ReadWrite.All | Global Administrator or Privileged Role Administrator | -|[accessReview](accessreview.md) of a group or app | Read | AccessReview.Read.All, AccessReview.ReadWrite.Membership or AccessReview.ReadWrite.All | Global Administrator, Global Reader, Security Administrator, Security Reader or User Administrator | -|[accessReview](accessreview.md) of a group or app | Create, Update or Delete | AccessReview.ReadWrite.Membership or AccessReview.ReadWrite.All | Global Administrator or User Administrator | -| [program](program.md) and [programControl](programcontrol.md)| Read | ProgramControl.Read.All or ProgramControl.ReadWrite.All | Global Administrator, Global Reader, Security Administrator, Security Reader or User Administrator | -| [program](program.md) and [programControl](programcontrol.md) | Create, Update or Delete | ProgramControl.ReadWrite.All | Global Administrator or User Administrator | +|[accessReview](accessreview.md) of a Microsoft Entra role | Read | AccessReview.Read.All or AccessReview.ReadWrite.All | Global Reader, Security Administrator, Security Reader or Privileged Role Administrator | +|[accessReview](accessreview.md) of a Microsoft Entra role | Create, Update, or Delete | AccessReview.ReadWrite.All | Privileged Role Administrator | +|[accessReview](accessreview.md) of a group or app | Read | AccessReview.Read.All, AccessReview.ReadWrite.Membership, or AccessReview.ReadWrite.All | Global Reader, Security Administrator, Security Reader, or User Administrator | +|[accessReview](accessreview.md) of a group or app | Create, Update, or Delete | AccessReview.ReadWrite.Membership or AccessReview.ReadWrite.All | User Administrator | +| [program](program.md) and [programControl](programcontrol.md)| Read | ProgramControl.Read.All or ProgramControl.ReadWrite.All | Global Reader, Security Administrator, Security Reader or User Administrator | +| [program](program.md) and [programControl](programcontrol.md) | Create, Update, or Delete | ProgramControl.ReadWrite.All | User Administrator | In addition, a user who is an assigned reviewer of an access review can manage their decisions, without needing to be in a directory role. |
v1.0 | Accessreviewscheduledefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewscheduledefinition.md | An accessReviewScheduleDefinition contains a list of [accessReviewInstance](acce | lastModifiedDateTime | DateTimeOffset | Timestamp when the access review series was last modified. Supports `$select`. Read-only.| | reviewers |[accessReviewReviewerScope](../resources/accessreviewreviewerscope.md) collection| This collection of access review scopes is used to define who are the reviewers. The reviewers property is only updatable if individual users are assigned as reviewers. Required on create. Supports `$select`. 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 will be ignored if reviewers are assigned through the **stageSettings** property. | | scope |[accessReviewScope](../resources/accessreviewscope.md) | Defines the entities whose access is reviewed. For supported scopes, see [accessReviewScope](accessreviewscope.md). Required on create. Supports `$select` and `$filter` (`contains` only). For examples of options for configuring scope, see [Configure the scope of your access review definition using the Microsoft Graph API](/graph/accessreviews-scope-concept). |-|stageSettings|[accessReviewStageSettings](../resources/accessreviewstagesettings.md) collection| Required only for a multi-stage access review to define the stages and their settings. You can break down each review instance into up to three sequential stages, where each stage can have a different set of reviewers, fallback reviewers, and settings. Stages are created sequentially based on the **dependsOn** property. Optional. <br/><br/>When this property is defined, its settings are used instead of the corresponding settings in the [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) object and its **settings**, **reviewers**, and **fallbackReviewers** properties. | +| stageSettings|[accessReviewStageSettings](../resources/accessreviewstagesettings.md) collection| Required only for a multi-stage access review to define the stages and their settings. You can break down each review instance into up to three sequential stages, where each stage can have a different set of reviewers, fallback reviewers, and settings. Stages are created sequentially based on the **dependsOn** property. Optional. <br/><br/>When this property is defined, its settings are used instead of the corresponding settings in the [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) object and its **settings**, **reviewers**, and **fallbackReviewers** properties. | | settings |[accessReviewScheduleSettings](../resources/accessreviewschedulesettings.md)| The settings for an access review series, see type definition below. Supports `$select`. Required on create. | | status |String | This read-only field specifies the status of an access review. The typical states include `Initializing`, `NotStarted`, `Starting`, `InProgress`, `Completing`, `Completed`, `AutoReviewing`, and `AutoReviewed`. <br>Supports `$select`, `$orderby`, and `$filter` (`eq` only). Read-only. | | backupReviewers (deprecated) |[accessReviewReviewerScope](../resources/accessreviewreviewerscope.md) collection| This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers are notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner doesn't exist, or manager is specified as reviewer but a user's manager doesn't exist. Supports `$select`. <br>**Note:** This property has been replaced by **fallbackReviewers**. However, specifying either **backupReviewers** or **fallbackReviewers** automatically populates the same values to the other property. | An accessReviewScheduleDefinition contains a list of [accessReviewInstance](acce | `instances` |[accessReviewInstance](accessreviewinstance.md) collection | If the `accessReviewScheduleDefinition` is a recurring access review, instances represent each recurrence. A review that doesn't recur will have exactly one instance. Instances also represent each unique resource under review in the `accessReviewScheduleDefinition`. If a review has multiple resources and multiple instances, each resource has a unique instance for each recurrence. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accessreviewstagesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewstagesettings.md | Represents the settings of the stages associated with a [multi-stage access revi |stageId|String|Unique identifier of the **accessReviewStageSettings**. The **stageId** is used in **dependsOn** property to indicate the stage relationship. Required. | ## 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 | Accessreviewsv2 Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewsv2-overview.md | The following table lists the methods that you can use to interact with access r The following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) are required for a calling user to manage access reviews. -| Operation | Application permissions | Required directory role of the calling user | +| Operation | Application permissions | Least privileged directory role of the calling user | |:|:|:--|-| Read | AccessReview.Read.All or AccessReview.ReadWrite.All | Global Administrator, Global Reader, Security Administrator, Security Reader, or User Administrator | -| Create, Update or Delete | AccessReview.ReadWrite.All | Global Administrator or User Administrator | +| Read | AccessReview.Read.All or AccessReview.ReadWrite.All | Global Reader, Security Administrator, Security Reader, or User Administrator | +| Create, Update or Delete | AccessReview.ReadWrite.All | User Administrator | In addition, a user who is an assigned reviewer of an access review can manage their decisions, without needing to be in a directory role. |
v1.0 | Accountswithaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accountswithaccess.md | description: "Contains information on external AWS accounts that have access to ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Actionsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/actionsummary.md | description: "Contains information on the number of authorization system actions ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Activeusersbreakdownmetric | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/activeusersbreakdownmetric.md | - Title: "activeUsersBreakdownMetric resource type (deprecated)" -description: "Represents breakdown insights of daily and monthly user activity on apps registered in your tenant that is configured for Microsoft Entra External ID for customers." ---doc_type: resourcePageType ---# activeUsersBreakdownMetric resource type (deprecated) --Namespace: microsoft.graph ---> [!CAUTION] -> The `activeUsersBreakdown` resource type and its associated methods is deprecated and will stop returning data on March 9, 2024. Use the [activeUsersMetric](../resources/activeusersmetric.md) resource and its associated methods instead. --Represents breakdown insights of daily and monthly user activity on apps registered in your tenant that is configured for Microsoft Entra External ID for customers. --Inherits from [entity](../resources/entity.md). --## Methods -|Method|Return type|Description| -|:|:|:| -|[List daily activeUsersBreakdown](../api/dailyuserinsightmetricsroot-list-activeusersbreakdown.md)|[activeUsersBreakdownMetric](../resources/activeusersbreakdownmetric.md) collection|Get a list of daily [activeUsersBreakdown](../resources/activeusersbreakdownmetric.md) objects on apps registered in your tenant configured for Microsoft Entra External ID for customers.| -|[List monthly activeUsersBreakdown](../api/monthlyuserinsightmetricsroot-list-activeusersbreakdown.md)|[activeUsersBreakdownMetric](../resources/activeusersbreakdownmetric.md) collection|Get a list of monthly [activeUsersBreakdown](../resources/activeusersbreakdownmetric.md) objects on apps registered in your tenant configured for Microsoft Entra External ID for customers.| --## Properties -|Property|Type|Description| -|:|:|:| -|appId|String|The ID of the Microsoft Entra application.| -|appName| String|Name of the application users authenticated to.| -|count| Int64|The total number of users who made at least one authentication request within the specified time period.| -|factDate|Date| The date of the insight.| -|id|String|Unique identifier for the **activeUsersBreakdownMetric** object. Inherited from [entity](../resources/entity.md).| -|os| String|The platform for the device that the customers used. Supports `$filter` (`eq`).| --## Relationships -None. --## JSON representation -The following JSON representation shows the resource type. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.activeUsersBreakdownMetric", - "openType": false -} >-``` json -{ - "@odata.type": "#microsoft.graph.activeUsersBreakdownMetric", - "appId": "String", - "appName": "String", - "count": "Int64", - "factDate": "String (date)", - "id": "String (identifier)", - "os": "String" -} -``` - |
v1.0 | Activitybasedtimeoutpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/activitybasedtimeoutpolicy.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Addin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/addin.md | Title: "addIn resource type" -description: "Here's a JSON representation of the resource." +description: "Represents a custom behavior that a consuming service can use to call an app in specific contexts." ms.localizationpriority: medium doc_type: resourcePageType Defines custom behavior that a consuming service can use to call an app in speci ## Properties | Property | Type |Description| |:|:--|:-|-|ID|guid|| -|properties|[keyValue](keyvalue.md) collection|| -|type|string|| +|id|GUID|The unique identifier for the **addIn** object.| +|properties|[keyValue](keyvalue.md) collection|The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the **addIns** collection. Required.| +|type|string|The unique name for the functionality exposed by the app. | ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Administrativeunit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/administrativeunit.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An administrative unit provides a conceptual container for user, group, and device directory objects. Using administrative units, a company administrator can now delegate administrative responsibilities to manage the users, groups, and devices contained within or scoped to an administrative unit to a regional or departmental administrator. This resource is an open type that allows other properties to be passed in. +An administrative unit provides a conceptual container for user, group, and device directory objects. With administrative units, a company administrator can now delegate administrative responsibilities to manage the users, groups, and devices contained within or scoped to an administrative unit to a regional or departmental administrator. For more information about administrative units, see [Administrative units in Microsoft Entra ID](/entra/identity/role-based-access-control/administrative-units). -This resource supports using [delta query](/graph/delta-query-overview) to track incremental additions, deletions, and updates, by providing a [delta](../api/administrativeunit-delta.md) function. --Let's look at an example. Imagine that Contoso Corp is made up of two divisions - a West Coast Division and an East Coast Division. Directory roles at Contoso are scoped to the entire tenant. Lee, a Contoso company administrator, wants to delegate administrative responsibilities, but scope them to the West Coast Division or the East Coast division. Lee can create a *West Coast administrative unit* and place all West Coast users into this administrative unit. Similarly, Lee can create an *East Coast administrative unit*. Now Lee, can start delegating administrative responsibilities to others, but **scoped** to the new administrative units he's created. Lee places Jennifer in a *helpdesk administrator* role **scoped** to the *West Coast administrative unit*. This allows Jennifer to reset any user's password, but only if those users are in the *West Coast administrative unit*. Similarly, Lee places Dave in a *user account administrator* role **scoped** to the *East Coast administrative unit*. This allows Dave to update users, assign licenses and reset any user's password, but only if those users are in the *East Coast administrative unit*. For a video overview, please see [Introduction to Microsoft Entra Administrative Units](https://channel9.msdn.com/Series/Windows-Azure-Active-Directory/Introduction-to-Azure-Active-Directory-Administrative-Units). +This resource is an open type that allows other properties to be passed in. This resource supports: - Adding your own data to custom properties as [extensions](/graph/extensibility-overview). - Using [delta query](/graph/delta-query-overview) to track incremental additions, deletions, and updates, by providing a [delta](../api/user-delta.md) function. - ## Methods -| Method | Return Type | Description | +| Method | Return Type | Description | |:|:--|:-| |[Create](../api/directory-post-administrativeunits.md) | [administrativeUnit](administrativeunit.md) | Create a new administrative unit.| |[List](../api/directory-list-administrativeunits.md) | [administrativeUnit](administrativeunit.md) collection |List properties of all administrativeUnits.| |[Get](../api/administrativeunit-get.md) | [administrativeUnit](administrativeunit.md) |Read properties and relationships of a specific administrativeUnit object.|-|[Update](../api/administrativeunit-update.md) | [administrativeUnit](administrativeunit.md) |Update administrativeUnit object. | +|[Update](../api/administrativeunit-update.md) | [administrativeUnit](administrativeunit.md) |Update administrativeUnit object. | |[Delete](../api/administrativeunit-delete.md) | None |Delete administrativeUnit object. | |[Get delta](../api/administrativeunit-delta.md)|[administrativeUnit](administrativeunit.md)|Get newly created, updated, or deleted **administrativeUnits** without having to perform a full read of the entire resource collection.| |[Add a member](../api/administrativeunit-post-members.md) |[directoryObject](directoryobject.md)| Add a member (user or group).| This resource supports: > [!IMPORTANT] > Specific usage of `$filter` and the `$search` query parameter is 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#administrative-unit-properties). -| Property | Type |Description| +| Property. | Type |Description| |:|:--|:-| |description|String|An optional description for the administrative unit. Supports `$filter` (`eq`, `ne`, `in`, `startsWith`), `$search`.| |displayName|String|Display name for the administrative unit. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderby`.| This resource supports: > Directory extensions and associated data are returned by default while schema extensions and associated data returned only on `$select`. ## Relationships-| Relationship | Type |Description| +| Relationship | Type |Description| |:|:--|:-| |extensions|[extension](extension.md) collection|The collection of open extensions defined for this administrative unit. Nullable.| |members|[directoryObject](directoryobject.md) collection|Users and groups that are members of this administrative unit. Supports `$expand`.| This resource supports: ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Agreementfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/agreementfile.md | Inherits from [agreementFileProperties](agreementfileproperties.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Agreementfilelocalization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/agreementfilelocalization.md | Inherits from [agreementFileProperties](agreementfileproperties.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Agreementfileproperties | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/agreementfileproperties.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Agreementfileversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/agreementfileversion.md | Inherits from [agreementFileProperties](agreementfileproperties.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Alert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/alert.md | Title: "alert resource type" + Title: "alert resource type (deprecated)" description: "Represents potential security issues within a customer's tenant that Microsoft or partner security solutions have identified." ms.localizationpriority: medium -# alert resource type +# alert resource type (deprecated) Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -This resource corresponds to the first generation of alerts in the Microsoft Graph security API, representing potential security issues within a customer's tenant that Microsoft or a partner security solution has identified. +> [!NOTE] +> The legacy alerts API is deprecated and will be removed by April 2026. We recommend that you migrate to the new [alerts and incidents](/graph/api/resources/security-alert) API. ++This resource corresponds to the first generation of alerts in the Microsoft Graph security API, representing potential security issues within a customer's tenant that Microsoft or a partner security solution identifies. This type of alerts federates calling of supported Azure and Microsoft 365 Defender security providers listed in [Use the Microsoft Graph security API](security-api-overview.md#legacy-alerts). It aggregates common alert data among the different domains to allow applications to unify and streamline management of security issues across all integrated solutions. To learn more, see the sample queries in [Graph Explorer](https://developer.micr |assignedTo|String|Name of the analyst the alert is assigned to for triage, investigation, or remediation (supports [update](../api/alert-update.md)).| |azureSubscriptionId|String|Azure subscription ID, present if this alert is related to an Azure resource.| |azureTenantId |String|Microsoft Entra tenant ID. Required. |-|category|String|Category of the alert (for example, credentialTheft, ransomware, etc.).| +|category|String|Category of the alert (for example, credentialTheft, ransomware).| |closedDateTime|DateTimeOffset|Time at which the alert was closed. 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` (supports [update](../api/alert-update.md)).| |cloudAppStates|[cloudAppSecurityState](cloudappsecuritystate.md) collection|Security-related stateful information generated by the provider about the cloud application/s related to this alert.| |comments|String collection|Customer-provided comments on alert (for customer alert management) (supports [update](../api/alert-update.md)).| To learn more, see the sample queries in [Graph Explorer](https://developer.micr |createdDateTime |DateTimeOffset|Time at which the alert was created by the alert provider. 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`. Required.| |description|String|Alert description.| |detectionIds|String collection|Set of alerts related to this alert entity (each alert is pushed to the SIEM as a separate record).|-|eventDateTime |DateTimeOffset|Time at which the event(s) that served as the trigger(s) to generate the alert occurred. 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`. Required.| -|feedback|alertFeedback|Analyst feedback on the alert. Possible values are: `unknown`, `truePositive`, `falsePositive`, `benignPositive`. (supports [update](../api/alert-update.md))| +|eventDateTime |DateTimeOffset|Time at which the event or events that served as the trigger to generate the alert occurred. 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`. Required.| +|feedback|alertFeedback|Analyst feedback on the alert. Possible values are: `unknown`, `truePositive`, `falsePositive`, `benignPositive`. Supports [update](../api/alert-update.md).| |fileStates|[fileSecurityState](filesecuritystate.md) collection|Security-related stateful information generated by the provider about the file(s) related to this alert.| |historyStates|[alertHistoryState](alerthistorystate.md) collection| A collection of **alertHistoryStates** comprising an audit log of all updates made to an alert. | |hostStates|[hostSecurityState](hostsecuritystate.md) collection|Security-related stateful information generated by the provider about the host(s) related to this alert.| To learn more, see the sample queries in [Graph Explorer](https://developer.micr |registryKeyStates|[registryKeyState](registrykeystate.md) collection|Security-related stateful information generated by the provider about the registry keys related to this alert.| |securityResources|[securityResource](securityResource.md) collection|Resources related to current alert. For example, for some alerts this can have the Azure Resource value.| |severity |alertSeverity|Alert severity - set by vendor/provider. Possible values are: `unknown`, `informational`, `low`, `medium`, `high`. Required.|-|sourceMaterials|String collection|Hyperlinks (URIs) to the source material related to the alert, for example, provider's user interface for alerts or log search, etc.| +|sourceMaterials|String collection|Hyperlinks (URIs) to the source material related to the alert, for example, provider's user interface for alerts or log search.| |status |alertStatus|Alert lifecycle status (stage). Possible values are: `unknown`, `newAlert`, `inProgress`, `resolved`. (supports [update](../api/alert-update.md)). Required.|-|tags|String collection|User-definable labels that can be applied to an alert and can serve as filter conditions (for example "HVA", "SAW", etc.) (supports [update](../api/alert-update.md)).| +|tags|String collection|User-definable labels that can be applied to an alert and can serve as filter conditions (for example "HVA", "SAW") (supports [update](../api/alert-update.md)).| |title |String|Alert title. Required.| |triggers|[alertTrigger](alerttrigger.md) collection|Security-related information about the specific properties that triggered the alert (properties appearing in the alert). Alerts might contain information about multiple users, hosts, files, ip addresses. This field indicates which properties triggered the alert generation.| |userStates|[userSecurityState](usersecuritystate.md) collection|Security-related stateful information generated by the provider about the user accounts related to this alert.| None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Allaccountswithaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/allaccountswithaccess.md | description: "Contains information on all external AWS accounts that have access ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Allinboundports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/allinboundports.md | description: "Allows incoming traffic from all ports." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Allowedvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/allowedvalue.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Anonymousguestconversationmember | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/anonymousguestconversationmember.md | Inherits from [conversationMember](../resources/conversationmember.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Apiapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/apiapplication.md | Specifies settings for an application that implements a web API. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Appidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/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 -Indicates the identity of the application that performed the action or was changed. This resource is called by the [directoryAudit](../api/directoryaudit-get.md) API. +Indicates the identity of the application that performed the action or was changed. Includes the IDs and names for the service principal and application. This resource is called by the [directoryAudit](../api/directoryaudit-get.md) API. ## Properties | Property | Type |Description| |:|:--|:-|-|appId|String|Refers to the unique identifier representing Application Id in the Microsoft Entra ID.| +|appId|String|Refers to the unique identifier representing application ID in the Microsoft Entra ID.| |displayName|String|Refers to the application name displayed in the Microsoft Entra admin center.|-|servicePrincipalId|String|Refers to the unique identifier indicating Service Principal Id in Microsoft Entra ID for the corresponding App.| +|servicePrincipalId|String|Refers to the unique identifier indicating service principal ID in Microsoft Entra ID for the corresponding App.| |servicePrincipalName|String|Refers to the Service Principal Name is the Application name in the tenant. | ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Applemanagedidentityprovider | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/applemanagedidentityprovider.md | Retrieve the **developerId**, **serviceId**, **keyId**, and the **certificateDat ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Application | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/application.md | This resource supports: |[Remove password](../api/application-removepassword.md)|[passwordCredential](passwordcredential.md)|Remove a password or secret from an application.| |[Add key](../api/application-addkey.md)|[keyCredential](keycredential.md)|Add a key credential to an application.| |[Remove key](../api/application-removekey.md)|None|Remove a key credential from an application.|-|**Extensions**| | | -| [List extensionProperties](../api/application-list-extensionproperty.md) | [extensionProperty](extensionProperty.md) collection | List extension properties on an application object. | -| [Create extensionProperties](../api/application-post-extensionproperty.md) | [extensionProperty](extensionProperty.md) | Create an extension property on an application object. | -| [Get extensionProperty](../api/extensionproperty-delete.md) | None | Get an extension property from an application object. | -| [Delete extensionProperty](../api/extensionproperty-delete.md) | None | Delete an extension property from an application object. | -|**Federated identity credentials**| | | -| [List federatedIdentityCredential](../api/application-list-federatedidentitycredentials.md) | [federatedIdentityCredential](../resources/federatedidentitycredential.md) collection | List federated identity credentials on an application object. | -| [Create federatedIdentityCredential](../api/application-post-federatedidentitycredentials.md) | [federatedIdentityCredential](../resources/federatedidentitycredential.md) | Create a federated identity credential on an application object. | -| [Get federatedIdentityCredential](../api/federatedidentitycredential-get.md) | [federatedIdentityCredential](../resources/federatedidentitycredential.md) | Retrieve the properties of a federated identity credential. | -| [Update federatedIdentityCredential](../api/federatedidentitycredential-update.md) | None | Update a federated identity credential of an application object. | -| [Delete federatedIdentityCredential](../api/federatedidentitycredential-delete.md) | None | Delete a federated identity credential from an application object. | |**Owners**| | | |[List owners](../api/application-list-owners.md) |[directoryObject](directoryobject.md) collection| Get the owners of an application. | |[Add owner](../api/application-post-owners.md) |[directoryObject](directoryobject.md)| Assign an owner to an application. Application owners can be users or service principals. | |[Remove owner](../api/application-delete-owners.md) |None| Remove an owner from an application. As a recommended best practice, apps should have at least two owners.|-|**Policies**| | | -|[Assign tokenIssuancePolicy](../api/application-post-tokenissuancepolicies.md)| [tokenIssuancePolicy](tokenissuancepolicy.md) collection| Assign a tokenIssuancePolicy to this object.| -|[List tokenIssuancePolicies](../api/application-list-tokenissuancepolicies.md)| [tokenIssuancePolicy](tokenissuancepolicy.md) collection| Get all tokenIssuancePolicies assigned to this object.| -|[Remove tokenIssuancePolicy](../api/application-delete-tokenissuancepolicies.md)| [tokenIssuancePolicy](tokenissuancepolicy.md) collection| Remove a tokenIssuancePolicy from this object.| -|[Assign tokenLifetimePolicy](../api/application-post-tokenlifetimepolicies.md)| [tokenLifetimePolicy](tokenlifetimepolicy.md) collection| Assign a tokenLifetimePolicy to this object.| -|[List tokenLifetimePolicies](../api/application-list-tokenlifetimepolicies.md)| [tokenLifetimePolicy](tokenlifetimepolicy.md) collection| Get all tokenLifetimePolicies assigned to this object.| -|[Remove tokenLifetimePolicy](../api/application-delete-tokenlifetimepolicies.md)| [tokenLifetimePolicy](tokenlifetimepolicy.md) collection| Remove a tokenLifetimePolicy from this object.| |**Verified publisher**| | | |[Set verified publisher](../api/application-setverifiedpublisher.md)| None | Set the verified publisher of an application.| |[Unset verified publisher](../api/application-unsetverifiedpublisher.md)| None | Unset the verified publisher of an application.| This resource supports: | displayName | String | The display name for the application. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderby`. | | groupMembershipClaims | String | Configures the `groups` claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: `None`, `SecurityGroup` (for security groups and Microsoft Entra roles), `All` (this gets all security groups, distribution groups, and Microsoft Entra directory roles that the signed-in user is a member of). | | id | String | Unique identifier for the application object. This property is referred to as **Object ID** in the Microsoft Entra admin center. Inherited from [directoryObject](directoryobject.md). Key. Not nullable. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`). |-| identifierUris | String collection | Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you reference in your API's code, and it must be globally unique. You can use the default value provided, which is in the form `api://<application-client-id>`, or specify a more readable URI like `https://contoso.com/api`. For more information on valid identifierUris patterns and best practices, see [Microsoft Entra application registration security best practices](/azure/active-directory/develop/security-best-practices-for-app-registration#appid-uri-configuration). Not nullable. <br><br>Supports `$filter` (`eq`, `ne`, `ge`, `le`, `startsWith`). | +| identifierUris | String collection | Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you reference in your API's code, and it must be globally unique. You can use the default value provided, which is in the form `api://<appId>`, or specify a more readable URI like `https://contoso.com/api`. For more information on valid identifierUris patterns and best practices, see [Microsoft Entra application registration security best practices](/azure/active-directory/develop/security-best-practices-for-app-registration#appid-uri-configuration). Not nullable. <br><br>Supports `$filter` (`eq`, `ne`, `ge`, `le`, `startsWith`). | | info | [informationalUrl](informationalurl.md) | Basic profile information of the application, such as it's marketing, support, terms of service, and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more information, see [How to: Add Terms of service and privacy statement for registered Microsoft Entra apps](/azure/active-directory/develop/howto-add-terms-of-service-privacy-statement). <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, and `eq` on `null` values). | | isDeviceOnlyAuthSupported | Boolean | Specifies whether this application supports device authentication without a user. The default is `false`. | | isFallbackPublicClient | Boolean | Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is `false`, which means the fallback application type is confidential client such as a web app. There are certain scenarios where Microsoft Entra ID can't determine the client application type. For example, the [ROPC](https://tools.ietf.org/html/rfc6749#section-4.3) flow where the application is configured without specifying a redirect URI. In those cases Microsoft Entra ID interprets the application type based on the value of this property.| This resource supports: | requiredResourceAccess |[requiredResourceAccess](requiredresourceaccess.md) collection| Specifies the resources that the application needs to access. This property also specifies the set of delegated permissions and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. <br/><br/>No more than 50 resource services (APIs) can be configured. Beginning mid-October 2021, the total number of required permissions must not exceed 400. For more information, see [Limits on requested permissions per app](#limits-on-requested-permissions-per-app). Not nullable. <br><br>Supports `$filter` (`eq`, `not`, `ge`, `le`).| | samlMetadataUrl | String | The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable. | | serviceManagementReference | String | References application or service contact information from a Service or Asset Management database. Nullable. |-| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. The possible values are: `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` (default), and `PersonalMicrosoftAccount`. See more in the [table](#signinaudience-values). <br/><br/>The value of this object also limits the number of permissions an app can request. For more information, see [Limits on requested permissions per app](#limits-on-requested-permissions-per-app). <br><br>The value for this property has implications on other app object properties. As a result, if you change this property, you may need to change other properties first. For more information, see [Validation differences for signInAudience](/azure/active-directory/develop/supported-accounts-validation?context=graph/context).<br><br>Supports `$filter` (`eq`, `ne`, `not`).| +| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. The possible values are: `AzureADMyOrg` (default), `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount`, and `PersonalMicrosoftAccount`. See more in the [table](#signinaudience-values). <br/><br/>The value of this object also limits the number of permissions an app can request. For more information, see [Limits on requested permissions per app](#limits-on-requested-permissions-per-app). <br><br>The value for this property has implications on other app object properties. As a result, if you change this property, you may need to change other properties first. For more information, see [Validation differences for signInAudience](/azure/active-directory/develop/supported-accounts-validation?context=graph/context).<br><br>Supports `$filter` (`eq`, `ne`, `not`).| | servicePrincipalLockConfiguration | [servicePrincipalLockConfiguration](servicePrincipalLockConfiguration.md) | Specifies whether sensitive properties of a multitenant application should be locked for editing after the application is provisioned in a tenant. Nullable. `null` by default. | | spa | [spaApplication](../resources/spaapplication.md) | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. | | tags |String collection| Custom strings that can be used to categorize and identify the application. Not nullable. Strings added here also appear in the **tags** property of any associated [service principals](serviceprincipal.md).<br><br>Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`) and `$search`.| | tokenEncryptionKeyId |Guid|Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to. 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.|-| verifiedPublisher | [verifiedPublisher](verifiedPublisher.md) | Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see [Publisher verification](/azure/active-directory/develop/publisher-verification-overview).| | uniqueName | String | The unique identifier that can be assigned to an application and used as an alternate key. Immutable. Read-only. |+| verifiedPublisher | [verifiedPublisher](verifiedPublisher.md) | Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see [Publisher verification](/azure/active-directory/develop/publisher-verification-overview).| | web |[webApplication](webapplication.md)| Specifies settings for a web application. | | windows |[windowsApplication](windowsapplication.md)| Specifies settings for apps running Microsoft Windows and published in the Microsoft Store or Xbox games store.| This resource supports: | Value | Description | |:|:--|-|AzureADMyOrg|Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).| +|AzureADMyOrg|Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant). This is the default value for the **signInAudience** property.| |AzureADMultipleOrgs|Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).|-|AzureADandPersonalMicrosoftAccount|Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant. For authenticating users with Azure AD B2C user flows, use `AzureADandPersonalMicrosoftAccount`. This value allows for the widest set of user identities including local accounts and user identities from Microsoft, Facebook, Google, Twitter, or any OpenID Connect provider. This is the default value for the **signInAudience** property.| +|AzureADandPersonalMicrosoftAccount|Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant. For authenticating users with Azure AD B2C user flows, use `AzureADandPersonalMicrosoftAccount`. This value allows for the widest set of user identities including local accounts and user identities from Microsoft, Facebook, Google, Twitter, or any OpenID Connect provider. | |PersonalMicrosoftAccount|Users with a personal Microsoft account only.| ### Limits on requested permissions per app |
v1.0 | Applicationauthenticationmethodpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/applicationauthenticationmethodpolicy.md | Depending on whether your app is a single tenant or multitenant app, you apply t ## Requirements -- Management of application authentication method policies can be performed by a global administrator, application administrator, or cloud application administrator.+- The least privileged [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) for management of application authentication method policies are Application Administrator and Cloud Application Administrator. - All app policy management operations require a [Microsoft Entra Workload ID Premium license](/azure/active-directory/workload-identities/workload-identities-faqs#what-is-the-cost-of-workload-identities-premium-plan). ## Next steps |
v1.0 | Applicationenforcedrestrictionssessioncontrol | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/applicationenforcedrestrictionssessioncontrol.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Applications Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/applications-api-overview.md | description: "Learn how to manage the lifecycle and settings for Microsoft Entra Last updated : 04/05/2024 ms.localizationpriority: medium |
v1.0 | Applicationsegment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/applicationsegment.md | This resource type is an abstract type that exposes properties used to configure ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.applicationSegment" |
v1.0 | Applicationsigninsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/applicationsigninsummary.md | Title: "applicationSignInDetailedSummary resource type" + Title: "applicationSignInSummary resource type" description: "Represents an application sign-in summary." ms.localizationpriority: medium The following is a JSON representation of the resource. ```json { "appDisplayName": "String",- "appId": "String (identifier)", "failedSignInCount": 1024, "successPercentage": 1024, "successfulSignInCount": 1024 |
v1.0 | Appliedauthenticationeventlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appliedauthenticationeventlistener.md | Represents the [authentication event listeners](authenticationeventlistener.md) 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.appliedAuthenticationEventListener" |
v1.0 | Appliedconditionalaccesspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appliedconditionalaccesspolicy.md | Indicates the attributes related to applied conditional access policy or policie ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Approle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/approle.md | With [appRoleAssignments](approleassignment.md), app roles can be assigned to us ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Approleassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/approleassignment.md | An app role assignment where the assigned principal is a service principal is an ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Appscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appscope.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Archivedprintjob | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/archivedprintjob.md | A record of a "final state" (completed, aborted, or canceled) print job that is ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Assignedcomputeinstancedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/assignedcomputeinstancedetails.md | description: "Represents the details of a list of S3 buckets associated with thi ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Assignedlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/assignedlabel.md | Represents a sensitivity label assigned to a Microsoft 365 group. Sensitivity la ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Assignedlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/assignedlicense.md | Title: "assignedLicense resource type" description: "Represents a license assigned to a user. The **assignedLicenses** property of the user entity is a collection of **assignedLicense**." ms.localizationpriority: medium doc_type: resourcePageType+ Represents a license assigned to a user. The **assignedLicenses** property of th ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Assignedplan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/assignedplan.md | The following table describes the possible statuses for the **capabilityStatus** ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Assignmentreviewsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/assignmentreviewsettings.md | This type has the following properties: ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.assignmentReviewSettings" |
v1.0 | Asyncjobstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/asyncjobstatus.md | description: "This resource provides information on the status of a asynchronous job progress." Last updated 09/10/2017 Title: AsyncJobStatus + Title: asyncJobStatus resource type ms.localizationpriority: medium doc_type: resourcePageType -# AsyncJobStatus resource +# asyncJobStatus resource type Namespace: microsoft.graph Namespace: microsoft.graph This resource provides information on the status of a asynchronous job progress. -The following API calls return **AsyncJobStatus** resources: +The following API calls return **asyncJobStatus** resources: * [Copy Item](../api/driveitem-copy.md) |
v1.0 | Attachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attachment.md | None ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Attachmentbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attachmentbase.md | Inherits from [entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Attachmentinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attachmentinfo.md | Represents the attributes of an attachment. 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.attachmentInfo" |
v1.0 | Attachmentitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attachmentitem.md | Represents attributes of an item to be attached. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Attacksimulationroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attacksimulationroot.md | Title: "attackSimulationRoot resource type" -description: "Represents an abstract type that provides the ability to launch a realistic phishing attack that organizations can learn from." +description: "Represents an abstract type for launching realistic phishing attacks that organizations can learn from." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents an abstract type that provides the ability to launch a realistic phishing attack that organizations can learn from. +Represents an abstract type for launching realistic phishing attacks that organizations can learn from. ## Methods Represents an abstract type that provides the ability to launch a realistic phis | **Training** | | | |[List trainings](../api/attacksimulationroot-list-trainings.md)|[training](../resources/training.md) collection|Get a list of the [training](../resources/training.md) objects and their properties.| |[Get training](../api/training-get.md)|[training](../resources/training.md)|Get an attack simulation [training](../resources/training.md) for a tenant. |-+|[List trainingCampaigns](../api/attacksimulationroot-list-trainingcampaigns.md)|[trainingCampaign](../resources/trainingcampaign.md) collection|Get the trainingCampaign resources from the trainingCampaigns navigation property.| +|[Create trainingCampaign](../api/attacksimulationroot-post-trainingcampaigns.md)|[trainingCampaign](../resources/trainingcampaign.md)|Create a new trainingCampaign object.| ## Properties None. None. |simulationAutomations|[simulationAutomation](../resources/simulationautomation.md) collection|Represents simulation automation created to run on a tenant.| |simulations|[simulation](../resources/simulation.md) collection|Represents an attack simulation training campaign in a tenant.| |trainings|[training](../resources/training.md) collection|Represents details about attack simulation trainings.|+|trainingCampaigns|[trainingCampaign](../resources/trainingcampaign.md) collection|Represents a training campaign in a tenant.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Attendee | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attendee.md | Derived from [attendeeBase](attendeebase.md). ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Attendeeavailability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attendeeavailability.md | The availability of an attendee. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Attendeebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attendeebase.md | Derived from [recipient](recipient.md). ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Authenticationattributecollectioninputconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationattributecollectioninputconfiguration.md | Represents the display configuration of attributes being collected on an attribu 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.authenticationAttributeCollectionInputConfiguration" |
v1.0 | Authenticationcombinationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationcombinationconfiguration.md | Inherits from [entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationcontext | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationcontext.md | For more information about authentication context in conditional access, see the 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.authenticationContext" |
v1.0 | Authenticationcontextclassreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationcontextclassreference.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Authenticationeventlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationeventlistener.md | To customize the authentication process, listeners can be registered which speci - [onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md) resource type - [onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md) resource type +> [!NOTE] +> +> You can have a maximum of 250 event listeners. + Inherits from [entity](../resources/entity.md). ## Methods |Method|Return type|Description| |:|:|:|-|[List authenticationEventListeners](../api/identitycontainer-list-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md) collection|Retrieve a list of the following object types derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Create authenticationEventListener](../api/identitycontainer-post-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Create a new [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Get authenticationEventListener](../api/authenticationeventlistener-get.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Read the properties and relationships of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Update authenticationEventListener](../api/authenticationeventlistener-update.md)|None|Update the properties of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Delete authenticationEventListener](../api/authenticationeventlistener-delete.md)|None|Delete an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| +|[List](../api/identitycontainer-list-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md) collection|Retrieve a list of the object types that are derived from **authenticationEventListener**.| +|[Create](../api/identitycontainer-post-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Create a new object type that is derived from **authenticationEventListener**.| +|[Get](../api/authenticationeventlistener-get.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Read the properties and relationships of an object type that is derived from **authenticationEventListener**.| +|[Update](../api/authenticationeventlistener-update.md)|None|Update the properties of an object type that is derived from **authenticationEventListener**.| +|[Delete](../api/authenticationeventlistener-delete.md)|None|Delete an object type that is derived from **authenticationEventListener**.| ## Properties |Property|Type|Description| |
v1.0 | Authenticationeventsflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationeventsflow.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Entity that represents a multi-event policy, that is, a **user flow**, and holds the handler configuration for multiple events. Each property of name *eventType* is optional and corresponds to the handler configuration on the event listener. This is a management level for the atomic authenticationEventListener that allows for managing of multiple listeners under the same priority and condition set. This provides a better managed view of checking which event listeners will be executed under a certain circumstance. +Represents a multi-event policy, that is, a **user flow**, and holds the handler configuration for multiple events. Each property of name *eventType* is optional and corresponds to the handler configuration on the event listener. This resource allows for managing multiple [authenticationEventListener](../resources/authenticationeventlistener.md) objects under the same priority and condition set. This resource provides a better-managed view of checking which event listeners are executed under a certain circumstance. -If no handler is set for an event, then this policy won't effect that event in any authentication, and no listener is created for that event. +If no handler is set for an event, then this policy doesn't effect that event in any authentication, and no listener is created for that event. -Additionally, this entity works as an orchestration step for the various event listeners it manages. For each event listener managed by the entity, it creates, modify, or delete the event listener accordingly. This means on creation time, it creates multiple event listeners and handles any rollback scenarios for any failing requests. +Additionally, this entity works as an orchestration step for the various event listeners it manages. For each event listener that it manages, it creates, modifies, or deletes the event listener accordingly. This means on creation time, it creates multiple event listeners and manages any rollback scenarios for any failing requests. -This is an abstract type from which the [externalUsersSelfServiceSignUpEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object type is derived. +This resource is an abstract type from which the [externalUsersSelfServiceSignUpEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object type is derived. Inherits from [entity](../resources/entity.md). Inherits from [entity](../resources/entity.md). |[Get](../api/authenticationeventsflow-get.md)|[authenticationEventsFlow](../resources/authenticationeventsflow.md)|Read the properties and relationships of an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. Only objects of the [externalUserSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) subtype are available.| |[Update](../api/authenticationeventsflow-update.md)|None|Update the properties of an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. Only objects of the [externalUserSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) subtype are available.| |[Delete](../api/authenticationeventsflow-delete.md)|None|Delete an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. Only objects of the [externalUserSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) subtype are supported. |-|[List linked applications](../api/authenticationconditionsapplications-list-includeapplications.md)|[authenticationConditionApplication](../resources/authenticationconditionapplication.md) collection|List listeners associated with an external identities self-service sign-up user flow.| -|[Add linked application](../api/authenticationconditionsapplications-post-includeapplications.md)|None|List listeners associated with an external identities self-service sign-up user flow.| -|[Remove linked application](../api/authenticationconditionapplication-delete.md)|None|List listeners associated with an external identities self-service sign-up user flow.| +|**Identity providers in a user flow**||| +|[List](../api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders.md)|[identityProviderBase](../resources/identityproviderbase.md) collection|Get the identity providers that are defined for an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object type.| +|[Add](../api/onauthenticationmethodloadstartexternalusersselfservicesignup-post-identityproviders.md)|None|Add an identity provider to an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object type. The identity provider must first be configured in the tenant.| +|[Remove](../api/onauthenticationmethodloadstartexternalusersselfservicesignup-delete-identityproviders.md)|None|Remove an identity provider from an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object type.| +|**User flow attributes**||| +|[List](../api/identityuserflowattribute-list.md)|identityUserFlowAttributes collection|Retrieve all built-in and custom user flow attributes.| +|[Create](../api/identityuserflowattribute-post.md)|identityUserFlowAttribute|Create a new custom user flow attribute.| +|[Get](../api/identityuserflowattribute-get.md) |identityUserFlowAttribute|Retrieve properties of a user flow attribute.| +|[Update](../api/identityuserflowattribute-update.md)|None|Update a custom user flow attribute.| +|[Delete](../api/identityuserflowattribute-delete.md)|None|Delete a custom user flow attribute.| +|[List attributes in a user flow](../api/onattributecollectionexternalusersselfservicesignup-list-attributes.md)|None|Get the collection of **identityUserFlowAttribute** objects associated with an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|[List attributes in a user flow](../api/onattributecollectionexternalusersselfservicesignup-list-attributes.md)|None|Get the collection of **identityUserFlowAttribute** objects associated with an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|[Add attribute to a user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md)|None|Add an **identityUserFlowAttribute** object associated with an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|[Remove attribute from a user flow](../api/onattributecollectionexternalusersselfservicesignup-delete-attributes.md)|None|Remove an **identityUserFlowAttribute** object associated with an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|**Linked applications**||| +|[List](../api/authenticationconditionsapplications-list-includeapplications.md)|[authenticationConditionApplication](../resources/authenticationconditionapplication.md) collection|List the applications linked to an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|[Add](../api/authenticationconditionsapplications-post-includeapplications.md)|None|Add an application to an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|[Remove](../api/authenticationconditionapplication-delete.md)|None|Remove an application from an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| ## Properties |Property|Type|Description| |:|:|:|-|id|String|The unique identifier for the entity. Read-only. Inherited from [entity](../resources/entity.md). Auto-generated.| +|id|String|The unique identifier for the entity. Read-only. Inherited from [entity](../resources/entity.md). Autogenerated.| |displayName|String|Required. The display name for the events policy.| |description|String|The description of the events policy.|-|conditions|[authenticationConditions](../resources/authenticationconditions.md)|The conditions representing the context of the authentication request that will be used to decide whether the events policy will be invoked.| +|conditions|[authenticationConditions](../resources/authenticationconditions.md)|The conditions representing the context of the authentication request that's used to decide whether the events policy is invoked.| |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. Defaults to 500.| ## Relationships None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationeventspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationeventspolicy.md | A resource that specifies the events in the authentication experience, with each ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationflowspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationflowspolicy.md | Represents the [policy configuration of self-service sign-up experience](../reso None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationlistener.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationmethodconfiguration.md | Title: "authenticationMethodConfigurations" -description: "authenticationMethodConfigurations object." +description: "An abstract type that represents the settings for each authentication method." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -This is an abstract type that represents the settings for each authentication method. It has the configuration of whether a specific authentication method is enabled or disabled for the tenant and which users and groups can register and use that method. +An abstract type that represents the settings for each authentication method. It has the configuration of whether a specific authentication method is enabled or disabled for the tenant and which users and groups can register and use that method. The following authentication methods are derived from the **authenticationMethodConfiguration** resource type: + [emailAuthenticationMethodConfiguration](emailauthenticationmethodconfiguration.md)++ [externalAuthenticationMethodConfiguration](externalauthenticationmethodconfiguration.md) + [fido2AuthenticationMethodConfiguration](fido2authenticationmethodconfiguration.md) + [hardwareOathAuthenticationMethodConfiguration](hardwareoathauthenticationmethodconfiguration.md) + [microsoftAuthenticatorAuthenticationMethodConfiguration](microsoftauthenticatorauthenticationmethodconfiguration.md) The following authentication methods are derived from the **authenticationMethod None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationmethodspolicies Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationmethodspolicies-overview.md | The authentication method policies APIs are used to manage policy settings. For |Authentication method policy | Description | |:|:| |[emailauthenticationmethodconfiguration](emailauthenticationmethodconfiguration.md)|Define users who can use email OTP on the Microsoft Entra tenant.|+|[externalauthenticationmethodconfiguration](externalauthenticationmethodconfiguration.md) (preview)|Define users who can use an external authentication method to satisfy the second factor of Microsoft Entra ID multifactor authentication requirements.| |[fido2authenticationmethodconfiguration](fido2authenticationmethodconfiguration.md)| Define FIDO2 security key restrictions and users who can use them to sign in to Microsoft Entra ID.| |[hardwareOathAuthenticationMethodConfiguration](hardwareoathauthenticationmethodconfiguration.md)| Define users who can use hardware OATH tokens to sign in to Microsoft Entra ID.| |[microsoftauthenticatorauthenticationmethodconfiguration](microsoftauthenticatorauthenticationmethodconfiguration.md)|Define users who can use Microsoft Authenticator on the Microsoft Entra tenant.| |
v1.0 | Authenticationmethodspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationmethodspolicy.md | Defines authentication methods and the users that are allowed to use them to sig |authenticationMethodConfigurations|[authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md) collection|Represents the settings for each authentication method. Automatically expanded on `GET /policies/authenticationMethodsPolicy`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationmethodsroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationmethodsroot.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Authenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationmethodtarget.md | Namespace: microsoft.graph A collection of groups that are enabled to use an authentication method as part of an authentication method policy in Microsoft Entra ID. Inherits from [entity](entity.md). +The following types are derived from this resource type: +- [microsoftAuthenticatorAuthenticationMethodTarget](../resources/microsoftauthenticatorauthenticationmethodtarget.md) +- [smsAuthenticationMethodTarget](../resources/smsauthenticationmethodtarget.md) +- [voiceAuthenticationMethodTarget](../resources/voiceauthenticationmethodtarget.md) + ## Properties |Property|Type|Description| A collection of groups that are enabled to use an authentication method as part None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationrequirementpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationrequirementpolicy.md | Microsoft Entra ID can require users to pass an MFA check before accessing resou |Property|Type|Description| |:|:|:| |detail|String|Provides additional detail on the feature identified in requirementProvider.|-|requirementProvider|requirementProvider|Identifies what Microsoft Entra feature requires MFA in this policy. Possible values are: `user`, `request`, `servicePrincipal`, `v1ConditionalAccess`, `multiConditionalAccess`, `tenantSessionRiskPolicy`, `accountCompromisePolicies`, `v1ConditionalAccessDependency`, `v1ConditionalAccessPolicyIdRequested`, `mfaRegistrationRequiredByIdentityProtectionPolicy`, `baselineProtection`, `mfaRegistrationRequiredByBaselineProtection`, `mfaRegistrationRequiredByMultiConditionalAccess`, `enforcedForCspAdmins`, `securityDefaults`, `mfaRegistrationRequiredBySecurityDefaults`, `proofUpCodeRequest`, `crossTenantOutboundRule`, `gpsLocationCondition`, `riskBasedPolicy`, `unknownFutureValue`.| +|requirementProvider|requirementProvider|Identifies what Microsoft Entra feature requires MFA in this policy. Possible values are: `user`, `request`, `servicePrincipal`, `v1ConditionalAccess`, `multiConditionalAccess`, `tenantSessionRiskPolicy`, `accountCompromisePolicies`, `v1ConditionalAccessDependency`, `v1ConditionalAccessPolicyIdRequested`, `mfaRegistrationRequiredByIdentityProtectionPolicy`, `baselineProtection`, `mfaRegistrationRequiredByBaselineProtection`, `mfaRegistrationRequiredByMultiConditionalAccess`, `enforcedForCspAdmins`, `securityDefaults`, `mfaRegistrationRequiredBySecurityDefaults`, `proofUpCodeRequest`, `crossTenantOutboundRule`, `gpsLocationCondition`, `riskBasedPolicy`, `unknownFutureValue`, `scopeBasedAuthRequirementPolicy`, `authenticationStrengths` . Also, note that 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): `scopeBasedAuthRequirementPolicy`, `authenticationStrengths`.| ## Relationships None. |
v1.0 | Authenticationsourcefilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationsourcefilter.md | 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.authenticationSourceFilter" |
v1.0 | Authorizationinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authorizationinfo.md | Title: "authorizationInfo resource type" description: "Represents the identifiers that can be used to identify and authenticate a user in non-Azure AD environments." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Authorizationpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authorizationpolicy.md | Represents a policy that can control Microsoft Entra authorization settings. It' |enabledPreviewFeatures|String collection| List of features enabled for private preview on the tenant. | |guestUserRoleId|Guid| Represents role templateId for the role that should be granted to guests. Refer to [List unifiedRoleDefinitions](../api/rbacapplication-list-roledefinitions.md) to find the list of available role templates. Currently following roles are supported: *User* (`a0b1b346-4d3e-4e8b-98f8-753987be4970`), *Guest User* (`10dae51f-b6af-4016-8d66-8c2a99b929b3`), and *Restricted Guest User* (`2af84b1e-32c8-42b7-82bc-daa82404023b`). | |id|String| ID of the authorization policy. Required. Read-only.|-|permissionGrantPolicyIdsAssignedToDefaultUserRole|String collection|Indicates if user consent to apps is allowed, and if it is, which app consent policy (permissionGrantPolicy) governs the permission for users to grant consent. Values should be in the format `managePermissionGrantsForSelf.{id}`, where `{id}` is the **id** of a built-in or custom [app consent policy](/azure/active-directory/manage-apps/manage-app-consent-policies). An empty list indicates user consent to apps is disabled. | +|permissionGrantPolicyIdsAssignedToDefaultUserRole|String collection|Indicates if user consent to apps is allowed, and if it is, the [app consent policy](../resources/permissiongrantpolicy.md) that governs the permission for users to grant consent. Values should be in the format `managePermissionGrantsForSelf.{id}` for user consent policies or `managePermissionGrantsForOwnedResource.{id}` for resource-specific consent policies, where `{id}` is the **id** of a built-in or custom app consent policy. An empty list indicates user consent to apps is disabled. | ### allowInvitesFrom values |
v1.0 | Authorizationsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authorizationsystem.md | description: "Represents a Microsoft Azure subscription, Amazon Web Services (AW ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Authorizationsystemidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authorizationsystemidentity.md | description: "A container representing an identity in an authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Authorizationsystemidentitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authorizationsystemidentitysource.md | description: "Represents the source for an authorization system identity." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Authorizationsysteminfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authorizationsysteminfo.md | description: "Represents the authorization system's identifying information." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Authorizationsystemresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authorizationsystemresource.md | description: "Represents a resource in an authorization system onboarded to Perm ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Authorizationsystemtypeaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authorizationsystemtypeaction.md | description: "Represents an action in an authorization system onboarded to Permi ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Authorizationsystemtypeservice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authorizationsystemtypeservice.md | description: "Represents a service in an authorization system that is onboarded ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Automaticrepliesmailtips | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/automaticrepliesmailtips.md | Namespace: microsoft.graph ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Automaticrepliessetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/automaticrepliessetting.md | respond to emails. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Availabilityitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/availabilityitem.md | Indicates the status of a [staff member](bookingstaffmember.md) for a given time ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Averagecomparativescore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/averagecomparativescore.md | Title: " averageComparativeScore resource type" -description: "This resource contains various different scores based by different scopes (for example, average by industry vertical, average by company seat size, and so on) and control category (Identity, Data, Device, Apps, Infrastructure)." +description: "Contains various different scores based by different scopes and control category." ms.localizationpriority: medium doc_type: resourcePageType -This resource contains various different scores based by different scopes (for example, average by industry vertical, average by company seat size, and so on) and control category (Identity, Data, Device, Apps, Infrastructure). +Contains various scores based on different scopes - such as average by industry vertical or company size - and control category (Identity, Data, Device, Apps, Infrastructure). -|Property |Type |Description | -|:--|:--|:--| -| basis | String | Scope type (By AllTenants, TotalSeats, IndustryTypes). | -| averageScore | Double | Average score within specified basis. | -| deviceScore | Double | Average score within specified basis. | -| dataScore | Double | Average score within specified basis. | -| identityScore | Double | Average score within specified basis. | +## Properties +| Property | Type | Description | +|:--|:-|:| +| basis | String | Scope type (by AllTenants, TotalSeats, IndustryTypes). | +| averageScore | Double | Average score within a specified basis. | +| deviceScore | Double | Average score within a specified basis. | +| dataScore | Double | Average score within a specified basis. | +| identityScore | Double | Average score within a specified basis. | ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Awsaccesskey | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsaccesskey.md | description: "Represents AWS access keys." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsactionspermissionsdefinitionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsactionspermissionsdefinitionaction.md | description: "Represents permissions for an AWS action." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsassociatedidentities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsassociatedidentities.md | description: "A container for the different kinds of AWS identities." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsauthorizationsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsauthorizationsystem.md | description: "Represents an AWS authorization system onboarded to Permissions Ma ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsauthorizationsystemresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsauthorizationsystemresource.md | description: "Represents an AWS resource in an AWS authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsauthorizationsystemtypeaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsauthorizationsystemtypeaction.md | description: "Represents an action in an AWS authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awscondition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awscondition.md | description: "An open type representing a JSON with AWS conditions for an AWS st ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsec2instance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsec2instance.md | description: "Represents AWS EC2 instances." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsexternalsystemaccessfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsexternalsystemaccessfinding.md | description: "Represents findings related to external accounts that are able to ms.localizationpriority: medium+ doc_type: resourcePageType Inherits from [finding](../resources/finding.md). |createdDateTime|DateTimeOffset|Defines when the finding was created. Inherited from [finding](../resources/finding.md).| |id|String|Unique identifier for the finding. Inherited from [entity](../resources/entity.md).| |systemWithAccessId|string|The account ID for the external system that is able to access the given system.|+|systemWithAccess|[authorizationSystemInfo](../resources/authorizationsysteminfo.md)|The external system that is able to access the given system.| |trustedIdentityCount|Int32|The number of identities in the external system that are trusted, if not all. Supports `$orderby`.| |trustsAllIdentities|Boolean|Flag that determines if all identities in the external system are trusted, or only a subset.| |
v1.0 | Awsexternalsystemaccessrolefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsexternalsystemaccessrolefinding.md | description: "Represents the findings for roles that allow for external system a ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsgroup.md | description: "Represents a group in AWS." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsidentity.md | description: "Represents identities in AWS." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsidentityaccessmanagementkeyagefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsidentityaccessmanagementkeyagefinding.md | description: "View the age of AWS IAM Access Keys." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsidentityaccessmanagementkeyusagefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsidentityaccessmanagementkeyusagefinding.md | description: "The IAM access key age represents the number of keys that have not ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsidentitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsidentitysource.md | description: "Represents an permissionsDefinitionIdentitySource for a cross-acco ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awslambda | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awslambda.md | description: "Represents AWS lambda functions." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awspermissionsdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awspermissionsdefinition.md | description: "AWS-specific permissions request details." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awspermissionsdefinitionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awspermissionsdefinitionaction.md | description: "An abstract complex type that represents the action to take in a p ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awspolicy.md | description: "Represents an AWS policy in an AWS authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awspolicypermissionsdefinitionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awspolicypermissionsdefinitionaction.md | description: "Represents permissions for an AWS policy." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsrole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsrole.md | description: "Represents AWS role." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awssecretinformationaccessfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awssecretinformationaccessfinding.md | description: "Represents findings for identities who can access secret informati ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awssecuritytooladministrationfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awssecuritytooladministrationfinding.md | description: "Represents findings for identities with privileges to modify setti ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awssource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awssource.md | description: "Represents an authorization system identity sourced from AWS." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsstatement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsstatement.md | description: "Specifies an AWS statement that includes information about a singl ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Awsuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/awsuser.md | description: "Represents AWS users." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azure Ad Auditlog Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azure-ad-auditlog-overview.md | The directory audit report provides you with access to the history of every task ### Custom security attribute audit logs -Custom security attribute audit logs provide you with the history of activities related to custom security attributes, such as adding a new definition or assigning an attribute value to a user. Custom security attribute audit logs are separate from directory audit logs and have a different endpoint. To view custom security attribute audit logs, you must be assigned the Attribute Log Reader or Attribute Log Administrator role. By default, a Global Administrator does not have access to these audit logs. +Custom security attribute audit logs provide you with the history of activities related to custom security attributes, such as adding a new definition or assigning an attribute value to a user. Custom security attribute audit logs are separate from directory audit logs and have a different endpoint. To view custom security attribute audit logs, you must be assigned the Attribute Log Reader or Attribute Log Administrator role. By default, a Global Administrator doesn't have access to these audit logs. ### Sign-ins |
v1.0 | Azure Ad Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azure-ad-overview.md | - Title: "Working with Microsoft Entra resources in Microsoft Graph" -description: "Microsoft Graph for Microsoft Entra provides REST APIs to help manage your organization, resources, and assets." -doc_type: conceptualPageType -- Previously updated : 11/29/2022---# Working with Microsoft Entra resources in Microsoft Graph ---With Microsoft Graph, you can access [Microsoft Entra](/azure/active-directory/active-directory-whatis) resources to enable scenarios like managing administrator (directory) roles, inviting external users to an organization, and, if you are a [Cloud Solution Provider (CSP)](https://partner.microsoft.com/cloud-solution-provider), managing your customer's data. Microsoft Graph also provides methods apps can use, for example, to discover information about users' transitive group and role memberships. --> **Note**: Some Microsoft Entra resources are documented in other sections of the API reference. For more information, see [Users](users.md) and [Groups](group.md). ---## Authorization --To call the Microsoft Graph APIs on Microsoft Entra resources, your app will need the appropriate permissions. Many of the APIs exposed on Microsoft Entra resources require one of the [_Directory_ permissions](/graph/permissions-reference#directory-permissions). Directory permissions are highly privileged and always require administrator consent. --If your app is acting on behalf of a user (delegated permissions), that user will likely need to be a member of an appropriate [administrator role](/azure/active-directory/active-directory-assign-admin-roles) for your app to successfully call many of the Microsoft Entra APIs. --For more information about permissions, including delegated and application permissions, see [Permissions](/graph/permissions-reference). --## Common use cases --The following table lists some common use cases for Microsoft Entra resources. --| **Use cases** | **REST resources** | **See also** | -|:--|:--|:-| -| **Directory object and methods** | | | -| `directoryObject` is the base class that many directory resources, like users and groups, inherit from. Microsoft Graph exposes several methods that you can use to discover information about users, groups, and other directory objects. For example, you can check for transitive membership in a list of groups, return all the groups and directory roles that a directory object is a transitive member of, or get all the resources of a specified type (like user or group) from a list of generic resource IDs. | [directoryObject](../resources/directoryobject.md) | N/A | -| **Manage directory (administrator) roles, administrative units, directory settings, and policy** | | | -| Activate directory roles in a Microsoft Entra tenant and manage user memberships in directory roles. Directory roles are also known as administrator roles. | [directoryRole](../resources/directoryrole.md) <br/>[directoryRoleTemplate](../resources/directoryroletemplate.md) |[Assigning Microsoft Entra administrator roles](/azure/active-directory/active-directory-assign-admin-roles)| -| Manage administrative units. Directory roles delegate tenant-wide authority to their members. An administrator can create and manage administrative units to delegate more granularly scoped administrative authority to users. | [administrativeUnit](../resources/administrativeunit.md) | [Administrative units management in Microsoft Entra ID](/azure/active-directory/active-directory-administrative-units-management) | -| Apply predefined directory settings across a tenant or to individual resource instances. Currently, only settings for Microsoft 365 groups are supported. Directory settings control behaviors like blocked word lists for group display names, whether guest users are allowed to be group owners, and much more. | [directorySetting](../resources/directorysetting.md) <br/>[directorySettingTemplate](../resources/directorysettingtemplate.md)| [Microsoft Entra cmdlets for configuring group settings](/azure/active-directory/active-directory-accessmanagement-groups-settings-cmdlets)| -| Apply Microsoft Entra policies to applications, service principals, groups, or the entire organization. Policies for claims mapping, token issuance, token lifetime, home realm discovery and more are supported. | [Available policies](../resources/policy-overview.md) | N/A | -| **Secure privileged access in Microsoft Entra** | | | -| Manage and monitor time-bound privileged access to directory and Azure resources for administrators and IT professionals with Privileged Identity Management (PIM). | [Privileged Identity Management API](../resources/privilegedidentitymanagement-root.md) | [What is Microsoft Entra Privileged Identity Management?](/azure/active-directory/active-directory-privileged-identity-management-configure)| -| Monitor identity risk events like users signing in from malware-infected devices or from unfamiliar locations. | [Identity Protection Service API](../resources/identityprotection-overview.md) | [Microsoft Entra ID Protection](/azure/active-directory/active-directory-identityprotection)<br/><br/>[Microsoft Entra risk events](/azure/active-directory/active-directory-reporting-risk-events) | -| **Manage devices** | | | -| Manage devices registered in the organization. Devices are registered to users and include items like laptops, desktops, tablets, and mobile phones. Devices are typically created in the cloud using the Device Registration Service or by Microsoft Intune. They're used by conditional access policies for multifactor authentication. | [device](../resources/device.md) | [Getting started with Microsoft Entra device registration](/mem/intune/enrollment/).<br/><br/>[What is Intune?](/mem/intune/fundamentals/what-is-intune)<br/><br/>[Enroll devices for management in Intune](/mem/intune/enrollment/) | -| **App management** | | | -| Manage app configuration in a developer tenant. | [application](../resources/application.md) | [Application and service principal objects in Microsoft Entra ID](/azure/active-directory/develop/active-directory-application-objects) | -| Manage apps installed in a tenant. | [servicePrinicpal](../resources/serviceprincipal.md) | [Application and service principal objects in Microsoft Entra ID](/azure/active-directory/develop/active-directory-application-objects) | -| Manage permissions consented by users and administrators on apps installed in a tenant. | [oAuth2PermissionGrant](../resources/oauth2permissiongrant.md) | N/A | -| Manage user, group, and service principal role memberships on apps installed in a tenant. | [appRoleAssignment](../resources/approleassignment.md) | N/A | -| **Partner tenant management** | | | -| Get information about partnerships with customer tenants. <br/><br/>**Note:** This applies to partner tenants only. Partner tenants are Microsoft Entra tenants that belong to Microsoft partners who are either part of the [Microsoft Cloud Solution Provider](https://partnercenter.microsoft.com/partner/programs), Office 365 Syndication, or Microsoft Advisor partner programs.| [contract](../resources/contract.md) | [Call Microsoft Graph from a Cloud Solution Provider application](/graph/auth-cloudsolutionprovider) | -| Manage domains associated with a tenant. Domain operations enable registrars to automate domain association for services such as Microsoft 365. | [domain](../resources/domain.md) | [Add a custom domain name to Microsoft Entra ID](/azure/active-directory/active-directory-domains-add-azure-portal) | -| **Tenant management** | | | -| Get information about an organization, such as its business address, technical and notification contacts, the service plans that it's subscribed to, and the domains associated with it. | [organization](../resources/organization.md) | N/A | -| Get information about the service SKUs that a company is subscribed to. | [subscribedSku](../resources/subscribedsku.md) | N/A | -| Invite external (guest) users to an organization. | [invitation](../resources/invitation.md) | [What is Microsoft Entra B2B collaboration?](/azure/active-directory/active-directory-b2b-what-is-azure-ad-b2b)| -| Manage branding for the sign-in experience of an organization. | [organizationalbranding](../resources/organizationalbranding.md) | [Add branding to your organization's Microsoft Entra sign-in page](/azure/active-directory/fundamentals/customize-branding)| -| **Access reviews** | | | -| Ensure group memberships and application access rights are correct with access reviews. | [access reviews API](../resources/accessreviews-root.md) |[Microsoft Entra access reviews](/azure/active-directory/active-directory-azure-ad-controls-access-reviews-overview) | -| **Consent requests** | | | -| Manage the consent request workflow for users attempting to access apps that require admin authorization. | [Consent requests API](../resources/consentrequests-overview.md) |[Configure the admin consent workflow](/azure/active-directory/manage-apps/configure-admin-consent-workflow) | --## Next steps -Directory resources and APIs can open up new ways for you to engage with users and manage their experiences with Microsoft Graph. To learn more: --- Drill down on the methods and properties of the resources most helpful to your scenario.-- Try the API in the [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). |
v1.0 | Azureactionpermissionsdefinitionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureactionpermissionsdefinitionaction.md | description: "Represents Azure actions." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azureassociatedidentities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureassociatedidentities.md | description: "A container for the different kinds of Azure identities." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azureauthorizationsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureauthorizationsystem.md | description: "Represents an Azure authorization system onboarded to Permissions ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azureauthorizationsystemresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureauthorizationsystemresource.md | description: "Represents an Azure resource in an Azure authorization system onbo ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azureauthorizationsystemtypeaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureauthorizationsystemtypeaction.md | description: "Represents an action in an Azure authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azuregroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azuregroup.md | description: "Represents a group in an Azure authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azureidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureidentity.md | description: "Represents identities in Azure including managed identities, servi ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azuremanagedidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azuremanagedidentity.md | description: "Represents a managed idetity object in an Azure authorization syst ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azurepermissionsdefinitionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azurepermissionsdefinitionaction.md | description: "This is an abstract type representing actions relating to permissi ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azureroledefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureroledefinition.md | description: "Represents an Azure role in an Azure authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azurerolepermissionsdefinitionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azurerolepermissionsdefinitionaction.md | description: "Represents permissions for an Azure role." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azureserverlessfunction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureserverlessfunction.md | description: "Represents a serverless function in an Azure authorization system. ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azureserviceprincipal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureserviceprincipal.md | description: "Represents a service principal in an Azure authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azuresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azuresource.md | description: "Represents an authorization system identity sourced from Microsoft ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Azureuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureuser.md | description: "Represents a user in an Azure authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | B2cauthenticationmethodspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/b2cauthenticationmethodspolicy.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | B2cidentityuserflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/b2cidentityuserflow.md | To help you set up the most common identity tasks for your applications, Azure A | Relationship | Type |Description| |:|:--|:-|-|userflowIdentityProviders|[identityProviderBase](../resources/identityproviderbase.md) collection|The identity providers included in the user flow.| +|userFlowIdentityProviders|[identityProviderBase](../resources/identityproviderbase.md) collection|The identity providers included in the user flow.| |identityProviders (deprecated)|[identityProvider](../resources/identityprovider.md) collection|The identity providers included in the user flow.| |userAttributeAssignments|[identityUserFlowAttributeAssignment](../resources/identityuserflowattributeassignment.md) collection|The user attribute assignments included in the user flow.| |languages|[userFlowLanguageConfiguration](../resources/userflowlanguageconfiguration.md) collection|The languages supported for customization within the user flow. Language customization is not enabled by default in B2C user flows.| The following is a JSON representation of the resource. "userFlowTypeVersion": "Single", "isLanguageCustomizationEnabled": "Boolean", "defaultLanguageTag": "String",- "userflowidentityProviders": [{"@odata.type": "microsoft.graph.identityProviderBase"}], + "userFlowIdentityProviders": [{"@odata.type": "microsoft.graph.identityProviderBase"}], "identityProviders": [{"@odata.type": "microsoft.graph.identityProvider"}], "userAttributeAssignments": [{"@odate.type": "microsoft.graph.identityUserFlowAttributeAssignment"}], "languages": [{"@odata.type": "microsoft.graph.userFlowLanguageConfiguration"}], |
v1.0 | B2xidentityuserflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/b2xidentityuserflow.md | User flows are used to enable a [self-service sign up](/azure/active-directory/e ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Baseitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/baseitem.md | Here's a JSON representation of a **baseItem** resource. | Property | Type | Description | | :- | :- | :- |+| description | string | The description of the item. | | id | string | The unique identifier of the drive. Read-only. |-| createdBy | [identitySet][] | Identity of the user, device, or application that created the item. Read-only. | +| createdBy | [identitySet][] | Identity of the user, device, or application that created the item. Read-only. | | createdDateTime | dateTimeOffset | Date and time of item creation. Read-only. | | eTag | string | ETag for the item. Read-only. |-| lastModifiedBy | [identitySet][] | Identity of the user, device, and application that last modified the item. Read-only. | +| lastModifiedBy | [identitySet][] | Identity of the user, device, and application that 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. | | parentReference | [itemReference][] | Parent information, if the item has a parent. Read-write. | |
v1.0 | Baseitemversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/baseitemversion.md | Represents a previous version of an item or entity. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.baseItemVersion", "@type.aka": "oneDrive.baseItemVersion" } --> ```json {- "content": { "@odata.type": "Edm.Stream" }, "id": "String (identifier)", "lastModifiedBy": { "@odata.type": "microsoft.graph.identitySet" }, "lastModifiedDateTime": "String (timestamp)", |
v1.0 | Basetasklist | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/basetasklist.md | The following methods apply to any of the derived types of **baseTaskList** (**w |tasks|[baseTask](../resources/basetask.md) collection|The tasks in this task list. Read-only. Nullable.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Basicauthentication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/basicauthentication.md | 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.basicAuthentication" |
v1.0 | Bitlocker | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/bitlocker.md | None. | recoveryKeys | [bitlockerRecoveryKey](../resources/bitlockerrecoverykey.md) collection | The recovery keys associated with the bitlocker entity. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.bitlocker", |
v1.0 | Bookingcurrency | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/bookingcurrency.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Bookingnamedentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/bookingnamedentity.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Bookingperson | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/bookingperson.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Bookingquestionassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/bookingquestionassignment.md | Contains the set of custom questions associated with a particular service. |Property|Type|Description| |:|:|:| |isRequired|Boolean|Indicates whether it's mandatory to answer the custom question. |-|questionId|String|If it's mandatory to answer the custom question. | +|questionId|String|The ID of the custom question. | ## 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.bookingQuestionAssignment" |
v1.0 | Bookingservice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/bookingservice.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Broadcastmeetingcaptionsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/broadcastmeetingcaptionsettings.md | The following table shows the supported language codes for translation languages ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.broadcastMeetingCaptionSettings" |
v1.0 | Broadcastmeetingsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/broadcastmeetingsettings.md | Represents settings related to a [live event](/microsoftteams/teams-live-events/ ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Bucketaggregationdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/bucketaggregationdefinition.md | Provides the details on how to generate the aggregations in the results. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Builtinidentityprovider | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/builtinidentityprovider.md | This type will inherit from [identityProviderBase](../resources/identityprovider ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Businessflowtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/businessflowtemplate.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Calendargroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/calendargroup.md | A group of user calendars. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Calendarpermission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/calendarpermission.md | Once a share recipient or delegate has been set up for a calendar, you can [upda ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Call | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/call.md | https://teams.microsoft.com/l/meetup-join/19:meeting_NTg0NmQ3NTctZDVkZC00YzRhLTh | meetingCapability | [meetingCapability](meetingcapability.md) | Contains the capabilities of a meeting. Read-only. | | meetingInfo | [organizerMeetingInfo](organizermeetinginfo.md), [tokenMeetingInfo](tokenmeetinginfo.md), or [joinMeetingIdMeetingInfo](joinmeetingidmeetinginfo.md) | The meeting information. Required information for meeting scenarios. | |transcription | [callTranscriptionInfo](calltranscriptioninfo.md) | The transcription information for the call. Read-only. |-myParticipantId | String | Read-only. | +| myParticipantId | String | Read-only. | | requestedModalities | modality collection | The list of requested modalities. Possible values are: `unknown`, `audio`, `video`, `videoBasedScreenSharing`, `data`. | | resultInfo | [resultInfo](resultinfo.md) | The result information. For example, the result can hold termination reason. Read-only. | | ringingTimeoutInSeconds | Int32 | Ringing timeout in seconds for outgoing peer to peer calls. The max value for this attribute is 115 seconds. | myParticipantId | String ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. "meetingInfo": {"@odata.type": "#microsoft.graph.meetingInfo"}, "transcription": {"@odata.type": "#microsoft.graph.callTranscriptionInfo"}, "myParticipantId": "String",- "replacesContext": "String", "requestedModalities": ["String"], "resultInfo": {"@odata.type": "#microsoft.graph.resultInfo"}, "ringingTimeoutInSeconds": 99, |
v1.0 | Callrecords Feedbacktokenset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/callrecords-feedbacktokenset.md | Explicit property names won't be documented since the feedback token names can c ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. ], "@odata.type": "microsoft.graph.callRecords.feedbackTokenSet",- "baseType": null + "openType": true }--> ```json |
v1.0 | Callrecords Segment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/callrecords-segment.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Callrecords Session | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/callrecords-session.md | Represents a user-user communication or a user-meeting communication in the case ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Campaignschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/campaignschedule.md | + + Title: "campaignSchedule resource type" +description: "Represents a schedule for launching a campaign." ++ms.localizationpriority: medium +++# campaignSchedule resource type ++Namespace: microsoft.graph +++Represents a schedule for launching a campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|completionDateTime|DateTimeOffset|The date and time at which the campaign completed.| +|launchDateTime|DateTimeOffset|The date and time at which the campaign was launched.| +|status|campaignStatus|The current state of the campaign. The possible values are: `unknown`, `draft`, `inProgress`, `scheduled`, `completed`, `failed`, `cancelled`, `excluded`, `deleted`, `unknownFutureValue`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.campaignSchedule" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.campaignSchedule", + "completionDateTime": "String (timestamp)", + "launchDateTime": "String (timestamp)", + "status": "String" +} +``` + |
v1.0 | Certificateauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/certificateauthority.md | Title: "certificateAuthority resource type" description: "Represents a certificate authority." ms.localizationpriority: medium-+ doc_type: "resourcePageType" |
v1.0 | Certificatebasedauthconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/certificatebasedauthconfiguration.md | Title: "certificateBasedAuthConfiguration resource type" description: "Represents a collection of certificate authorities." ms.localizationpriority: medium-+ doc_type: "resourcePageType" +toc.keywords: [ CBA ] # certificateBasedAuthConfiguration resource type |
v1.0 | Certification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/certification.md | The certification property of an application is read-only, and can't be manually |lastCertificationDateTime|DateTimeOffset|The timestamp when the certification for the application was most recently added or updated.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Certificationcontrol | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/certificationcontrol.md | Namespace: microsoft.graph Contains compliance certification data associated with secure score control. -## Property +## Properties |Property |Type |Description | |:--|:--|:--| |
v1.0 | Change Notifications Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/change-notifications-api-overview.md | description: "Deliver change notifications to clients." ms.localizationpriority: medium doc_type: conceptualPageType+ # Use the Microsoft Graph API to get change notifications |
v1.0 | Changenotification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/changenotification.md | description: "Represents the change notification sent to the subscriber." ms.localizationpriority: medium doc_type: resourcePageType+ # changeNotification resource type |
v1.0 | Changenotificationencryptedcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/changenotificationencryptedcontent.md | description: "A changeNotificationEncryptedContent object represents the encrypt ms.localizationpriority: medium doc_type: resourcePageType+ # changeNotificationEncryptedContent resource type |
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. |[List channel members](../api/channel-list-members.md) | [conversationMember](conversationmember.md) collection | Get the list of members in a channel.| |[Add channel member](../api/channel-post-members.md) | [conversationMember](conversationmember.md) | Add a member to a channel. Only supported for channels with a **membershipType** of `private` or `shared`.| |[Get channel member](../api/channel-get-members.md) | [conversationMember](conversationmember.md) collection | Get a member in a channel.|+|[Archive channel](../api/channel-archive.md) | None | Archive a channel.| +|[Unarchive channel](../api/channel-unarchive.md) | None | Unarchive a channel.| |[Update channel member's role](../api/channel-update-members.md) | [conversationMember](conversationmember.md) | Update the properties of a member of the channel. Only supported for channels with a **membershipType** of `private` or `shared`.| |[Remove channel member](../api/channel-delete-members.md) | None | Delete a member from a channel. Only supported for channels with a **membershipType** of `private` or `shared`.| |[Complete migration](../api/channel-completemigration.md)|[channel](channel.md)| Removes the migration mode from the channel and makes the channel available to users to post and read messages.| where files are shared, and where tabs are added. |[Provision channel email address](../api/channel-provisionemail.md) |[provisionChannelEmailResult](../resources/provisionchannelemailresult.md)| Provision an email address for the channel.| |[Remove channel email address](../api/channel-removeemail.md) | None | Remove the email address of the channel.| |[Remove incoming channel](../api/team-delete-incomingchannels.md) | None| Remove an incoming [channel](../resources/channel.md) (a **channel** shared with a **team**) from a [team](../resources/team.md).|-|[List teams sharing a channel](../api/sharedwithchannelteaminfo-list.md)|[sharedWithChannelTeamInfo](../resources/sharedwithchannelteaminfo.md) collection|Get the list of teams that has been shared the specified channel.| -|[Get team sharing a channel](../api/sharedwithchannelteaminfo-get.md)|[sharedWithChannelTeamInfo](../resources/sharedwithchannelteaminfo.md)|Get a team that has been shared the specified channel.| +|[List teams sharing a channel](../api/sharedwithchannelteaminfo-list.md)|[sharedWithChannelTeamInfo](../resources/sharedwithchannelteaminfo.md) collection|Get the list of teams that share the specified channel.| +|[Get team sharing a channel](../api/sharedwithchannelteaminfo-get.md)|[sharedWithChannelTeamInfo](../resources/sharedwithchannelteaminfo.md)|Get a team that shares the specified channel.| |[Unshare channel with team](../api/sharedwithchannelteaminfo-delete.md)|None|Unshare a channel with a team.| |[List allowed members](../api/sharedwithchannelteaminfo-list-allowedmembers.md)|[conversationMember](../resources/conversationmember.md) collection|Get the list of team members who have access to the shared channel.| |[Check user access](../api/channel-doesuserhaveaccess.md)|Boolean|Check whether a user has access to a shared channel or not.| where files are shared, and where tabs are added. | Property | Type |Description| |:|:--|:-| |description|String|Optional textual description for the channel.|-|displayName|String|Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters.| +|displayName|String|Channel name as it appears to the user in Microsoft Teams. The maximum length is 50 characters.| |id|String|The channel's unique identifier. Read-only.| |isFavoriteByDefault|Boolean|Indicates whether the channel should automatically be marked 'favorite' for all members of the team. Can only be set programmatically with [Create team](../api/team-post.md). Default: `false`.| |email|String| The email address for sending messages to the channel. Read-only.|-|webUrl|String|A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.| -|membershipType|[channelMembershipType](../resources/channel.md#channelmembershiptype-values)|The type of the channel. Can be set during creation and can't be changed. The possible values are: `standard`, `private`, `unknownFutureValue`, `shared`. The default value is `standard`. 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): `shared`.| +|webUrl|String|A hyperlink to the channel in Microsoft Teams. This URL is supplied when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.| +|membershipType|[channelMembershipType](../resources/channel.md#channelmembershiptype-values)|The type of the channel. Can be set during creation and can't be changed. The possible values are: `standard`, `private`, `unknownFutureValue`, `shared`. The default value is `standard`. 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): `shared`.| |createdDateTime|dateTimeOffset|Read only. Timestamp at which the channel was created.| |moderationSettings|[channelModerationSettings](../resources/channelmoderationsettings.md)|Settings to configure channel moderation to control who can start new posts and reply to posts in that channel.|-|summary|[channelSummary](../resources/channelsummary.md)|Contains summary information about the channel, including number of guests, members, owners, and an indicator for members from other tenants. The **summary** property will only be returned if it is specified in the `$select` clause of the [Get channel](../api/channel-get.md) method.| +|summary|[channelSummary](../resources/channelsummary.md)|Contains summary information about the channel, including number of guests, members, owners, and an indicator for members from other tenants. The **summary** property is only returned if it appears in the `$select` clause of the [Get channel](../api/channel-get.md) method.| |tenantId |string | The ID of the Microsoft Entra tenant. |+|isArchived| Boolean | Indicates whether the channel is archived. Read-only. | ### channelMembershipType values where files are shared, and where tabs are added. ### Instance attributes -Instance attributes are properties with special behaviors. These properties are temporary and either a) define behavior the service should perform or b) provide short-term property values, like a download URL for an item that expires. +Instance attributes are properties with special behaviors. These properties are temporary. They either define behavior that the service should perform, or provide short-term property values, such as a download URL for an item that expires. | Property name| Type | Description |:--|:-|:-| For a POST request example, see [Request (create channel in migration state)](/m ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type <!-- { "blockType": "resource", The following is a JSON representation of the resource. "email": "string", "webUrl": "string", "membershipType": "String",+ "isArchived": false, "createdDateTime": "string (timestamp)", "moderationSettings": { "@odata.type": "microsoft.graph.channelModerationSettings" } } |
v1.0 | Chat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chat.md | A chat is a collection of [chatMessages](chatmessage.md) between one or more par | chatType| [chatType](../resources/chat.md#chattype-values) | Specifies the type of chat. Possible values are: `group`, `oneOnOne`, `meeting`, `unknownFutureValue`.| | createdDateTime| dateTimeOffset| Date and time at which the chat was created. Read-only.| | id| String| The chat's unique identifier. Read-only.|+| isHiddenForAllMembers | Boolean | Indicates whether the chat is hidden for all its members. Read-only.| | lastUpdatedDateTime| dateTimeOffset| Date and time at which the chat was renamed or list of members were last changed. Read-only.| | onlineMeetingInfo | [teamworkOnlineMeetingInfo](../resources/teamworkonlinemeetinginfo.md) | Represents details about an online meeting. If the chat isn't associated with an online meeting, the property is empty. Read-only.| | tenantId| String | The identifier of the tenant in which the chat was created. Read-only.| A chat is a collection of [chatMessages](chatmessage.md) between one or more par ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", The following is a JSON representation of the resource. ```json {- "chatType": "string", - "createdDateTime": "dateTimeOffset", + "chatType": "String", + "createdDateTime": "String (timestamp)", "id": "string (identifier)",- "lastUpdatedDateTime": "dateTimeOffset", + "isHiddenForAllMembers": "Boolean", + "lastUpdatedDateTime": "String (timestamp)", "onlineMeetingInfo": { "@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo" },- "tenantId": "string", - "topic": "string", + "tenantId": "String", + "topic": "String", "viewpoint": { "@odata.type": "microsoft.graph.chatViewpoint" },- "webUrl": "string" + "webUrl": "String" } ``` |
v1.0 | Chatmessagehostedcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessagehostedcontent.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Chatmessageinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessageinfo.md | Represents a preview of a [chatMessage](../resources/chatmessage.md) resource. T None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Chatmessagepolicyviolation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessagepolicyviolation.md | Represents a policy violation on a chat message. Policy violations are typically ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 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`.| +|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`. | |user|[chatMessageReactionIdentitySet](chatmessagereactionidentityset.md)|The user who reacted to the message.| ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", The following is a JSON representation of the resource. ```json { "createdDateTime": "String (timestamp)",+ "reactionContentUrl": "String", "reactionType": "String", "user": {"@odata.type": "microsoft.graph.chatMessageReactionIdentitySet"} } The following is a JSON representation of the resource. "section": "documentation", "tocPath": "" }-->-- |
v1.0 | Chunkeduploadsessiondescriptor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chunkeduploadsessiondescriptor.md | Namespace: microsoft.graph ## Properties | Property | Type |Description| |:|:--|:-|-|name|String|| +|name|String|The name of the **chunkedUploadSessionDescriptor** object.| ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Claimsmapping | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/claimsmapping.md | After the custom identity provider sends an ID token back to Azure AD B2C, Azure 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.claimsMapping" |
v1.0 | Claimsmappingpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/claimsmappingpolicy.md | The properties below form the JSON object that represents a claims-mapping polic ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Clientcertificateauthentication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/clientcertificateauthentication.md | Inherits from [apiAuthenticationConfigurationBase](../resources/apiauthenticatio ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.clientCertificateAuthentication" |
v1.0 | Cloudappsecuritystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudappsecuritystate.md | Contains stateful information about the cloud application (destinationServiceNam ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Cloudclipboardroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudclipboardroot.md | +toc. Title: Cloud clipboard # cloudClipboardRoot resource type |
v1.0 | Cloudpc Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpc-api-overview.md | Title: "Working with Windows 365 Cloud PCs using the Microsoft Graph API" description: "The Microsoft Graph API enables programmatic access to Cloud PC information and management actions on your organization." ms.localizationpriority: medium -doc_type: resourcePageType # Working with Windows 365 Cloud PCs using the Microsoft Graph API |
v1.0 | Cloudpc | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpc.md | Title: "cloudPC resource type" -description: "Cloud managed virtual desktops." +description: "Represents a cloud-managed virtual desktop." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into Intune and managed through the Microsoft Endpoint Manager portal, so the Cloud PC also has a corresponding Intune managed device ID. +Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled in Intune and managed through the Microsoft Endpoint Manager portal, so the Cloud PC also has a corresponding Intune-managed device ID. ## Methods |Method|Return type|Description| |:|:|:|-|[List cloudPCs](../api/virtualendpoint-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List properties and relationships of the [cloudPC](../resources/cloudpc.md) objects.| -|[Get cloudPC](../api/cloudpc-get.md)|[cloudPC](../resources/cloudpc.md)|Read the properties and relationships of a [cloudPC](../resources/cloudpc.md) object.| -|[Get provisioned cloudPCs](../api/cloudpc-getprovisionedcloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|Get all provisioned Cloud PCs of a specific service plan for users under a Microsoft Entra user group.| +|[List cloudPCs](../api/virtualendpoint-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List properties and relationships of the Cloud PC objects.| +|[Get cloudPC](../api/cloudpc-get.md)|[cloudPC](../resources/cloudpc.md)|Read the properties and relationships of a Cloud PC object.| +|[Get provisioned Cloud PCs](../api/cloudpc-getprovisionedcloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|Get all provisioned Cloud PCs of a specific service plan for users under a Microsoft Entra user group.| |[Change user account type](../api/cloudpc-changeuseraccounttype.md)|None|Change the account type of the user on a specific Cloud PC.|-|[End grace period](../api/cloudpc-endgraceperiod.md)|None|End the grace period for a [cloudPC](../resources/cloudpc.md) object.| +|[End grace period](../api/cloudpc-endgraceperiod.md)|None|End the grace period for a Cloud PC object.| |[Get remote action results](../api/manageddevice-getcloudpcremoteactionresults.md)|[cloudPcRemoteActionResult](../resources/cloudpcremoteactionresult.md)|Check the [Cloud PC-specified remote action results](../resources/cloudpcremoteactionresult.md) for a Cloud PC device.|-|[Power on](../api/cloudpc-poweron.md)|None|Power on a specific Windows Frontline [cloudPC](../resources/cloudpc.md) object. This action supports MEM admin scenarios.| -|[Power off](../api/cloudpc-poweroff.md)|None|Power off a specific Windows Frontline [cloudPC](../resources/cloudpc.md) object.This action supports MEM admin scenarios.| -|[Reboot](../api/cloudpc-reboot.md)|None|Reboot a specific [cloudPC](../resources/cloudpc.md) object.| -|[Rename](../api/cloudpc-rename.md)|None|Rename a specific [cloudPC](../resources/cloudpc.md) object. Use this API to update the **displayName** for the Cloud PC entity.| -|[Reprovision](../api/cloudpc-reprovision.md)|None|Reprovision a [cloudPC](../resources/cloudpc.md) object.| +|[Power on](../api/cloudpc-poweron.md)|None|Power on a specific Windows Frontline Cloud PC object. This action supports MEM admin scenarios.| +|[Power off](../api/cloudpc-poweroff.md)|None|Power off a specific Windows Frontline Cloud PC object. This action supports MEM admin scenarios.| +|[Reboot](../api/cloudpc-reboot.md)|None|Reboot a specific Cloud PC object.| +|[Rename](../api/cloudpc-rename.md)|None|Rename a specific Cloud PC object. Use this API to update the **displayName** for the Cloud PC entity.| +|[Reprovision](../api/cloudpc-reprovision.md)|None|Reprovision a Cloud PC object.| |[Bulk reprovision remote action](../api/manageddevice-bulkreprovisioncloudpc.md)|None|Bulk reprovision a set of Cloud PC devices with Intune managed device IDs.|-|[Resize remote action](../api/manageddevice-resizecloudpc.md)|None|Upgrade or downgrade an existing Cloud PC to another configuration with new vCPU and storage size through Intune managed device ID.| -|[Start](../api/cloudpc-start.md)|None|Start a specific [cloudPC](../resources/cloudpc.md) for a user. Currently, only Windows 365 Frontline Cloud PCs are supported. | -|[Stop](../api/cloudpc-stop.md)|None|Stop a specific [cloudPC](../resources/cloudpc.md) for a user. Currently, only Windows 365 Frontline Cloud PCs are supported. | -|[Troubleshoot](../api/cloudpc-troubleshoot.md)|None|Troubleshoot a specific [cloudPC](../resources/cloudpc.md) object. Use this API to check the health status of the Cloud PC and the session host.| -|[Restore](../api/cloudpc-restore.md)|None|Restore a [cloudPC](../resources/cloudpc.md) object to a previous state from a snapshot.| +|[Resize remote action](../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.| +|[Start](../api/cloudpc-start.md)|None|Start a specific Cloud PC for a user. Currently, only Windows 365 Frontline Cloud PCs are supported. | +|[Stop](../api/cloudpc-stop.md)|None|Stop a specific Cloud PC for a user. Currently, only Windows 365 Frontline Cloud PCs are supported. | +|[Troubleshoot](../api/cloudpc-troubleshoot.md)|None|Troubleshoot a specific Cloud PC object. Use this API to check the health status of the Cloud PC and the session host.| +|[Restore](../api/cloudpc-restore.md)|None|Restore a Cloud PC object to a previous state from a snapshot.| |[Bulk restore remote action](../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.| |[Set review status](../api/manageddevice-setcloudpcreviewstatus.md)|None|Set the review status of a specific Cloud PC device.| |[Get review status](../api/manageddevice-getcloudpcreviewstatus.md)|[cloudPcReviewStatus](../resources/cloudpcreviewstatus.md)|Get the review status of a specific Cloud PC device.| |[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 [cloudPC](../resources/cloudpc.md) 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.| +|[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.| |[Get supported remote actions](../api/cloudpc-getsupportedcloudpcremoteactions.md)|[cloudPcRemoteActionCapability](../resources/cloudpcremoteactioncapability.md) collection|Get a list of supported Cloud PC remote actions for a specific Cloud PC device, including the action names and capabilities.|-|[Retry partner agent installation](../api/cloudpc-retrypartneragentinstallation.md)|None|Retry installation for the partner agents that failed to install on the [cloudPC](../resources/cloudpc.md).| -|[Bulk resize](../api/cloudpc-retrypartneragentinstallation.md)|[cloudPcRemoteActionResult](../resources//cloudpcremoteactionresult.md) collection|Perform a bulk resize action to resize a group of [cloudPCs](../resources/cloudpc.md) 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.| -|[Validate bulk resize](../api/cloudpc-validatebulkresize.md)|[cloudPcResizeValidateResult](../resources/cloudPcResizeValidationResult.md) collection|Validate that a set of [cloudPC](../resources/cloudpc.md) devices meet the requirements to be bulk resized.| +|[Retry partner agent installation](../api/cloudpc-retrypartneragentinstallation.md)|None|Retry installation for the partner agents that failed to install on the Cloud PC.| +|[Bulk resize](../api/cloudpc-retrypartneragentinstallation.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.| +|[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.| |[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`.| |[Get shift work access state](../api/cloudpc-getshiftworkcloudpcaccessstate.md) (deprecated)|[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`. Note that 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](../api/manageddevice-reprovisioncloudpc.md) (deprecated)|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.| Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into |Property|Type|Description| |:|:|:| |aadDeviceId|String|The Microsoft Entra device ID of the Cloud PC.|+|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.| |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 happen. 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`.| +|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`.| |id|String|The unique identifier for the Cloud PC. Read-only.| |imageDisplayName|String|Name of the OS image that's on the Cloud PC.| |lastLoginResult|[cloudPcLoginResult](../resources/cloudpcloginresult.md)|The last login result of the Cloud PC. For example, `{ "time": "2014-01-01T00:00:00Z"}`.|-|lastModifiedDateTime|DateTimeOffset|The last modified date and time of the Cloud PC. 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`.| -|lastRemoteActionResult|[cloudPcRemoteActionResult](../resources/cloudpcremoteactionresult.md)|The last remote action result of the enterprise Cloud PCs. The supported remote actions are: `Reboot`, `Rename`, `Reprovision`, `Restore`, and `Troubleshoot`.| +|lastModifiedDateTime|DateTimeOffset|The last modified date and time of the Cloud PC. 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`.| +|lastRemoteActionResult|[cloudPcRemoteActionResult](../resources/cloudpcremoteactionresult.md)|The last remote action result of the enterprise Cloud PCs. The supported remote actions are: `Reboot`, `Rename`, `Reprovision`, `Restore`, `Troubleshoot`.| |managedDeviceId|String|The Intune device ID of the Cloud PC.| |managedDeviceName|String|The Intune device name of the Cloud PC.| |onPremisesConnectionName|String|The Azure network connection that is applied during the provisioning of Cloud PCs.|-|osVersion|[cloudPcOperatingSystem](../resources/cloudpcorganizationsettings.md#cloudpcoperatingsystem-values)|The version of the operating system (OS) to provision on Cloud PCs. Possible values are: `windows10`, `windows11`, and `unknownFutureValue`.| +|osVersion|[cloudPcOperatingSystem](../resources/cloudpcorganizationsettings.md#cloudpcoperatingsystem-values)|The version of the operating system (OS) to provision on Cloud PCs. Possible values are: `windows10`, `windows11`, `unknownFutureValue`.| |partnerAgentInstallResults|[cloudPcPartnerAgentInstallResult](../resources/cloudpcpartneragentinstallresult.md) collection|The results of every partner agent's installation status on Cloud PC.|-|powerState|[cloudPcPowerState](#cloudpcpowerstate-values)|The power state of a Cloud PC. The possible values are: `running`, `poweredOff` and `unknown`. This property only supports shift work Cloud PCs.| +|powerState|[cloudPcPowerState](#cloudpcpowerstate-values)|The power state of a Cloud PC. The possible values are: `running`, `poweredOff`, `unknown`. This property only supports shift work Cloud PCs.| |provisioningPolicyId|String|The provisioning policy ID of the Cloud PC.| |provisioningPolicyName|String|The provisioning policy that is applied during the provisioning of Cloud PCs.|-|provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|The type of licenses to be used when provisioning Cloud PCs using this policy. Possible values are: `dedicated`, `shared`, `unknownFutureValue`. Default value is `dedicated`. | +|provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|The type of licenses to be used when provisioning Cloud PCs using this policy. Possible values are: `dedicated`, `shared`, `unknownFutureValue`,`sharedByUser`, `sharedByUser`. 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): `sharedByUser`, `sharedByEntraGroup`. The default value is `dedicated`. CAUTION: The `shared` member is deprecated and will stop returning on April 30, 2027; in the future, use the `sharedByUser` member. | |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`, `upgrading`, `inGracePeriod`, `deprovisioning`, `failed`, `restoring`.| +|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`. 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`.| |statusDetails|[cloudPcStatusDetails](../resources/cloudpcstatusdetails.md)|The details of the Cloud PC status.|-|userAccountType|[cloudPcUserAccountType](../resources/cloudpcorganizationsettings.md#cloudpcuseraccounttype-values)|The account type of the user on provisioned Cloud PCs. Possible values are: `standardUser`, `administrator`, and `unknownFutureValue`.| +|userAccountType|[cloudPcUserAccountType](../resources/cloudpcorganizationsettings.md#cloudpcuseraccounttype-values)|The account type of the user on provisioned Cloud PCs. Possible values are: `standardUser`, `administrator`, `unknownFutureValue`.| |userPrincipalName|String|The user principal name (UPN) of the user assigned to the Cloud PC.| ### cloudPcDiskEncryptionState values |Member|Description| |:|:|-|notAvailable|The Cloud PC isn't provisioned, or is in a state where encryption isn't available.| +|notAvailable|The Cloud PC isn't provisioned or is in a state where encryption isn't available.| |notEncrypted|The Cloud PC should be encrypted, but the encryption isn't done so yet (reserved, shouldn't happen).|-|encryptedUsingPlatformManagedKey|The Cloud PC is encrypted using a platform managed key. This is the default value if the customer-managed key isn't enabled.| +|encryptedUsingPlatformManagedKey|The Cloud PC is encrypted using a platform-managed key. This member is the default value if the customer-managed key isn't enabled.| |encryptedUsingCustomerManagedKey|The Cloud PC is encrypted using the customer-managed key.| |unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into |Member|Description| |:|:| |running|The Cloud PC status is running.|-|poweredOff|The Cloud PC status is power off.| +|poweredOff|The Cloud PC status is powered off.| |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). You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `movingRegion`, `resizePendingLicense`. +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`. |Member|Description| |:|:|-|notProvisioned|The Cloud PC hasn't been provisioned.| +|notProvisioned|The Cloud PC hasn't been provisioned yet.| |provisioning|Cloud PC provisioning is in progress.|-|provisioned|The Cloud PC is provisioned and can be accessed by end users.| -|inGracePeriod|The Cloud PC is in the one week grace period before it’s deprovisioned.| +|provisioned|The Cloud PC is provisioned and users can access it.| +|inGracePeriod|The Cloud PC is in the one-week grace period before deprovision.| |deprovisioning|The Cloud PC is deprovisioning.|-|failed|The operation on Cloud PC has failed.| -|provisionedWithWarnings|The Cloud PC is provisioned and can be accessed by end users but with some warnings. The user can continue to use this Cloud PC.| +|failed|The operation on Cloud PC failed.| +|provisionedWithWarnings|The Cloud PC is provisioned and end users can access it with some warnings. The user can continue to use this Cloud PC.| |resizing|The Cloud PC is resizing.|-|pendingProvision|The provisioning is pending on the Cloud PC. In this case, the number of Cloud PCs in grace period is more than the number of total available licenses. | +|pendingProvision|The provisioning is pending on the Cloud PC. In this case, the number of Cloud PCs in the grace period is more than the number of total available licenses. | |restoring|The Cloud PC is restoring.| |unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| |movingRegion|Indicates that the Cloud PC is being moved from one region to another.|-|resizePendingLicense|Indicates that the Cloud PC resize process has been 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.| +|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.| ### frontlineCloudPcAccessState values The following table lists the members of an [evolvable enumeration](/graph/best- |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 standby state is still accessible by the user.| +|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](#shiftworkcl |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 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. | +|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.| The following JSON representation shows the resource type. { "@odata.type": "#microsoft.graph.cloudPC", "aadDeviceId": "String",+ "allotmentDisplayName": "String", "connectivityResult": "String", "diskEncryptionState": "String", "displayName": "String", |
v1.0 | Cloudpcauditevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcauditevent.md | The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.cloudPcAuditEvent",- "id": "String (identifier)", - "displayName": "String", - "componentName": "String", - "actor": { - "@odata.type": "microsoft.graph.cloudPcAuditActor", - "type": "String", - "userPermissions": [ - "String" - ], - "applicationId": "String", - "applicationDisplayName": "String", - "userPrincipalName": "String", - "servicePrincipalName": "String", - "ipAddress": "String", - "userId": "String", - "userRoleScopeTags": [ - { - "@odata.type": "microsoft.graph.cloudPcUserRoleScopeTagInfo", - "displayName": "String", - "roleScopeTagId": "String" - } - ], - "remoteTenantId": "String", - "remoteUserId": "String" - }, "activity": "String", "activityDateTime": "String (timestamp)",- "activityType": "String", "activityOperationType": "String", "activityResult": "String",+ "activityType": "String", + "actor": {"@odata.type": "microsoft.graph.cloudPcAuditActor"}, + "category": "String", + "componentName": "String", "correlationId": "String",- "resources": [ - { - "@odata.type": "microsoft.graph.cloudPcAuditResource", - "displayName": "String", - "modifiedProperties": [ - { - "@odata.type": "microsoft.graph.cloudPcAuditProperty", - "displayName": "String", - "oldValue": "String", - "newValue": "String" - } - ], - "type": "String", - "resourceId": "String" - } - ], - "category": "String" + "displayName": "String", + "id": "String (identifier)", + "resources": [{"@odata.type": "microsoft.graph.cloudPcAuditResource"}] } ``` |
v1.0 | Cloudpcauditresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcauditresource.md | Represents the audit resource. This shows the target edited resource entity, w |:|:|:| |displayName|String|The resource entity display name.| |modifiedProperties|[cloudPcAuditProperty](../resources/cloudpcauditproperty.md) collection|A list of modified properties.|-|type|String|The type of the audit resource.| |resourceId|String|The ID of the audit resource.|+|resourceType|String|The type of the audit resource.| +|type (deprecated)|String|The type of the audit resource. The **type** property is deprecated and will stop returning data on May 8, 2024. Going forward, use the **resourceType** property.| ## Relationships -None +None. ## JSON Representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.cloudPcAuditResource" The following is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.cloudPcAuditResource", "displayName": "String",- "modifiedProperties": [ - { - "@odata.type": "microsoft.graph.cloudPcAuditProperty", - "displayName": "String", - "oldValue": "String", - "newValue": "String" - } - ], - "type": "String", - "resourceId": "String" + "modifiedProperties": [{"@odata.type": "microsoft.graph.cloudPcAuditProperty"}], + "resourceId": "String", + "resourceType": "String", + "type": "String" } ``` |
v1.0 | Cloudpcbulkaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulkaction.md | + + Title: "cloudPcBulkAction resource type" +description: "An abstract type that represents the bulk action applied to Cloud PCs specified in a parameter." ++ms.localizationpriority: medium ++++# cloudPcBulkAction resource type ++Namespace: microsoft.graph +++An abstract type that represents the bulk action applied to Cloud PCs specified in a parameter. ++Base type of [cloudPcBulkPowerOff](../resources/cloudpcbulkpoweroff.md), [cloudPcBulkPowerOn](../resources/cloudpcbulkpoweron.md), [cloudPcBulkReprovision](../resources/cloudpcbulkreprovision.md), [cloudPcBulkResize](../resources/cloudpcbulkresize.md), [cloudPcBulkRestart](../resources/cloudpcbulkrestart.md), [cloudPcBulkRestore](../resources/cloudpcbulkrestore.md), and [cloudPcBulkTroubleshoot](../resources/cloudpcbulktroubleshoot.md). ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List bulkActions](../api/virtualendpoint-list-bulkactions.md)|[cloudPcBulkAction](../resources/cloudpcbulkaction.md) collection|Get a list of the [cloudPcBulkAction](../resources/cloudpcbulkaction.md) objects and their properties.| +|[Create cloudPcBulkAction](../api/virtualendpoint-post-bulkactions.md)|[cloudPcBulkAction](../resources/cloudpcbulkaction.md)|Create a new [cloudPcBulkAction](../resources/cloudpcbulkaction.md) object.| +|[Get cloudPcBulkAction](../api/cloudpcbulkaction-get.md)|[cloudPcBulkAction](../resources/cloudpcbulkaction.md)|Read the properties and relationships of a [cloudPcBulkAction](../resources/cloudpcbulkaction.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|actionSummary|[cloudPcBulkActionSummary](../resources/cloudpcbulkactionsummary.md)|Run summary of this bulk action.| +|cloudPcIDs|String collection|IDs of the Cloud PCs the bulk action applies to. | +|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`.| +|displayName|String|Name of the bulk action.| +|id|String|ID of the bulk action. Inherited from [entity](entity.md).| +|scheduledDuringMaintenanceWindow|Boolean|Indicates whether the bulk actions can be initiated during maintenance window. When `true`, bulk action will use maintenance window to schedule action, When `false` means bulk action will not use the maintenance window. Default value is `false`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkAction", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)", + "scheduledDuringMaintenanceWindow": "Boolean" +} +``` |
v1.0 | Cloudpcbulkactionsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulkactionsummary.md | + + Title: "cloudPcBulkActionSummary resource type" +description: "Represents a run summary of the bulk actions." ++ms.localizationpriority: medium ++++# cloudPcBulkActionSummary resource type ++Namespace: microsoft.graph +++Represents a run summary of the bulk actions. ++## Properties +|Property|Type|Description| +|:|:|:| +|failedCount|Int32|The number of Cloud PCs where the action failed.| +|inProgressCount|Int32|The number of Cloud PCs where the action is in progress.| +|notSupportedCount|Int32|The number of Cloud PCs where the action isn't supported.| +|pendingCount|Int32|The number of Cloud PCs where the action is pending.| +|successfulCount|Int32|The number of Cloud PCs where the action is successful.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.cloudPcBulkActionSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkActionSummary", + "failedCount": "Int32", + "inProgressCount": "Int32", + "notSupportedCount": "Int32", + "pendingCount": "Int32", + "successfulCount": "Int32" +} +``` |
v1.0 | Cloudpcbulkpoweroff | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulkpoweroff.md | + + Title: "cloudPcBulkPowerOff resource type" +description: "Defines the bulk power-off action, with Cloud PC IDs as the only input parameter for the bulk power-off operation." ++ms.localizationpriority: medium ++++# cloudPcBulkPowerOff resource type ++Namespace: microsoft.graph +++Defines the bulk power-off action, with Cloud PC IDs as the only input parameter for the bulk power-off operation. ++Inherits from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). ++## Methods ++## Properties +|Property|Type|Description| +|:|:|:| +|actionSummary|[cloudPcBulkActionSummary](../resources/cloudpcbulkactionsummary.md)|Run summary of this bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|cloudPcIds|String collection|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|ID of the bulk action. 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.cloudPcBulkPowerOff", + "baseType": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkPowerOff", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)" +} +``` + |
v1.0 | Cloudpcbulkpoweron | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulkpoweron.md | + + Title: "cloudPcBulkPowerOn resource type" +description: "Defines the bulk power-on action, with Cloud PC IDs as the only input parameter for the bulk power-on operation." ++ms.localizationpriority: medium ++++# cloudPcBulkPowerOn resource type ++Namespace: microsoft.graph +++Defines the bulk power-on action, with Cloud PC IDs as the only input parameter for the bulk power-on operation. ++Inherits from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). ++## Methods ++## Properties +|Property|Type|Description| +|:|:|:| +|actionSummary|[cloudPcBulkActionSummary](../resources/cloudpcbulkactionsummary.md)|Run summary of this bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|cloudPcIds|String collection|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|ID of the bulk action. 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.cloudPcBulkPowerOn", + "baseType": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkPowerOn", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)" +} +``` + |
v1.0 | Cloudpcbulkreprovision | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulkreprovision.md | + + Title: "cloudPcBulkReprovision resource type" +description: "Represents the entity that performs a bulk reprovision action." ++ms.localizationpriority: medium ++++# cloudPcBulkReprovision resource type ++Namespace: microsoft.graph +++Represents the entity that performs a bulk reprovision action. If provisioning a Cloud PC device through the standard steps (creating a provisioning policy and assigning it to trigger Cloud PC provisioning for a new user), customers can use this API to re-create the Cloud PC by providing the Cloud PC ID. ++Inherits from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). ++## Methods ++## Properties +|Property|Type|Description| +|:|:|:| +|actionSummary|[cloudPcBulkActionSummary](../resources/cloudpcbulkactionsummary.md)|Run summary of this bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|cloudPcIds|String collection|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|ID of the bulk action. 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.cloudPcBulkReprovision", + "baseType": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkReprovision", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)" +} +``` |
v1.0 | Cloudpcbulkresize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulkresize.md | + + Title: "cloudPcBulkResize resource type" +description: "Represents the entity that performs a bulk resize action." ++ms.localizationpriority: medium ++++# cloudPcBulkResize resource type ++Namespace: microsoft.graph +++Represents the entity that performs a bulk resize action. When IT administrators want to upgrade or downgrade Cloud PC devices, they can use this API to trigger a resize remote action for the Cloud PC. This API requires a parameter that specifies the target service plan ID that indicates the configuration to which the Cloud PC should be resized. ++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|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|ID of the bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|targetServicePlanId|String|The target service plan ID of the resize configuration with new vCPU and storage size.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.cloudPcBulkResize", + "baseType": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkResize", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)", + "targetServicePlanId": "String" +} +``` |
v1.0 | Cloudpcbulkrestart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulkrestart.md | + + Title: "cloudPcBulkRestart resource type" +description: "Represents the entity that performs a bulk restart action." ++ms.localizationpriority: medium ++++# cloudPcBulkRestart resource type ++Namespace: microsoft.graph +++Represents the entity that performs a bulk restart action. ++Inherits from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). ++## Methods ++## Properties +|Property|Type|Description| +|:|:|:| +|actionSummary|[cloudPcBulkActionSummary](../resources/cloudpcbulkactionsummary.md)|Run summary of this bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|cloudPcIds|String collection|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|ID of the bulk action. 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.cloudPcBulkRestart", + "baseType": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkRestart", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)" +} +``` |
v1.0 | Cloudpcbulkrestore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulkrestore.md | + + Title: "cloudPcBulkRestore resource type" +description: "Represents the entity that performs a bulk restore action." ++ms.localizationpriority: medium ++++# cloudPcBulkRestore resource type ++Namespace: microsoft.graph +++Represents the entity that performs a bulk restore action. Perform a bulk restore for a set of Cloud PCs with associated Cloud PC ID and restore point. If some of the devices don't have any snapshots to restore, they're set as restore failed, while the others with snapshots still be triggered successfully. ++Inherits from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). ++## Methods ++## Properties +|Property|Type|Description| +|:|:|:| +|actionSummary|[cloudPcBulkActionSummary](../resources/cloudpcbulkactionsummary.md)|Run summary of this bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|cloudPcIds|String collection|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|ID of the bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|restorePointDateTime|DateTimeOffset|The date and time point for the selected Cloud PCs to restore. 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`.| +|timeRange|restoreTimeRange|The time range of the restore point. The possible values are: `before`, `after`, `beforeOrAfter`, `unknownFutureValue`. The default value is `before`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.cloudPcBulkRestore", + "baseType": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkRestore", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)", + "restorePointDateTime": "String (timestamp)", + "timeRange": "String" +} +``` |
v1.0 | Cloudpcbulktroubleshoot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulktroubleshoot.md | + + Title: "cloudPcBulkTroubleshoot resource type" +description: "Represents the entity that performs a bulk troubleshooting action." ++ms.localizationpriority: medium ++++# cloudPcBulkTroubleshoot resource type ++Namespace: microsoft.graph +++Represents the entity that performs a bulk troubleshooting action. This resource triggers an action that troubleshoots the Cloud PC and session host health status. ++Inherits from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). ++## Methods ++## Properties +|Property|Type|Description| +|:|:|:| +|actionSummary|[cloudPcBulkActionSummary](../resources/cloudpcbulkactionsummary.md)|Run summary of this bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|cloudPcIds|String collection|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|ID of the bulk action. 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.cloudPcBulkTroubleshoot", + "baseType": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkTroubleshoot", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)" +} +``` |
v1.0 | Cloudpcexternalpartnersetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcexternalpartnersetting.md | Represents an external partner setting on Cloud PC. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Cloudpconpremisesconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpconpremisesconnection.md | +toc. Title: Cloud PC Azure network connection # cloudPcOnPremisesConnection resource type |
v1.0 | Cloudpcorganizationsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcorganizationsettings.md | Represents the Cloud PC organization settings for a tenant. A tenant has only on None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
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. |[Update cloudPcProvisioningPolicy](../api/cloudpcprovisioningpolicy-update.md)|[cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md)|Update the properties of a [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md) object.| |[Delete cloudPcProvisioningPolicy](../api/cloudpcprovisioningpolicy-delete.md)|None|Delete a [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md) object.| |[Assign cloudPcProvisioningPolicy](../api/cloudpcprovisioningpolicy-assign.md)|None |Assign a [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md) to user groups.|+|[Apply cloudPcProvisioningPolicy](../api/cloudpcprovisioningpolicy-apply.md)|None|Apply the current [provisioning policy](../resources/cloudpcprovisioningpolicy.md) configuration to all Cloud PC devices under a specified policy. Currently, you can only change the region.| +|[applyConfig](../api/cloudpcprovisioningpolicy-applyconfig.md)|None|Update the [provisioning policy](../resources/cloudpcprovisioningpolicy.md) configuration for a set of Cloud PC devices by their IDs.| ## Properties Represents a Cloud PC provisioning policy. |description|String|The provisioning policy description. Supports `$filter`, `$select`, and `$orderBy`. | |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 (Azure AD). Supports `$select`.|-|enableSingleSignOn|Boolean|`True` if the provisioned Cloud PC can be accessed by single sign-on. `False` indicates that the provisioned Cloud PC doesn't support this feature. The default value is `false`. Windows 365 users can use single sign-on to authenticate to Microsoft Entra ID with passwordless options (for example, FIDO keys) to access their Cloud PC. Optional.| +|enableSingleSignOn|Boolean|`True` if single sign-on can access the provisioned Cloud PC. `False` indicates that the provisioned Cloud PC doesn't support this feature. The default value is `false`. Windows 365 users can use single sign-on to authenticate to Microsoft Entra ID with passwordless options (for example, FIDO keys) to access their Cloud PC. Optional.| |gracePeriodInHours|Int32|The number of hours to wait before reprovisioning/deprovisioning happens. Read-only.| |id|String|The unique identifier associated with the provisioning policy. This ID is auto populated during the creation of a new provisioning policy. Read-only. Supports `$filter`, `$select`, and `$orderBy`. | |imageDisplayName|String|The display name of the operating system image that is used for provisioning. For example, `Windows 11 Preview + Microsoft 365 Apps 23H2 23H2`. Supports `$filter`, `$select`, and `$orderBy`. | |imageId|String|The unique identifier that represents an operating system image that is used for provisioning new Cloud PCs. The format for a gallery type image is: {publisherName_offerName_skuName}. Supported values for each of the parameters are:<ul><li>publisher: `Microsoftwindowsdesktop`</li> <li>offer: `windows-ent-cpc`</li> <li>sku: `21h1-ent-cpc-m365`, `21h1-ent-cpc-os`, `20h2-ent-cpc-m365`, `20h2-ent-cpc-os`, `20h1-ent-cpc-m365`, `20h1-ent-cpc-os`, `19h2-ent-cpc-m365`, and `19h2-ent-cpc-os`</li></ul> Supports `$filter`, `$select`, and `$orderBy`.| |imageType|cloudPcProvisioningPolicyImageType|The type of operating system image (custom or gallery) that is used for provisioning on Cloud PCs. Possible values are: `gallery`, `custom`. The default value is `gallery`. Supports $filter, $select, and $orderBy.| |localAdminEnabled|Boolean|When `true`, the local admin is enabled for Cloud PCs; `false` indicates that the local admin isn't enabled for Cloud PCs. The default value is `false`. Supports `$filter`, `$select`, and `$orderBy`.|-|managedBy|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|Indicates the service that manages the provisioning policy. Possible values are: `windows365`, `devBox`, `unknownFutureValue`, `rpaBox`. The default value is `windows365`. 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): `rpaBox`. Supports `$filter`, `$select`, and `$orderBy`.| +|managedBy|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|Indicates the service that manages the provisioning policy. Possible values are: `windows365`, `devBox`, `unknownFutureValue`, `rpaBox`. The default value is `windows365`. 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`. Supports `$filter`, `$select`, and `$orderBy`.| |microsoftManagedDesktop|[microsoftManagedDesktop](../resources/microsoftmanageddesktop.md)|The specific settings to **microsoftManagedDesktop** that enables Microsoft Managed Desktop customers to get device managed experience for Cloud PC. To enable **microsoftManagedDesktop** to provide more value, an admin needs to specify certain settings in it. Supports `$filter`, `$select`, and `$orderBy`.|-|provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|Specifies the type of license used when provisioning Cloud PCs using this policy. By default, the license type is `dedicated` if the **provisioningType** isn't specified when you create the **cloudPcProvisioningPolicy**. You can't change this property after the **cloudPcProvisioningPolicy** was created. Possible values are: `dedicated`, `shared`, `unknownFutureValue`.| +|provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|Specifies the type of licenses to be used when provisioning Cloud PCs using this policy. The possible values are `dedicated`, `shared`, `unknownFutureValue`, `sharedByUser`, `sharedByEntraGroup`. 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): `sharedByUser`, `sharedByEntraGroup`. The `shared` member is deprecated and will stop returning on April 30, 2027; going forward, use the `sharedByUser` member. For example, a `dedicated` service plan can be assigned to only one user and provision only one Cloud PC. The `shared` and `sharedByUser` plans require customers to purchase a shared service plan. Each shared license purchased can enable up to three Cloud PCs, with only one user signed in at a time. The `sharedByEntraGroup` plan also requires the purchase of a shared service plan. Each shared license under this plan can enable one Cloud PC, which is shared for the group according to the assignments of this policy. By default, the license type is `dedicated` if the **provisioningType** isn't specified when you create the **cloudPcProvisioningPolicy**. You can't change this property after the **cloudPcProvisioningPolicy** is created.| |windowsSetting|[cloudPcWindowsSettings](../resources/cloudpcwindowssetting.md)|Indicates a specific Windows setting to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. |-|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID.| -|onPremisesConnectionId (deprecated)|String|The ID of the [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnection.md). To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service.| +|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID. The **domainJoinConfiguration** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.| +|onPremisesConnectionId (deprecated)|String|The ID of the [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnection.md). To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network that the Cloud PC service validated it. The **onPremisesConnectionId** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.| |windowsSettings (deprecated)|[cloudPcWindowsSettings](../resources/cloudpcwindowssettings.md)|Specific Windows settings to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. The **windowsSettings** property is deprecated and will stop returning data on January 31, 2024. Going forward, use the **windowsSetting** property.| ### cloudPcProvisioningType values + The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `sharedByUser`, `sharedByEntraGroup`. + | Member | Description | |:--|:--| | dedicated | Indicates that a dedicated license is used for provisioning Cloud PCs. Default value. |-| shared | Indicates that a shared license is used for provisioning Cloud PCs. | -| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +| shared (deprecated) | Indicates that a shared license is used for provisioning Cloud PCs. The `shared` member is deprecated and will stop returning on April 30, 2027. Going forward, use the `sharedByUser` member. +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +| sharedByUser | Indicates the provisioning policy when a dedicated Cloud PC is provisioned for each user in the assignment group. Users are always connected to the same Cloud PC. However, Cloud PC availability is limited by the total number of active sessions. | +| sharedByEntraGroup | Indicates the provisioning policy associated with Cloud PCs shared by a Microsoft Entra (Azure AD) group. When a shared Cloud PC is provisioned, it becomes available for any user in the Microsoft Entra ID assignment group to connect to. Users may be connected to a different Cloud PC on each connection and availability is limited by the number of provisioned Cloud PCs. | ## Relationships |
v1.0 | Cloudpcremoteactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcremoteactionresult.md | 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.cloudPcRemoteActionResult" |
v1.0 | Cloudpcresizevalidationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcresizevalidationresult.md | 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.cloudPcResizeValidationResult" |
v1.0 | Cloudpcserviceplan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcserviceplan.md | For examples of currently available service plans, see [Windows 365 compare plan |:|:|:| |displayName|String|The name for the service plan. Read-only.| |id|String|Unique identifier for the service plan. Read-only.|+|provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|Specifies the type of license used when provisioning Cloud PCs. By default, the license type is `dedicated`. Possible values are: `dedicated`, `shared`, `unknownFutureValue`, `sharedByUser`, `sharedByEntraGroup`. 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): `sharedByUser`, `sharedByEntraGroup`. The `shared` member is deprecated and will stop returning on April 30, 2027; going forward, use the `sharedByUser` member.| |ramInGB|Int32|The size of the RAM in GB. Read-only.|+|supportedSolution|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|The supported service or solution for the region. The possible values are: `windows365`, `devBox`, `rpaBox`, `unknownFutureValue`. Read-only.| |storageInGB|Int32|The size of the OS Disk in GB. Read-only.| |type|[cloudPcServicePlanType](#cloudpcserviceplantype-values)|The type of the service plan. Possible values are: `enterprise`, `business`, `unknownFutureValue`. Read-only.| |userProfileInGB|Int32|The size of the user profile disk in GB. Read-only.| |vCpuCount|Int32|The number of vCPUs. Read-only.|-|supportedSolution|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|The supported service or solution for the region. The possible values are: `windows365`, `devBox`, `rpaBox`, `unknownFutureValue`. Read-only.| -|provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|Specifies the type of license used when provisioning Cloud PCs. By default, the license type is `dedicated`. Possible values are: `dedicated`, `shared`, `unknownFutureValue`.| ### cloudPcServicePlanType values For examples of currently available service plans, see [Windows 365 compare plan |:|:| |enterprise|Enterprise service plan type for enterprise customers.| |business|Business service plan type for Very Small Business (VSB) customers.|-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| ## Relationships None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Cloudpcuserrolescopetaginfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcuserrolescopetaginfo.md | Represents the scope tag info with display name and identity. 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.cloudPcUserRoleScopeTagInfo" |
v1.0 | Cloudrealtimecommunicationinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudrealtimecommunicationinfo.md | Represents a group of properties that relate to Microsoft real-time communicatio | isSipEnabled | Boolean | Indicates whether the user has a SIP-enabled client registered for them. Read-only. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo" |
v1.0 | Command | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/command.md | None ## Relationships 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.command" |
v1.0 | Commsoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/commsoperation.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ ],- "@odata.type": "microsoft.graph.commsOperation" + "@odata.type": "microsoft.graph.commsOperation", + "baseType": "microsoft.graph.entity" }--> ```json { |
v1.0 | Communications Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/communications-api-overview.md | This API provides calling functionality as well as the ability to create and ret One of the following [permissions](/graph/permissions-reference#calls-permissions) is required to access the cloud communications API. These permissions need to be granted by the administrator. -| Scenario | Permissions | -|:-|:--| -| Calling | Calls.JoinGroupCallAsGuest.All, Calls.JoinGroupCall.All, Calls.Initiate.All, Calls.InitiateGroupCall.All, Calls.AccessMedia.All | -| Meetings | OnlineMeetings.ReadWrite.All, OnlineMeetings.Read.All | -| Presence | Presence.Read, Presence.Read.All | -| Call records | CallRecords.Read.All | +| Scenario | Permissions | +|:--|:--| +| Call records | CallRecords.Read.All | +| Calling | Calls.JoinGroupCallAsGuest.All, Calls.JoinGroupCall.All, Calls.Initiate.All, Calls.InitiateGroupCall.All, Calls.AccessMedia.All | +| Meetings | OnlineMeetings.ReadWrite.All, OnlineMeetings.Read.All | +| Presence | Presence.Read, Presence.Read.All | +| Virtual event | VirtualEvent.Read, VirtualEvent.ReadWrite | + ## Common use cases The following table lists some of the common uses for the cloud communications A | Use cases | REST resources | See also | |:|:|:-|-| Creating and joining 1-1 and group calls | [Call](/graph/api/resources/call?view=graph-rest-beta&preserve-view=true&preserve-view=true)| [Methods for calls](/graph/api/resources/call?view=graph-rest-beta&preserve-view=true#methods&preserve-view=true)| +| Creating and joining 1-1 and group calls | [call](/graph/api/resources/call?view=graph-rest-beta&preserve-view=true&preserve-view=true)| [Methods for calls](/graph/api/resources/call?view=graph-rest-beta&preserve-view=true#methods&preserve-view=true)| |IVR calls | | [Methods for IVR](/graph/api/resources/calls-api-ivr-overview?view=graph-rest-beta?&preserve-view=true&preserve-view=true)-| Call controls (participant) | [Participant](/graph/api/resources/participant?view=graph-rest-beta&preserve-view=true&preserve-view=true) || +| Call controls (participant) | [participant](/graph/api/resources/participant?view=graph-rest-beta&preserve-view=true&preserve-view=true) || |Meetings|[onlineMeeting](/graph/api/resources/onlinemeeting?view=graph-rest-beta&preserve-view=true&preserve-view=true)| [Methods for meetings](/graph/api/resources/onlinemeeting?view=graph-rest-beta&preserve-view=true#methods&preserve-view=true)| |Presence | [presence](/graph/api/resources/presence?view=graph-rest-beta&preserve-view=true) | [Methods for presence](/graph/api/resources/presence?view=graph-rest-beta&preserve-view=true#methods) | | Retrieving call records | [callRecord](/graph/api/resources/callrecords-callrecord?view=graph-rest-beta&preserve-view=true&preserve-view=true) | [Webhook subscriptions](/graph/api/resources/webhooks?view=graph-rest-beta&preserve-view=true&preserve-view=true) |+| Virtual events | [virtualEvent](/graph/api/resources/virtualevent?view=graph-rest-beta&preserve-view=true) | [Methods for virtualEventTownhall](/graph/api/resources/virtualeventtownhall#methods?view=graph-rest-beta&preserve-view=true), [Methods for virtualEventWebinar](/graph/api/resources/virtualeventwebinar#methods?view=graph-rest-beta&preserve-view=true) | ## Common properties |
v1.0 | Conditionalaccessaudience | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/conditionalaccessaudience.md | + + Title: "conditionalaccessAudience resource type" +description: "Represents the audience evaluated by Conditional Access during a sign-in event." +ms.localizationpriority: medium +++++# conditionalAccessAudience resource type ++Namespace: microsoft.graph +++Represents the audience evaluated by Conditional Access during a sign-in event. ++## Properties ++| Property | Type |Description| +|:|:--|:-| +|applicationId|String|The ID of the application.| +|audienceReasons|[conditionalAccessAudienceReason](#conditionalaccessaudiencereason-values)|Indicates the reasons this audience was included for a sign-in request.| ++## conditionalAccessAudienceReason values ++|Member| +|:--| +|resourcelessRequest| +|confidentialClientIdToken| +|confidentialClientNonIdToken| +|resourceMapping| +|resourceMappingDefault| +|scopeMapping| +|scopeMappingDefault| +|delegatedScope | +|firstPartyResourceDefault| +|thirdPartyResourceDefault| +|unknownFutureValue| ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.conditionalAccessAudience" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.conditionalAccessAudience", + "applicationID": "String", + "audienceReasons": "String" +} +``` |
v1.0 | Conditionalaccessconditionset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/conditionalaccessconditionset.md | Represents the type of conditions that govern when the policy applies. |authenticationFlows|[conditionalAccessAuthenticationFlows](conditionalaccessauthenticationflows.md)| Authentication flows included in the policy scope. For more information, see [Conditional Access: Authentication flows](/entra/identity/conditional-access/concept-authentication-flows). | |users|[conditionalAccessUsers](conditionalaccessusers.md)| Users, groups, and roles included in and excluded from the policy. Either **users** or **clientApplications** is required. | |clientApplications|[conditionalAccessClientApplications](../resources/conditionalaccessclientapplications.md)|Client applications (service principals and workload identities) included in and excluded from the policy. Either **users** or **clientApplications** is required. |-|clientAppTypes|conditionalAccessClientApp collection| Client application types included in the policy. Possible values are: `all`, `browser`, `mobileAppsAndDesktopClients`, `exchangeActiveSync`, `easSupported`, `other`. Required. <br/><br/> The `easUnsupported` enumeration member will be deprecated in favor of `exchangeActiveSync`, which includes EAS supported and unsupported platforms.| +|clientAppTypes|conditionalAccessClientApp collection| Client application types included in the policy. Possible values are: `all`, `browser`, `mobileAppsAndDesktopClients`, `exchangeActiveSync`, `easSupported`, `other`. Required. <br/><br/> The `easUnsupported` enumeration member is deprecated in favor of `exchangeActiveSync`, which includes EAS supported and unsupported platforms.| |deviceStates|[conditionalAccessDeviceStates](conditionalaccessdevicestates.md)| Device states in the policy. To be deprecated and removed. Use the **devices** property instead. | |devices|[conditionalAccessDevices](conditionalaccessdevices.md)| Devices in the policy. | |locations|[conditionalAccessLocations](conditionalaccesslocations.md)| Locations included in and excluded from the policy. | Represents the type of conditions that govern when the policy applies. |servicePrincipalRiskLevels|riskLevel collection| Service principal risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `none`, `unknownFutureValue`.| |signInRiskLevels|riskLevel collection| Sign-in risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`. Required.| |userRiskLevels|riskLevel collection| User risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`. Required.|+|insiderRiskLevels|conditionalAccessInsiderRiskLevels| Insider risk levels included in the policy. The possible values are: `minor`, `moderate`, `elevated`, `unknownFutureValue`.| ## Relationships The following JSON representation shows the resource type. "platforms": {"@odata.type": "microsoft.graph.conditionalAccessPlatforms"}, "servicePrincipalRiskLevels": ["String"], "signInRiskLevels": ["String"],- "authenticationFlows": {"@odata.type": "microsoft.graph.conditionalAccessAuthenticationFlows"} + "authenticationFlows": {"@odata.type": "microsoft.graph.conditionalAccessAuthenticationFlows"}, + "insiderRiskLevels": "String" } ``` The following JSON representation shows the resource type. "section": "documentation", "tocPath": "" }-->-- |
v1.0 | Conditionalaccessguestsorexternalusers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/conditionalaccessguestsorexternalusers.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Conditionalaccesssessioncontrols | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/conditionalaccesssessioncontrols.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Connector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/connector.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Connectors are lightweight agents that sit on-premises and facilitate the outbound connection to the [Microsoft Entra application proxy](/azure/active-directory/app-proxy/what-is-application-proxy) service. Each connector is part of a [connectorGroup](connectorgroup.md). +Represents an Application Proxy connector. Connectors are lightweight agents that sit on-premises and facilitate the outbound connection to the [Microsoft Entra application proxy](/azure/active-directory/app-proxy/what-is-application-proxy) service. Each connector is part of a [connectorGroup](connectorgroup.md). ## Methods | Method | Return Type | Description | |:-|:|:| | [List connectors](../api/connector-list.md) | [connector](connector.md) collection | Retrieve a list of connector objects. | -| [Get connector](../api/connector-get.md) | [connector](connector.md) | Read properties and relationships of connector object. | -| [List memberOf](../api/connector-list-memberof.md) | [connectorGroup](connectorgroup.md) collection | List the connectorGroup object collection the connector is a member of. | -| [Add connector to connectorGroup](../api/connector-post-memberof.md)| [connectorGroup](connectorgroup.md) | Add a connector to a connectorGroup. | +| [Get connector](../api/connector-get.md) | [connector](connector.md) | Read the properties and relationships of a connector object. | +| [List memberOf](../api/connector-list-memberof.md) | [connectorGroup](connectorgroup.md) collection | List the **connectorGroup** object collection the connector is a member of. | +| [Add connector to connectorGroup](../api/connector-post-memberof.md)| [connectorGroup](connectorgroup.md) | Add a connector to a **connectorGroup**. | ## Properties | Property | Type | Description | |:-|:|:|-|externalIp|String| The external IP address as detected by the the connector server. Read-only. | -|id|String| Unique identifier of the connector. Read-only. | -|machineName|String| The machine name the connector is installed and running on. | -|status|connectorStatus| Indicates the status of the connector. Possible values are: `active`, `inactive`. Read-only. | +|externalIp|String| The external IP address as detected by the connector server. Read-only. | +|id|String| The unique identifier of the connector. Read-only. | +|machineName|String| The name of the computer on which the connector is installed and runs on. | +|status|connectorStatus| Indicates the status of the connector. The possible values are: `active`, `inactive`. Read-only. | +|version|String|The version of the connector.| ## Relationships | Relationship | Type |Description| |:|:--|:-|-|memberOf|[connectorGroup](connectorgroup.md) collection| The connectorGroup that the connector is a member of. Read-only. | +|memberOf|[connectorGroup](connectorgroup.md) collection| The **connectorGroup** that the connector is a member of. Read-only. | ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", The following is a JSON representation of the resource. "externalIp": "String", "id": "String (identifier)", "machineName": "String",- "status": "string" + "status": "String", + "version": "String" }- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Connectors Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/connectors-api-overview.md | The following are current known limitations: - An application is limited to 25 concurrent operations on a connection. - Connections have a capacity limit of 5,000,000 items or ~350 GB of data. - Maximum size of an **externalItem** entity is 4 MB.-- Sorting results is not supported. ## Next steps -- See the [Microsoft Graph connectors overview](https://learn.microsoft.com/graph/connecting-external-content-connectors-overview).+- See the [Microsoft Graph connectors overview](/graph/connecting-external-content-connectors-overview). - Drill down on the methods, properties, and relationships of the [externalConnection](externalconnectors-externalconnection.md), [schema](externalconnectors-schema.md), and [externalItem](externalconnectors-externalitem.md) resources. - Check out the [Microsoft Graph postman collection](https://www.postman.com/microsoftgraph/workspace/microsoft-graph/folder/455214-66cbb476-ad94-448e-ba5a-ef58e1da7a90?ctx=documentation). - Check out the [sample search connector](https://github.com/microsoftgraph/msgraph-search-connector-sample). |
v1.0 | Consentrequests Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/consentrequests-overview.md | Before an app can be used to access any data in your organization, the admin mus The Microsoft Entra consent workflow allows users to request the tenant admins to grant consent to apps that require admin approval. The consent requests APIs in Microsoft Graph allows admin to configure the consent workflow and track consent requests for both apps and users. >[!NOTE]->The current APIs are limited to configuring the workflow and reading the list of requests. At this time, there arenΓÇÖt any methods available to programmatically approve or deny a request. However, the contents of the request can be used to recreate a URL which can be used to grant admin consent and approve a request. +>The current APIs are limited to configuring the workflow and reading the list of requests. At this time, there aren't any methods available to programmatically approve or deny a request. However, the contents of the request can be used to recreate a URL which can be used to grant admin consent and approve a request. [!INCLUDE [GDPR-related-guidance](../../includes/gdpr-msgraph-export-note.md)] The following directory roles are required for a calling application. | Operation | Delegated permissions | Required directory role of the calling user | |:|:|:--|-| Read | ConsentRequest.Read.All, ConsentRequest.ReadWrite.All | Global Reader, Cloud App Administrator, Application Administrator, or Global Administrator | +| Read | ConsentRequest.Read.All, ConsentRequest.ReadWrite.All | Global Reader, Cloud App Administrator, or Application Administrator | ## Related content |
v1.0 | Contact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/contact.md | The following is a JSON representation of the resource. "singleValueExtendedProperties" ], "keyProperty":"id",- "@odata.type": "microsoft.graph.contact" + "@odata.type": "microsoft.graph.contact", + "baseType": "microsoft.graph.outlookItem" }--> ```json |
v1.0 | Containstransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/containstransformation.md | + + Title: "containsTransformation resource type" +description: "Contains the output of a transformation if the input matches the specified value." ++ms.localizationpriority: medium ++++# containsTransformation resource type ++Namespace: microsoft.graph +++Contains the output of a transformation if the input matches the specified value. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|output|[transformationAttribute](../resources/transformationattribute.md)|The output attribute that is used based on the condition applied in this transformation.| +|value|String|The value to be used as part of the transformation.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.containsTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.containsTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "output": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "value": "String" +} +``` |
v1.0 | Contentcustomization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/contentcustomization.md | Contains details of the various content options to be customized in the authenti |:|:|:| |attributeCollection|[keyValue](../resources/keyvalue.md) collection| Represents the content options of External Identities to be customized throughout the authentication flow for a tenant.| |attributeCollectionRelativeUrl|String| A relative URL for the content options of External Identities to be customized throughout the authentication flow for a tenant.|+|registrationCampaign|[keyValue](../resources/keyvalue.md) collection| Represents content options to customize during MFA proofup interruptions. | +|registrationCampaignRelativeUrl|String| The relative URL of the content options to customize during MFA proofup interruptions. | ## Relationships None. The following is a JSON representation of the resource. "@odata.type": "microsoft.graph.keyValue" } ],- "attributeCollectionRelativeUrl": "String" + "attributeCollectionRelativeUrl": "String", + "registrationCampaign": [ + { + "@odata.type": "microsoft.graph.keyValue" + } + ], + "registrationCampaignRelativeUrl": "String" } ``` |
v1.0 | Contenttypeinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/contenttypeinfo.md | Represents the SharePoint [contentType](contenttype.md) of an item. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.contentTypeInfo", "@type.aka": "oneDrive.contentTypeFacet" } --> |
v1.0 | Contract | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/contract.md | None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Controlscore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/controlscore.md | Namespace: microsoft.graph This resource contains a tenant score and description for an individual control. -|Name |Type |Description | -|:--|:--|:--| +## Properties +|Property|Type|Description| +|:|:|:| | controlName | String | Control unique name | | score | Double | Tenant achieved score for the control (it varies day by day depending on tenant operations on the control). | | controlCategory | String | Control action category (Identity, Data, Device, Apps, Infrastructure). | |
v1.0 | Conversation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/conversation.md | This resource supports subscribing to [change notifications](/graph/webhooks). ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Conversationmemberroleupdatedeventmessagedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/conversationmemberroleupdatedeventmessagedetail.md | The following is a JSON representation of the resource. "conversationMemberRoles": [ "String" ],- "converstaionMemberUser": { + "conversationMemberUser": { "@odata.type": "microsoft.graph.teamworkUserIdentity" }, "initiator": { |
v1.0 | Conversationthread | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/conversationthread.md | A new thread is created when a recipient is removed from the thread. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Conversionuserdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/conversionuserdetails.md | description: "Represents information that the API returns after a user is conver ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Convertidresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/convertidresult.md | The result of an ID format conversion performed by the [translateExchangeIds](.. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Crosstenantaccesspolicyconfigurationpartner | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/crosstenantaccesspolicyconfigurationpartner.md | For any partner-specific property that is `null`, these settings will inherit th ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "tenantId", |
v1.0 | Customaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customaction.md | Represents any custom actions that a label may provide, if configured by the adm ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Customauthenticationextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customauthenticationextension.md | Inherits from [customCalloutExtension](../resources/customcalloutextension.md). Learn how to use this API when [Configuring a custom claim provider token issuance event (preview)](/azure/active-directory/develop/custom-extension-get-started?tabs=microsoft-graph?toc=/graph/toc.json&context=graph/context). +> [!NOTE] +> +> You can have a maximum of 100 custom extension policies. + ## Methods |Method|Return type|Description| |:|:|:|-|[List customAuthenticationExtensions](../api/identitycontainer-list-customauthenticationextensions.md)|[customAuthenticationExtension](../resources/customauthenticationextension.md) collection|Get a list of the [customAuthenticationExtension](../resources/customauthenticationextension.md) objects and their properties.| -|[Create customAuthenticationExtension](../api/identitycontainer-post-customauthenticationextensions.md)|[customAuthenticationExtension](../resources/customauthenticationextension.md)|Create a new [customAuthenticationExtension](../resources/customauthenticationextension.md) object.| -|[Get customAuthenticationExtension](../api/customauthenticationextension-get.md)|[customAuthenticationExtension](../resources/customauthenticationextension.md)|Read the properties and relationships of a [customAuthenticationExtension](../resources/customauthenticationextension.md) object.| -|[Update customAuthenticationExtension](../api/customauthenticationextension-update.md)|None|Update the properties of a [customAuthenticationExtension](../resources/customauthenticationextension.md) object.| -|[Delete customAuthenticationExtension](../api/customauthenticationextension-delete.md)|None|Delete a [customAuthenticationExtension](../resources/customauthenticationextension.md) object.| -|[validateAuthenticationConfiguration](../api/customauthenticationextension-validateauthenticationconfiguration.md)|[authenticationConfigurationValidation](../resources/authenticationconfigurationvalidation.md)|Check validity of the endpoint and authentication configuration for a [customAuthenticationExtension](../resources/customauthenticationextension.md) object.| +|[List](../api/identitycontainer-list-customauthenticationextensions.md)|[customAuthenticationExtension](../resources/customauthenticationextension.md) collection|Retrieve a list of the object types that are derived from **customAuthenticationExtension**.| +|[Create](../api/identitycontainer-post-customauthenticationextensions.md)|[customAuthenticationExtension](../resources/customauthenticationextension.md)|Create a new object type that is derived from **customAuthenticationExtension**.| +|[Get](../api/customauthenticationextension-get.md)|[customAuthenticationExtension](../resources/customauthenticationextension.md)|Read the properties and relationships of an object type that is derived from **customAuthenticationExtension**.| +|[Update](../api/customauthenticationextension-update.md)|None|Update the properties of an object type that is derived from **customAuthenticationExtension**.| +|[Delete](../api/customauthenticationextension-delete.md)|None|Delete an object type that is derived from **customAuthenticationExtension**.| +|[Validate authentication configuration](../api/customauthenticationextension-validateauthenticationconfiguration.md)|[authenticationConfigurationValidation](../resources/authenticationconfigurationvalidation.md)|Check validity of the endpoint and authentication configuration for a [customAuthenticationExtension](../resources/customauthenticationextension.md) object.| +|**On attribute collection start**||| +|[Get](../api/onattributecollectionstartcustomextension-get.md)|[onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md)|Read the properties and relationships of an [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) object.| +|[Update](../api/onattributecollectionstartcustomextension-update.md)|[onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md)|Update the properties of an [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) object.| +|**On attribute collection submit**||| +|[Get](../api/onattributecollectionsubmitcustomextension-get.md)|[onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md)|Read the properties and relationships of an [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) object.| +|[Update](../api/onattributecollectionsubmitcustomextension-update.md)|[onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md)|Update the properties of an [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) object.| ## Properties |Property|Type|Description| |
v1.0 | Customclaim | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customclaim.md | + + Title: "customClaim resource type" +description: "Represents an individual claim included in the tokens affected by this policy." ++ms.localizationpriority: medium ++++# customClaim resource type ++Namespace: microsoft.graph +++Represents an individual claim included in the tokens affected by this policy. It consists of a configurable name, namespace, token format, and claim name format. The claim name format is applicable only for SAML tokens. ++Inherits from [customClaimBase](../resources/customclaimbase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|configurations|[customClaimConfiguration](../resources/customclaimconfiguration.md) collection|One or more configurations that describe how the claim is sourced and under what conditions. Inherited from [customClaimBase](../resources/customclaimbase.md).| +|name|String|The name of the claim to be emitted.| +|namespace|String|An optional namespace to be included as part of the claim name.| +|samlAttributeNameFormat|samlAttributeNameFormat|If specified, it sets the `nameFormat` attribute associated with the claim in the SAML response. The possible values are: `unspecified`, `uri`, `basic`, `unknownFutureValue`.| +|tokenFormat|tokenFormat collection|List of token formats for which this claim should be emitted. The possible values are: `saml`,`jwt`, `unknownFutureValue`| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.customClaim" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customClaim", + "configurations": [ + { + "@odata.type": "microsoft.graph.customClaimConfiguration" + } + ], + "name": "String", + "namespace": "String", + "tokenFormat": [ + "String" + ], + "samlAttributeNameFormat": "String" +} +``` |
v1.0 | Customclaimattributebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customclaimattributebase.md | + + Title: "customClaimAttributeBase resource type" +description: "Custom claim attribute base." ++ms.localizationpriority: medium ++++# customClaimAttributeBase resource type ++Namespace: microsoft.graph +++This is an abstract type for the custom claim attribute base. ++## Properties +None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.customClaimAttributeBase" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customClaimAttributeBase" +} +``` |
v1.0 | Customclaimbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customclaimbase.md | + + Title: "customClaimBase resource type" +description: "Represents an abstract type for a claim, contains a collection of configurations for a claim." ++ms.localizationpriority: medium ++++# customClaimBase resource type ++Namespace: microsoft.graph +++Represents an abstract type for a custom claim. It contains a collection of configurations for a claim. ++## Properties +|Property|Type|Description| +|:|:|:| +|configurations|[customClaimConfiguration](../resources/customclaimconfiguration.md) collection|One or more configurations that describe how the claim is sourced and under what conditions.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.customClaimBase" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customClaimBase", + "configurations": [ + { + "@odata.type": "microsoft.graph.customClaimConfiguration" + } + ] +} +``` |
v1.0 | Customclaimcondition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customclaimcondition.md | + + Title: "customClaimCondition resource type" +description: "Represents a claim condition associated with a particular claim configuration. The claim configuration is only applied if the condition is met." ++ms.localizationpriority: medium ++++# customClaimCondition resource type ++Namespace: microsoft.graph +++Represents a claim condition associated with a particular claim configuration. The claim configuration is only applied if the condition is met. ++Inherits from [customClaimConditionBase](../resources/customclaimconditionbase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|memberOf|String collection|A list of groups (GUIDs) to which the user/application must be a member for this condition to be applied.| +|userType|claimConditionUserType|The type of user this condition applies to. The possible values are: `any`, `members`, `allGuests`, `aadGuests`, `externalGuests`, `unknownFutureValue`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.customClaimCondition" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customClaimCondition", + "userType": "String", + "memberOf": [ + "String" + ] +} +``` |
v1.0 | Customclaimconditionbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customclaimconditionbase.md | + + Title: "customClaimConditionBase resource type" +description: "Represents a custom claim condition base." ++ms.localizationpriority: medium ++++# customClaimConditionBase resource type ++Namespace: microsoft.graph +++Represents an abstract type for a custom claim condition base. ++## Properties +None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.customClaimConditionBase" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customClaimConditionBase" +} +``` |
v1.0 | Customclaimconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customclaimconfiguration.md | + + Title: "customClaimConfiguration resource type" +description: "Represents a claim configuration that details the conditions and sources of any custom claim." ++ms.localizationpriority: medium ++++# customClaimConfiguration resource type ++Namespace: microsoft.graph +++Represents a claim configuration that details the conditions and sources of any custom claim. Typically, an attribute or a set of transforms should be provided to source the claim value. In the case where both are provided, the output of the transforms takes priority. If the transform results in no output then the attribute value is used. ++## Properties +|Property|Type|Description| +|:|:|:| +|attribute|[customClaimAttributeBase](../resources/customclaimattributebase.md)|The attribute on which we source this property.| +|condition|[customClaimConditionBase](../resources/customclaimconditionbase.md)|The condition, if any, associated with this configuration.| +|transformations|[customClaimTransformation](../resources/customclaimtransformation.md) collection|An ordered list of transformations that are applied in sequence.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.customClaimConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customClaimConfiguration", + "condition": { + "@odata.type": "microsoft.graph.customClaimConditionBase" + }, + "attribute": { + "@odata.type": "microsoft.graph.customClaimAttributeBase" + }, + "transformations": [ + { + "@odata.type": "microsoft.graph.containsTransformation" + } + ] +} +``` |
v1.0 | Customclaimspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customclaimspolicy.md | + + Title: "customClaimsPolicy resource type" +description: "Represents a claims policy that allows application admins to customize the claims emitted in tokens affected by this policy." ++ms.localizationpriority: medium ++++# customClaimsPolicy resource type ++Namespace: microsoft.graph +++Represents a claims policy that allows application admins to customize the claims emitted in tokens affected by this policy. ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get](../api/customclaimspolicy-get.md)|[customClaimsPolicy](../resources/customclaimspolicy.md)|Read the properties and relationships of a custom claims policy object.| +|[Create or replace](../api/serviceprincipal-put-claimspolicy.md)|[customClaimsPolicy](../resources/customclaimspolicy.md)|Create a new custom claims policy object if it doesn't exist, or replace an existing one.| +|[Update](../api/customclaimspolicy-update.md)|[customClaimsPolicy](../resources/customclaimspolicy.md)|Update the properties of a custom claims policy object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|audienceOverride|String|If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols. A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored. The value provided must be in the format of an absolute URI.| +|claims|[customClaim](../resources/customclaim.md) collection|Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set. Inherited from [customclaimbase](../resources/customclaimbase.md).| +|id|String|Policy identifier string. Inherited from [entity](../resources/entity.md).| +|includeApplicationIdInIssuer|Boolean|Indicates whether the application ID is added to the claim. It is relevant only for SAML2.0 and if a custom signing key is used. the default value is `true`. Optional.| +|includeBasicClaimSet|Boolean|Determines whether the basic claim set is included in tokens affected by this policy. If set to `true`, all claims in the basic claim set are emitted in tokens affected by the policy. By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.customClaimsPolicy", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customClaimsPolicy", + "id": "String (identifier)", + "includeBasicClaimSet": "Boolean", + "includeApplicationIdInIssuer": "Boolean", + "audienceOverride": "String", + "groupFilter": { + "@odata.type": "microsoft.graph.groupClaimFilterBase" + }, + "claims": [ + { + "@odata.type": "microsoft.graph.customClaim" + } + ] +} +``` |
v1.0 | Customclaimtransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customclaimtransformation.md | + + Title: "customClaimTransformation resource type" +description: "Represents an abstract type for a single input attribute." ++ms.localizationpriority: medium ++++# customClaimTransformation resource type ++Namespace: microsoft.graph +++Represents an abstract type for a single input attribute. ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.customClaimTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customClaimTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + } +} +``` |
v1.0 | Customextensionauthenticationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customextensionauthenticationconfiguration.md | 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.customExtensionAuthenticationConfiguration", |
v1.0 | Customextensionclientconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customextensionclientconfiguration.md | Connection settings that define how long Microsoft Entra ID can wait for a respo 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.customExtensionClientConfiguration" |
v1.0 | Customextensionhandler | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customextensionhandler.md | None. |customExtension|[customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md)|Indicates which custom workflow extension is executed at this stage. Nullable. Supports `$expand`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Customextensionstagesetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customextensionstagesetting.md | None |customExtension|[customCalloutExtension](../resources/customcalloutextension.md)|Indicates the custom workflow extension that is executed at this stage. Nullable. Supports `$expand`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Customquestionanswer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customquestionanswer.md | Represents a registrant's answer to the [custom registration question](meetingre <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.customQuestionAnswer" + "@odata.type": "microsoft.graph.customQuestionAnswer", + "baseType": "microsoft.graph.entity" }--> ```json |
v1.0 | Customtimezone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customtimezone.md | Represents a time zone where the transition from standard to daylight saving tim ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Dailyuserinsightmetricsroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dailyuserinsightmetricsroot.md | None. |Relationship|Type|Description| |:|:|:| |activeUsers|[activeUsersMetric](../resources/activeusersmetric.md) collection|Insights for active users on apps registered in the tenant for a specified period.|-|activeUsersBreakdown (deprecated)|[activeUsersBreakdownMetric](../resources/activeusersbreakdownmetric.md) collection| Insights for the breakdown of users who were active on apps registered in the tenant for a specified period.| |authentications|[authenticationsMetric](../resources/authenticationsmetric.md) collection|Insights for authentications on apps registered in the tenant for a specified period.| |mfaCompletions|[mfaCompletionMetric](../resources/mfacompletionmetric.md) collection|Insights for MFA usage on apps registered in the tenant for a specified period.| |signUps|[userSignUpMetric](../resources/usersignupmetric.md) collection| Total sign-ups on apps registered in the tenant for a specified period.| |
v1.0 | Datacollectioninfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/datacollectioninfo.md | description: "Represents the details and status of the data collection process f ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Datapolicyoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/datapolicyoperation.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Datasubject | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/datasubject.md | The following is a JSON representation of the resource. "email": "String", "firstName": "String", "lastName": "String",- "residency": "String", - "SSN": "String" + "residency": "String" } ``` |
v1.0 | Datetimetimezone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/datetimetimezone.md | Describes the date, time, and time zone of a point in time. In general, the **timeZone** property _can_ be set to any of the [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones), and the additional [time zones supported by the calendar API](#additional-time-zones). - If you use **dateTimeTimeZone** with a method (such as [creating](../api/user-post-events.md) or [updating](../api/event-update.md) an event), take note of the actual time zones supported, which can be a smaller subset.-- If you use **dateTimeTimeZone** with the [virtual event](../resources/virtualevent.md) APIs, the only supported format for the **timeZone** property is [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones).+- If you use **dateTimeTimeZone** with the [virtual event](../resources/virtualevent.md) APIs, the only supported format for the **timeZone** property is 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). ### Additional time zones Pacific/Kiritimati ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Daylighttimezoneoffset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/daylighttimezoneoffset.md | daylight saving time to standard occurs at 2 AM on the fourth Sunday of May, eve ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Defaultsharinglink | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/defaultsharinglink.md | + + Title: "defaultSharingLink resource type" +description: "Represents the default sharing link a user can create." ++ms.localizationpriority: medium ++++# defaultSharingLink resource type ++Namespace: microsoft.graph +++Represents the default sharing link a user can create. ++## Properties ++|Property|Type|Description| +|:|:|:| +|defaultToExistingAccess|Boolean|Indicates whether the default link setting for this object is a direct URL rather than a sharing link.| +|role|sharingRole|The default sharing link role. The possible values are: `none`, `view`, `edit`, `manageList`, `review`, `restrictedView`, `submitOnly`, `unknownFutureValue`.| +|scope|sharingScope|The default sharing link scope. The possible values are: `anyone`, `organization`, `specificPeople`, `anonymous`, `users`, `unknownFutureValue`.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.defaultSharingLink" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.defaultSharingLink", + "role": "String", + "scope": "String", + "defaultToExistingAccess": "Boolean" +} +``` |
v1.0 | Delegatedadminrelationship | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/delegatedadminrelationship.md | Represents a delegated admin relationship between a partner and customer. |requests|[delegatedAdminRelationshipRequest](../resources/delegatedadminrelationshiprequest.md) collection|The requests associated with the delegated admin relationship.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Delegatedadminrelationshipoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/delegatedadminrelationshipoperation.md | Represents a long-running operation related to a delegated admin relationship. A |data|String|The data (payload) for the operation. Read-only.| |id|String|The unique identifier of the delegated admin long-running operation. Read-only. Inherited from [entity](../resources/entity.md).| |lastModifiedDateTime|DateTimeOffset|The time in ISO 8601 format and in UTC time when the long-running operation was last modified. Read-only.|-|operationType|delegatedAdminRelationshipOperationType|The type of long-running operation. The possible values are: `delegatedAdminAccessAssignmentUpdate`, `unknownFutureValue`. Read-only.| +|operationType|delegatedAdminRelationshipOperationType|The type of long-running operation. The possible values are: `delegatedAdminAccessAssignmentUpdate`, `unknownFutureValue`,`delegatedAdminRelationshipUpdate`. Read-only. You must use the `Prefer: include-unknown-enum-members` request header to get the following value from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `delegatedAdminRelationshipUpdate`.| |status|longRunningOperationStatus|The status of the operation. Read-only. The possible values are: `notStarted`, `running`, `succeeded`, `failed`, `skipped`, `unknownFutureValue`. Read-only. Supports `$orderby`.| ## Relationships None. ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Delegatedadminrelationships Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/delegatedadminrelationships-api-overview.md | Title: "Granular delegated admin privileges (GDAP) API overview" description: "Granular delegated admin privileges (GDAP) allow Microsoft partners to configure and request granular and time-bound access to their customers' environments, allowing customers to enforce a least-privileged access for Microsoft partners." ms.localizationpriority: medium -doc_type: resourcePageType # Granular delegated admin privileges (GDAP) API overview After running the [Create delegatedAdminRelationshipRequest](../api/delegatedadm Send the invitation link to the customer for them to approve the GDAP request. For example, `https://admin.microsoft.com/AdminPortal/Home#/partners/invitation/granularAdminRelationships/5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836` is an invitation link, where `5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836` is the admin relationship request ID. After the customer approves the GDAP request, the GDAP relationship will transition to an active state. -To finalize the workflow for enabling admin on behalf of (AOBO) management of the customer's tenant, proceed by creating a new access assignment for the delegated admin relationship by using the [Create accessAssignments](../api/delegatedadminrelationship-post-accessassignments.md) API. +To finalize the workflow for enabling admin on behalf of (AOBO) management of the customer's tenant, proceed by creating a new access assignment for the delegated admin relationship by using the [Create accessAssignments](../api/delegatedadminrelationship-post-accessassignments.md) API. ### Lifecycle of a GDAP relationship access assignment |
v1.0 | Deleted | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/deleted.md | See [view changes for an item](../api/driveitem-delta.md) for more information o ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Deleteditemcontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/deleteditemcontainer.md | Inherits from [entity](../resources/entity.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Detailsinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/detailsinfo.md | The **detailsInfo** resource is a JSON string that contains other properties suc ## 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.detailsInfo", |
v1.0 | Device | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/device.md | This resource is an open type that allows other properties to be passed in. You > [!IMPORTANT] > Specific usage of `$filter` and the `$search` query parameter is 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#device-properties). -| Property | Type |Description| +| Property | Type |Description| |:|:--|:-|-|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Default is `true`. <br/><br/> Supports `$filter` (`eq`, `ne`, `not`, `in`). Only callers in Global Administrator and Cloud Device Administrator roles can set this property.| +|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Default is `true`. <br/><br/> Supports `$filter` (`eq`, `ne`, `not`, `in`). Only callers with at least the Cloud Device Administrator role can set this property.| |alternativeSecurityIds|[alternativeSecurityId](alternativeSecurityId.md) collection| For internal use only. Not nullable. Supports `$filter` (`eq`, `not`, `ge`, `le`). | |approximateLastSignInDateTime|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` (`eq`, `ne`, `not`, `ge`, `le`, and `eq` on `null` values) and `$orderby`. | |complianceExpirationDateTime|DateTimeOffset| The timestamp when the device is no longer deemed compliant. 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. | This resource is an open type that allows other properties to be passed in. You |isCompliant|Boolean|`true` if the device complies with Mobile Device Management (MDM) policies; otherwise, `false`. Read-only. This can only be updated by Intune for any device OS type or by an [approved MDM app](/windows/client-management/mdm/azure-active-directory-integration-with-mdm) for Windows OS devices. Supports `$filter` (`eq`, `ne`, `not`).| |isManaged|Boolean|`true` if the device is managed by a Mobile Device Management (MDM) app; otherwise, `false`. This can only be updated by Intune for any device OS type or by an [approved MDM app](/windows/client-management/mdm/azure-active-directory-integration-with-mdm) for Windows OS devices. Supports `$filter` (`eq`, `ne`, `not`). | |isManagementRestricted|Boolean|Indicates whether the device is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. The default value is `false`. Read-only. <br/><br/> To manage a device that's a member of a restricted administrative unit, the calling app must be assigned the `Directory.Write.Restricted` permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.|-|isRooted|Boolean|`true` if device is rooted; `false` if device is jail-broken. This can only be updated by Intune.| +|isRooted|Boolean|`true` if the device is rooted; `false` if the device is jail-broken. This property can only be updated by Intune.| |kind| String| Form factor of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome. | |managementType|String|Management channel of the device. This property is set by Intune. Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`.| |manufacturer| String| Manufacturer of the device. Read-only. | This resource is an open type that allows other properties to be passed in. You |trustType|String| Type of trust for the joined device. Read-only. Possible values: `Workplace` (indicates *bring your own personal devices*), `AzureAd` (Cloud only joined devices), `ServerAd` (on-premises domain joined devices joined to Microsoft Entra ID). For more information, see [Introduction to device management in Microsoft Entra ID](/azure/active-directory/device-management-introduction). | ## Relationships-| Relationship | Type |Description| +| Relationship | Type |Description| |:|:--|:-| |commands | [command](command.md) collection | Set of commands sent to this device.| |extensions|[extension](extension.md) collection|The collection of open extensions defined for the device. Read-only. Nullable. | |
v1.0 | Devicedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/devicedetail.md | Indicates device details associated with a device used for signing in. Includes ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Devicemanagement Alertimpact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/devicemanagement-alertimpact.md | 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.deviceManagement.alertImpact" |
v1.0 | Devicemanagement Alertrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/devicemanagement-alertrule.md | The following JSON representation shows the resource type. "threshold": { "@odata.type": "microsoft.graph.deviceManagement.ruleThreshold" },- "condition": [ + "conditions": [ { "@odata.type": "microsoft.graph.deviceManagement.ruleCondition" } |
v1.0 | Devicemanagement Monitoring | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/devicemanagement-monitoring.md | Title: "monitoring resource type" + Title: monitoring resource type description: "Represents the entry point entity type to access all resources related to alerts in the Microsoft Endpoint Manager admin center." ms.localizationpriority: medium doc_type: resourcePageType+toc.keywords: [ Microsoft Endpoint Manager admin center alerts ] # monitoring resource type Namespace: microsoft.graph.deviceManagement Represents the entry point to access all resources related to alerts in the [Microsoft Endpoint Manager admin center](https://endpoint.microsoft.com). -The alert monitoring API provide 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 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. |
v1.0 | Diagnostic | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/diagnostic.md | Information about an error or warning for a OneNote operation. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Directory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directory.md | ms.localizationpriority: medium doc_type: resourcePageType+toc. Title: Deleted item # directory resource type |
v1.0 | Directoryaudit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directoryaudit.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Directoryrole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directoryrole.md | This resource supports: ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Directoryroletemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directoryroletemplate.md | None ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Directorysetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directorysetting.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Directorysettingtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directorysettingtemplate.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Directorysizequota | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directorysizequota.md | description: "Represents a company's used and total directory quota." ms.localizationpriority: medium doc_type: resourcePageType -+ # directorySizeQuota resource type [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a company's used and total directory quota. +Represents a [tenant's](organization.md) used and total directory quota. ## Properties | Property | Type|Description| |
v1.0 | Directsharingabilities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directsharingabilities.md | + + Title: "directSharingAbilities resource type" +description: "Represents the direct sharing abilities." ++ms.localizationpriority: medium ++++# directSharingAbilities resource type ++Namespace: microsoft.graph +++Represents the direct sharing abilities. ++## Properties ++|Property|Type|Description| +|:|:|:| +|addExistingExternalUsers|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates whether the current user can add existing guest recipients to this item using direct sharing.| +|addInternalUsers|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates whether the current user can add internal recipients to this item using direct sharing.| +|addNewExternalUsers|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates whether the current user can add new guest recipients to this item using direct sharing.| +|requestGrantAccess|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates whether the user querying this endpoint can request access for the user or on behalf of other users, after which, site admins, can approve or deny the creation of a potential sharing link.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.directSharingAbilities" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.directSharingAbilities", + "requestGrantAccess": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "addNewExternalUsers": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "addExistingExternalUsers": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "addInternalUsers": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + } +} +``` |
v1.0 | Disableanddeleteuserapplyaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/disableanddeleteuserapplyaction.md | None. 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.disableAndDeleteUserApplyAction" |
v1.0 | Domain | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domain.md | Title: "domain resource type" description: "Represents a domain associated with the tenant."-+ ms.localizationpriority: medium doc_type: resourcePageType 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. 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. To associate a domain with a tenant: To associate a domain with a tenant: 2. [Retrieve](../api/domain-list-verificationdnsrecords.md) the domain verification records. Add the verification record details to the domain's zone file using the domain registrar or DNS server configuration. -3. [Verify](../api/domain-verify.md) the ownership of the domain. This will verify the domain and set the **isVerified** property to `true`. +3. [Verify](../api/domain-verify.md) the ownership of the domain. This verifies the domain and sets the **isVerified** property to `true`. 4. [Indicate](../api/domain-update.md) the supported services you plan to use with the domain. To associate a domain with a tenant: | Property | Type | Description | |:|:--|:-|-|authenticationType|String| Indicates the configured authentication type for the domain. The value is either `Managed` or `Federated`. `Managed` indicates a cloud managed domain where Microsoft Entra ID performs user authentication. `Federated` indicates authentication is federated with an identity provider such as the tenant's on-premises Active Directory via Active Directory Federation Services. Not nullable. | +|authenticationType|String| Indicates the configured authentication type for the domain. The value is either `Managed` or `Federated`. `Managed` indicates a cloud managed domain where Microsoft Entra ID performs user authentication. `Federated` indicates authentication is federated with an identity provider such as the tenant's on-premises Active Directory via Active Directory Federation Services. Not nullable. <br/><br/>To update this property in delegated scenarios, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission. | |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 has been 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 is 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 is only one initial domain per company. Not nullable | +|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 | +|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 is not set, a default value of 14 days will be used.| -|passwordValidityPeriodInDays|Int32| Specifies the length of time that a password is valid before it must be changed. If the property is not set, a default value of 90 days will be used. | -|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 which you can add/remove using Graph API include: `Email`, `OfficeCommunicationsOnline`, `Yammer`. 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.| +|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. | +|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.| |state|[domainState](domainstate.md)| Status of asynchronous operations scheduled for the domain. | ## Relationships 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`.| +|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`.| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Domaindnscnamerecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domaindnscnamerecord.md | Title: "domainDnsCnameRecord resource type" description: "Represents a CNAME record added to the DNS zone file of a particular domain in the tenant."-+ ms.localizationpriority: medium doc_type: resourcePageType None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Domaindnsmxrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domaindnsmxrecord.md | Title: "domainDnsMxRecord resource type" description: "Represents an MX record added to the DNS zone file of a particular domain in the tenant."-+ ms.localizationpriority: medium doc_type: resourcePageType Direct queries to this resource aren't supported. See the [domain](domain.md) ar None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ ],- "@odata.type": "microsoft.graph.domainDnsMxRecord" + "@odata.type": "microsoft.graph.domainDnsMxRecord", + "baseType": "microsoft.graph.domainDnsRecord" }--> ```json {- "canonicalName": "String", "id": "String (identifier)", "isOptional": true, "label": "String", |
v1.0 | Domaindnsrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domaindnsrecord.md | Title: "domainDnsRecord resource type" description: "The domainDnsRecord entity is used to present DNS records." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -For each [domain](domain.md) in the tenant, you may be required to add DNS record(s) to the DNS zone file of the domain before the domain can be used by Microsoft Online Services. The **domainDnsRecord** entity is used to present such DNS records. This resource type is the base entity for the following resources: +For each [domain](domain.md) in the tenant, you may be required to add DNS records to the DNS zone file of the domain before the domain can be used by Microsoft Online Services. The **domainDnsRecord** entity is used to present such DNS records. This resource type is the base entity for the following resources: + [domainDnsCnameRecord](domaindnscnamerecord.md) + [domainDnsMxRecord](domaindnsmxrecord.md) + [domainDnsSrvRecord](domaindnssrvrecord.md) For each [domain](domain.md) in the tenant, you may be required to add DNS recor None. ## Properties-| Property | Type |Description| +| Property | Type |Description| |:|:--|:-| |id|String| Unique identifier assigned to this entity. Not nullable, Read-only.|-|isOptional|Boolean| If false, this record must be configured by the customer at the DNS host for Microsoft Online Services to operate correctly with the domain. | +|isOptional|Boolean| If false, the customer must configure this record at the DNS host for Microsoft Online Services to operate correctly with the domain. | |label|String| Value used when configuring the name of the DNS record at the DNS host. |-|recordType|String| Indicates what type of DNS record this entity represents. The value can be one of the following: `CName`, `Mx`, `Srv`, `Txt`. | +|recordType|String| Indicates what type of DNS record this entity represents. The value can be one of the following values: `CName`, `Mx`, `Srv`, `Txt`. | |supportedService|String| Microsoft Online Service or feature that has a dependency on this DNS record. Can be one of the following values: `null`, `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer`, `Intune`.| |ttl|Int32| Value to use when configuring the time-to-live (ttl) property of the DNS record at the DNS host. Not nullable. | None. None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Domaindnssrvrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domaindnssrvrecord.md | Title: "domainDnsSrvRecord resource type" description: "Represents a SRV record added to the DNS zone file of a particular domain in the tenant."-+ ms.localizationpriority: medium doc_type: resourcePageType None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. ```json {- "canonicalName": "String", "id": "String (identifier)", "isOptional": true, "label": "String", |
v1.0 | Domaindnstxtrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domaindnstxtrecord.md | Title: "domainDnsTxtRecord resource type" description: "Represents a TXT record added to the DNS zone file of a particular domain in the tenant."-+ ms.localizationpriority: medium doc_type: resourcePageType None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. ```json {- "canonicalName": "String", "id": "String (identifier)", "isOptional": true, "label": "String", |
v1.0 | Domaindnsunavailablerecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domaindnsunavailablerecord.md | Title: "domainDnsUnavailableRecord resource type" description: "Indicates that serviceConfigurationRecords can't be generated." ms.localizationpriority: medium-+ doc_type: resourcePageType Direct queries to this resource aren't supported. See the [domain](domain.md) ar None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ ],- "@odata.type": "microsoft.graph.domainDnsUnavailableRecord" + "@odata.type": "microsoft.graph.domainDnsUnavailableRecord", + "baseType": "microsoft.graph.domainDnsRecord" }--> ```json {- "canonicalName": "String", "description": "String", "id": "String (identifier)", "isOptional": true, "label": "String", "recordType": "String", "supportedService": "String",- "text": "String", "ttl": 1024 } |
v1.0 | Domainstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domainstate.md | Title: "domainState resource type" description: "Represents the status of asynchronous operations scheduled on a domain."-+ ms.localizationpriority: medium doc_type: resourcePageType Represents the status of asynchronous operations scheduled on a domain. | Property | Type | Description | |:|:--|:-| | lastActionDateTime | DateTimeOffset | Timestamp for when the last activity occurred. The value is updated when an operation is scheduled, the asynchronous task starts, and when the operation completes. |-| operation | String | Type of asynchronous operation. The values can be *ForceDelete* or *Verification* | -| status | String | Current status of the operation. <br> *Scheduled* - Operation has been scheduled but has not started. <br> *InProgress* - Task has started and is in progress. <br> *Failed* - Operation has failed. | +| operation | String | Type of asynchronous operation. The values can be `ForceDelete` or `Verification`. | +| status | String | Current status of the operation. <br> `Scheduled` - Operation is scheduled but hasn't started. <br> `InProgress` - Task is in progress. <br> `Failed` - The operation failed. | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Downgradejustification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/downgradejustification.md | Represents user input on why downgrade was performed. Downgrade justification mi ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Driveitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/driveitem.md | Items with the **folder** facet act as containers of items and therefore have a | specialFolder | [specialFolder][] | If the current item is also available as a special folder, this facet is returned. Read-only. | source | [driveItemSource][]| Information about the drive item source. Read-only. Only on OneDrive for Business and SharePoint. | video | [video][] | Video metadata, if the item is a video. Read-only.+| viewpoint | [driveItemViewpoint][] | Returns information specific to the calling user for this drive item. Read-only. | webDavUrl | String | WebDAV compatible URL for the item. | webUrl | String | URL that displays the resource in the browser. Read-only. The **driveItem** resource is derived from [**baseItem**][baseItem] and inherits "source": { "@odata.type": "microsoft.graph.driveItemSource" }, "specialFolder": { "@odata.type": "microsoft.graph.specialFolder" }, "video": { "@odata.type": "microsoft.graph.video" },+ "viewpoint": { "@odata.type": "microsoft.graph.driveItemViewpoint" }, "webDavUrl": "string", /* relationships */ "activities": [{"@odata.type": "microsoft.graph.itemActivity"}], "children": [{ "@odata.type": "microsoft.graph.driveItem" }], "createdByUser": { "@odata.type": "microsoft.graph.user" },- "itemRetentionLabel": [{ "@odata.type": "microsoft.graph.itemRetentionLabel" }], + "retentionLabel": { "@odata.type": "microsoft.graph.itemRetentionLabel" }, "lastModifiedByUser": { "@odata.type": "microsoft.graph.user" }, "permissions": [ {"@odata.type": "microsoft.graph.permission"} ], "subscriptions": [ {"@odata.type": "microsoft.graph.subscription"} ], The **driveItem** resource is derived from [**baseItem**][baseItem] and inherits [subscription]: subscription.md [thumbnailSet]: thumbnailset.md [video]: video.md+[driveItemViewpoint]: driveitemviewpoint.md [workbook]: workbook.md [user]: /graph/api/resources/users [publicationFacet]: publicationfacet.md |
v1.0 | Driveitemaccessoperationsviewpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/driveitemaccessoperationsviewpoint.md | + + Title: "driveItemAccessOperationsViewpoint resource type" +description: "Indicates whether the user can carry out the described actions on this item." ++ms.localizationpriority: medium ++++# driveItemAccessOperationsViewpoint resource type ++Namespace: microsoft.graph +++Indicates whether the user can carry out the described actions on this item. ++## Properties ++|Property|Type|Description| +|:|:|:| +|canComment|Boolean|Indicates whether the user can comment on this item.| +|canCreateFile|Boolean|Indicates whether the user can create files within this object. Returned only on folders.| +|canCreateFolder|Boolean|Indicates whether the user can create folders within this object. Returned only on folders.| +|canDelete|Boolean|Indicates whether the user can delete this item.| +|canDownload|Boolean|Indicates whether the user can download this item.| +|canRead|Boolean|Indicates whether the user can read this item.| +|canUpdate|Boolean|Indicates whether the user can update this item.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.driveItemAccessOperationsViewpoint" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.driveItemAccessOperationsViewpoint", + "canComment": "Boolean", + "canCreateFile": "Boolean", + "canCreateFolder": "Boolean", + "canDelete": "Boolean", + "canDownload": "Boolean", + "canRead": "Boolean", + "canUpdate": "Boolean" +} +``` |
v1.0 | Driveitemviewpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/driveitemviewpoint.md | + + Title: "driveItemViewpoint resource type" +description: "Returns information specific to the calling user for this drive item." ++ms.localizationpriority: medium ++++# driveItemViewpoint resource type ++Namespace: microsoft.graph +++Returns information specific to the calling user for this drive item. ++## Properties ++|Property|Type|Description| +|:|:|:| +|accessOperations|[driveItemAccessOperationsViewpoint](../resources/driveitemaccessoperationsviewpoint.md)| Indicates whether the user can perform the described actions on this item.| +|sharing|[sharingViewpoint](../resources/sharingviewpoint.md)| Indicates sharing operations the current user can take on the specified item.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.driveItemViewpoint" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.driveItemViewpoint", + "accessOperations": { + "@odata.type": "microsoft.graph.driveItemAccessOperationsViewpoint" + }, + "sharing": { + "@odata.type": "microsoft.graph.sharingViewpoint" + } +} +``` |
v1.0 | Driverecipient | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/driverecipient.md | description: The driveRecipient resource represents a person, group, or other recipient to share with using the invite action. Last updated 09/10/2017 Title: DriveRecipient + Title: driveRecipient resource type ms.localizationpriority: medium doc_type: resourcePageType -# driveRecipient resource +# driveRecipient resource type Namespace: microsoft.graph |
v1.0 | Dynamics Account | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-account.md | Title: "accounts resource type" -description: "Represents an account object in Dynamics 365 Business Central." --+ Title: account resource type +description: Represents an account object in Dynamics 365 Business Central. ++ ms.localizationpriority: medium-+ doc_type: resourcePageType -# accounts resource type +# account resource type Namespace: microsoft.graph Represents an account object in Dynamics 365 Business Central. | Method | Return Type |Description| |:|:--|:-|-|[Get accounts](../api/dynamics-account-get.md)|accounts|Get accounts object.| +|[Get account](../api/dynamics-account-get.md)|account|Get accounts object.| ## Properties | Property | Type |Description| None. ## JSON representation -Here's a JSON representation of the resource. -+The following JSON representation shows the resource type. ```json {- "blocked": "Boolean", + "blocked": "Boolean", "category": "String", "displayName": "String", "id": "GUID", Here's a JSON representation of the resource. "subCategory": "String" } ```-- |
v1.0 | Dynamics Agedaccountspayable | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-agedaccountspayable.md | Title: "agedAccountsPayable resource type" -description: "Represents an agedAccountsPayable object in Dynamics 365 Business Central that shows the aging of a vendor account.". +description: "Represents an agedAccountsPayable object in Dynamics 365 Business Central that shows the aging of a vendor account." ms.localizationpriority: medium |
v1.0 | Dynamics Agedaccountsreceivable | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-agedaccountsreceivable.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. ```json |
v1.0 | Dynamics Companies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-companies.md | Title: companies resource type + Title: company resource type description: A company in Dynamics 365 Business Central. documentationcenter: ''-# companies resource type +# company resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a companies resource type in Dynamics 365 Business Central. +Represents a company resource type in Dynamics 365 Business Central. ## Methods | Method | Return Type |Description| |:|:-|:-|-|[Get companies](../api/dynamics-companies-get.md)|companies|Get a company.| +|[Get company](../api/dynamics-companies-get.md)|company|Get a company.| ## Properties | Property | Type |Description | None. ## JSON representation -Here is a JSON representation of the company. +Here's a JSON representation of the company. ```json { |
v1.0 | Dynamics Countriesregions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-countriesregions.md | Title: countriesRegions resource type -description: A Countries/Regions object in Dynamics 365 Business Central. + Title: countryRegion resource type +description: A country/region object in Dynamics 365 Business Central. documentationcenter: '' -# countriesRegions resource type +# countryRegion resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a countriesRegions object in Dynamics 365 Business Central, which is part of an address. +Represents a countryRegion object in Dynamics 365 Business Central, which is part of an address. ## Methods | Method | Return Type |Description | |:--|:|:--|-|[Get countriesRegions](../api/dynamics-countriesregions-get.md) |countriesRegions|Get a Countries/Regions. | -|[Post countriesRegions](../api/dynamics-create-countriesregions.md) |countriesRegions|Create a Countries/Regions.| -|[Patch countriesRegions](../api/dynamics-countriesregions-update.md) |countriesRegions|Update a Countries/Regions.| -|[Delete countriesRegions](../api/dynamics-countriesregions-delete.md)|none |Delete a Countries/Regions.| +|[Get countryRegion](../api/dynamics-countriesregions-get.md) |countryRegion|Get a Countries/Regions. | +|[Post countryRegion](../api/dynamics-create-countriesregions.md) |countryRegion|Create a Countries/Regions.| +|[Patch countryRegion](../api/dynamics-countriesregions-update.md) |countryRegion|Update a Countries/Regions.| +|[Delete countryRegion](../api/dynamics-countriesregions-delete.md)|none |Delete a Countries/Regions.| ## Properties | Property | Type |Description | Represents a countriesRegions object in Dynamics 365 Business Central, which is |code |string |Specifies the code of the country/region. | |displayName |string |Specifies the display name of the country/region. | |addressFormat |string |Specifies the format of the address that is displayed on external-facing documents. You link an address format to a country/region code so that external-facing documents based on cards or documents with that country/region code use the specified address format.|-|lastModifiedDateTime|datetime|The last datetime the country/region was modified. Read-Only.| +|lastModifiedDateTime|datetime|The last datetime the country/region was modified. Read-Only.| ## Relationships |
v1.0 | Dynamics Currencies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-currencies.md | Title: "currencies resource type" -description: "Represents a currency used in Dynamics 365 Business Central." + Title: "currency resource type" +description: "Represents a currency used in Dynamics 365 Business Central." documentationcenter: "" -# currencies resource type +# currency resource type Namespace: microsoft.graph Represents a currency used in Dynamics 365 Business Central. ## Methods | Method |Return Type|Description | |:--|:-|:--|-|[Get currencies](../api/dynamics-currencies-get.md) |[currencies](dynamics-currencies.md) |Get a currency. | -|[Create currencies](../api/dynamics-create-currencies.md) |[currencies](dynamics-currencies.md) |Create a currency.| -|[Update currencies](../api/dynamics-currencies-update.md) |[currencies](dynamics-currencies.md) |Update a currency.| -|[Delete currencies](../api/dynamics-currencies-delete.md)|None |Delete a currency.| +|[Get currency](../api/dynamics-currencies-get.md) |[currency](dynamics-currencies.md) |Get a currency. | +|[Create currency](../api/dynamics-create-currencies.md) |[currency](dynamics-currencies.md) |Create a currency.| +|[Update currency](../api/dynamics-currencies-update.md) |[currency](dynamics-currencies.md) |Update a currency.| +|[Delete currency](../api/dynamics-currencies-delete.md)|None |Delete a currency.| ## Properties | Property | Type |Description | Represents a currency used in Dynamics 365 Business Central. |amountRoundingPrecision|Decimal |The size of the interval to be used when rounding amounts for this currency.| |code |String |The currency code. | |displayName |String |The display name for the currency. |-|id |String |The unique identifier of the currency. Non-editable. | -|lastModifiedDateTime |Datetime|The date and time the currency was last modified. Read-Only. | +|id |String |The unique identifier of the currency. Noneditable. | +|lastModifiedDateTime |Datetime|The date and time the currency was last modified. Read-Only. | |symbol |String |The symbol for this currency that appears on checks.| None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource. ```json { |
v1.0 | Dynamics Customer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-customer.md | Title: customers resource type + Title: customer resource type description: Represents a customer in Dynamics 365 Business Central. ms.localizationpriority: medium-# customers resource type +# customer resource type Namespace: microsoft.graph Represents a customer in Dynamics 365 Business Central. | Method |Return Type| Description | |:-|:-|:--|-|[Get customers](../api/dynamics-customer-get.md) |customers |Gets a customer. | -|[Create customers](../api/dynamics-create-customer.md)|customers |Creates a customer.| -|[Update customers](../api/dynamics-customer-update.md)|customers |Updates a customer.| -|[Delete customers](../api/dynamics-customer-delete.md)|none |Deletes a customer.| +|[Get customer](../api/dynamics-customer-get.md) |customer |Gets a customer. | +|[Create customer](../api/dynamics-create-customer.md)|customer |Creates a customer.| +|[Update customer](../api/dynamics-customer-update.md)|customer |Updates a customer.| +|[Delete customer](../api/dynamics-customer-delete.md)|none |Deletes a customer.| ## Properties | Property | Type |Description| |:|:|:-|-|id |GUID |The unique ID of the item. Non-editable.| +|id |GUID |The unique ID of the item. Noneditable.| |number |string |The customer number.|-|displayName |string |Specifies the customer's name. This name will appear on all sales documents for the customer.| +|displayName |string |Specifies the customer's name. This name appears on all sales documents for the customer.| |type |string |Specifies the type of customer, can be "Company" or "Person".|-|address |[NAV.PostalAddress](../resources/dynamics-complextypes.md)|Specifies the customer's address. This address will appear on all sales documents for the customer.| +|address |[NAV.PostalAddress](../resources/dynamics-complextypes.md)|Specifies the customer's address. This address appears on all sales documents for the customer.| |phoneNumber |string |Specifies the customer's telephone number.| |email |string |Specifies the customer's email address.| |website |string |Specifies the customer's home page address.| Represents a customer in Dynamics 365 Business Central. |paymentTermsId|GUID |Specifies which payment term the customer uses.| |paymentMethodId|GUID |Specifies which payment method the customer uses.| |shipmentMethodId|GUID |Specifies which shipment method the customer uses.|-|blocked |string |Specifies that transactions with the customer cannot be posted. Set to **All**, if the customer is blocked, set to blank if not blocked.| +|blocked |string |Specifies that transactions with the customer can't be posted. Set to **All**, if the customer is blocked, set to blank if not blocked.| |balance |numeric |Specifies the payment amount that the customer owes for completed sales. This value is also known as the customer's balance. Read-Only.| |overdueAmount|numeric |Specifies the customer's overdue amount.| |totalSalesExcludingTax|numeric|Specifies the total sales amount excluding tax of the customer.|-|lastModifiedDateTime|datetime|The last datetime the customer was modified. Read-Only.| +|lastModifiedDateTime|datetime|The last datetime the customer was modified. Read-Only.| ## Relationships A Tax Area(taxArea) must exist in the Tax Area table. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. ```json |
v1.0 | Dynamics Customerpayment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-customerpayment.md | Title: "customerPayments resource type" + Title: "customerPayment resource type" description: "Represents a customer payment in Dynamics 365 Business Central." documentationcenter: ""-# customerPayments resource type +# customerPayment resource type Namespace: microsoft.graph Represents a customer payment in Dynamics 365 Business Central. A customer payme | Method | Return Type |Description| |:|:-|:-|-|[Get customerPayments](../api/dynamics-customerpayment-get.md)|[customerPayments](dynamics-customerpayment.md)|Get a customer payment.| -|[Post customerPayments](../api/dynamics-create-customerpayment.md)|[customerPayments](dynamics-customerpayment.md)|Create a customer payment.| -|[Patch customerPayments](../api/dynamics-customerpayment-update.md)|[customerPayments](dynamics-customerpayment.md)|Update a customer payment.| -|[Delete customerPayments](../api/dynamics-customerpayment-delete.md)|None|Delete a customer payment.| +|[Get customerPayment](../api/dynamics-customerpayment-get.md)|[customerPayment](dynamics-customerpayment.md)|Get a customer payment.| +|[Post customerPayment](../api/dynamics-create-customerpayment.md)|[customerPayment](dynamics-customerpayment.md)|Create a customer payment.| +|[Patch customerPayment](../api/dynamics-customerpayment-update.md)|[customerPayment](dynamics-customerpayment.md)|Update a customer payment.| +|[Delete customerPayment](../api/dynamics-customerpayment-delete.md)|None|Delete a customer payment.| ## Properties | Property | Type |Description| An Invoice (appliesToInvoiceId) must exist in the Sales Invoices Table. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json { |
v1.0 | Dynamics Customerpaymentsjournal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-customerpaymentsjournal.md | Title: customerPaymentJournals resource type + Title: customerPaymentJournal resource type description: A customer payments journal in Dynamics 365 Business Central. documentationcenter: ''-# customerPaymentsJournals resource type +# customerPaymentsJournal resource type Namespace: microsoft.graph Represents a customer payment journal in Dynamics 365 Business Central. | Method | Return Type |Description | |:|:|:--|-|[Get customerPaymentJournals](../api/dynamics-customerpaymentsjournal-get.md) |customerPaymentJournals|Gets a customer payment journal. | -|[Post customerPaymentJournals](../api/dynamics-create-customerpaymentsjournal.md) |customerPaymentJournals|Creates a customer payment journal.| -|[Patch customerPaymentJournals](../api/dynamics-customerpaymentsjournal-update.md) |customerPaymentJournals|Updates a customer payment journal.| -|[Delete customerPaymentJournals](../api/dynamics-customerpaymentsjournal-delete.md)|none |Deletes a customer payment journal.| +|[Get customerPaymentJournal](../api/dynamics-customerpaymentsjournal-get.md) |customerPaymentJournals|Gets a customer payment journal. | +|[Post customerPaymentJournal](../api/dynamics-create-customerpaymentsjournal.md) |customerPaymentJournals|Creates a customer payment journal.| +|[Patch customerPaymentJournal](../api/dynamics-customerpaymentsjournal-update.md) |customerPaymentJournals|Updates a customer payment journal.| +|[Delete customerPaymentJournal](../api/dynamics-customerpaymentsjournal-delete.md)|none |Deletes a customer payment journal.| ## Properties | Property | Type |Description | Represents a customer payment journal in Dynamics 365 Business Central. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json |
v1.0 | Dynamics Dimension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-dimension.md | Title: dimensions resource type + Title: dimension resource type description: A dimension in Dynamics 365 Business Central. ms.localizationpriority: medium-# Dimensions resource type +# dimension resource type Namespace: microsoft.graph Represents a dimension in Dynamics 365 Business Central. ## Methods | Method | Return Type |Description| |:-|:-|:-|-|[Get dimensions](../api/dynamics-dimension-get.md)|dimension|Gets a dimension.| +|[Get dimension](../api/dynamics-dimension-get.md)|dimension|Gets a dimension.| ## Properties Represents a dimension in Dynamics 365 Business Central. |id |GUID |The unique ID of the item.| |code |string, maximum size 20|The dimension code. | |displayName |string |Specifies the dimension's name. This name appears where the dimension is used.|-|lastModifiedDateTime|datetime |The last datetime the dimension was modified.| +|lastModifiedDateTime|datetime |The last datetime the dimension was modified.| ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json |
v1.0 | Dynamics Dimensionvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-dimensionvalue.md | Title: dimensionValues resource type + Title: dimensionValue resource type description: A dimension value in Dynamics 365 Business Central. documentationcenter: ''-# dimensionValues resource type +# dimensionValue resource type Namespace: microsoft.graph Represents a dimension value in Dynamics 365 Business Central. | Method | Return Type |Description | |:-|:-|:--|-|[Get dimensionValues](../api/dynamics-dimensionvalue-get.md)|dimensionValues|Gets a dimension value object.| +|[Get dimensionValue](../api/dynamics-dimensionvalue-get.md)|dimensionValues|Gets a dimension value object.| ## Properties Represents a dimension value in Dynamics 365 Business Central. |id |GUID |The unique ID of the item. | |code |string, maximum size 20|The dimension value code. | |displayName |string |Specifies the dimension value's name. This name appears where the dimension value is used.|-|lastModifiedDateTime|datetime |The last datetime the dimension value was modified.| +|lastModifiedDateTime|datetime |The last datetime the dimension value was modified.| ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json |
v1.0 | Dynamics Employee | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-employee.md | Title: employees resource type + Title: employee resource type description: An employee object in Dynamics 365 Business Central. documentationcenter: ''-# employees resource type +# employee resource type Namespace: microsoft.graph Represents an employee in Dynamics 365 Business Central. | Method | Return Type|Description | |:-|:--|:-|-|[Get employees](../api/dynamics-employee-get.md) |employees |Get an employee object. | -|[Post employees](../api/dynamics-create-employee.md) |employees |Create an employee object.| -|[Patch employees](../api/dynamics-employee-update.md) |employees |Update an employee object.| -|[Delete employees](../api/dynamics-employee-delete.md)|none |Delete an employee object.| +|[Get employee](../api/dynamics-employee-get.md) |employee |Get an employee object. | +|[Post employee](../api/dynamics-create-employee.md) |employee |Create an employee object.| +|[Patch employee](../api/dynamics-employee-update.md) |employee |Update an employee object.| +|[Delete employee](../api/dynamics-employee-delete.md)|none |Delete an employee object.| ## Properties | Property | Type |Description | |:-|:-|:|-|id |GUID |The employee ID. Non-editable. | +|id |GUID |The employee ID. Noneditable. | |number |string |The employee number. Read-Only. | |displayName |string |The employee givenName + surname. Read-Only. | |givenName |string |The given name of the employee. | |middleName |string |The middle name of the employee. | |surname |string |The surname of the employee | |jobTitle |string |The job title of the employee |-|address |[NAV.PostalAddress](../resources/dynamics-complextypes.md)|Specifies the employee's address. This address will appear on all resource documents for the employee.| +|address |[NAV.PostalAddress](../resources/dynamics-complextypes.md)|Specifies the employee's address. This address appears on all resource documents for the employee.| |phoneNumber |string |Specifies the employee's telephone number. | |mobilePhone |string |Specifies the employee's mobile telephone number. | |email |string |Specifies the employee's email address. | |personalEmail |string |Specifies the employee's personal email address. | |employmentDate |date |Specifies the date when the employee began to work for the company.| |terminationDate |date |Specifies the date when the employee was terminated, due to retirement or dismissal, for example.|-|status |string |Specifies the employee's status. Possible values are Active, Inactive or Terminated| +|status |string |Specifies the employee's status. Possible values are Active, Inactive, or Terminated| |birthDate |date |Specifies the employee's date of birth. | |picture |stream |The employee picture. Read-Only. |-|lastModifiedDateTime|datetime|The last datetime the employee was modified. Read-Only.| +|lastModifiedDateTime|datetime|The last datetime the employee was modified. Read-Only.| ## Relationships None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. ```json |
v1.0 | Dynamics Generalledgerentries | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-generalledgerentries.md | Title: generalLedgerEntries resource type + Title: generalLedgerEntry resource type description: A general ledger entry in Dynamics 365 Business Central. documentationcenter: ''-# generalLedgerEntries resource type +# generalLedgerEntry resource type Namespace: microsoft.graph Represents a general ledger entry in Dynamics 365 Business Central. | Method | Return Type |Description| |:-|:-|:-|-|[Get generalLedgerEntries](../api/dynamics-generalledgerentries-get.md)|generalLedgerEntries|Get a general ledger entry object.| +|[Get generalLedgerEntry](../api/dynamics-generalledgerentries-get.md)|generalLedgerEntry|Get a general ledger entry object.| ## Properties | Property | Type |Description | The following is a JSON representation of the resource. ```json { "accountId": "GUID",- "accountNumber": "String", + "accountNumber": "String", "creditAmount": "Decimal", "debitAmount": "Decimal", "description": "String", |
v1.0 | Dynamics Item | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-item.md | Title: items resource type + Title: item resource type description: An item object in Dynamics 365 Business Central. documentationcenter: ''-# items resource type +# item resource type Namespace: microsoft.graph Represents an item in Dynamics 365 Business Central. | Method |Return Type|Description | |:--|:-|:--|-|[Get items](../api/dynamics-item-get.md) |items |Gets an item object. | -|[Post items](../api/dynamics-create-item.md) |items |Creates an item object.| -|[Patch item](../api/dynamics-item-update.md) |items |Updates an item object.| -|[Delete items](../api/dynamics-item-delete.md)|none |Deletes an item object.| +|[Get item](../api/dynamics-item-get.md) |item |Gets an item object. | +|[Post item](../api/dynamics-create-item.md) |item |Creates an item object.| +|[Patch item](../api/dynamics-item-update.md) |item |Updates an item object.| +|[Delete item](../api/dynamics-item-delete.md)|none |Deletes an item object.| ## Properties | Property | Type |Description | Represents an item in Dynamics 365 Business Central. |unitCost |decimal |Specifies the cost per unit of the item. | |taxGroupId |GUID |Specifies the ID of the Tax Group for the item. | |taxGroupCode |numeric |A Tax Group represents a group of inventory items or resources that are subject to identical tax terms.|-|lastModifiedDateTime|datetime|The last datetime the item was modified. Read-Only. | +|lastModifiedDateTime|datetime|The last datetime the item was modified. Read-Only. | ## Relationships A Tax Group(taxGroupCode) must exist in the Tax Group table. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json |
v1.0 | Dynamics Itemcategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-itemcategories.md | Title: "itemCategories resource type" + Title: "itemCategory resource type" description: "Represents a category for many items in Dynamics 365 Business Central." documentationcenter: ""-# itemCategories resource type +# itemCategory resource type Namespace: microsoft.graph Represents a category for many items in Dynamics 365 Business Central. | Method | Return Type |Description | |:-|:-|:--|-|[Get itemCategories](../api/dynamics-itemcategories-get.md) |[itemCategories](dynamics-itemcategories.md)|Get an item category. | -|[Post itemCategories](../api/dynamics-create-itemcategories.md) |[itemCategories](dynamics-itemcategories.md)|Create an item category.| -|[Patch itemCategories](../api/dynamics-itemcategories-update.md) |[itemCategories](dynamics-itemcategories.md)|Update an item category.| -|[Delete itemCategories](../api/dynamics-itemcategories-delete.md)|None |Delete an item category.| +|[Get itemCategory](../api/dynamics-itemcategories-get.md) |[itemCategory](dynamics-itemcategories.md)|Get an item category. | +|[Post itemCategory](../api/dynamics-create-itemcategories.md) |[itemCategory](dynamics-itemcategories.md)|Create an item category.| +|[Patch itemCategory](../api/dynamics-itemcategories-update.md) |[itemCategory](dynamics-itemcategories.md)|Update an item category.| +|[Delete itemCategory](../api/dynamics-itemcategories-delete.md)|None |Delete an item category.| ## Properties Represents a category for many items in Dynamics 365 Business Central. |code |String |The item category code. | |displayName |String |The display name of the item category. | |id |String |The unique ID of the item category. Noneditable.|-|lastModifiedDateTime|Datetime|The date and time when the item category was last modified. Read-Only.| +|lastModifiedDateTime|Datetime|The date and time when the item category was last modified. Read-Only.| ## Relationships None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json { |
v1.0 | Dynamics Journal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-journal.md | The response has no content; the response code is 204. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json |
v1.0 | Dynamics Journalline | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-journalline.md | Title: journalLines resource type + Title: journalLine resource type description: A journal line in Dynamics 365 Business Central. documentationcenter: ''-# journalLines resource type +# journalLine resource type Namespace: microsoft.graph Represents a line in a journal in Dynamics 365 Business Central. | Method | Return Type|Description | |:-|:--|:-|-|[Get journalLines](../api/dynamics-journalline-get.md) |journalLines|Gets a journal line. | -|[Post journalLines](../api/dynamics-create-journalline.md) |journalLines|Creates a journal line.| -|[Patch journalLines](../api/dynamics-journalline-update.md) |journalLines|Updates a journal line.| -|[Delete journalLines](../api/dynamics-journalline-delete.md)|none |Deletes a journal line.| +|[Get journalLine](../api/dynamics-journalline-get.md) |journalLine|Gets a journal line. | +|[Post journalLine](../api/dynamics-create-journalline.md) |journalLine|Creates a journal line.| +|[Patch journalLine](../api/dynamics-journalline-update.md) |journalLine|Updates a journal line.| +|[Delete journalLine](../api/dynamics-journalline-delete.md)|none |Deletes a journal line.| ## Properties | Property | Type |Description | An Account (accountId) must exist in the Accounts table. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. ```json |
v1.0 | Dynamics Paymentmethods | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-paymentmethods.md | Title: "paymentMethods resource type" + Title: "paymentMethod resource type" description: "Represents a method of payment in Dynamics 365 Business Central such as PayPal, credit card, and bank account." documentationcenter: ""-# paymentMethods resource type +# paymentMethod resource type Namespace: microsoft.graph Represents a method of payment in Dynamics 365 Business Central such as PayPal, | Method | Return Type |Description | |:-|:-|:--|-|[Get paymentMethods](../api/dynamics-paymentmethods-get.md) |[paymentMethods](dynamics-paymentmethods.md)|Get a payment method object. | -|[Post paymentMethods](../api/dynamics-create-paymentmethods.md) |[paymentMethods](dynamics-paymentmethods.md)|Create a payment method object.| -|[Patch paymentMethods](../api/dynamics-paymentmethods-update.md) |[paymentMethods](dynamics-paymentmethods.md)|Update a payment method object.| -|[Delete paymentMethods](../api/dynamics-paymentmethods-delete.md)|None |Delete a payment method object.| +|[Get paymentMethod](../api/dynamics-paymentmethods-get.md) |[paymentMethod](dynamics-paymentmethods.md)|Get a payment method object. | +|[Post paymentMethod](../api/dynamics-create-paymentmethods.md) |[paymentMethod](dynamics-paymentmethods.md)|Create a payment method object.| +|[Patch paymentMethod](../api/dynamics-paymentmethods-update.md) |[paymentMethod](dynamics-paymentmethods.md)|Update a payment method object.| +|[Delete paymentMethod](../api/dynamics-paymentmethods-delete.md)|None |Delete a payment method object.| ## Properties | Property | Type |Description | |:-|:-|:| |code |String |The payment method code. | |displayName |String |The payment method display name. |-|id |GUID |The unique identifier of the **paymentMethods**. Noneditable.| -|lastModifiedDateTime|Datetime|The date and time when the payment method was last modified. Read-Only.| +|id |GUID |The unique identifier of the **paymentMethod**. Noneditable.| +|lastModifiedDateTime|Datetime|The date and time when the payment method was last modified. Read-Only.| ## Relationships None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json { |
v1.0 | Dynamics Paymentterms | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-paymentterms.md | Title: paymentTerms resource type -description: A payment terms object in Dynamics 365 Business Central. + Title: paymentTerm resource type +description: A payment term object in Dynamics 365 Business Central. documentationcenter: '' -# paymentTerms resource type +# paymentTerm resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a [payment term](../resources/dynamics-paymentterms.md) in Dynamics 365 Business Central. +Represents a payment term in Dynamics 365 Business Central. ## Methods | Method | Return Type|Description | |:|:--|:-|-|[Get paymentTerms](../api/dynamics-paymentterms-get.md) |**paymentTerms**|Get a payment terms object. | -|[Post paymentTerms](../api/dynamics-create-paymentterms.md) |**paymentTerms**|Create a payment terms object.| -|[Patch paymentTerms](../api/dynamics-paymentterms-update.md) |**paymentTerms**|Update a payment terms object.| -|[Delete paymentTerms](../api/dynamics-paymentterms-delete.md)|none |Delete a payment terms object.| +|[Get paymentTerm](../api/dynamics-paymentterms-get.md) |**paymentTerm**|Get a payment terms object. | +|[Post paymentTerm](../api/dynamics-create-paymentterms.md) |**paymentTerm**|Create a payment terms object.| +|[Patch paymentTerm](../api/dynamics-paymentterms-update.md) |**paymentTerm**|Update a payment terms object.| +|[Delete paymentTerm](../api/dynamics-paymentterms-delete.md)|none |Delete a payment terms object.| ## Properties | Property | Type |Description | Represents a [payment term](../resources/dynamics-paymentterms.md) in Dynamics 3 |discountPercent |decimal |Specifies the discount percentage that is applied for early payment of an invoice amount.| |displayName |string |Specifies the payment term display name. | |dueDateCalculation |string |Specifies the formula that is used to calculate the date that a payment must be made.|-|id |GUID |The unique identifier for the **paymentTerms**. Non-editable. | -|lastModifiedDateTime |datetime|The date and time when the **paymentTerms** were last modified. Read-Only.| +|id |GUID |The unique identifier for the **paymentTerm**. Non-editable. | +|lastModifiedDateTime |datetime|The date and time when the **paymentTerm** were last modified. Read-Only.| ## Relationships None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json Here's a JSON representation of the resource. "discountPercent": "decimal", "displayName": "string", "dueDateCalculation": "string",- "id": "GUID", + "id": "GUID", "lastModifiedDateTime": "datetime" } ``` |
v1.0 | Dynamics Shipmentmethods | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-shipmentmethods.md | Title: "shipmentMethods resource type" -description: "Represents a method of shipment in Dynamics 365 Business Central, such as UPS, Fedex, and DHL." + Title: "shipmentMethod resource type" +description: "Represents a method of shipment in Dynamics 365 Business Central, such as UPS, Fedex, and DHL." documentationcenter: "" -# shipmentMethods resource type +# shipmentMethod resource type Namespace: microsoft.graph Represents a method of shipment in Dynamics 365 Business Central, such as UPS, F | Method | Return Type |Description| |:|:--|:-|-|[Get shipmentMethods](../api/dynamics-shipmentmethods-get.md)|[shipmentMethods](dynamics-shipmentmethods.md)|Get a shipment method.| -|[Create shipmentMethods](../api/dynamics-create-shipmentmethods.md)|[shipmentMethods](dynamics-shipmentmethods.md)|Create a shipment method.| -|[Update shipmentMethods](../api/dynamics-shipmentmethods-update.md)|[shipmentMethods](dynamics-shipmentmethods.md)|Update a shipment method.| -|[Delete shipmentMethods](../api/dynamics-shipmentmethods-delete.md)|None|Delete a shipment method.| +|[Get shipmentMethod](../api/dynamics-shipmentmethods-get.md)|shipmentMethod|Get a shipment method.| +|[Create shipmentMethod](../api/dynamics-create-shipmentmethods.md)|shipmentMethod|Create a shipment method.| +|[Update shipmentMethod](../api/dynamics-shipmentmethods-update.md)|shipmentMethod|Update a shipment method.| +|[Delete shipmentMethod](../api/dynamics-shipmentmethods-delete.md)|None|Delete a shipment method.| ## Properties | Property | Type |Description| Represents a method of shipment in Dynamics 365 Business Central, such as UPS, F |code|String|The shipment method code.| |displayName|String|The display name for the shipment method.| |id|String|The unique identifier of the **shipmentMethod**. Noneditable.|-|lastModifiedDateTime|Datetime|The date and time when the shipment method was last modified. Read-Only.| +|lastModifiedDateTime|Datetime|The date and time when the shipment method was last modified. Read-Only.| ## Relationships None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json { |
v1.0 | Dynamics Taxarea | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-taxarea.md | Title: taxAreas resource type + Title: taxArea resource type description: A tax area. documentationcenter: ''-# taxAreas resource type +# taxArea resource type Namespace: microsoft.graph Represents a tax area resource type in Dynamics 365 Business Central. ## Methods | Method | Return Type |Description| |:|:--|:-|-|[Get taxAreas](../api/dynamics-taxarea-get.md)|taxAreas|Gets a tax area object.| -|[Post taxAreas](../api/dynamics-create-taxarea.md)|taxAreas|Creates a tax area object.| -|[Patch taxAreas](../api/dynamics-taxarea-update.md)|taxAreas|Updates a tax area object.| -|[Delete taxAreas](../api/dynamics-taxarea-delete.md)|none|Deletes a tax area object.| +|[Get taxArea](../api/dynamics-taxarea-get.md)|taxArea|Gets a tax area object.| +|[Post taxArea](../api/dynamics-create-taxarea.md)|taxArea|Creates a tax area object.| +|[Patch taxArea](../api/dynamics-taxarea-update.md)|taxArea|Updates a tax area object.| +|[Delete taxArea](../api/dynamics-taxarea-delete.md)|none|Deletes a tax area object.| ## Properties | Property | Type |Description| Represents a tax area resource type in Dynamics 365 Business Central. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json |
v1.0 | Dynamics Taxgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-taxgroups.md | Title: "taxGroups resource type" -description: "A tax group object in Dynamics 365 Business Central." + Title: "taxGroup resource type" +description: "A tax group object in Dynamics 365 Business Central." documentationcenter: "" -# taxGroups resource type +# taxGroup resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a [taxGroups](dynamics-taxgroups.md) object in Dynamics 365 Business Central. +Represents a taxGroup object in Dynamics 365 Business Central. ## Methods | Method | Return Type |Description| |:|:--|:-|-|[Get taxGroups](../api/dynamics-taxgroups-get.md)|[taxGroups](dynamics-taxgroups.md)|Get a tax group object.| -|[Post taxGroups](../api/dynamics-create-taxgroups.md)|[taxGroups](dynamics-taxgroups.md)|Create a tax group object.| -|[Patch taxGroups](../api/dynamics-taxgroups-update.md)|[taxGroups](dynamics-taxgroups.md)|Update a tax group object.| -|[Delete taxGroups](../api/dynamics-taxgroups-delete.md)|None|Delete a tax group object.| +|[Get taxGroup](../api/dynamics-taxgroups-get.md)|taxGroup|Get a tax group object.| +|[Post taxGroup](../api/dynamics-create-taxgroups.md)|taxGroup|Create a tax group object.| +|[Patch taxGroup](../api/dynamics-taxgroups-update.md)|taxGroup|Update a tax group object.| +|[Delete taxGroup](../api/dynamics-taxgroups-delete.md)|None|Delete a tax group object.| ## Properties | Property | Type |Description| Represents a [taxGroups](dynamics-taxgroups.md) object in Dynamics 365 Business |code|String|Indicates the tax group.| |displayName|String|The display name of the tax group.| |id|String|The unique identifier for the tax group. Read-Only.|-|lastModifiedDateTime|datetime|The date and time when the tax group was last modified. Read-Only.| +|lastModifiedDateTime|datetime|The date and time when the tax group was last modified. Read-Only.| |taxType|string|The tax type for the group.| |
v1.0 | Dynamics Unitsofmeasure | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-unitsofmeasure.md | Title: unitsOfMeasure resource type + Title: unitOfMeasure resource type description: A unit of measure object in Dynamics 365 Business Central. documentationcenter: ''-# unitsOfMeasure resource type +# unitOfMeasure resource type Namespace: microsoft.graph Represents a unit of measure, which is a standard of measurement of a quantity, | Method | Return Type |Description| |:|:--|:-|-|[Get unitsOfMeasure](../api/dynamics-unitsofmeasure-get.md)|unitsOfMeasure|Gets a unit of measure object.| -|[Post unitsOfMeasure](../api/dynamics-create-unitsofmeasure.md)|unitsOfMeasure|Creates a unit of measure object.| -|[Patch unitsOfMeasure](../api/dynamics-unitsofmeasure-update.md)|unitsOfMeasure|Updates a unit of measure object.| -|[Delete unitsOfMeasure](../api/dynamics-unitsofmeasure-delete.md)|none|Deletes a unit of measure object.| +|[Get unitOfMeasure](../api/dynamics-unitsofmeasure-get.md)|unitOfMeasure|Gets a unit of measure object.| +|[Post unitOfMeasure](../api/dynamics-create-unitsofmeasure.md)|unitOfMeasure|Creates a unit of measure object.| +|[Patch unitOfMeasure](../api/dynamics-unitsofmeasure-update.md)|unitOfMeasure|Updates a unit of measure object.| +|[Delete unitOfMeasure](../api/dynamics-unitsofmeasure-delete.md)|none|Deletes a unit of measure object.| ## Properties | Property | Type |Description| |:|:--|:-|-|id|GUID|The unique ID of the unitsOfMeasure. Noneditable.| +|id|GUID|The unique ID of the unitOfMeasure. Noneditable.| |code|string|Specifies the code for the unit of measure.| |displayName|string|Specifies the unit of measure's display name.| |internationalStandardCode|string|Specifies the unit of measure code expressed according to the UNECE Rec20 standard for electronically ending sales documents.|-|lastModifiedDateTime|datetime|The last datetime the unit of measure was modified. Read-Only.| +|lastModifiedDateTime|datetime|The last datetime the unit of measure was modified. Read-Only.| ## Relationships None ## JSON representation -Here's a JSON representation of the **unitsOfMeasure** resource. +Here's a JSON representation of the **unitOfMeasure** resource. ```json { |
v1.0 | Dynamics Vendor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-vendor.md | Title: vendors resource type -description: A vendor object in Dynamics 365 Business Central. + Title: vendor resource type +description: A vendor object in Dynamics 365 Business Central. documentationcenter: '' -# vendors resource type +# vendor resource type Namespace: microsoft.graph Represents a vendor in Dynamics 365 Business Central. | Method | Return Type |Description| |:|:--|:-|-|[Get vendors](../api/dynamics-vendor-get.md)|vendors|Gets a vendor object.| -|[Post vendors](../api/dynamics-create-vendor.md)|vendors|Creates a vendor object.| -|[Patch vendors](../api/dynamics-vendor-update.md)|vendors|Updates a vendor object.| +|[Get vendor](../api/dynamics-vendor-get.md)|vendor|Gets a vendor object.| +|[Post vendor](../api/dynamics-create-vendor.md)|vendor|Creates a vendor object.| +|[Patch vendor](../api/dynamics-vendor-update.md)|vendor|Updates a vendor object.| |[Delete vendor](../api/dynamics-vendor-delete.md)|none|Deletes a vendor object.| ## Properties Represents a vendor in Dynamics 365 Business Central. |taxLiable|boolean|Specifies if the vendor is liable for tax.| |blocked|string|Specifies which transactions with the vendor that can't be posted. Accepted values are blank, Payment or All| |balance|decimal|The vendor's balance. Read-Only.|-|lastModifiedDateTime|datetime|The last datetime the vendor was modified. Read-Only.| +|lastModifiedDateTime|datetime|The last datetime the vendor was modified. Read-Only.| ## Relationships |
v1.0 | Edidentitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/edidentitysource.md | description: "Represents an permissionsDefinitionIdentitySource for a configured ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Ediscovery Caseexportoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-caseexportoperation.md | Inherits from [caseOperation](../resources/ediscovery-caseoperation.md). |exportOptions|microsoft.graph.ediscovery.exportOptions| The options provided for the export. For more information, see [reviewSet: export](../api/ediscovery-reviewset-export.md). Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`.| |exportStructure|microsoft.graph.ediscovery.exportFileStructure|The options provided specify the structure of the export. For more information, see [reviewSet: export](../api/ediscovery-reviewset-export.md). Possible values are: `none`, `directory`, `pst`.| |id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/ediscovery-caseoperation.md).|+|outputFolderId|String|The output folder ID.| |outputName|String| The name provided for the export.| |percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/ediscovery-caseoperation.md).| |resultInfo|[resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. Inherited from [caseOperation](../resources/ediscovery-caseoperation.md).| Inherits from [caseOperation](../resources/ediscovery-caseoperation.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Ediscovery Casesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-casesettings.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Ediscovery Datasource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-datasource.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Ediscovery Noncustodialdatasource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-noncustodialdatasource.md | Inherits from [dataSourceContainer](../resources/ediscovery-datasourcecontainer. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Ediscovery Sourcecollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-sourcecollection.md | Represents an eDiscovery collection, commonly known as a search. For details, se ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Ediscovery Topicmodelingsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-topicmodelingsettings.md | 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.ediscovery.topicModelingSettings" |
v1.0 | Ediscovery Unifiedgroupsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-unifiedgroupsource.md | Types of source related to the user. Includes mailbox and site both by default. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", Here's a JSON representation of the resource. ``` json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#compliance/ediscovery/cases('4c8f8f70-7785-4bd4-b296-c98376a2c5e1')/custodians('2192ca408ea2410eba3bec8ae873be6b')/unifiedGroupSources", - "value": [ - { - "displayName": "Developers group", - "createdDateTime": "2020-10-27T15:14:11.0048392Z", - "id": "33434233-3030-3739-3043-393039324633", - "includedSources": "mailbox,site", - "createdBy": { - "user": { - "id": "c1db6f13-332a-4d84-b111-914383ff9fc9", - "displayName": null - } - } - } - ] + "@odata.type": "#microsoft.graph.ediscovery.unifiedGroupSource", + "displayName": "Developers group", + "createdDateTime": "2020-10-27T15:14:11.0048392Z", + "id": "33434233-3030-3739-3043-393039324633", + "includedSources": "mailbox,site", + "createdBy": { "@odata.type": "microsoft.graph.identitySet" } } ``` |
v1.0 | Educationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationassignment.md | Inherits from [entity](../resources/entity.md). |id|String| The unique identifier for the **assignment**. Inherited from [entity](../resources/entity.md). Read-only.| |instructions|[itemBody](itembody.md)| Instructions for the **assignment**. This property and the display name tell the student what to do. | |lastModifiedBy|[identitySet](identityset.md)| Who last modified the **assignment**. |-|lastModifiedDateTime|DateTimeOffset|Moment when the **assignment** 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`| +|lastModifiedDateTime|DateTimeOffset|The date and time on which the **assignment** was modified. A student submission doesn't modify the assignment; only teachers can update assignments. 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`| |moduleUrl|string| The URL of the module from which to access the **assignment**.| |notificationChannelUrl|String|Optional field to specify the URL of the [channel](channel.md) to post the **assignment** publish notification. If not specified or null, defaults to the `General` channel. This field only applies to **assignments** where the **assignTo** value is [educationAssignmentClassRecipient](educationassignmentclassrecipient.md). Updating the **notificationChannelUrl** isn't allowed after the **assignment** has been published.| |resourcesFolderUrl|string| Folder URL where all the file resources for this **assignment** are stored.| |
v1.0 | Educationassignmentindividualrecipient | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationassignmentindividualrecipient.md | This resource is a subclass of [educationAssignmentRecipient](educationassignmen ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationassignmentpointsgrade | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationassignmentpointsgrade.md | which will add the who data to this property. The max points are stored in the * ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationassignmentresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationassignmentresource.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationassignmentsettings.md | Specifies class-level assignments settings. |gradingCategories|[educationGradingCategory](educationgradingcategory.md) collection| When set, enables users to weight assignments differently when computing a class average grade.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Educationfileresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationfileresource.md | A subclass of [educationResource](educationresource.md) that represents a file o ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationfilesynchronizationverificationmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationfilesynchronizationverificationmessage.md | Represents an error returned to the client in response to a request to [start sy | Property | Type | Description | | :- | :-- | : | | type | string | Type of the message. Possible values are: `error`, `warning`, `information`. |-| filename | string | Source file that contains the error. | +| fileName | string | Source file that contains the error. | | description | string | Detailed information about the message type. | ## JSON representation |
v1.0 | Educationlinkresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationlinkresource.md | A subclass of [educationResource](educationresource.md). This resource is a link ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationmoduleresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationmoduleresource.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationonerosterapidataprovider | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationonerosterapidataprovider.md | Title: "educationOneRosterApiDataProvider resource" + Title: educationOneRosterApiDataProvider resource type description: "Used to set up the school data synchronization profile when the OneRoster API is used as the input source." ms.localizationpriority: medium-# educationOneRosterApiDataProvider resource +# educationOneRosterApiDataProvider resource type Namespace: microsoft.graph |
v1.0 | Educationpowerschooldataprovider | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationpowerschooldataprovider.md | Title: "educationPowerSchoolDataProvider resource" + Title: educationPowerSchoolDataProvider resource type description: "Used to set up the school data synchronization profile when PowerSchool is used as the input source." ms.localizationpriority: medium-# educationPowerSchoolDataProvider resource +# educationPowerSchoolDataProvider resource type Namespace: microsoft.graph |
v1.0 | Educationresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationresource.md | This resource stores the common properties across all resource types. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationschool | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationschool.md | This resource is a subtype of [educationOrganization](educationorganization.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 |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` and `reassigned`. 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): `reassigned`.| +|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`.| |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.| |
v1.0 | Educationsubmissionresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationsubmissionresource.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationsynchronizationoauth1connectionsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationsynchronizationoauth1connectionsettings.md | Title: "educationSynchronizationOAuth1ConnectionSettings resource" + Title: educationSynchronizationOAuth1ConnectionSettings resource type description: "When OAuth1 is to be used to connect to the data provider, this connection settings type should be used to set up the profile." ms.localizationpriority: medium -# educationSynchronizationOAuth1ConnectionSettings resource +# educationSynchronizationOAuth1ConnectionSettings resource type Namespace: microsoft.graph |
v1.0 | Educationsynchronizationoauth2clientcredentialsconnectionsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationsynchronizationoauth2clientcredentialsconnectionsettings.md | Title: "educationSynchronizationOAuth2ClientCredentialsConnectionSettings resource" + Title: educationSynchronizationOAuth2ClientCredentialsConnectionSettings resource type description: "When OAuth2 Client Credentials Grant is to be used to connect to the data provider, this connection settings type should be used to set up the profile." ms.localizationpriority: medium -# educationSynchronizationOAuth2ClientCredentialsConnectionSettings resource +# educationSynchronizationOAuth2ClientCredentialsConnectionSettings resource type Namespace: microsoft.graph |
v1.0 | Educationterm | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationterm.md | A term. This represents a designated portion of the academic year. It's used wit ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationuser.md | This object provides a targeted subset of properties from the core [user] object | mailingAddress | [physicalAddress] | Mail address of user. Note: `type` and `postOfficeBox` aren't supported for `educationUser` resources. | | middleName | String | The middle name of user. | | mobilePhone | String | The primary cellular telephone number for the user. |+| officeLocation | String | The office location for the user. | | onPremisesInfo | [educationOnPremisesInfo] | Additional information used to associate the Microsoft Entra user with its Active Directory counterpart. | | passwordPolicies | String | Specifies password policies for the user. See standard [user] resource for more details. | | passwordProfile | [passwordProfile] | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. See standard [user] resource for more details. | This object provides a targeted subset of properties from the core [user] object ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Email Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/email-activity-reports.md | - Title: "Email activity reports" -description: "You can get a high level view of email traffic within your organization from the Reports page. You can also drill into the Email Activity widget to understand the trends and details per user of the email activity in your organization." ---doc_type: conceptualPageType ---# Email activity reports --Namespace: microsoft.graph ---You can get a high level view of email traffic within your organization from the Reports page. You can also drill into the Email Activity widget to understand the trends and details per user of the email activity in your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Email Activity](https://support.office.com/client/Email-activity-1cbe2c00-ca65-4fb9-9663-1bbfa58ebe44). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get user detail](../api/reportroot-getemailactivityuserdetail.md) | Stream | Stream | Get details about email activity users have performed. | -| [Get activity counts](../api/reportroot-getemailactivitycounts.md) | Stream | 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 | Stream | Enables you to understand trends on the number of unique users who are performing email activities like send, read, and receive. | -- |
v1.0 | Email App Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/email-app-usage-reports.md | - Title: "Email app usage reports" -description: "You can see how many email apps are used to connect to Exchange Online. You can also see which versions of Outlook apps are used which will enable you to follow up with users who should upgrade to supported Outlook versions." ---doc_type: conceptualPageType ---# Email app usage reports --Namespace: microsoft.graph ---You can see how many email apps are used to connect to Exchange Online. You can also see which versions of Outlook apps are used which will enable you to follow up with users who should upgrade to supported Outlook versions. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Email apps usage](https://support.office.com/client/Email-apps-usage-c2ce12a2-934f-4dd4-ba65-49b02be4703d). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get user detail](../api/reportroot-getemailappusageuserdetail.md) | Stream | Stream | Get details about which activities users performed on the various email apps. | -| [Get apps user counts](../api/reportroot-getemailappusageappsusercounts.md) | Stream | Stream | Get the count of unique users per email app. | -| [Get user counts](../api/reportroot-getemailappusageusercounts.md) | Stream | 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 | Stream | Get the count of unique users by Outlook desktop version. | -- |
v1.0 | Emailaddress | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/emailaddress.md | Represents the name and SMTP address of an entity instance, for example, a messa ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Emailauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/emailauthenticationmethodconfiguration.md | Inherits from [authenticationMethodConfiguration](../resources/authenticationmet ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Emailfileassessmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/emailfileassessmentrequest.md | Inherits from [threatAssessmentRequest](threatassessmentrequest.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Emailidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/emailidentity.md | Inherits from [identity](../resources/identity.md). 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.emailIdentity" |
v1.0 | Emailpayloaddetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/emailpayloaddetail.md | 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.emailPayloadDetail" + "@odata.type": "microsoft.graph.emailPayloadDetail", + "baseType": "microsoft.graph.payloadDetail" } --> ``` json |
v1.0 | Employeeorgdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/employeeorgdata.md | Title: "employeeOrgData resource type" description: "Represents organization data associated with a user." ms.localizationpriority: medium doc_type: resourcePageType+ |
v1.0 | Encryptedawsstoragebucketfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/encryptedawsstoragebucketfinding.md | description: "Represents the findings for AWS encrypted storage buckets." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Encryptedazurestorageaccountfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/encryptedazurestorageaccountfinding.md | description: "Represents the findings for Azure encrypted storage accounts." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Encryptedgcpstoragebucketfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/encryptedgcpstoragebucketfinding.md | description: "Represents the findings for GCP encrypted storage buckets." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Endpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/endpoint.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Endswithtransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/endswithtransformation.md | + + Title: "endsWithTransformation resource type" +description: "Contains the output of a transformation if the input ends with the specified value." ++ms.localizationpriority: medium ++++# endsWithTransformation resource type ++Namespace: microsoft.graph +++Contains the output of a transformation if the input ends with the specified value. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|output|[transformationAttribute](../resources/transformationattribute.md)|The output attribute used, based on the condition applied in this transformation.| +|value|String|The value to be used as part of the transformation.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.endsWithTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.endsWithTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "output": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "value": "String" +} +``` |
v1.0 | Entitlementmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/entitlementmanagement.md | The following is a JSON representation of the resource. "blockType": "resource", "keyProperty": "id", "@odata.type": "microsoft.graph.entitlementManagement",- "openType": false + "openType": false, + "baseType": "microsoft.graph.entity" } --> ``` json |
v1.0 | Entitlementmanagementsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/entitlementmanagementsettings.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Entitlementsdatacollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/entitlementsdatacollection.md | description: "Represents the details and status of data collection about permiss ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Entitlementsdatacollectioninfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/entitlementsdatacollectioninfo.md | description: "An abstract type that defines any data collected about permissions ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Entity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/entity.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Enumeratedaccountswithaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enumeratedaccountswithaccess.md | description: "Contains information on specified external AWS accounts that have ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Enumeratedinboundports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enumeratedinboundports.md | description: "Allows incoming traffic from certain ports." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Enums Identitygovernance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums-identitygovernance.md | Namespace: microsoft.graph.identityGovernance |unknownFutureValue| +### membershipChangeType values ++++|Member| +|:| +|add| +|remove| +|unknownFutureValue| +++ <!-- { |
v1.0 | Enums Industrydata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums-industrydata.md | Enum values for the industry data API in Microsoft Graph. | expired | | unknownFutureValue | +### filteroptions values ++| Member | +|:-| +| orgExternalId | +| unknownFutureValue | ++### additionalUserAttributes values ++| Member | +|:-| +| userGradeLevel | +| userNumber | +| unknownFutureValue | ++### additionalClassGroupAttributes values ++| Member | +|:--| +| courseTitle | +| courseCode | +| courseSubject | +| courseGradeLevel | +| courseExternalId | +| academicSessionTitle | +| academicSessionExternalId | +| classCode | +| unknownFutureValue | + <!-- { "type": "#page.annotation", |
v1.0 | Enums Networkaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums-networkaccess.md | Namespace: microsoft.graph.networkaccess |southAfricaWest| |southAfricaNorth| |uaeNorth|+|australiaEast| +|westCentralUS| +|centralIndia| +|southEastAsia| +|swedenCentral| +|southIndia| +|australiaSouthEast| +|koreaCentral| +|polandCentral| +|brazilSouth| +|japanEast| +|japanWest| +|koreaSouth| +|italyNorth| +|franceSouth| +|israelCentral| |unknownFutureValue| + ### status values |Member| Namespace: microsoft.graph.networkaccess "type": "#page.annotation", "namespace": "microsoft.graph.networkaccess" }>+--> |
v1.0 | Enums Partner Security | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums-partner-security.md | + + Title: "Partner security enum values" +description: "Microsoft Graph partner security enumeration values." ++ms.localizationpriority: medium ++++# Partner security enum values ++Namespace: microsoft.graph.partner.security ++### securityAlertConfidence values ++|Member| +|:| +|low| +|medium| +|high| +|unknownFutureValue| +++### securityAlertResolvedReason values ++|Member| +|:| +|legitimate| +|ignore| +|fraud| +|unknownFutureValue| +++### securityAlertSeverity values ++|Member| +|:| +|informational| +|high| +|medium| +|low| +|unknownFutureValue| +++### securityAlertStatus values ++|Member| +|:| +|active| +|resolved| +|investigating| +|unknownFutureValue| ++<!-- +{ + "type": "#page.annotation", + "namespace": "microsoft.graph.partner.security" +} +--> |
v1.0 | Enums | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums.md | +### fileStorageContainerOwnershipType values ++| Member | +|:-| +| tenantOwned | +| unknownfuturevalue | ++### groupAccessType values ++| Member | +|:-| +| none | +| private | +| secret | +| public | + ### fileStorageContainerStatus values | Member | Namespace: microsoft.graph | certificate | | unknownFutureValue | +### plannerTaskCompletionRequirements values ++| Member | +|:-| +| none | +| checklistCompletion| +| unknownFutureValue | +| formCompletion | +| approvalCompletion | ++### plannerApprovalStatus values ++| Member | +|:-| +| requested | +| approved | +| rejected | +| cancelled | +| unknownFutureValue | + ### applicationKeyOrigin values | Member | Namespace: microsoft.graph |generallyAvailable| |unknownFutureValue| +### requiredLicenses values ++|Member| +|:| +|notApplicable| +|microsoftEntraIdFree| +|microsoftEntraIdP1| +|microsoftEntraIdP2| +|microsoftEntraIdGovernance| +|microsoftEntraWorkloadId| +|unknownFutureValue| + ### recommendationCategory values | Member | Namespace: microsoft.graph | saml20 | | deviceCode | | unknownFutureValue |+| authenticationTransfer| +| nativeAuth | ### accessReviewInstanceDecisionItemFilterByCurrentUserOptions values Namespace: microsoft.graph | gpsLocationCondition | | riskBasedPolicy | | unknownFutureValue |+| scopeBasedAuthRequirementPolicy | +| authenticationStrengths | ### riskDetail values Namespace: microsoft.graph |returned| |unknownFutureValue| |reassigned|+|excused| ### educationFeedbackResourceOutcomeStatus values Possible values for user account types (group membership), per Windows definitio ### stagedFeatureName values -| Member | Description | -| : | :- | -| passthroughAuthentication | Passthrough Authentication | -| seamlessSso | Seamless Single Sign-on | -| passwordHashSync | Password Hash Synchronization | -| emailAsAlternateId | Email as an alternate ID | -| unknownFutureValue | A sentinel member | +| Member | +| : | +| passthroughAuthentication | +| seamlessSso | +| passwordHashSync | +| emailAsAlternateId | +| unknownFutureValue | +| certificateBasedAuthentication | ### tokenIssuerType values Possible values for user account types (group membership), per Windows definitio |unbound| |unknownFutureValue| +### conditionalAccessAudienceReason values ++| Member | +| :-- | +|none| +|resourcelessRequest| +|confidentialClientIdToken| +|confidentialClientNonIdToken| +|resourceMapping| +|resourceMappingDefault| +|scopeMapping| +|scopeMappingDefault| +|delegatedScope | +|firstPartyResourceDefault| +|thirdPartyResourceDefault| +|unknownFutureValue| + ### persistentBrowserSessionMode values | Member | Possible values for user account types (group membership), per Windows definitio | gallery | | unknownFutureValue | +### cloudPcPolicySettingType values ++|Member| +|:| +|region| +|singleSignOn| +|unknownFutureValue| + ### chatType values | Member | Value | Description | Possible values for user account types (group membership), per Windows definitio |deviceCodeFlow| |authenticationTransfer| |unknownFutureValue|++### claimConditionUserType values ++|Member| +|:| +|any| +|members| +|allGuests| +|aadGuests| +|externalGuests| +|unknownFutureValue| ++### filterType values ++|Member| +|:| +|prefix| +|suffix| +|contains| +|unknownFutureValue| ++### matchOn values ++|Member| +|:| +|displayName| +|samAccountName| +|unknownFutureValue| ++### samlAttributeNameFormat values ++|Member| +|:| +|unspecified| +|uri| +|basic| +|unknownFutureValue| ++### samlNameIDFormat values ++|Member| +|:| +|default| +|unspecified| +|emailAddress| +|windowsDomainQualifiedName| +|persistent| +|unknownFutureValue| ++### samlSLOBindingType values ++|Member| +|:| +|httpRedirect| +|httpPost| +|unknownFutureValue| ++### tokenFormat values ++|Member| +|:| +|saml| +|jwt| +|unknownFutureValue| ++### transformationExtractType values ++|Member| +|:| +|prefix| +|suffix| +|unknownFutureValue| ++### transformationTrimType values ++|Member| +|:| +|leading| +|trailing| +|leadingAndTrailing| +|unknownFutureValue| ++### sharingRole values ++|Member| +|:| +|none| +|view| +|edit| +|manageList| +|review| +|restrictedView| +|submitOnly| +|unknownFutureValue| ++### sharingScope values ++|Member| +|:| +|anyone| +|organization| +|specificPeople| +|anonymous| +|users| +|unknownFutureValue| ++### sharingVariant values ++|Member| +|:| +|none| +|requiresAuthentication| +|passwordProtected| +|addressBar| +|embed| +|unknownFutureValue| ++### trustFrameworkKeyStatus values ++|Member| +|:| +|enabled| +|disabled| +|unknownFutureValue| ++### conditionalAccessInsiderRiskLevels values ++|Member| +|:| +|minor| +|moderate| +|elevated| +|unknownFutureValue| + |
v1.0 | Evaluatedynamicmembershipresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/evaluatedynamicmembershipresult.md | Represents the result of membership evaluation. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Event | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/event.md | The following JSON representation shows the resource type. "singleValueExtendedProperties", "multiValueExtendedProperties" ],- "@odata.type": "microsoft.graph.event" + "@odata.type": "microsoft.graph.event", + "baseType": "microsoft.graph.outlookItem" }--> ```json |
v1.0 | Eventmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/eventmessage.md | Aside from a meeting request, an **eventMessage** instance can be found in an in ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Eventmessagerequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/eventmessagerequest.md | To respond to the meeting request, first, use the **event** navigation property ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Extension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/extension.md | An abstract type to support the OData v4 open type [openTypeExtension](opentypee ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Extensionproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/extensionproperty.md | Title: "extensionProperty resource type (directory extensions)" description: "Represents a directory extension" ms.localizationpriority: medium + doc_type: "resourcePageType"+toc. Title: Directory extension # extensionProperty resource type (directory extensions) |
v1.0 | Extensionschemaproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/extensionschemaproperty.md | Title: "extensionSchemaProperty resource type" description: "Use the **extensionSchemaProperty** resource to define a property's name and its type, as part of a schemaExtension definition." ms.localizationpriority: medium doc_type: resourcePageType+ Use the **extensionSchemaProperty** resource to define a property's name and its | Property | Type |Description| |:|:--|:-| |name|String| The name of the strongly typed property defined as part of a schema extension.|-|type|String| The type of the property that is defined as part of a schema extension. Allowed values are `Binary`, `Boolean`, `DateTime`, `Integer` or `String`. See the table below for more details.| +|type|String| The type of the property that is defined as part of a schema extension. Allowed values are `Binary`, `Boolean`, `DateTime`, `Integer`, or `String`. For more information, see [Supported property data types](#supported-property-data-types).| ### Supported property data types The following data types are supported when defining a property in a schema extension: The following data types are supported when defining a property in a schema exte | Property Type | Remarks | |-|| | Binary | 256 bytes maximum. |-| Boolean | Not supported for messages, events and posts. | -| DateTime | Must be specified in ISO 8601 format. Will be stored in UTC. | -| Integer | 32-bit value. Not supported for messages, events and posts. | +| Boolean | Not supported for messages, events, and posts. | +| DateTime | Must be specified in ISO 8601 format. Is stored in UTC. | +| Integer | 32-bit value. Not supported for messages, events, and posts. | | String | 256 characters maximum. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Externalauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalauthenticationmethodconfiguration.md | + + Title: "externalAuthenticationMethodConfiguration resource type" +description: "Specifies the properties and connection information for an external authentication method." ++ms.localizationpriority: medium ++++# externalAuthenticationMethodConfiguration resource type ++Namespace: microsoft.graph +++Specifies the properties and connection information for an external authentication method. +++Inherits from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get](../api/externalauthenticationmethodconfiguration-get.md)|[externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md)|Read the properties and relationships of an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object.| +|[Update](../api/externalauthenticationmethodconfiguration-update.md)|[externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md)|Update the properties of an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object.| +|[Delete](../api/externalauthenticationmethodconfiguration-delete.md)|None|Delete an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|appId|String|**appId** for the app registration in Microsoft Entra ID representing the integration with the external provider.| +|displayName|String|Display name for the external authentication method. This name is shown to users during sign-in.| +|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users excluded from the policy. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).| +|id|String|The unique identifier for this object. Read-only. Inherited from [entity](../resources/entity.md).| +|openIdConnectSetting|[openIdConnectSetting](../resources/openidconnectsetting.md)|Open ID Connection settings used by this external authentication method.| +|state|authenticationMethodState|The state of the method in the policy. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md). The possible values are: `enabled`, `disabled`.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of groups that are enabled to use an authentication method as part of an authentication method policy in Microsoft Entra ID.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.externalAuthenticationMethodConfiguration", + "baseType": "microsoft.graph.authenticationMethodConfiguration", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.externalAuthenticationMethodConfiguration", + "id": "String (identifier)", + "state": "String", + "excludeTargets": [ + { + "@odata.type": "microsoft.graph.excludeTarget" + } + ], + "displayName": "String", + "appId": "String", + "openIdConnectSetting": { + "@odata.type": "microsoft.graph.openIdConnectSetting" + } +} +``` + |
v1.0 | Externalconnectors Acl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalconnectors-acl.md | An access control entry for an item indexed by a Microsoft Search [externalConne ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Externalconnectors External | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalconnectors-external.md | description: "The base container for Microsoft Graph APIs such as the industry d ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Externalconnectors Externalgroupmember | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalconnectors-externalgroupmember.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Externalconnectors Identity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalconnectors-identity.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Externalconnectors Property | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalconnectors-property.md | A [schema](externalconnectors-schema.md) property definition for a Microsoft Sea ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Externalconnectors Schema | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalconnectors-schema.md | The following is a JSON representation of the resource. "optionalProperties": [ ], "@odata.type": "microsoft.graph.externalConnectors.schema",- "keyProperty": "id" + "keyProperty": "id", + "baseType": "microsoft.graph.entity" }--> ```json |
v1.0 | Externalidentitiespolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalidentitiespolicy.md | Inherits from [policyBase](../resources/policybase.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", Here's a JSON representation of the resource. { "@odata.type": "#microsoft.graph.externalIdentitiesPolicy", "id": "String (identifier)",- "deletedDateTime": "String (timestamp)", "description": "String", "displayName": "String", "allowExternalIdentitiesToLeave": "Boolean", |
v1.0 | Externallyaccessibleawsstoragebucketfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externallyaccessibleawsstoragebucketfinding.md | description: "Get insight into the AWS S3 buckets accessible externally in your ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Externallyaccessibleazureblobcontainerfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externallyaccessibleazureblobcontainerfinding.md | description: "Get insights into Azure blob containers that are accessible extern ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Externallyaccessiblegcpstoragebucketfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externallyaccessiblegcpstoragebucketfinding.md | description: "Represents the findings for externally accessible GCP storage buck ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Externalprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalprofile.md | Title: "externalProfile resource type" description: "Defines an external profile." + ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Externaluserprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externaluserprofile.md | Title: "externalUserProfile resource type" description: "Represents the profile of an external user in a Microsoft Entra tenant." ms.localizationpriority: high + doc_type: resourcePageType |
v1.0 | Externalusersselfservicesignupeventsflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalusersselfservicesignupeventsflow.md | Title: "externalUsersSelfServiceSignUpEventsFlow resource type" -description: "Represents a self-service user flow for external identities within a Microsoft Entra workforce tenant or customer tenant." +description: "Represents a self-service user flow for external identities within a Microsoft Entra External ID in workforce or external tenants." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a self-service user flow for external identities within a Microsoft Entra workforce tenant or customer tenant. A user flow is implemented as a multi-event policy executing the specific events at specific points of user interaction. +Represents a self-service user flow for external identities within a Microsoft Entra External ID in workforce or external tenants. A user flow is implemented as a multi-event policy executing the specific events at specific points of user interaction. Inherits from [authenticationEventsFlow](../resources/authenticationeventsflow.md). ## Methods-|Method|Return type|Description| -|:|:|:| -|[List](../api/identitycontainer-list-authenticationeventsflows.md)|[authenticationEventsFlow](../resources/authenticationeventsflow.md) collection|Retrieve a list of the [authenticationEventsFlow](../resources/authenticationeventsflow.md) objects and their properties. | -|[Create](../api/identitycontainer-post-authenticationeventsflows.md)|[externalUsersSelfServiceSignUpEventsFlow](../resources/externalusersselfservicesignupeventsflow.md)|Create an external identities self-service sign-up user flow.| -|[Get](../api/authenticationeventsflow-get.md)|[externalUsersSelfServiceSignUpEventsFlow](../resources/externalusersselfservicesignupeventsflow.md)|Retrieve the properties and relationships of an external identities self-service sign-up user flow.| -|[Update](../api/authenticationeventsflow-update.md)|None|Update the properties of an external identities self-service sign-up user flow| -|[Delete](../api/authenticationeventsflow-delete.md)|None|Delete an external identities self-service sign-up user flow.| -|[List linked applications](../api/authenticationconditionsapplications-list-includeapplications.md)|[authenticationConditionApplication](../resources/authenticationconditionapplication.md) collection|List listeners associated with an external identities self-service sign-up user flow.| -|[Add linked application](../api/authenticationconditionsapplications-post-includeapplications.md)|None|List listeners associated with an external identities self-service sign-up user flow.| -|[Remove linked application](../api/authenticationconditionapplication-delete.md)|None|List listeners associated with an external identities self-service sign-up user flow.| -|[List identity providers](../api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders.md)|[identityProvider](../resources/identityproviderbase.md) collection|List identity provider selections associated with an external identities self-service sign-up user flow.| -|[Add identity providers](../api/onauthenticationmethodloadstartexternalusersselfservicesignup-post-identityproviders.md)|None|Add an identity provider to an external identities self-service sign-up user flow.| -|[Remove identity providers](../api/onauthenticationmethodloadstartexternalusersselfservicesignup-delete-identityproviders.md)|None|Remove an identity provider from an external identities self-service sign-up user flow.| -|[List attributes](../api/onattributecollectionexternalusersselfservicesignup-list-attributes.md)|[identityUserFlowAttribute](../resources/identityuserflowattribute.md) collection|Retrieve all user attributes associated with an external identities self-service sign-up user flow.| -|[Add an attribute](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md)|None|Retrieve all user attributes associated with an external identities self-service sign-up user flow.| -|[Delete an attribute](../api/onattributecollectionexternalusersselfservicesignup-delete-attributes.md)|None|Remove a user flow attribute from an external identities self-service sign-up user flow.| -<!--|[List listeners]()|None|List listeners associated with an External Identities Self-Service-Sign-up User Flow **is this required?**| -|[Get listener]()|None|List listeners associated with an External Identities Self-Service-Sign-up User Flow **is this required?**| -|[Create listener]()|None|List listeners associated with an External Identities Self-Service-Sign-up User Flow **is this required?**| -|[Update listeners]()|None|List listeners associated with an External Identities Self-Service-Sign-up User Flow **is this required?**| -|[Delete listeners]()|None|List listeners associated with an External Identities Self-Service-Sign-up User Flow **is this required?**|--> +None. ++For the list of API operations for managing this resource type, see the [authenticationEventsFlow resource type](../resources/authenticationeventsflow.md). ## Properties |
v1.0 | Extractalphatransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/extractalphatransformation.md | + + Title: "extractAlphaTransformation resource type" +description: "Returns the alphabetical part of the string." ++ms.localizationpriority: medium ++++# extractAlphaTransformation resource type ++Namespace: microsoft.graph +++Returns the alphabetical part of the string. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|type|transformationExtractType|The type of extract transformation to apply. The possible values are: `prefix`, `suffix`, `unknownFutureValue`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.extractAlphaTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.extractAlphaTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "type": "String" +} +``` |
v1.0 | Extractmailprefixtransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/extractmailprefixtransformation.md | + + Title: "extractMailPrefixTransformation resource type" +description: "Removes the domain suffix from either the email address or the user principal name." ++ms.localizationpriority: medium ++++# extractMailPrefixTransformation resource type ++Namespace: microsoft.graph +++Removes the domain suffix from either the email address or the user principal name. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.extractMailPrefixTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.extractMailPrefixTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + } +} +``` |
v1.0 | Extractnumbertransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/extractnumbertransformation.md | + + Title: "extractNumberTransformation resource type" +description: "Returns the numerical part of the string." ++ms.localizationpriority: medium ++++# extractNumberTransformation resource type ++Namespace: microsoft.graph +++Returns the numerical part of the string. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|type|transformationExtractType|The type of extract transformation to apply. The possible values are: `prefix`, `suffix`, `unknownFutureValue`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.extractNumberTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.extractNumberTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "type": "String" +} +``` |
v1.0 | Extracttransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/extracttransformation.md | + + Title: "extractTransformation resource type" +description: "Returns the substring after, between or before it matches the specified value.*" ++ms.localizationpriority: medium ++++# extractTransformation resource type ++Namespace: microsoft.graph +++Returns the substring after, between or before it matches the specified value. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|type|String|The type of extract transformation to apply.| +|value|String|The value to be used as part of the transformation.| +|value2|String|An optional secondary value to be used when dealing with between extract operations.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.extractTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.extractTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "type": "String", + "value": "String", + "value2": "String" +} +``` |
v1.0 | Featurerolloutpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/featurerolloutpolicy.md | The following are limitations of feature rollout: - Each feature supports a maximum of 10 groups. - The **appliesTo** field only supports groups.-- Dynamic groups and nested groups are not supported.+- Dynamic groups and nested groups aren't supported. -The following are pre-requisites for each of the features that are currently supported for rollout using this rollout policy. --### Passthrough Authentication --* Identify a server running Windows Server 2012 R2 or later where you want the [PassthroughAuthentication](/azure/active-directory/hybrid/how-to-connect-pta) Agent to run. Ensure that the server is domain-joined, can authenticate selected users with Active Directory, and can communicate with Microsoft Entra ID on outbound ports / URLs. -* [Download](https://aka.ms/getauthagent) & install the Microsoft Entra Connect Authentication Agent on the server. -* To enable high availability, install additional Authentication Agents on other servers as described [here](/azure/active-directory/hybrid/how-to-connect-pta-quick-start#step-4-ensure-high-availability). -* Ensure that you have configured your [Smart Lockout](/azure/active-directory/authentication/howto-password-smart-lockout) settings appropriately. This is to ensure that your users' on-premises Active Directory accounts don't get locked out by bad actors. --### SeamlessSso --* Enable [SeamlessSso](/azure/active-directory/hybrid/how-to-connect-sso) for the AD forests based on [these](/azure/active-directory/hybrid/tshoot-connect-sso#manual-reset-of-the-feature) instructions. --### PasswordHashSync --* Enable [PasswordHashSync](/azure/active-directory/hybrid/whatis-phs) from the "Optional features" page in Microsoft Entra Connect. --### EmailAsAlternateId --* Associate alternate email with user accounts. +For more information about staged rollout, see [How to configure staged rollout in Microsoft Entra ID](https://www.youtube.com/watch?v=LFTE1epYDFQ). ## Methods The following are pre-requisites for each of the features that are currently sup |:-|:|:| |description|String|A description for this feature rollout policy.| |displayName|String|The display name for this feature rollout policy.|-|feature|stagedFeatureName| Possible values are: `passthroughAuthentication`, `seamlessSso`, `passwordHashSync`, `emailAsAlternateId`, `unknownFutureValue`.| +|feature|stagedFeatureName| Possible values are: `passthroughAuthentication`, `seamlessSso`, `passwordHashSync`, `emailAsAlternateId`, `unknownFutureValue`, `certificateBasedAuthentication`. 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): `certificateBasedAuthentication`. For more information about the prerequisites for the enabled features, see [Prerequisites for enabled features](#prerequisites-for-enabled-features).| |id|String| Read-only.| |isAppliedToOrganization|Boolean|Indicates whether this feature rollout policy should be applied to the entire organization.| |isEnabled|Boolean|Indicates whether the feature rollout is enabled.| +### Prerequisites for enabled features ++The following are prerequisites for each of the features that are currently supported for rollout using this rollout policy. ++#### Passthrough Authentication ++* Identify a server running Windows Server 2012 R2 or later where you want the [PassthroughAuthentication](/azure/active-directory/hybrid/how-to-connect-pta) Agent to run. Ensure that the server is domain-joined, can authenticate selected users with Active Directory, and can communicate with Microsoft Entra ID on outbound ports / URLs. +* [Download](https://aka.ms/getauthagent) & install the Microsoft Entra Connect Authentication Agent on the server. +* To enable high availability, install additional Authentication Agents on other servers as described [here](/azure/active-directory/hybrid/how-to-connect-pta-quick-start#step-4-ensure-high-availability). +* Ensure that you've configured your [Smart Lockout](/azure/active-directory/authentication/howto-password-smart-lockout) settings appropriately. This is to ensure that your users' on-premises Active Directory accounts don't get locked out by bad actors. ++#### SeamlessSso ++* Enable [SeamlessSso](/azure/active-directory/hybrid/how-to-connect-sso) for the AD forests based on [these](/azure/active-directory/hybrid/tshoot-connect-sso#manual-reset-of-the-feature) instructions. ++#### PasswordHashSync ++* Enable [PasswordHashSync](/azure/active-directory/hybrid/whatis-phs) from the "Optional features" page in Microsoft Entra Connect. ++#### EmailAsAlternateId ++* Associate alternate email with user accounts. + ## Relationships | Relationship | Type | Description | |:-|:|:|-|appliesTo|[directoryObject](directoryobject.md) collection| Nullable. Specifies a list of directoryObjects that feature is enabled for.| +|appliesTo|[directoryObject](directoryobject.md) collection| Nullable. Specifies a list of directoryObject resources that feature is enabled for.| ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", The following is a JSON representation of the resource. } ``` +## Related content ++- [Migrate to cloud authentication using Staged Rollout](/entra/identity/hybrid/connect/how-to-connect-staged-rollout) + <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 2019-02-04 14:57:30 UTC --> <!-- { |
v1.0 | Federatedidentitycredential | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/federatedidentitycredential.md | +toc.keywords: [ Workload identity federation, workload identities ] # federatedIdentityCredential resource type |
v1.0 | Fido2combinationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/fido2combinationconfiguration.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Fieldvalueset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/fieldvalueset.md | description: "Represents the column values in a listItem resource." Last updated 09/11/2017 Title: FieldValueSet + Title: fieldValueSet resource type ms.localizationpriority: medium doc_type: resourcePageType -# FieldValueSet resource +# fieldValueSet resource type Namespace: microsoft.graph |
v1.0 | File | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/file.md | In addition to other properties, files have a **content** relationship that cont ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Fileassessmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/fileassessmentrequest.md | The file can be a text file or Word document or binary file received in an email ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Fileattachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/fileattachment.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Filestorage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/filestorage.md | + + Title: "fileStorage resource type" +description: "Represents the structure of active and deleted fileStorageContainer objects." ++ms.localizationpriority: medium ++++# fileStorage resource type ++Namespace: microsoft.graph +++Represents the structure of active and deleted [fileStorageContainer](../resources/filestoragecontainer.md) objects. ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|containers|[fileStorageContainer](../resources/filestoragecontainer.md) collection|The collection of active **fileStorageContainer** resources.| +|deletedContainers|[fileStorageContainer](../resources/filestoragecontainer.md) collection|The collection of deleted **fileStorageContainer** resources.| |
v1.0 | Filestoragecontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/filestoragecontainer.md | Namespace: microsoft.graph Represents a location where multiple users or a group of users can store files and access them via an application. All file system objects in a **fileStorageContainer** are returned as [driveItem](../resources/driveitem.md) resources. - ## Methods |Method|Return type|Description| |:|:|:|-|[List fileStorageContainers](../api/filestorage-list-containers.md)|[fileStorageContainer](../resources/filestoragecontainer.md)|Get a list of the [fileStorageContainer](../resources/filestoragecontainer.md) objects and their properties.| -|[Create fileStorageContainer](../api/filestoragecontainer-post.md)|[fileStorageContainer](../resources/filestoragecontainer.md)|Create a new [fileStorageContainer](../resources/filestoragecontainer.md) object.| -|[Get fileStorageContainer](../api/filestoragecontainer-get.md)|[fileStorageContainer](../resources/filestoragecontainer.md)|Read the properties and relationships of a [fileStorageContainer](../resources/filestoragecontainer.md) object.| -|[Update fileStorageContainer](../api/filestoragecontainer-update.md)|[fileStorageContainer](../resources/filestoragecontainer.md)|Update the properties of a [fileStorageContainer](../resources/filestoragecontainer.md) object.| -|[Delete fileStorageContainer](../api/filestorage-delete-containers.md)|None|Delete a [fileStorageContainer](../resources/filestoragecontainer.md) object.| -|[Activate fileStorageContainer](../api/filestoragecontainer-activate.md)|None|Activate a [fileStorageContainer](../resources/filestoragecontainer.md) object.| +|[List](../api/filestorage-list-containers.md)|[fileStorageContainer](../resources/filestoragecontainer.md) collection|Get a list of the [fileStorageContainer](../resources/filestoragecontainer.md) objects and their properties.| +|[Create](../api/filestoragecontainer-post.md)|[fileStorageContainer](../resources/filestoragecontainer.md)|Create a new [fileStorageContainer](../resources/filestoragecontainer.md) object.| +|[Get](../api/filestoragecontainer-get.md)|[fileStorageContainer](../resources/filestoragecontainer.md)|Read the properties and relationships of a [fileStorageContainer](../resources/filestoragecontainer.md) object.| +|[Update](../api/filestoragecontainer-update.md)|[fileStorageContainer](../resources/filestoragecontainer.md)|Update the properties of a [fileStorageContainer](../resources/filestoragecontainer.md) object.| +|[Delete](../api/filestorage-delete-containers.md)|None|Delete a [fileStorageContainer](../resources/filestoragecontainer.md) object.| +|[Activate](../api/filestoragecontainer-activate.md)|None|Activate a [fileStorageContainer](../resources/filestoragecontainer.md) object.| +|[Restore](../api/filestoragecontainer-restore.md)|[fileStorageContainer](../resources/filestoragecontainer.md)|Restore a deleted [fileStorageContainer](../resources/filestoragecontainer.md) object.| +|[Remove deleted](../api/filestorage-delete-deletedcontainers.md)|None|Remove a deleted [fileStorageContainer](../resources/filestoragecontainer.md) object.| +|[Permanent delete](../api/filestoragecontainer-permanentdelete.md)|None|Permanently delete a [fileStorageContainer](../resources/filestoragecontainer.md) object.| |[Get drive](../api/filestoragecontainer-get-drive.md)|[drive](../resources/drive.md)|Get the drive resource from a [fileStorageContainer](../resources/filestoragecontainer.md) object.|-|[List permissions](../api/filestoragecontainer-list-permissions.md)|[permission](../resources/permission.md)| List permissions on a fileStorageContainer.| +|[List permissions](../api/filestoragecontainer-list-permissions.md)|[permission](../resources/permission.md) collection| List permissions on a fileStorageContainer.| |[Create permissions](../api/filestoragecontainer-post-permissions.md)|[permission](../resources/permission.md)|Add permission to a fileStorageContainer.| |[Update permissions](../api/filestoragecontainer-update-permissions.md)|[permission](../resources/permission.md)|Update permission on a fileStorageContainer.|-|[Delete permissions](../api/filestoragecontainer-delete-permissions.md)|[permission](../resources/permission.md)|Delete permission from a fileStorageContainer.| -|[List fileStorageContainer custom property](../api/filestoragecontainer-list-customproperty.md)|[filestoragecontainercustompropertyvalue](../resources/filestoragecontainercustompropertyvalue.md)|List custom properties of the fileStorageContainer.| -|[Create fileStorageContainer custom property](../api/filestoragecontainer-post-customproperty.md)|[filestoragecontainercustompropertyvalue](../resources/filestoragecontainercustompropertyvalue.md)|Create custom property to the fileStorageContainer.| -|[Update fileStorageContainer custom property](../api/filestoragecontainer-update-customproperty.md)|[filestoragecontainercustompropertyvalue](../resources/filestoragecontainercustompropertyvalue.md)|Update custom property on a fileStorageContainer.| -|[Delete fileStorageContainer custom property](../api/filestoragecontainer-delete-customproperty.md)|[filestoragecontainercustompropertyvalue](../resources/filestoragecontainercustompropertyvalue.md)|Delete custom property from a fileStorageContainer.| +|[Delete permissions](../api/filestoragecontainer-delete-permissions.md)|None|Delete permission from a fileStorageContainer.| +|[List custom property](../api/filestoragecontainer-list-customproperty.md)|[filestoragecontainercustompropertyvalue](../resources/filestoragecontainercustompropertyvalue.md) collection|List custom properties of the fileStorageContainer.| +|[Create custom property](../api/filestoragecontainer-post-customproperty.md)|[filestoragecontainercustompropertyvalue](../resources/filestoragecontainercustompropertyvalue.md)|Create custom property to the fileStorageContainer.| +|[Update custom property](../api/filestoragecontainer-update-customproperty.md)|[filestoragecontainercustompropertyvalue](../resources/filestoragecontainercustompropertyvalue.md)|Update custom property on a fileStorageContainer.| +|[Delete custom property](../api/filestoragecontainer-delete-customproperty.md)|None|Delete a custom property from a fileStorageContainer.| +|[List columns](../api/filestoragecontainer-list-columns.md)|[columnDefinition](../resources/columndefinition.md) collection|List columns in a fileStorageContainer.| +|[Create column](../api/filestoragecontainer-post-columns.md)|[columnDefinition](../resources/columndefinition.md)|Create a columnDefinition for afileStorageContainer.| +|[Update column](../api/filestoragecontainer-update-column.md)|[columnDefinition](../resources/columndefinition.md)|Update a column in a fileStorageContainer.| +|[Delete 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.| +|[Restore recyclebin items](../api/filestoragecontainer-restore-recyclebin-items.md)|[recycleBinItem](../resources/recyclebinitem.md) collection|Restore recycle bin items in a fileStorageContainer.| +|[Delete recyclebin items](../api/filestoragecontainer-delete-recyclebin-items.md)|None|Delete recycle bin items from a fileStorageContainer.| +|[Get recyclebin items](../api/filestoragecontainer-list-recyclebin-items.md)|[recycleBinItem](../resources/recyclebinitem.md) collection|List recycle bin items in a fileStorageContainer.| ## Properties- |Property|Type|Description| |:|:|:|-|containerTypeId|Guid|Container type ID of the fileStorageContainer. Each container must have only one container type. Read-only.| -|createdDateTime|DateTimeOffset|Date and time of the fileStorageContainer creation. Read-only.| +|assignedSensitivityLabel|[assignedLabel](../resources/assignedlabel.md)|Sensitivity label assigned to the **fileStorageContainer**. Read-write.| +|containerTypeId|GUID|Container type ID of the **fileStorageContainer**. Each container must have only one container type. Read-only.| +|createdDateTime|DateTimeOffset|Date and time of the **fileStorageContainer** creation. Read-only.| |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.|-|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.| +|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.| +|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.| +|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.| ## Relationships- |Relationship|Type|Description| |:|:|:|-|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.| +|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.| +|recycleBin|[recycleBin](../resources/recyclebin.md)|Recycle bin of the **fileStorageContainer**. Read-only.| ### roles property values- |Value|Description| |:|:| |reader|Readers can read **fileStorageContainer** metadata and the content inside.| Represents a location where multiple users or a group of users can store files a |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.| + ## JSON representation The following JSON representation shows the resource type. <!-- { The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.fileStorageContainer",- "id": "String (identifier)", - "displayName": "String", - "description": "String", - "containerTypeId": "Guid", - "customProperties": { - "@odata.type": "microsoft.graph.fileStorageContainerCustomPropertyDictionary" - }, - "viewpoint": { - "@odata.type": "microsoft.graph.fileStorageContainerViewpoint" - }, - "status": "String", - "createdDateTime": "String (timestamp)" + "id": "string (identifier)", + "displayName": "string", + "description": "string", + "containerTypeId": "string", + "containerTypeDisplayName": "string", + "permissions": [ { "@odata.type": "microsoft.graph.permission" } ], + "customProperties": "Dictionary(Edm.String, microsoft.graph.fileStorageContainerCustomPropertyValue)", + "viewpoint": {"@odata.type": "microsoft.graph.fileStorageContainerViewpoint" }, + "drive": {"@odata.type": "microsoft.graph.drive"}, + "recycleBin": {"@odata.type": "microsoft.graph.recycleBin"}, + "status": {"@odata.type": "microsoft.graph.fileStorageContainerStatus"}, + "columns": [ {"@odata.type": "microsoft.graph.columnDefinition" } ], + "createdDateTime": {"@odata.type": "microsoft.graph.dateTimeOffset"}, + "storageUsedInBytes": "int64", + "assignedSensitivityLabel": {"@odata.type": "microsoft.graph.assignedLabel"}, + "owners": [ { "@odata.type": "microsoft.graph.userIdentity" } ], + "ownershipType": {"@odata.type": "microsoft.graph.fileStorageContainerOwnershipType"}, + "expiryDateTime": "string (timestamp)", + "itemMajorVersionLimit": "int64", + "isItemVersioningEnabled": "boolean", } ``` |
v1.0 | Filestoragecontainercustompropertydictionary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/filestoragecontainercustompropertydictionary.md | doc_type: resourcePageType Namespace: microsoft.graph -Represents a [dictionary](https://github.com/microsoft/api-guidelines/blob/vNext/graph/patterns/dictionary.md) that stores the custom properties of a [fileStorageContainer](../resources/filestoragecontainer.md) in key/value pairs. +Represents a [dictionary](https://github.com/microsoft/api-guidelines/blob/vNext/graph/patterns/dictionary.md) that stores the custom properties of a [fileStorageContainer](../resources/filestoragecontainer.md) in key-value pairs. Each custom property consists of keys (custom property names) and [fileStorageContainerCustomPropertyValue](../resources/filestoragecontainercustompropertyvalue.md) values (custom property values). None. None. ## JSON representation+ The following JSON representation shows the resource type. <!-- { |
v1.0 | Filestoragecontainercustompropertyvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/filestoragecontainercustompropertyvalue.md | Title: "fileStorageContainerCustomPropertyValue resource type" -description: "Contains the custom property values stored in a fileStorageContainerCustomPropertyDictionary". +description: "Contains the custom property values that are stored in a fileStorageContainerCustomPropertyDictionary resource." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Contains the custom property values stored in a [fileStorageContainerCustomPropertyDictionary](../resources/filestoragecontainercustompropertydictionary.md) resource. +Contains the custom property values that are stored in a [fileStorageContainerCustomPropertyDictionary](../resources/filestoragecontainercustompropertydictionary.md) resource. ## Properties |Property|Type|Description| |:|:|:| |isSearchable|Boolean|Indicates whether the custom property is searchable. Optional. The default value is `false`.|-|value|String|Value of the custom property. Required.| +|value|String|The value of the custom property. Required.| ## Relationships None. ## JSON representation-The following is a JSON representation of the resource type. ++The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Filestoragecontainerviewpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/filestoragecontainerviewpoint.md | Title: "fileStorageContainerViewpoint resource type" -description: "Represents data specific to the current user of a fileStorageContainer". +description: "Represents data for the current user of a fileStorageContainer." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents data specific to the current user of a [fileStorageContainer](../resources/filestoragecontainer.md). +Represents data for the current user of a [fileStorageContainer](../resources/filestoragecontainer.md). ## Properties+ |Property|Type|Description| |:|:|:| |effectiveRole|String|The current user's effective role. Read-only.| ## Relationships+ None. ## JSON representation+ The following JSON representation shows the resource type. + <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.fileStorageContainerViewpoint" |
v1.0 | Filterdatetime | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/filterdatetime.md | Title: "FilterDatetime resource type" + Title: "workbookFilterDatetime resource type" description: "Represents how to filter a date when filtering on values." ms.localizationpriority: medium doc_type: resourcePageType-# FilterDatetime resource type +# workbookFilterDatetime resource type Namespace: microsoft.graph Represents how to filter a date when filtering on values. ## Properties | Property | Type |Description| |:|:--|:-|-|date|string|The date in ISO8601 format used to filter data.| -|specificity|string|How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specificity is set to "month," the filter operation will keep all rows with a date in the month of April 2009. Possible values are: `Year`, `Monday`, `Day`, `Hour`, `Minute`, `Second`.| +|date|String|The date in ISO 8601 format used to filter data.| +|specificity|String|Defines how specific you should use the **date** to keep data. For example, if the date is `2005-04-02` and the **specificity** property is set to `month`, the filter operation keeps all rows with a date in the month of April 2009. The possible values are: `Year`, `Month`, `Day`, `Hour`, `Minute`, `Second`.| ## Relationships-None +None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. ```json {- "date": "string", - "specificity": "string" + "date": "String", + "specificity": "String" }- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 Here's a JSON representation of the resource. "suppressions": [] } -->-- |
v1.0 | Finding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/finding.md | description: "The output of the permissions usage data analysis performed by Per ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Folder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/folder.md | The **Folder** resource groups folder-related data on an item into a single stru ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Followupflag | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/followupflag.md | Allows setting a flag for the user to follow up on an item later. Supported item ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Formatprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/formatprotection.md | Title: "FormatProtection resource type" + Title: "workbookFormatProtection resource type" description: "Represents the format protection of a range object." ms.localizationpriority: medium doc_type: resourcePageType-# FormatProtection resource type +# workbookFormatProtection resource type Namespace: microsoft.graph Represents the format protection of a range object. | Method | Return Type |Description| |:|:--|:-|-|[Get FormatProtection](../api/formatprotection-get.md) | [FormatProtection](formatprotection.md) |Read properties and relationships of formatProtection object.| -|[Update](../api/formatprotection-update.md) | [FormatProtection](formatprotection.md) |Update FormatProtection object. | +|[Get FormatProtection](../api/formatprotection-get.md) | [workbookFormatProtection](formatprotection.md) |Read properties and relationships of formatProtection object.| +|[Update](../api/formatprotection-update.md) | [workbookFormatProtection](formatprotection.md) |Update FormatProtection object. | ## Properties | Property | Type |Description| None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Formssettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/formssettings.md | Company-wide settings for Microsoft Forms. 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.formsSettings" |
v1.0 | Gcpactionpermissionsdefinitionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpactionpermissionsdefinitionaction.md | description: "Represents actions for permissions in GCP." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcpassociatedidentities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpassociatedidentities.md | description: "A container for different kinds of GCP identities." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcpauthorizationsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpauthorizationsystem.md | description: "Represents a GCP authorization system onboarded to Permissions Man ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcpauthorizationsystemresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpauthorizationsystemresource.md | description: "Represents a GCP resource in an GCP authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcpauthorizationsystemtypeaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpauthorizationsystemtypeaction.md | description: "Represents an action in a GCP authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcpcloudfunction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpcloudfunction.md | description: "Represents a cloud function in a GCP authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcpgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpgroup.md | description: "Represents a group in a GCP authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcpidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpidentity.md | description: "Represents GCP identities." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcppermissionsdefinitionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcppermissionsdefinitionaction.md | description: "Represents permissions for GCP." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcprole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcprole.md | description: "Represents a GCP role in a GCP authorization system." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcprolepermissionsdefinitionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcprolepermissionsdefinitionaction.md | description: "Represents actions for permissions for under GCP role." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcpscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpscope.md | description: "Represents the service and resource type of a GCP resource" ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcpserviceaccount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpserviceaccount.md | description: "Represents GCP service accounts." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Gcpuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gcpuser.md | description: "Represents GCP users." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Genericerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/genericerror.md | A general-purpose error. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here is a JSON representation of the resource. ```json {+ "@odata.type": "#microsoft.graph.genericError", "message": "String", "code": "String" } |
v1.0 | Geocoordinates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/geocoordinates.md | If a [**driveItem**](driveitem.md) has a non-null **location** facet, the item r ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Governancepermission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governancepermission.md | Represents the access permission that a [governanceSubject](../resources/governa ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Governanceresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governanceresource.md | No `POST`, `PUT`, `PATCH`, `DELETE` are supported on `roleDefinitions` entity se ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Governanceroleassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governanceroleassignment.md | No `POST`, `PUT`, `PATCH`, or `DELETE` operations are supported on the `roleAssi ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { |
v1.0 | Governanceroleassignmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governanceroleassignmentrequest.md | Represents the request for role assignment operations in Privileged Identity Man ### JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Governanceroleassignmentrequeststatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governanceroleassignmentrequeststatus.md | Represents the status of the [governanceRoleAssignmentRequest](../resources/gove ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Governanceroledefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governanceroledefinition.md | Namespace: microsoft.graph [!INCLUDE [pim-v2ResourceRoles-deprecation](../../includes/pim-v2ResourceRoles-deprecation.md)] -Represents the role definitions. For Azure resources, it can represent Azure RBAC roles, such as Owner, Reader, Contributor, etc. +Represents the role definitions. For Azure resources, it can represent Azure RBAC roles, such as Owner, Reader, or Contributor. ## Methods Represents the role definitions. For Azure resources, it can represent Azure RBA | Method | Return Type |Description| |:|:--|:--| |[List](../api/governanceroledefinition-list.md) | [governanceRoleDefinition](../resources/governanceroledefinition.md) collection |List a collection of role definitions on a resource.|-|[Get](../api/governanceroledefinition-get.md) | [governanceRoleDefinition](../resources/governanceroledefinition.md) |Read properties and relationships of a role definition entity specified by id.| +|[Get](../api/governanceroledefinition-get.md) | [governanceRoleDefinition](../resources/governanceroledefinition.md) |Read properties and relationships of a role definition entity specified by ID.| No `POST`, `PUT`, `PATCH`, `DELETE` is supported on `roleDefinitions` entity set for now. ## Properties | Property | Type | Description | |:|:-|:-|-| id | String | The id of the role definition. | -| resourceId | String | Required. The id of the resource associated with the role definition. | -| externalId | String | The external id of the role definition. | +| id | String | The ID of the role definition. | +| resourceId | String | Required. The ID of the resource associated with the role definition. | +| externalId | String | The external ID of the role definition. | | displayName | String | The display name of the role definition. |-| templateId | String | | +| templateId | String | The unique identifier for the template. | ## Relationships | Relationship | Type |Description| No `POST`, `PUT`, `PATCH`, `DELETE` is supported on `roleDefinitions` entity set ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Governancerolesetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governancerolesetting.md | Represents a set of configurations on each role definition that needs to be eval ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Governancerulesetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governancerulesetting.md | Represents the rules that the role settings are composed of. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Governanceschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governanceschedule.md | Represents the schedule for a [governanceRoleAssignmentRequest](../resources/gov ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Governancesubject | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governancesubject.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Group | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/group.md | This resource supports: | Property | Type | Description | |--|--||+| 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`. | | assignedLicenses | [assignedLicense](assignedlicense.md) collection | The licenses that are assigned to the group. <br><br>Returned only on `$select`. Supports `$filter` (`eq`). Read-only. | This resource supports: | hideFromOutlookClients | Boolean | `true` if the group isn't displayed in Outlook clients, such as Outlook for Windows and Outlook on the web, false otherwise. The default value is `false`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). | | id | String | The unique identifier for the group. <br><br>Returned by default. Inherited from [directoryObject](directoryobject.md). Key. Not nullable. Read-only. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `in`). | | isArchived | Boolean | When a group is associated with a team, this property determines whether the team is in read-only mode. <br/>To read this property, use the `/group/{groupId}/team` endpoint or the [Get team](../api/team-get.md) API. To update this property, use the [archiveTeam](../api/team-archive.md) and [unarchiveTeam](../api/team-unarchive.md) APIs. |-| isAssignableToRole | Boolean | Indicates whether this group can be assigned to a Microsoft Entra role. Optional. <br><br>This property can only be set while creating the group and is immutable. If set to `true`, the **securityEnabled** property must also be set to `true`, **visibility** must be `Hidden`, and the group cannot be a dynamic group (that is, **groupTypes** can't contain `DynamicMembership`). <br/><br/>Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the _RoleManagement.ReadWrite.Directory_ permission to set this property or update the membership of such groups. For more, see [Using a group to manage Microsoft Entra role assignments](https://go.microsoft.com/fwlink/?linkid=2103037)<br><br>Using this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports `$filter` (`eq`, `ne`, `not`). | +| isAssignableToRole | Boolean | Indicates whether this group can be assigned to a Microsoft Entra role. Optional. <br><br>This property can only be set while creating the group and is immutable. If set to `true`, the **securityEnabled** property must also be set to `true`, **visibility** must be `Hidden`, and the group cannot be a dynamic group (that is, **groupTypes** can't contain `DynamicMembership`). <br/><br/>Only callers with at least the Privileged Role Administrator role can set this property. The caller must also be assigned the _RoleManagement.ReadWrite.Directory_ permission to set this property or update the membership of such groups. For more, see [Using a group to manage Microsoft Entra role assignments](https://go.microsoft.com/fwlink/?linkid=2103037)<br><br>Using this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports `$filter` (`eq`, `ne`, `not`). | +| isFavorite | Boolean | Indicates whether the user marked the group as favorite. | | isManagementRestricted | Boolean | Indicates whether the group is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. The default value is `false`. Read-only. <br/><br/> To manage a group member of a restricted administrative unit, the calling app must be assigned the *Directory.Write.Restricted* permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope. | | infoCatalogs | String collection | Identifies the info segments assigned to the group. Returned by default. Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`). | | isSubscribedByMail | Boolean | Indicates whether the signed-in user is subscribed to receive email conversations. The default value is `true`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). | This resource supports: | onPremisesSamAccountName | String | Contains the on-premises **SAM account name** 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.<br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`). Read-only. | | onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. <br><br>Returned by default. Supports `$filter` (`eq` including on `null` values). Read-only. | | onPremisesSyncEnabled | Boolean | `true` if this group is synced from an on-premises directory; `false` if this group was originally synced from an on-premises directory but is no longer synced; **null** if this object has never been synced from an on-premises directory (default). <br><br>Returned by default. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). |-| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling app must be granted the *Directory.ReadWrite.All* permission and the user be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): <br><ul><li> Global Administrator <li> User Account Administrator <li>Directory Writer <li> Exchange Administrator <li> SharePoint Administrator </ul><br/> For more information about this property, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction) and [Create a Microsoft 365 group with a specific PDL](/office365/enterprise/multi-geo-add-group-with-pdl). <br><br>Nullable. Returned by default. | +| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling app must be granted the *Directory.ReadWrite.All* permission and the user be assigned at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): <br><ul><li> User Account Administrator <li>Directory Writer <li> Exchange Administrator <li> SharePoint Administrator </ul><br/> For more information about this property, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction) and [Create a Microsoft 365 group with a specific PDL](/office365/enterprise/multi-geo-add-group-with-pdl). <br><br>Nullable. Returned by default. | | preferredLanguage | String | The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, `en-US`. <br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). | | proxyAddresses | String collection | Email addresses for the group that direct to the same group mailbox. For example: `["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]`. The **any** operator is required for filter expressions on multi-valued properties. <br><br>Returned by default. Read-only. Not nullable. Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`, `endsWith`, `/$count eq 0`, `/$count ne 0`). | | renewedDateTime | DateTimeOffset | Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the [renew service action](../api/grouplifecyclepolicy-renewgroup.md). 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. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`). Read-only. | The following JSON representation shows the resource type. "id": "String (identifier)", "isFavorite": true, "isArchived": false,- "isAssignableRole": false, + "isAssignableToRole": false, "isSubscribedByMail": true, "licenseProcessingState": "String", "mail": "String", |
v1.0 | Groupclaimfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/groupclaimfilter.md | + + Title: "groupClaimFilter resource type" +description: "Applies filters to the group of the user to be included in the group claim." ++ms.localizationpriority: medium ++++# groupClaimFilter resource type ++Namespace: microsoft.graph +++Applies filters to the group of the user to be included in the group claim. It can be a useful means of reducing the token size. ++Inherits from [groupClaimFilterBase](../resources/groupclaimfilterbase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|matchOn|matchOn|Identifies the group attribute on which the filter would be applied. The possible values are: `displayName`, `samAccountName`, `unknownFutureValue`.| +|type|filterType|Selects the type of filter you wish to apply to the attribute selected by the matchOn property. The possible values are: `prefix`, `suffix`, `contains`, `unknownFutureValue`.| +|value|String|The value of the filter to be applied.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.groupClaimFilter" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.groupClaimFilter", + "type": "String", + "matchOn": "String", + "value": "String" +} +``` |
v1.0 | Groupclaimfilterbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/groupclaimfilterbase.md | + + Title: "groupClaimFilterBase resource type" +description: "This is an abstract type for base group filter." ++ms.localizationpriority: medium ++++# groupClaimFilterBase resource type ++Namespace: microsoft.graph +++This is an abstract type for base group filter. ++## Properties +None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.groupClaimFilterBase" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.groupClaimFilterBase" +} +``` |
v1.0 | Grouplifecyclepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/grouplifecyclepolicy.md | None. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Groupwritebackconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/groupwritebackconfiguration.md | Inherits from [writebackConfiguration](../resources/writebackconfiguration.md). 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.groupWritebackConfiguration" |
v1.0 | Gsuitesource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/gsuitesource.md | description: "Represents an authorization system identity sourced from Google Wo ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Hardwareoathauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/hardwareoathauthenticationmethodconfiguration.md | Inherits from [authenticationMethodConfiguration](../resources/authenticationmet |includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method. Expanded by default.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Hashes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/hashes.md | Groups available hashes into a single structure for an item. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Homerealmdiscoverypolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/homerealmdiscoverypolicy.md | The properties below form the JSON object that represents a token lifetime polic ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Horizontalsectioncolumn | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/horizontalsectioncolumn.md | Inherits from [entity](../resources/entity.md). |webparts|[webPart](../resources/webpart.md) collection|The collection of WebParts in this column.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Hostsecuritystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/hostsecuritystate.md | Contains stateful information about the host (including devices, computers, and ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Hybridagentupdaterconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/hybridagentupdaterconfiguration.md | The update of the agent follows the below priority list |:-|:|:| |allowUpdateConfigurationOverride|Boolean|Indicates if updater configuration will be skipped and the agent will receive an update when the next version of the agent is available.| |deferUpdateDateTime|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`|-|updateWindow|[updateWindow](updatewindow.md)|| +|updateWindow|[updateWindow](updatewindow.md)|The time window during which the agent can receive updates.| ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Identity Network Access Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identity-network-access-overview.md | + + Title: "Manage Microsoft Entra identity and network access by using Microsoft Graph" +description: "Microsoft Graph provides REST APIs to help manage identity and network access capabilities, most of which are available through Microsoft Entra." +ms.localizationpriority: high ++++ Last updated : 04/30/2024+++# Manage Microsoft Entra identity and network access by using Microsoft Graph +++With Microsoft Graph, you can manage identity and network access capabilities, most of which are available through [Microsoft Entra](/entra/fundamentals/whatis). The APIs in Microsoft Graph help you to automate identity and network access management tasks and integrate with any application, and are the programmatic alternative to the administrator portals such as the Microsoft Entra admin center. ++Microsoft Entra is a family of identity and network access capabilities that are available in the following products. All these capabilities are available through Microsoft Graph APIs: +- Microsoft Entra ID that groups identity and access management (IAM) capabilities. +- Microsoft Entra ID Governance +- Microsoft Entra External ID +- Microsoft Entra Verified ID +- Microsoft Entra Permissions Management +- Microsoft Entra Internet Access and Network Access ++## Manage user identities ++Users are the main identities in any identity and access solution. You can manage the entire lifecycle of users in your organization, and their entitlements like licenses or group memberships, using Microsoft Graph APIs. For more information, see [Working with users in Microsoft Graph](/graph/api/resources/users). ++## Manage groups ++Groups are the containers that allow you to efficiently manage the entitlements for identities as a unit. For example, through a group, you can grant users access to a resource, such as a SharePoint site. Or you can grant them licenses to use a service. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview). ++## Manage applications ++You can use Microsoft Graph APIs to register and manage your applications programmatically, enabling you to use Microsoft's IAM capabilities. For more information, see [Manage Microsoft Entra applications and service principals by using Microsoft Graph](/graph/api/resources/applications-api-overview). ++++## Tenant administration or directory management ++A core functionality of identity and access management is managing your tenant configuration, administrative roles, and settings. Microsoft Graph provides APIs to manage your Microsoft Entra tenant for the following scenarios: ++| Use cases | API operations | +|--|--| +| Manage administrative units including the following operations: <li>Create administrative units <li> Create and manage members and membership rules of administrative units <li> Assign administrator roles that are scoped to administrative units | [administrativeUnit resource type](administrativeunit.md) and its associated APIs | +| Retrieve BitLocker recovery keys | [bitlockerRecoveryKey resource type](bitlockerrecoverykey.md) and its associated APIs | +| Monitor licenses and subscriptions for the tenant | <li> [companySubscription resource type](companysubscription.md) and its associated APIs <li> [subscribedSku resource type](subscribedsku.md) and its associated APIs | +| Manage custom security attributes | See [Overview of custom security attributes using the Microsoft Graph API](custom-security-attributes-overview.md) | +| Manage deleted directory objects. The functionality to store deleted objects in a "recycle bin" is supported for the following objects: <li> Administrative units <li> Applications <li> External user profiles <li> Groups <li> Pending external user profiles <li> Service principals <li> Users | <li> [Get](../api/directory-deleteditems-get.md) or [List](../api/directory-deleteditems-list.md) deleted objects <li> [Permanently delete](../api/directory-deleteditems-delete.md) a deleted object <li> [Restore a deleted item](../api/directory-deleteditems-restore.md) <li> [List deleted items owned by user](../api/directory-deleteditems-getuserownedobjects.md) | +| Manage devices in the cloud | [device resource type](device.md) and its associated APIs | +| View local administrator credential information for all device objects in Microsoft Entra ID that are enabled with Local Admin Password Solution (LAPS). This feature is the cloud-based LAPS solution | [deviceLocalCredentialInfo resource type](devicelocalcredentialinfo.md) and its associated APIs | +| Directory objects are the core objects in Microsoft Entra ID, such as users, groups, and applications. You can use the directoryObject resource type and its associated APIs to check memberships of directory objects, track changes for multiple directory objects, or validate that a Microsoft 365 group's display name or mail nickname complies with naming policies | [directoryObject resource type](directoryobject.md) and its associated APIs | +| Administrator roles, including Microsoft Entra administrator roles, are one of the most sensitive resources in a tenant. You can manage the lifecycle of their assignment in the tenant, including creating custom roles, assigning roles, tracking changes to role assignments, and removing assignees from roles | [directoryRole resource type](directoryrole.md) and [directoryRoleTemplate resource type](directoryroletemplate.md)and their associated APIs <br/><br/> [roleManagement resource type](rolemanagement.md) and its associated APIs <br/><br/> These APIs allow you to make direct role assignments. Alternatively, you can use Privileged Identity Management APIs for [Microsoft Entra roles](privilegedidentitymanagementv3-overview.md) and [groups](privilegedidentitymanagement-for-groups-api-overview.md) to make just-in-time and time-bound role assignments, instead of direct forever active assignments. | +| Define the following configurations that can be used to customize the tenant-wide and object-specific restrictions and allowed behavior. <li> Settings for Microsoft 365 groups such as guest user access, classifications, and naming policies <li> Password rule settings such as banned password lists and lockout duration <li> Prohibited names for applications, reserved words, and blocking trademark violations <li> Custom conditional access policy URL <li> Consent policies such as user consent requests, group-specific consent, and consent for risky apps | [directorySetting resource type](directorysetting.md) and [directorySettingTemplate resource type](directorysettingtemplate.md) and their associated APIs <br/><br/> For more information, see [Overview of group settings](/graph/group-directory-settings). | +| Domain management operations such as: <li> associating a domain with your tenant <li> retrieving DNS records <li> verifying domain ownership <li> associating specific services with specific domains <li> deleting domains | [domain resource type](domain.md) and its associated APIs | +| Manage the profile objects for external users that you're invited to collaborate via Teams. These APIs aren't similar to the invitation APIs for Microsoft Entra External ID B2B collaboration | [externalUserProfile resource type](externaluserprofile.md) and [pendingExternalUserProfile resource type](externaluserprofile.md) and their associated APIs | +| Configure and manage staged rollout of specific Microsoft Entra ID features | [featureRolloutPolicy resource type](featurerolloutpolicy.md) and its associated APIs | +| Manage the policies for Mobile Device Management (MDM) and Mobile Application Management (MAM) autoenrollment for Microsoft Entra joined and registered devices | [mobilityManagementPolicy resource type](mobilitymanagementpolicy.md) and its associated APIs | +| Configure options that are available in Microsoft Entra Cloud Sync such as preventing accidental deletions and managing group writebacks. | [onPremisesDirectorySynchronization resource type](onpremisesdirectorysynchronization.md) and its associated APIs | +| Manage the base settings for your Microsoft Entra tenant | [organization resource type](organization.md) and its associated APIs | +| Manage the tenant-wide settings for your Microsoft Entra tenant, such as whether people and item insights are enabled for the organization | [organizationSettings resource type](organizationsettings.md) and its associated APIs | +| Retrieve the organizational contacts that might be synchronized from on-premises directories or from Exchange Online | [orgContact resource type](orgcontact.md) and its associated APIs | +| Discover the basic details of other Microsoft Entra tenants by querying using the tenant ID or the domain name | [tenantInformation resource type](tenantinformation.md) and its associated APIs | +| Configure trusted certificate authorities for certificates that can be assigned to apps and service principals in the tenant. | [certificateBasedApplicationConfiguration resource type](certificatebasedapplicationconfiguration.md) and its associated APIs | +| Manage the delegated permissions and their assignments to service principals in the tenant | [oAuth2PermissionGrant resource type](oauth2permissiongrant.md) and its associated APIs | ++++## Identity and sign-in ++| Use cases | API operations | +|--|--| +| Configure listeners that monitor events that should trigger or invoke custom logic, typically defined outside Microsoft Entra ID | [authenticationEventListener resource type](authenticationeventlistener.md) and its associated APIs | +| Manage authentication methods that are supported in Microsoft Entra ID | See [Microsoft Entra authentication methods API overview](authenticationmethods-overview.md) and [Microsoft Entra authentication methods policies API overview](authenticationmethodspolicies-overview.md) | +| Manage the authentication methods or combinations of authentication methods that you can apply as grant control in Microsoft Entra Conditional Access | See [Microsoft Entra authentication strengths API overview](authenticationstrengths-overview.md) | +|Manage tenant-wide authorization policies such as: <li> enable SSPR for administrator accounts <li>enable self-service join for guests <li> limit who can invite guests <li> whether users can consent to risky apps <li> block the use of MSOL <li> customize the default user permissions <li> identity private preview features enabled <li>Customize the guest user permissions between *User*, *Guest User*, and *Restricted Guest User*| [authorizationPolicy resource type](authorizationpolicy.md) and its associated APIs| +|Configure Continuous Access Evaluation (CAE), which allows access tokens to be revoked based on critical events and policy evaluation rather than relying on token expiry based on lifetime| [continuousAccessEvaluationPolicy resource type](continuousaccessevaluationpolicy.md) and its associated APIs| +| Manage the policies for certificate-based authentication in the tenant | [certificateBasedAuthConfiguration resource type](certificatebasedauthconfiguration.md) and its associated APIs | +| Manage Microsoft Entra conditional access policies | [conditionalAccessRoot resource type](conditionalaccessroot.md) and its associated APIs | +| Manage cross-tenant access settings and manage outbound restrictions, inbound restrictions, tenant restrictions, and cross-tenant synchronization of users in multitenant organizations | See [Cross-tenant access settings API overview](crosstenantaccesspolicy-overview.md) | +| Manage the user profiles that are shared with you or external tenants using B2B direct connect, including removing and exporting personal data | [inboundSharedUserProfile resource type](inboundshareduserprofile.md) and [outboundSharedUserProfile resource type](outboundshareduserprofile.md) and their associated APIs | +| Configure how and which external systems interact with Microsoft Entra ID during a user authentication session | [customAuthenticationExtension resource type](customauthenticationextension.md) and its associated APIs | +| Manage requests against user data in the organization, such as exporting personal data | [dataPolicyOperation resource type](datapolicyoperation.md) and its associated APIs | +|Configure the policies for managing Microsoft Entra join and Microsoft Entra register devices|[deviceRegistrationPolicy resource type](deviceregistrationpolicy.md) and its associated APIs| +| Manage the tenant-wide policy that controls whether external users can leave a Microsoft Entra tenant via self-service controls, for example, through the **organizations** menu of the **My Account** portal | [externalIdentitiesPolicy resource type](externalidentitiespolicy.md) and its associated APIs | +|Force autoacceleration sign-in to skip the username entry screen and automatically forward users to federated sign-in endpoints |[homeRealmDiscoveryPolicy resource type](homerealmdiscoverypolicy.md) resource type and its associated APIs| +| Detect, investigate, and remediate identity-based risks using Microsoft Entra ID Protection and feed the data into security information and event management (SIEM) tools for further investigation and correlation | See [Use the Microsoft Graph identity protection APIs](identityprotection-overview.md) | +| Manage identity providers for Microsoft Entra ID, Microsoft Entra External ID, and Azure AD B2C tenants. You can perform the following operations: <li> Manage identity providers for external identities, including social identity providers, OIDC, Apple, SAML/WS-Fed, and built-in providers <li> Manage configuration for federated domains and token validation | [identityProviderBase resource type](identityproviderbase.md) and its associated APIs | +| Invite external users to collaborate with your tenant by using Microsoft Entra External ID | [invitation resource type](invitation.md) and its associated APIs | +| Define a group of tenants belonging to your organization and streamline intra-organization cross-tenant collaboration | See [Multitenant organization API overview](multitenantorganization-overview.md) | +| Customize sign-in UIs to match your company branding, including applying branding that's based on the browser language | [organizationalBranding resource type](organizationalbranding.md) and its associated APIs | +| Customize the UI/UX in Azure AD B2C using the Identity Experience Framework (IEF) | [trustFrameworkKeySet resource type](trustframeworkkeyset.md) and [trustFrameworkPolicy resource type](trustframeworkpolicy.md) and their associated APIs | +| User flows for Microsoft Entra External ID for workforce | The following resource types and their associated APIs: <li>[b2xIdentityUserFlow](b2xidentityuserflow.md) to configure the base user flow and its properties such as identity providers <li> [identityUserFlowAttribute](identityuserflowattribute.md) to manage built-in and custom user flow attributes <li> [identityUserFlowAttributeAssignment](identityuserflowattributeassignment.md) to manage user flow attribute assignments <li> [userFlowLanguageConfiguration resource type](userflowlanguageconfiguration.md) to configure custom languages for user flows | +| User flows for Azure AD B2C | The following resource types and their associated APIs: <li>[b2cIdentityUserFlow ](b2cidentityuserflow.md) to configure the base user flow and its properties such as identity providers <li> [identityUserFlowAttribute](identityuserflowattribute.md) to manage built-in and custom user flow attributes <li> [identityUserFlowAttributeAssignment](identityuserflowattributeassignment.md) to manage user flow attribute assignments <li> [userFlowLanguageConfiguration resource type](userflowlanguageconfiguration.md) to configure custom languages for user flows | +| User flows for Microsoft Entra External ID for external tenants | [authenticationEventsFlow resource type](authenticationeventsflow.md) and its associated APIs | +|Manage app consent policies and condition sets|[permissionGrantPolicy resource type](permissiongrantpolicy.md)| +|Manage app consent preapproval policies|[permissionGrantPreApprovalPolicy resource type](permissiongrantpreapprovalpolicy.md)| +|Enable or disable security defaults in Microsoft Entra ID|[identitySecurityDefaultsEnforcementPolicy resource type](identitysecuritydefaultsenforcementpolicy.md)| ++++## Identity governance ++For more information, see [Overview of Microsoft Entra ID Governance using Microsoft Graph](identitygovernance-overview.md). ++## Microsoft Entra External ID for external tenants ++The following API use cases ar supported to customize how users interact with your customer-facing applications. For administrators, most of the features available in Microsoft Entra ID and also supported for Microsoft Entra External ID for external tenants. For example, domain management, application management, and conditional access. ++| Use cases | API operations | +|--|--| +| User flows for Microsoft Entra External ID for external tenants and self-service sign-up experiences | [authenticationEventsFlow resource type](authenticationeventsflow.md) and its associated APIs | +| Manage identity providers for Microsoft Entra External ID. You can identify the identity providers that are supported or configured in the tenant | See [identityProviderBase resoruce type](identityproviderbase.md) and its associated APIs | +| Customize sign-in UIs to match your company branding, including applying branding that's based on the browser language | [organizationalBranding resource type](organizationalbranding.md) and its associated APIs | +| Manage identity providers for Microsoft Entra External ID, such as social identities | [identityProviderBase resoruce type](identityproviderbase.md) and its associated APIs | +| Manage user profiles in Microsoft Entra External ID for customers | For more information, see [Default user permissions in customer tenants](/graph/api/resources/users#default-user-permissions-in-customer-tenants) | +| Add your own business logic to the authentication experiences by integrating with systems that are external to Microsoft Entra ID| [authenticationEventListener resource type](authenticationeventlistener.md) and [customAuthenticationExtension resource type](customauthenticationextension.md) and their associated APIs | ++## Multicloud permissions management ++For more information, see [Discover, remediate, and monitor permissions in multicloud infrastructures using permissions management APIs](permissions-management-api-overview.md). ++## Network access management ++For more information, see [Secure access to cloud, public, and private apps using Microsoft Graph network access APIs](networkaccess-global-secure-access-api-overview.md). ++## Partner tenant management +Microsoft Graph also provides the following identity and access capabilities for Microsoft partners in the Cloud Solution Provider (CSP), Value Added Reseller (VAR), or Advisor programs to help manage their customer tenants. ++| Use cases | API operations | +|--|| +| Manage contracts for the partner with its customers | [contract resource type](contract.md) and its associated APIs | +| Microsoft partners can empower their customers to ensure the partners have least privileged access to their customers' tenants. This feature gives extra control to customers over their security posture while allowing them to receive support from the Microsoft resellers | See [Granular delegated admin privileges (GDAP) API overview](delegatedadminrelationships-api-overview.md) | +| Get detections and security alerts for unauthorized party abuse, account takeovers, and anomalous usage of Azure subscriptions in the customer tenants that you're responsible for. | See [Use the partner security alert API in Microsoft Graph](identity-network-access-overview.md) | ++++## Licensing ++Microsoft Entra licenses include Microsoft Entra ID Free, P1, P2, and Governance; Microsoft Entra Permissions Management; and Microsoft Entra Workload ID. ++For detailed information about licensing for different features, see [Microsoft Entra ID licensing](/entra/fundamentals/licensing). ++## Related content ++- [Implement identity standards with Microsoft Entra ID](/entra/standards/) +- [Microsoft Entra ID Guide for independent software developers](/entra/architecture/guide-for-independent-software-developers) |
v1.0 | Identitybuiltinuserflowattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitybuiltinuserflowattribute.md | Title: "identityBuiltInUserFlowAttribute resource type" -description: "Represents a built-in user flow attribute in Microsoft Entra ID for workforce tenants, Microsoft Entra ID for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows." +description: "Represents a built-in user flow attribute that can be used in self-service sign-up user flows in Microsoft Entra External ID in workforce and external tenants, and in Azure AD B2C tenants." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a built-in user flow attribute in Microsoft Entra ID for workforce tenants, Microsoft Entra ID for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows. These attributes can't be modified and are read-only. +Represents a built-in user flow attribute that can be used in self-service sign-up user flows in Microsoft Entra External ID in workforce and external tenants, and in Azure AD B2C tenants. These attributes can't be modified and are read-only. Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute |Property|Type|Description| |:|:|:|-|id|String|The identifier of the user flow attribute and is a read-only attribute that is automatically created. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| -|displayName|String|The display name of the user flow attribute. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.| -|description|String|The description of the user flow attribute that's shown to the user at the time of sign-up. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.| -|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute and is a read-only attribute that is automatically set. The value for this property will be `builtIn`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.| |dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute and can't be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.|+|displayName|String|The display name of the user flow attribute. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.| +|description|String|The description of the user flow attribute that's shown to the user at the time of sign up. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.| +|id|String|The identifier of the user flow attribute. Read-only. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| +|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute and is a read-only attribute that is automatically set. The value for this property is `builtIn`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.| ## Relationships None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Identitycontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitycontainer.md | None. | Relationship | Type | Description | |:-|:|:| |apiConnectors|[identityApiConnector](identityApiConnector.md) collection|Represents entry point for API connectors.|-|authenticationEventsFlows|[authenticationEventsFlow](../resources/authenticationeventsflow.md) collection|Represents the entry point for self-service sign up and sign in user flows in both Microsoft Entra workforce and customer tenants.| +|authenticationEventsFlows|[authenticationEventsFlow](../resources/authenticationeventsflow.md) collection|Represents the entry point for self-service sign-up and sign-in user flows in both Microsoft Entra workforce and external tenants.| |authenticationEventListener|[authenticationEventListener](authenticationeventlistener.md) collection| Represents listeners for custom authentication extension events in Microsoft Entra ID for workforce and customers.| |b2cUserFlows|[b2cIdentityUserFlow](b2cIdentityUserFlow.md) collection|Represents entry point for B2C identity userflows.| |b2xUserFlows|[b2xIdentityUserFlow](b2xIdentityUserFlow.md) collection| Represents entry point for B2X and self-service sign-up identity userflows.| |
v1.0 | Identitycustomuserflowattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitycustomuserflowattribute.md | Title: "identityCustomUserFlowAttribute resource type" -description: "Represents a custom user flow attribute in Microsoft Entra ID for workforce tenants, Microsoft Entra ID for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows." +description: "Represents a custom user flow attribute that can be used in self-service sign-up user flows in Microsoft Entra External ID in workforce and external tenants, and in Azure AD B2C tenants." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a custom user flow attribute in Microsoft Entra ID for workforce tenants, Microsoft Entra ID for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows. +Represents a custom user flow attribute that can be used in self-service sign-up user flows in Microsoft Entra External ID in workforce and external tenants, and in Azure AD B2C tenants. Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute |Property|Type|Description| |:|:|:|-|id|String|The identifier of the user flow attribute. This is a read-only attribute that is automatically created. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| -|displayName|String|The display name of the user flow attribute. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| -|description|String|The description of the user flow attribute that's shown to the user at the time of sign-up. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| -|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute and is a read-only attribute that is automatically set. The value for this property will be `custom`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).| |dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute and can't be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).|+|displayName|String|The display name of the user flow attribute. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| +|description|String|The description of the user flow attribute that's shown to the user at the time of sign up. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| +|id|String|The identifier of the user flow attribute. Read-only. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| +|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute and is a read-only attribute that is automatically set. The value for this attribute is `custom`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).| ## Relationships None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Identitydetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitydetails.md | description: "Represents the details for identity findings." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Identityfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identityfinding.md | description: "Represents a finding related to an identity such as a user, role, ms.localizationpriority: medium+ doc_type: resourcePageType |
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." ++ms.localizationpriority: medium ++++# attributeChangeTrigger resource type ++Namespace: microsoft.graph.identityGovernance +++An abstract type representing 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/beta/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/beta/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| +|:|:|:| +|[topWorkflowsProcessedSummary](../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.| +|[topTasksProcessedSummary](../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.| +|[workflowsProcessedSummary](../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.| +|[workflowsProcessedByCategory](../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 Lifecycleworkflows Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-lifecycleworkflows-overview.md | Title: "Overview of Lifecycle Workflows APIs" description: "Use Lifecycle Workflows to manage the lifecycle of users in your organization." ms.localizationpriority: medium + doc_type: conceptualPageType Last updated 03/12/2024 Last updated 03/12/2024 Lifecycle Workflows is an Identity Governance service in Microsoft Entra ID that enables organizations to automate basic lifecycle processes for their users at three levels: -1. **Joiner**: When an individual comes into scope of needing access; for example, a new employee joining a company or organization. +1. **Joiner**: When an individual comes into the scope of needing access; for example, a new employee joining a company or organization. 2. **Mover**: When an individual moves between boundaries within an organization; for example, a user who was in marketing is now a member of the sales organization. This movement might require more access or authorization, or revocation of other privileges.-3. **Leaver**: When an individual leaves the scope of needing access, access might need to be revoked, and the user deprovisioned. For example, an employee who is retiring or has been terminated. +3. **Leaver**: When an individual leaves the scope of needing access, access might need to be revoked, and the user deprovisioned. For example, an employee who is retiring or terminated. -For this reason, Lifecycle Workflows can be referred to as the **Joiner-Mover-Leaver** (JML) workflow. Only the *joiner* and *leaver* processes are currently implemented. +For this reason, lifecycle workflows can be referred to as the **Joiner-Mover-Leaver** (JML) workflow. -The lifecycle workflows APIs in Microsoft Graph allow you to automate the Lifecycle Workflows capabilities for your organization. This article introduced the set of APIs that enable the Lifecycle Workflows service in Microsoft Entra ID. +The lifecycle workflow APIs in Microsoft Graph allow you to automate the Lifecycle workflow capabilities for your organization. This article introduced the set of APIs that enable the Lifecycle Workflows service in Microsoft Entra ID. The lifecycle workflows APIs are defined in the OData subnamespace, microsoft.graph.identityGovernance. When creating or updating a workflow, use the [workflowExecutionConditions resou ### Create and manage workflows -After identifying the tasks and execution conditions that you want to define for your workflow, use the [workflow resource type](identitygovernance-workflow.md), and its associated methods to create and manage the workflow. You can create up to 50 workflows in a tenant. The category of the task must match the category of the workflow. Each workflow can have up to 25 tasks. Therefore: +After identifying the tasks and execution conditions that you want to define for your workflow, use the [workflow resource type](identitygovernance-workflow.md), and its associated methods to create and manage the workflow. You can create up to 100 workflows in a tenant. The category of the task must match the category of the workflow. Each workflow can have up to 25 tasks. Therefore: -+ A task supported for only the "leaver" workflow category can't be specified in a "joiner" workflow scenario, and vice versa. -+ A task supported for both "leaver" and "joiner" workflow categories can be specified in either a "joiner" or "leaver" workflow scenario. ++ A task supported for only the "leaver" workflow category can't be specified in a "joiner" or "mover" workflow scenario, and vice versa.++ A task supported for "joiner", "mover", and "leaver" workflow categories can be specified in either a "joiner", "mover" or "leaver" workflow scenario.++You can schedule a workflow to run based on the [tenant-wide schedule](#settings) or run it on-demand. The tenant schedule can take care of scheduled new hires and terminations, while you can run a workflow on-demand immediately to terminate an employee's access if there is a sensitive event. -You can schedule a workflow to run based on the [tenant-wide schedule](#settings) or run it on-demand. The tenant schedule can take care of regular new hires and terminations, while you can run a workflow on-demand to immediately terminate an employee's access if there was a sensitive event. ### Workflow versions While a workflow is in use, you might need to update execution conditions and tasks for a workflow. However, Lifecycle Workflows doesn't allow you to update these properties for an existing workflow. -Instead of creating new workflows, use the [workflowVersion resource type](identitygovernance-workflowversion.md) and its associated methods to create and manage a new workflow version, based off an existing workflow object. The workflow version can have similar or a different set of tasks and execution conditions. +Instead of creating new workflows, use the [workflowVersion resource type](identitygovernance-workflowversion.md) and its associated methods to create and manage a new workflow version, based on an existing workflow object. The workflow version can have a similar or a different set of tasks and execution conditions. ## Reports |
v1.0 | Identitygovernance Lifecycleworkflows Reporting Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-lifecycleworkflows-reporting-overview.md | Lifecycle Workflows offers reports that enable organizations to gain insight int [!INCLUDE [GDPR-related-guidance](../../includes/gdpr-msgraph-export-note.md)] -The lifecycle workflows API is defined in the OData subnamespace, microsoft.graph.identityGovernance. +The lifecycle workflows API is defined in the OData subnamespace, microsoft.graph.identityGovernance. ## Key elements of Lifecycle Workflows reports |
v1.0 | Identitygovernance Lifecycleworkflowscontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/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/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." ++ms.localizationpriority: medium ++++# membershipChangeTrigger resource type ++Namespace: microsoft.graph.identityGovernance +++An abstract type representing 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 Rulebasedsubjectset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-rulebasedsubjectset.md | Lifecycle Workflows supports the following user properties for configuring the r | city | String | :heavy_check_mark: | :heavy_check_mark: | | companyName | String | :heavy_check_mark: | :heavy_check_mark: | | country | String | :heavy_check_mark: | :heavy_check_mark: |+| customSecurityAttributes | String | :heavy_check_mark: | :heavy_check_mark: | | department | String | :heavy_check_mark: | :heavy_check_mark: | | displayName | String | :heavy_check_mark: | :heavy_check_mark: | | employeeId | String | :heavy_check_mark: | | Lifecycle Workflows supports the following user properties for configuring the r | userPrincipalName | String | :heavy_check_mark: | :heavy_check_mark: | | userType | String | :heavy_check_mark: | | -You can also configure rules using [Directory (Microsoft Entra ID) extensions](/graph/extensibility-overview#directory-azure-ad-extensions). It is not supported to configure rules with schema extensions, open extensions or [custom security attributes](/graph/api/resources/custom-security-attributes-overview). +You can also configure rules using [Directory (Microsoft Entra ID) extensions](/graph/extensibility-overview#directory-azure-ad-extensions) and [custom security attributes](/graph/api/resources/custom-security-attributes-overview). It is not supported to configure rules with schema extensions or open extensions. ++> [!NOTE] +> Using custom security attributes requires the Attribute Assignment Administrator role. For more information, see: [Attribute Assignment Administrator](/entra/identity/role-based-access-control/permissions-reference#attribute-assignment-administrator). #### Examples of rules You can also configure rules using [Directory (Microsoft Entra ID) extensions](/ | `"rule": "(otherMails/any(p:startsWith(p, 'Av')))"` | Run the workflow for users whose **otherMails** starts with `Av`. | | `"rule": "(department eq 'Marketing') and (accountEnabled in (true))"` | Run the workflow for users in the marketing department and whose account is enabled. | | `"rule": "(department eq 'Marketing') or (not (city eq 'Redmond'))"` | Run the workflow for users in the marketing department and whose city is not "Redmond". |+| `"rule": "(customSecurityAttributes/OnsightLocation/CustomerOnsite eq true)"` | Run the workflow for users who have the custom security attribute for **CustomerOnSite** set as *true*. | ## Relationships |
v1.0 | Identitygovernance Taskdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-taskdefinition.md | Inherits from [entity](../resources/entity.md). |Property|Type|Description| |:|:|:| |category|microsoft.graph.identityGovernance.lifecycleTaskCategory|The category of the HR function that the tasks created using this definition can be used with. The possible values are: `joiner`, `leaver`, `mover`, `unknownFutureValue`. This is a multi-valued enumeration whose allowed combinations are `joiner`, `joiner,leaver`, or `leaver`.<br><br>Supports `$filter`(`eq`, `ne`, `has`) and `$orderby`. |-|ContinueOnError|Boolean|Defines if the workflow will continue if the task has an error.| +|continueOnError|Boolean|Defines if the workflow will continue if the task has an error.| |description|String|The description of the taskDefinition.| |displayName|String|The display name of the taskDefinition.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.| |id|String|The unique identifier for the taskDefinition. Inherited from [entity](../resources/entity.md).| |
v1.0 | Identitygovernance Toptasksinsightssummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/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/beta/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/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." ++ms.localizationpriority: medium ++++# triggerAttribute resource type ++Namespace: microsoft.graph.identityGovernance +++An abstract type that 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 Workflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-workflow.md | Namespace: microsoft.graph.identityGovernance Represents workflows created using Lifecycle Workflows. Workflows, when triggered by execution conditions, automate parts of the lifecycle management process using tasks. These tasks can either be built-in tasks, or a custom task can be called using the custom task extension which integrate with Azure Logic Apps. -You can create up to 50 workflows in a tenant. +You can create up to 100 workflows in a tenant. Inherits from [workflowBase](../resources/identitygovernance-workflowbase.md). |
v1.0 | Identitygovernance Workflowbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-workflowbase.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Identitygovernance Workflowexecutionconditions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-workflowexecutionconditions.md | Title: "workflowExecutionConditions resource type" -description: "An abstract type that's inherited by derived types that define different conditions that trigger execution of a workflow." +description: "An abstract type inherited by derived types that define different conditions that trigger execution of a workflow." ms.localizationpriority: medium 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 will run and rules that identify the users that are the target of the workflow. The following types are derived from this abstract type: +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: + + [onDemandExecutionOnly](../resources/identitygovernance-ondemandexecutiononly.md) + [triggerAndScopeBasedConditions](../resources/identitygovernance-triggerandscopebasedconditions.md) None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.identityGovernance.workflowExecutionConditions" |
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)] -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: +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: + [timeBasedAttributeTrigger](../resources/identitygovernance-timebasedattributetrigger.md)++ [attributeChangeTrigger](../resources/identitygovernance-attributechangetrigger.md)++ [membershipChangeTrigger](../resources/identitygovernance-membershipchangetrigger.md) ## Properties 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.identityGovernance.workflowExecutionTrigger" |
v1.0 | Identitygovernance Workflowsinsightsbycategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/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/beta/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 | Identitysecuritydefaultsenforcementpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitysecuritydefaultsenforcementpolicy.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Identityset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identityset.md | description: "Represents a keyed collection of identity resources." Title: "identitySet resource type" ms.localizationpriority: medium doc_type: resourcePageType+ # identitySet resource type |
v1.0 | Identitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitysource.md | 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.identitySource" |
v1.0 | Identityuserflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identityuserflow.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Identityuserflowattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identityuserflowattribute.md | Configuring user flow attributes in your Microsoft Entra ID or Azure AD B2C tena |Property|Type|Description| |:|:--|:-|-|dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute. This can't be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`).| +|dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute. Can't be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`).| |displayName|String|The display name of the user flow attribute. <br/><br/> Supports `$filter` (`eq`, `ne`). |-|description|String|The description of the user flow attribute that's shown to the user at the time of sign-up.| -|id|String|The identifier of the user flow attribute. This is a read-only attribute that is automatically created. <br/><br/> Supports `$filter` (`eq`, `ne`). | -|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute. This is a read-only attribute that is automatically set. Depending on the type of attribute, the values for this property are `builtIn`, `custom`, `required`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`). | +|description|String|The description of the user flow attribute that's shown to the user at the time of sign up.| +|id|String|The identifier of the user flow attribute. Read-only. <br/><br/> Supports `$filter` (`eq`, `ne`). | +|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute. Read-only. Depending on the type of attribute, the values for this property are `builtIn`, `custom`, `required`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`). | ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Identityuserflowattributeassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identityuserflowattributeassignment.md | identityUserFlowAttributeAssignments are used to collect specific identityUserFl ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Ifemptytransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ifemptytransformation.md | + + Title: "ifEmptyTransformation resource type" +description: " Contains the output of a transformation if the input is null or empty." ++ms.localizationpriority: medium ++++# ifEmptyTransformation resource type ++Namespace: microsoft.graph +++ Contains the output of a transformation if the input is null or empty. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|output|[transformationAttribute](../resources/transformationattribute.md)|The output attribute used, based on the condition applied in this transformation.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.ifEmptyTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.ifEmptyTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "output": { + "@odata.type": "microsoft.graph.transformationAttribute" + } +} +``` |
v1.0 | Ifnotemptytransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ifnotemptytransformation.md | + + Title: "ifNotEmptyTransformation resource type" +description: " Contains the output of a transformation if the input is not null or empty." ++ms.localizationpriority: medium ++++# ifNotEmptyTransformation resource type ++Namespace: microsoft.graph +++ Contains the output of a transformation if the input is not null or empty. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|output|[transformationAttribute](../resources/transformationattribute.md)|The output attribute used, based on the condition applied in this transformation.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.ifNotEmptyTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.ifNotEmptyTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "output": { + "@odata.type": "microsoft.graph.transformationAttribute" + } +} +``` |
v1.0 | Implicitgrantsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/implicitgrantsettings.md | Specifies whether this web application can request tokens using the OAuth 2.0 im |enableAccessTokenIssuance| Boolean | Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow.| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Inactiveawsresourcefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inactiveawsresourcefinding.md | description: "Represents inactive AWS resources." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Inactiveawsrolefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inactiveawsrolefinding.md | description: "Represents inactive AWS roles." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Inactiveazureserviceprincipalfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inactiveazureserviceprincipalfinding.md | description: "Represents the inactive Azure service principals." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Inactivegcpserviceaccountfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inactivegcpserviceaccountfinding.md | description: "Represents the inactive GCP service acccounts." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Inactivegroupfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inactivegroupfinding.md | description: "Contains analytic information for an inactive group in an authoriz ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Inactiveserverlessfunctionfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inactiveserverlessfunctionfinding.md | description: "Represents the inactive serverless functions in AWS, Azure, and GC ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Inactiveuserfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inactiveuserfinding.md | description: "Represents the inactive users in AWS, Azure, or GCP." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Inboundoutboundpolicyconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inboundoutboundpolicyconfiguration.md | 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.inboundOutboundPolicyConfiguration" |
v1.0 | Inboundports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inboundports.md | description: Contains information about ports that allow inbound traffic." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Inboundshareduserprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inboundshareduserprofile.md | Title: "inboundSharedUserProfile resource type" description: "Represents a Microsoft Entra user from an external Microsoft Entra tenant whose profile data is shared with the current tenant using B2B direct connect."-++ ms.localizationpriority: medium doc_type: resourcePageType None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "userId", |
v1.0 | Includetarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/includetarget.md | 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.includeTarget" |
v1.0 | Incomingcontext | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/incomingcontext.md | The context associated with an incoming call. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Industrydata Additionalclassgroupoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-additionalclassgroupoptions.md | + + Title: "additionalClassGroupOptions resource type" +description: "The different management choices for the class groups to be provisioned." ++ms.localizationpriority: medium ++++# additionalClassGroupOptions resource type ++Namespace: microsoft.graph.industryData +++The different management choices for the class groups to be provisioned. ++## Properties ++| Property | Type | Description | +| : | : | : | +| createTeam | Boolean | Indicates whether a team should be created for the class group. | +| writeDisplayNameOnCreateOnly | Boolean | Indicates whether the class group display name should be set on create. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.additionalClassGroupOptions" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.additionalClassGroupOptions", + "createTeam": "Boolean", + "writeDisplayNameOnCreateOnly": "Boolean" +} +``` |
v1.0 | Industrydata Additionaluseroptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-additionaluseroptions.md | + + Title: "additionalUserOptions resource type" +description: "The different management choices for the users to be provisioned." ++ms.localizationpriority: medium ++++# additionalUserOptions resource type ++Namespace: microsoft.graph.industryData +++The different management choices for the users to be provisioned. ++## Properties ++| Property | Type | Description | +| :-- | : | :-- | +| allowStudentContactAssociation | Boolean | Indicates whether student contact association should be allowed. | +| markAllStudentsAsMinors | Boolean | Indicates whether all students should be marked as minors. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.additionalUserOptions" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.additionalUserOptions", + "markAllStudentsAsMinors": "Boolean", + "allowStudentContactAssociation": "Boolean" +} +``` |
v1.0 | Industrydata Administrativeunitprovisioningflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-administrativeunitprovisioningflow.md | + + Title: "administrativeUnitProvisioningFlow resource type" +description: "Represents the parameters that school data sync uses to create administrative units from your inbound data." ++ms.localizationpriority: medium ++++# administrativeUnitProvisioningFlow resource type ++Namespace: microsoft.graph.industryData +++Represents the parameters that school data sync uses to create administrative units from your inbound data. Administrative units provide a grouping construct for delegated IT administration and scoped role assignments. Scoped role assignments allow admins to manage a subset of the broader Microsoft 365 directory. ++administrativeUnitProvisioningFlow is defined within an [outboundProvisioningFlowSet](industrydata-outboundprovisioningflowset.md) that may specify a filter based on a subset of available organizations (schools) or may include all of the organizations in the inbound data. ++There may be multiple administrativeUnitProvisioningFlows, defined within separate outboundProvsioningFlowSets allowing different configurations for different organizations. ++Inherits from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). ++## Methods ++| Method | Return type | Description | +| :- | :-- | : | +| [Get administrativeUnitProvisioningFlow](../api/industrydata-administrativeunitprovisioningflow-get.md) | [microsoft.graph.industryData.administrativeUnitProvisioningFlow](industrydata-administrativeunitprovisioningflow.md) | Read the properties and relationships of an administrativeunitprovisioningflow object. | +| [Update administrativeUnitProvisioningFlow](../api/industrydata-administrativeunitprovisioningflow-update.md) | [microsoft.graph.industryData.administrativeUnitProvisioningFlow](industrydata-administrativeunitprovisioningflow.md) | Update the properties of an administrativeunitprovisioningflow object. | +| [Delete administrativeUnitProvisioningFlow](../api/industrydata-administrativeunitprovisioningflow-delete.md) | None | Delete an administrativeunitprovisioningflow object. | ++## Properties ++| Property | Type | Description | +| :- | :- | : | +| createdDateTime | DateTimeOffset | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| creationOptions | [microsoft.graph.industryData.adminUnitCreationOptions](industrydata-adminunitcreationoptions.md) | The different attribute choices for the administrative units to be provisioned. | +| id | String | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| lastModifiedDateTime | DateTimeOffset | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| readinessStatus | microsoft.graph.industryData.readinessStatus | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). The possible values are: `notReady`, `ready`, `failed`, `disabled`, `expired`, `unknownFutureValue`. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.industryData.administrativeUnitProvisioningFlow", + "baseType": "microsoft.graph.industryData.provisioningFlow", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.administrativeUnitProvisioningFlow", + "createdDateTime": "String (timestamp)", + "lastModifiedDateTime": "String (timestamp)", + "readinessStatus": "String", + "id": "String (identifier)", + "creationOptions": { + "@odata.type": "microsoft.graph.industryData.adminUnitCreationOptions" + } +} +``` |
v1.0 | Industrydata Adminunitcreationoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-adminunitcreationoptions.md | + + Title: "adminUnitCreationOptions resource type" +description: "The different management choices for the administrative units to be provisioned." ++ms.localizationpriority: medium ++++# adminUnitCreationOptions resource type ++Namespace: microsoft.graph.industryData +++The different management choices for the administrative units to be provisioned. ++## Properties ++| Property | Type | Description | +| :- | : | : | +| createBasedOnOrg | Boolean | Indicates whether the administrative unit should be created based on the org. | +| createBasedOnOrgPlusRoleGroup | Boolean | Indicates whether the administrative unit should be created based on the org and role group. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.adminUnitCreationOptions" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.adminUnitCreationOptions", + "createBasedOnOrg": "Boolean", + "createBasedOnOrgPlusRoleGroup": "Boolean" +} +``` |
v1.0 | Industrydata Basicfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-basicfilter.md | + + Title: "basicFilter resource type" +description: "A basic filter implementation with single condition on a single attribute" ++ms.localizationpriority: medium ++++# basicFilter resource type ++Namespace: microsoft.graph.industryData +++A basic filter implementation with single condition on a single attribute. ++Inherits from [microsoft.graph.industryData.filter](../resources/industrydata-filter.md). ++## Properties ++| Property | Type | Description | +| :-- | :-- | : | +| attribute | microsoft.graph.industryData.filteroptions | The attribute to filter on. The possible values are: `orgExternalId`, `unknownFutureValue`. | +| in | String collection | The condition to filter with. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.basicFilter" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.basicFilter", + "attribute": "String", + "in": ["String"] +} +``` |
v1.0 | Industrydata Classgroupconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-classgroupconfiguration.md | + + Title: "classGroupConfiguration resource type" +description: "The different configurations choices for the class groups to be provisioned with." ++ms.localizationpriority: medium ++++# classGroupConfiguration resource type ++Namespace: microsoft.graph.industryData +++The different configurations choices for the class groups to be provisioned with. ++## Properties ++| Property | Type | Description | +| :- | :- | : | +| additionalAttributes | microsoft.graph.industryData.additionalClassGroupAttributes collection | The different attributes to sync for the class groups. The possible values are: `courseTitle`, `courseCode`, `courseSubject`, `courseGradeLevel`, `courseExternalId`, `academicSessionTitle`, `academicSessionExternalId`, `classCode`, `unknownFutureValue`. | +| additionalOptions | [microsoft.graph.industryData.additionalClassGroupOptions](../resources/industrydata-additionalclassgroupoptions.md) | The different options for the class groups to be provisioned with. | +| enrollmentMappings | [microsoft.graph.industryData.enrollmentMappings](../resources/industrydata-enrollmentmappings.md) | The different enrollmentMappings for the class groups to be provisioned with. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.classGroupConfiguration" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.classGroupConfiguration", + "additionalAttributes": ["String"], + "additionalOptions": { + "@odata.type": "microsoft.graph.industryData.additionalClassGroupOptions" + }, + "enrollmentMappings": { + "@odata.type": "microsoft.graph.industryData.enrollmentMappings" + } +} +``` |
v1.0 | Industrydata Classgroupprovisioningflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-classgroupprovisioningflow.md | + + Title: "classGroupProvisioningFlow resource type" +description: "Represents the parameters that school data sync uses to create class groups and teams in Microsoft 365 from your inbound data." ++ms.localizationpriority: medium ++++# classGroupProvisioningFlow resource type ++Namespace: microsoft.graph.industryData +++Represents the parameters that school data sync uses to create class groups and teams in Microsoft 365 from your inbound data. Class groups allow users to connect, communicate, and collaborate across various Microsoft 365 applications including Teams. ++classGroupProvisioningFlow is defined within an [outboundProvisioningFlowSet](industrydata-outboundprovisioningflowset.md) that may specify a filter based on a subset of available organizations (schools) or may include all of the organizations in the inbound data. ++There may be multiple classGroupProvisioningFlows, defined within separate OutboundProvsioningFlowSets (editor note, hyperlink to related docs) allowing different configurations for different organizations. ++Inherits from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). ++## Methods ++| Method | Return type | Description | +| : | :- | :-- | +| [Get classGroupProvisioningFlow](../api/industrydata-classgroupprovisioningflow-get.md) | [microsoft.graph.industryData.classGroupProvisioningFlow](industrydata-classgroupprovisioningflow.md) | Read the properties and relationships of a classgroupprovisioningflow object. | +| [Update classGroupProvisioningFlow](../api/industrydata-classgroupprovisioningflow-update.md) | [microsoft.graph.industryData.classGroupProvisioningFlow](industrydata-classgroupprovisioningflow.md) | Update the properties of a classgroupprovisioningflow object. | +| [Delete classGroupProvisioningFlow](../api/industrydata-classgroupprovisioningflow-delete.md) | None. | Delete a classgroupprovisioningflow object. | ++## Properties ++| Property | Type | Description | +| :- | :-- | : | +| configuration | [microsoft.graph.industryData.classGroupConfiguration](industrydata-classgroupconfiguration.md) | The different attribute choices for the class groups to be provisioned. | +| createdDateTime | DateTimeOffset | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| id | String | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| lastModifiedDateTime | DateTimeOffset | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| readinessStatus | microsoft.graph.industryData.readinessStatus | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). The possible values are: `notReady`, `ready`, `failed`, `disabled`, `expired`, `unknownFutureValue`. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.industryData.classGroupProvisioningFlow", + "baseType": "microsoft.graph.industryData.provisioningFlow", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.classGroupProvisioningFlow", + "createdDateTime": "String (timestamp)", + "lastModifiedDateTime": "String (timestamp)", + "readinessStatus": "String", + "id": "String (identifier)", + "configuration": { + "@odata.type": "microsoft.graph.industryData.classGroupConfiguration" + } +} +``` |
v1.0 | Industrydata Enrollmentmappings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-enrollmentmappings.md | + + Title: "enrollmentMappings resource type" +description: "The different management choices for the class groups to be provisioned." ++ms.localizationpriority: medium ++++# enrollmentMappings resource type ++Namespace: microsoft.graph.industryData +++The different management choices for the class groups to be provisioned. ++## Properties ++| Property | Type | Description | +| :-- | :-- | : | +| memberEnrollmentMappings | [microsoft.graph.industryData.sectionRoleReferenceValue](../resources/industrydata-sectionrolereferencevalue.md) collection | The enrollmentMappings member for the class group. | +| ownerEnrollmentMappings | [microsoft.graph.industryData.sectionRoleReferenceValue](../resources/industrydata-sectionrolereferencevalue.md) collection | The enrollmentMappings owner for the class group. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.enrollmentMappings" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.enrollmentMappings", + "ownerEnrollmentMappings": [ + { + "@odata.type": "microsoft.graph.industryData.sectionRoleReferenceValue" + } + ], + "memberEnrollmentMappings": [ + { + "@odata.type": "microsoft.graph.industryData.sectionRoleReferenceValue" + } + ] +} +``` |
v1.0 | Industrydata Filter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-filter.md | + + Title: "filter resource type" +description: "A filter base type" ++ms.localizationpriority: medium ++++# filter resource type ++Namespace: microsoft.graph.industryData +++A filter base type. This is an abstract type. ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.filter" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.filter" +} +``` |
v1.0 | Industrydata Outboundprovisioningflowset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-outboundprovisioningflowset.md | + + Title: "outboundProvisioningFlowSet resource type" +description: "Represents a collection of outbound provisioning flows used to configure how school data sync populates data in Microsoft 365 and Microsoft Entra ID." ++ms.localizationpriority: medium ++++# outboundProvisioningFlowSet resource type ++Namespace: microsoft.graph.industryData +++Represents a collection of outbound provisioning flows used to configure how school data sync populates data in Microsoft 365 and Microsoft Entra ID. A flow set may specify a filter based on a subset of available organizations (schools) or may include all of the organizations in the inbound data. There may be multiple outboundProvisioningFlowSets, allowing different configurations for different organizations. Each outbound provisioning flow set doesn't need to include every provisioning flow type. ++Outbound provisioning flow set may contain no more than one (1) of each provisioning flow configuration that is being configured: [userProvisioningFlow](industrydata-userprovisioningflow.md), [classGroupProvisioingFlow](industrydata-classgroupprovisioningflow.md), [securityGroupProvisioingFlow](industrydata-securitygroupprovisioningflow.md), [administrativeUnitProvisioingFlow](industrydata-administrativeunitprovisioningflow.md). ++## Methods ++| Method | Return type | Description | +| :-- | : | :- | +| [List outboundProvisioningFlowSet objects](../api/industrydata-industrydataroot-list-outboundprovisioningflowsets.md) | [microsoft.graph.industryData.outboundProvisioningFlowSet](industrydata-outboundprovisioningflowset.md) collection | Get a list of outboundprovisioningflowset objects and their properties. | +| [Create outboundProvisioningFlowSet](../api/industrydata-industrydataroot-post-outboundprovisioningflowsets.md) | [microsoft.graph.industryData.outboundProvisioningFlowSet](industrydata-outboundprovisioningflowset.md) | Create a new outboundprovisioningflowset object. | +| [Get outboundProvisioningFlowSet](../api/industrydata-outboundprovisioningflowset-get.md) | [microsoft.graph.industryData.outboundProvisioningFlowSet](industrydata-outboundprovisioningflowset.md) | Read the properties and relationships of an outboundprovisioningflowset object. | +| [Update outboundProvisioningFlowSet](../api/industrydata-outboundprovisioningflowset-update.md) | [microsoft.graph.industryData.outboundProvisioningFlowSet](industrydata-outboundprovisioningflowset.md) | Update the properties of an outboundprovisioningflowset object. | +| [Delete outboundProvisioningFlowSet](../api/industrydata-industrydataroot-delete-outboundprovisioningflowsets.md) | None | Delete an outboundprovisioningflowset object. | +| [List provisioningFlows](../api/industrydata-outboundprovisioningflowset-list-provisioningflows.md) | [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md) collection | Get the provisioningFlow resources from the provisioningFlows navigation property. | +| [Create provisioningFlow](../api/industrydata-outboundprovisioningflowset-post-provisioningflows.md) | [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md) | Create a new provisioningFlow object. | ++## Properties ++| Property | Type | Description | +| :- | :- | :-- | +| createdDateTime | DateTimeOffset | The date and time when the flowSet 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`. | +| displayName | String | The display name of the flowSet provided by the caller. | +| filter | [microsoft.graph.industryData.filter](industrydata-filter.md) | The collection of provisioning filters applicable to all the flows under the given flowSet. | +| id | String | The unique identifier for the flowSet. Inherited from [entity](entity.md). | +| lastModifiedDateTime | DateTimeOffset | The date and time when the flowSet was most recently changed. 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 ++| Relationship | Type | Description | +| :- | :-- | :-- | +| provisioningFlows | [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md) collection | A flow that provisions relevant records of a given entity type in the Microsoft 365 tenant. | ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.industryData.outboundProvisioningFlowSet", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.outboundProvisioningFlowSet", + "displayName": "String", + "createdDateTime": "String (timestamp)", + "lastModifiedDateTime": "String (timestamp)", + "id": "String (identifier)", + "filter": { + "@odata.type": "microsoft.graph.industryData.filter" + } +} +``` |
v1.0 | Industrydata Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-overview.md | The industry data API is defined in the OData subnamespace `microsoft.graph.indu ## Industry data API and education -The industry data API powers the [Microsoft School Data Sync](https://sds.microsoft.com) (SDS) platform to help automate the process of importing data and synchronizing organizations, users and users associations, and groups <!-- with Azure Active Directory (Azure AD) and Office 365 --> from student information systems (SIS) and student management systems (SMS) into an organization's Azure Data Lake. After normalizing the data in Azure Data Lake <!-- the API utilizes the data in multiple outbound flows, --> SDS can synchronize the data with [Insights for Education Leaders](/schooldatasync/enable-sync-with-insights), for use with the Insights app in Teams for Education, and [Education Data Lake Export](/schooldatasync/enable-education-data-lake-export), for custom analytics scenarios. +The industry data API powers the [Microsoft School Data Sync](https://sds.microsoft.com) (SDS) platform to help automate the process of importing data and synchronizing organizations, users and users associations, and groups with Microsoft Entra ID and Microsoft 365 from student information systems (SIS) and student management systems (SMS). After normalizing the data the API utilizes the data through multiple outbound provisioning flows to manage users, class groups, administrative units, and security groups. ![Illustration of the industry data ETL process](/graph/images/industrydata-overview.png) At the end of each run, [industryDataRunStatistics](industrydata-industrydatarun Errors and warnings related to **industryDataRunStatistics** are produced to help provide an initial understanding of data health. When you investigate data health, industry data provides the ability to download a log file that contains information based on the errors and warnings found to begin the data investigation process to correct the data in the source system. -After investigating and addressing any data errors or warnings, when you're comfortable with the current state of the data health, you can enable the scenarios with the data that is now in the education data lake. When you enable a scenario to use this data, the scenario creates an outbound flow. <!-- Outbound flows are defined by Microsoft 365 provisioning, Insights & Analytics. --> +After investigating and addressing any data errors or warnings, when you're comfortable with the current state of the data health, you can enable the scenarios with the data. When you enable a scenario to use this data, the scenario creates an outbound provisioning flow. -<!-- Microsoft 365 Provisioning outbound flows help with simplifying management of users and classes. Only active and matched users are included in the data that will be used to write the link to the AAD user object between the SIS/ SMS and their sections for groups and Teams classrooms. --> --Insights and analytics help provide analysis for student progress and activity within their classes. Guided by this data, educators have the information they need to ensure that their students' emotional, social, and academic needs are met. +Managing data through outbound provisioning flows simplifies the management of users and classes. Only active and matched users are included in the data that is used to write the link to the Microsoft Entra user object. This link facilitates the integration between the SIS/SMS and their sections for groups and Microsoft Teams classrooms. For more information, see the sections School Data Sync, SDS prerequisites, and SDS core concepts of the [School Data Sync overview](/schooldatasync/school-data-sync-overview). Transformation of the data is often shaped by each individual user's role within ### Industry data connectors -An [industryDataConnector](industrydata-industrydataconnector.md) acts as a bridge between a [sourceSystemDefinition](industrydata-sourcesystemdefinition.md) and an [inboundFlow](industrydata-inboundflow.md). It is responsible for acquiring data from an external source and providing the data to inbound data flows. +An [industryDataConnector](industrydata-industrydataconnector.md) acts as a bridge between a [sourceSystemDefinition](industrydata-sourcesystemdefinition.md) and an [inboundFlow](industrydata-inboundflow.md). It's responsible for acquiring data from an external source and providing the data to inbound data flows. #### Upload and validate CSV data |
v1.0 | Industrydata Passwordsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-passwordsettings.md | + + Title: "passwordSettings resource type" +description: "The different password settings for the users to be provisioned" ++ms.localizationpriority: medium ++++# passwordSettings resource type ++Namespace: microsoft.graph.industryData +++The different password settings for the users to be provisioned. +This is an abstract type. ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.passwordSettings" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.passwordSettings" +} +``` |
v1.0 | Industrydata Provisioningflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-provisioningflow.md | + + Title: "provisioningFlow resource type" +description: "A flow that provisions relevant records of a given entity type in the Microsoft 365 tenant." ++ms.localizationpriority: medium ++++# provisioningFlow resource type ++Namespace: microsoft.graph.industryData +++A flow that provisions relevant records of a given entity type in the Microsoft 365 tenant. +This is an abstract type. ++## Methods ++|Method|Return type|Description| +|:--|:-|:-| +|[List provisioningFlow objects](../api/industrydata-outboundprovisioningflowset-list-provisioningflows.md)|[microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md) collection|Get a list of the provisioning flow objects and their properties.| +|[Create provisioningFlow](../api/industrydata-outboundprovisioningflowset-post-provisioningflows.md)|[microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md)|Create a new provisioning flow object.| +|[Reset provisioningFlow](../api/industrydata-provisioningflow-reset.md)|None|Resets a provisioning flow object.| ++## Properties ++|Property|Type|Description| +|:-|:|:-| +|createdDateTime|DateTimeOffset|The date and time when the provisioning flow 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`.| +|id|String|The unique identifier for the provisioning flow. Inherited from [entity](entity.md).| +|lastModifiedDateTime|DateTimeOffset|The date and time when the provisioning flow was most recently changed. 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`.| +|readinessStatus|microsoft.graph.industryData.readinessStatus|The state of the activity from creation through to ready to do work. The possible values are: `notReady`, `ready`, `failed`, `disabled`, `expired`, `unknownFutureValue`.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.industryData.provisioningFlow", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.provisioningFlow", + "createdDateTime": "String (timestamp)", + "lastModifiedDateTime": "String (timestamp)", + "readinessStatus": "String", + "id": "String (identifier)" +} +``` |
v1.0 | Industrydata Sectionrolereferencevalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-sectionrolereferencevalue.md | + + Title: "sectionRoleReferenceValue resource type" +description: " A reference value for a role in a section." ++ms.localizationpriority: medium ++++# sectionRoleReferenceValue resource type ++Namespace: microsoft.graph.industryData +++A reference value for a role in a section. ++Inherits from [microsoft.graph.industryData.referenceValue](../resources/industrydata-referencevalue.md). ++## Properties ++| Property | Type | Description | +| :- | :-- | : | +| code | String | Inherited from [microsoft.graph.industryData.referenceValue](../resources/industrydata-referencevalue.md). | ++## Relationships ++| Relationship | Type | Description | +| :-- | :- | :-- | +| value | [microsoft.graph.industryData.referenceDefinition](../resources/industrydata-referencedefinition.md) | Inherited from [microsoft.graph.industryData.referenceValue](../resources/industrydata-referencevalue.md). | ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.sectionRoleReferenceValue" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue", + "code": "String" +} +``` |
v1.0 | Industrydata Securitygroupcreationoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-securitygroupcreationoptions.md | + + Title: "securityGroupCreationOptions resource type" +description: "The different options for the security groups to be provisioned." ++ms.localizationpriority: medium ++++# securityGroupCreationOptions resource type ++Namespace: microsoft.graph.industryData +++The different options for the security groups to be provisioned. ++## Properties ++| Property | Type | Description | +| :- | : | :-- | +| createBasedOnOrgPlusRoleGroup | Boolean | Indicates whether the security group should be created based on the org and role group. | +| createBasedOnRoleGroup | Boolean | A boolean choice indicating whether the security group should be created based on the role group | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.securityGroupCreationOptions" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.securityGroupCreationOptions", + "createBasedOnRoleGroup": "Boolean", + "createBasedOnOrgPlusRoleGroup": "Boolean" +} +``` |
v1.0 | Industrydata Securitygroupprovisioningflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-securitygroupprovisioningflow.md | + + Title: "securityGroupProvisioningFlow resource type" +description: "Represents the parameters that school data sync uses to create security groups and teams in Microsoft 365 from your inbound data." ++ms.localizationpriority: medium ++++# securityGroupProvisioningFlow resource type ++Namespace: microsoft.graph.industryData +++Represents the parameters that school data sync uses to create security groups and teams in Microsoft 365 from your inbound data. Security groups provide a grouping construct for use within various identity management, application management, and device management scenarios in Microsoft 365. ++securityGroupProvisioningFlow is defined within an [outboundProvisioningFlowSet](industrydata-outboundprovisioningflowset.md) that may specify a filter based on a subset of available organizations (schools) or may include all of the organizations in the inbound data. ++There may be multiple securityGroupProvisioningFlows, defined within separate outboundProvsioningFlowSets allowing different configurations for different organizations. ++Inherits from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). ++## Methods ++| Method | Return type | Description | +| : | :- | :-- | +| [Get securityGroupProvisioningFlow](../api/industrydata-securitygroupprovisioningflow-get.md) | [microsoft.graph.industryData.securityGroupProvisioningFlow](industrydata-securitygroupprovisioningflow.md) | Read the properties and relationships of a securitygroupprovisioningflow object. | +| [Update securityGroupProvisioningFlow](../api/industrydata-securitygroupprovisioningflow-update.md) | [microsoft.graph.industryData.securityGroupProvisioningFlow](industrydata-securitygroupprovisioningflow.md) | Update the properties of a securitygroupprovisioningflow object. | +| [Delete securityGroupProvisioningFlow](../api/industrydata-securitygroupprovisioningflow-delete.md) | None | Delete a securitygroupprovisioningflow object. | ++## Properties ++| Property | Type | Description | +| :- | : | : | +| createdDateTime | DateTimeOffset | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| creationOptions | [microsoft.graph.industryData.securityGroupCreationOptions](industrydata-securitygroupcreationoptions.md) | The different attribute choices for the class groups to be provisioned. | +| id | String | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| lastModifiedDateTime | DateTimeOffset | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| readinessStatus | microsoft.graph.industryData.readinessStatus | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). The possible values are: `notReady`, `ready`, `failed`, `disabled`, `expired`, `unknownFutureValue`. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.industryData.securityGroupProvisioningFlow", + "baseType": "microsoft.graph.industryData.provisioningFlow", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.securityGroupProvisioningFlow", + "createdDateTime": "String (timestamp)", + "lastModifiedDateTime": "String (timestamp)", + "readinessStatus": "String", + "id": "String (identifier)", + "creationOptions": { + "@odata.type": "microsoft.graph.industryData.securityGroupCreationOptions" + } +} +``` |
v1.0 | Industrydata Simplepasswordsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-simplepasswordsettings.md | + + Title: "simplePasswordSettings resource type" +description: "The password settings for the users to be provisioned" ++ms.localizationpriority: medium ++++# simplePasswordSettings resource type ++Namespace: microsoft.graph.industryData +++The password settings for the users to be provisioned. ++Inherits from [microsoft.graph.industryData.passwordSettings](../resources/industrydata-passwordsettings.md). ++## Properties ++| Property | Type | Description | +| :- | :-- | : | +| password | String | The password for the user. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.simplePasswordSettings" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings", + "password": "String" +} +``` |
v1.0 | Industrydata Userconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-userconfiguration.md | + + Title: "userConfiguration resource type" +description: "The different configurations choices for the users to be provisioned with." ++ms.localizationpriority: medium ++++# userConfiguration resource type ++Namespace: microsoft.graph.industryData +++The different configurations choices for the users to be provisioned with. ++## Properties ++| Property | Type | Description | +| :- | : | : | +| defaultPasswordSettings | [microsoft.graph.industryData.passwordSettings](../resources/industrydata-passwordsettings.md) | The password settings for the users to be provisioned with. | +| licenseSkus | String collection | The license skus for the users to be provisioned with. | ++## Relationships ++| Relationship | Type | Description | +| :-- | :-- | :-- | +| roleGroup | [microsoft.graph.industryData.roleGroup](../resources/industrydata-rolegroup.md) | The role for the users to be provisioned with. | ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.userConfiguration" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.userConfiguration", + "defaultPasswordSettings": { + "@odata.type": "microsoft.graph.industryData.passwordSettings" + }, + "licenseSkus": ["String"] +} +``` |
v1.0 | Industrydata Usercreationoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-usercreationoptions.md | + + Title: "userCreationOptions resource type" +description: "The different management choices for the users to be provisioned" ++ms.localizationpriority: medium ++++# userCreationOptions resource type ++Namespace: microsoft.graph.industryData +++The different management choices for the users to be provisioned. ++## Properties ++| Property | Type | Description | +| :- | :- | : | +| configurations | [microsoft.graph.industryData.userConfiguration](../resources/industrydata-userconfiguration.md) collection | The different management choices for the users to be provisioned. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.userCreationOptions" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.userCreationOptions", + "configurations": [ + { + "@odata.type": "microsoft.graph.industryData.userConfiguration" + } + ] +} +``` |
v1.0 | Industrydata Usermanagementoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-usermanagementoptions.md | + + Title: "userManagementOptions resource type" +description: "The different configurations choices for the users to be provisioned." ++ms.localizationpriority: medium ++++# userManagementOptions resource type ++Namespace: microsoft.graph.industryData +++The different configurations choices for the users to be provisioned. ++## Properties ++| Property | Type | Description | +| :- | :- | : | +| additionalAttributes | microsoft.graph.industryData.additionalUserAttributes collection | The different attribute choices for the users to be provisioned. The possible values are: `userGradeLevel`, `userNumber`, `unknownFutureValue`. | +| additionalOptions | [microsoft.graph.industryData.additionalUserOptions](../resources/industrydata-additionaluseroptions.md) | The different management choices for the users to be provisioned. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.industryData.userManagementOptions" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.userManagementOptions", + "additionalAttributes": ["String"], + "additionalOptions": { + "@odata.type": "microsoft.graph.industryData.additionalUserOptions" + } +} +``` |
v1.0 | Industrydata Userprovisioningflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-userprovisioningflow.md | + + Title: "userProvisioningFlow resource type" +description: "Represents the configuration parameters that allow you to automate creation and matching to Microsoft 365 users from your inbound data." ++ms.localizationpriority: medium ++++# userProvisioningFlow resource type ++Namespace: microsoft.graph.industryData +++Represents the configuration parameters that allow you to automate creation and matching to Microsoft 365 users from your inbound data. ++userProvisioningFlow is defined within an [outboundProvisioningFlowSet](industrydata-outboundprovisioningflowset.md) that may specify a filter based on a subset of available organizations (schools) or may include all of the organizations in the inbound data. ++There may be multiple userProvisioningFlows, defined within separate outboundProvsioningFlowSets allowing different configurations for different organizations. ++Inherits from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). ++## Methods ++| Method | Return type | Description | +| : | :- | :-- | +| [Get userProvisioningFlow](../api/industrydata-userprovisioningflow-get.md) | [microsoft.graph.industryData.userProvisioningFlow](industrydata-userprovisioningflow.md) | Read the properties and relationships of a userprovisioningflow object. | +| [Update userProvisioningFlow](../api/industrydata-userprovisioningflow-update.md) | [microsoft.graph.industryData.userProvisioningFlow](industrydata-userprovisioningflow.md) | Update the properties of a userprovisioningflow object. | +| [Delete userProvisioningFlow](../api/industrydata-userprovisioningflow-delete.md) | None | Delete a userprovisioningflow object. | ++## Properties ++| Property | Type | Description | +| :- | :- | : | +| createdDateTime | DateTimeOffset | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| createUnmatchedUsers | Boolean | A boolean choice indicating whether unmatched users should be created or ignored. | +| creationOptions | [microsoft.graph.industryData.userCreationOptions](industrydata-usercreationoptions.md) | The different management choices for the new users to be provisioned. | +| id | String | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| lastModifiedDateTime | DateTimeOffset | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). | +| managementOptions | [microsoft.graph.industryData.userManagementOptions](industrydata-usermanagementoptions.md) | The different attribute choices for all the users to be considered. | +| readinessStatus | microsoft.graph.industryData.readinessStatus | Inherited from [microsoft.graph.industryData.provisioningFlow](industrydata-provisioningflow.md). The possible values are: `notReady`, `ready`, `failed`, `disabled`, `expired`, `unknownFutureValue`. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.industryData.userProvisioningFlow", + "baseType": "microsoft.graph.industryData.provisioningFlow", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.industryData.userProvisioningFlow", + "createdDateTime": "String (timestamp)", + "lastModifiedDateTime": "String (timestamp)", + "readinessStatus": "String", + "id": "String (identifier)", + "createUnmatchedUsers": "Boolean", + "managementOptions": { + "@odata.type": "microsoft.graph.industryData.userManagementOptions" + }, + "creationOptions": { + "@odata.type": "microsoft.graph.industryData.userCreationOptions" + } +} +``` |
v1.0 | Inferenceclassification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inferenceclassification.md | For more information, see [Manage Focused Inbox](manage-focused-inbox.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Inferenceclassificationoverride | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inferenceclassificationoverride.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Informationalurl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/informationalurl.md | Basic profile information of the application. |termsOfServiceUrl|String| Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Insights Insightidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/insights-insightidentity.md | Title: "insightIdentity" + Title: insightIdentity complex type description: "Complex type containing properties of Shared items." ms.localizationpriority: medium-# insightIdentity +# insightIdentity complex type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Complex type containing properties of [sharedInsight](insights-shared.md) items. +Complex type containing properties of [sharedInsight](insights-shared.md) items. ## JSON representation-Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Insights Resourcereference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/insights-resourcereference.md | Complex type containing properties of [itemInsights](iteminsights.md) ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Insights Sharingdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/insights-sharingdetail.md | Title: "sharingDetail resource type" -description: "Complex type containing properties of Shared items. " +description: "Contains the properties of shared items. " ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Complex type containing properties of [sharedInsight](insights-shared.md) items. +Contains the properties of [sharedInsight](insights-shared.md) items. ++## Properties ++| Property | Type | Description | +| - |-- | -| +| sharedDateTime | DateTimeOffset| The date and time the file was last shared. 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. | +| sharingSubject | String | The subject with which the document was shared. | +| sharingType | String | Determines the way the document was shared, can be by a "Link", "Attachment", "Group", "Site". | +| sharedBy | [insightIdentity](insights-insightidentity.md) | The user who shared the document. | +| sharingReference | [resourceReference](insights-resourcereference.md) | Reference properties of the document, such as the URL and type of the document. Read-only | + ## JSON representation-Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ Here's a JSON representation of the resource } ``` -## Properties --| Property | Type | Description | -| - |-- | -| -| sharedDateTime | DateTimeOffset| The date and time the file was last shared. 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. | -| sharingSubject | String | The subject with which the document was shared. | -| sharingType | String | Determines the way the document was shared, can be by a "Link", "Attachment", "Group", "Site". | -| sharedBy | [insightIdentity](insights-insightidentity.md) | The user who shared the document. | -| sharingReference | [resourceReference](insights-resourcereference.md) | | - |
v1.0 | Insights Trending | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/insights-trending.md | Rich relationship connecting a user to documents that are trending around the us | weight | Double | Value indicating how much the document is currently trending. The larger the number, the more the document is currently trending around the user (the more relevant it is). Returned documents are sorted by this value. | | resourceVisualization | [resourceVisualization](insights-resourcevisualization.md) | Properties that you can use to visualize the document in your experience. | | resourceReference | [resourceReference](insights-resourcereference.md) | Reference properties of the trending document, such as the url and type of the document. |-| lastModifiedDateTime | DateTimeOffset | | +| 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` | ## Relationships |
v1.0 | Insights Used | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/insights-used.md | An insight representing documents used by a specific user. The insights return t | resource | [entity](entity.md) collection | Used for navigating to the item that was used. For file attachments, the type is *fileAttachment*. For linked attachments, the type is *driveItem*. | ## JSON representation-Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Insightssettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/insightssettings.md | doc_type: resourcePageType [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents _settings_ to calculate and manage the display or programmatic return of a specific type of insights in an organization. The insights can be contact insights, item insights, meeting hours insights, or people insights. +Represents settings to calculate and manage the display or programmatic return of a specific type of insights in an organization. The insights can be contact insights, item insights, meeting hours insights, or people insights. Contact insights represent intelligent suggestions to organize user contacts in Microsoft 365. Programmatically, user contacts are represented by the [contact](contact.md) resource. An example of a contact insight is merge suggestions for duplicate contacts, available for end users in Outlook. Item insights and [meeting hours insights](https://support.microsoft.com/office/ People insights represent connections of people who are relevant to or work with one another based on their public relationships. Programmatically, individual people are represented by the [person](person.md) resource. You can [use the people API to get people insights](/graph/people-insights-overview). You can use **insightsSettings** to [customize the privacy settings for displaying or returning people insights](/graph/insights-customize-people-insights-privacy). -In contrast, for item insights and [meeting hours insights](https://support.microsoft.com/office/update-your-meeting-hours-using-the-profile-card-0613d113-d7c1-4faa-bb11-c8ba30a78ef1), you can also manage their calculation and visibility at a _user_ level by using the [userInsightsSettings](userinsightssettings.md) resource. +In contrast, for item insights and [meeting hours insights](https://support.microsoft.com/office/update-your-meeting-hours-using-the-profile-card-0613d113-d7c1-4faa-bb11-c8ba30a78ef1), you can also manage their calculation and visibility at a user level by using the [userInsightsSettings](userinsightssettings.md) resource. ## Methods | Method | Return Type | Description | |:-|:|:|-| [List contactInsights](../api/organizationsettings-list-contactinsights.md) | [insightsSettings](insightssettings.md) | Get the _settings_ in an [insightsSettings](insightssettings.md) object for displaying contact insights in an organization. | -| [List itemInsights](../api/organizationsettings-list-iteminsights.md) | [insightsSettings](insightssettings.md) | Get the _settings_ in an [insightsSettings](insightssettings.md) object for displaying item insights in an organization. | -| [List peopleInsights](../api/organizationsettings-list-peopleinsights.md) | [insightsSettings](insightssettings.md) | Get the _settings_ in an [insightsSettings](insightssettings.md) object for displaying people insights in an organization. | +| [List contactInsights](../api/organizationsettings-list-contactinsights.md) | [insightsSettings](insightssettings.md) | Get the properties of the [insightsSettings](insightssettings.md) resource for displaying contact insights in an organization. | +| [List itemInsights](../api/peopleadminsettings-list-iteminsights.md) | [insightsSettings](insightssettings.md) | Get the properties of the [insightsSettings](insightssettings.md) resource for displaying item insights in an organization. | +| [List peopleInsights](../api/organizationsettings-list-peopleinsights.md) | [insightsSettings](insightssettings.md) | Get the properties of the [insightsSettings](insightssettings.md) resource for displaying people insights in an organization. | | [Update insightsSettings](../api/insightssettings-update.md) | [insightsSettings](insightssettings.md) | Update the properties of an **insightsSettings** resource to manage the display or return of the specified type of insights, which can be contact insights, item insights, or people insights. | In contrast, for item insights and [meeting hours insights](https://support.micr | Property | Type|Description| |:|:--|:-|-|isEnabledInOrganization|Boolean| `true` if the specified type of insights is enabled for the organization; `false` if the specified type of insights is disabled for all users without exceptions. Default is `true`. Optional.| +|isEnabledInOrganization|Boolean| `true` if insights of the specified type are enabled for the organization; `false` if insights of the specified type are disabled for all users without exceptions. Default is `true`. Optional.| |disabledForGroup|String| The ID of a Microsoft Entra group, of which the specified type of insights are disabled for its members. Default is `empty`. Optional.| ## JSON representation |
v1.0 | Insightsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/insightsummary.md | Namespace: microsoft.graph Represents a daily or monthly summary of all usage insights on apps registered in your tenant that is configured for Microsoft Entra External ID for customers. A user (in **activeUsers**) can be counted more that once if they use multiple device platforms. This resource represents a summary of the insights. For a breakdown of each insight, see the following resources and their associated APIs:-- [activeUsersBreakdown](../resources/activeusersbreakdownmetric.md) - [activeUsers](../resources/activeusersmetric.md) - [authentications](../resources/authenticationsmetric.md) - [mfaCompletion](../resources/mfacompletionmetric.md) |
v1.0 | Internaldomainfederation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/internaldomainfederation.md | Title: "internalDomainFederation resource type" description: "Represents configurations of the domains in a tenant that are federated with Azure AD." ms.localizationpriority: medium-+ doc_type: resourcePageType Inherits from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md). |signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |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).| + ### federatedIdpMfaBehavior values | Member | Description | Inherits from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", Here's a JSON representation of the resource. "federatedIdpMfaBehavior": "String" } ```++<!-- +{ + "type": "#page.annotation", + "description": "", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: /resources/internaldomainfederation.md: + Exception processing links. + Link Definition was null. Link text: !INCLUDE Azure AD PowerShell deprecation note (Parameter 'Definition')" + ] +} +--> |
v1.0 | Internetmessageheader | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/internetmessageheader.md | For examples of an Internet message header, see ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Intune Androidforwork Androiddeviceownerenrollmentmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androiddeviceownerenrollmentmode.md | The enrollment mode for an enrollment profile. |corporateOwnedFullyManaged|1|| |corporateOwnedWorkProfile|2|| |corporateOwnedAOSPUserlessDevice|3|Corporate owned, userless Android Open Source Project (AOSP) device, without Google Mobile Services.|-|corporateOwnedAOSPUserAssociatedDevice|4|Corporate owned, user-associated Android Open Source Project (AOSP) device, without Google Mobile Services.| +|corporateOwnedAOSPUserAssociatedDevice|4|Corporate owned, user-associated Android Open Source Project (AOSP) device, without Google Mobile Services.| |
v1.0 | Intune Androidforwork Androiddeviceownerenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androiddeviceownerenrollmentprofile.md | Here is a JSON representation of the resource. "wifiHidden": true, "isTeamsDeviceProfile": true }-``` +``` |
v1.0 | Intune Androidforwork Androiddeviceownerenrollmenttokentype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androiddeviceownerenrollmenttokentype.md | The enrollment token type for an enrollment profile. |:|:|:| |default|0|Default token type.| |corporateOwnedDedicatedDeviceWithAzureADSharedMode|1|Token type for Azure AD shared dedicated device enrollment. It applies to CorporateOwnedDedicatedDevice enrollment mode only.|-|deviceStaging|2|Token type for Android Device Staging enrollment type. It applies to CorporateOwnedFullyManaged and CorporateOwnedWorkProfile only.| +|deviceStaging|2|Token type for Android Device Staging enrollment type. It applies to CorporateOwnedFullyManaged and CorporateOwnedWorkProfile only.| |
v1.0 | Intune Androidforwork Androidenrollmentcompanycode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidenrollmentcompanycode.md | Here is a JSON representation of the resource. "value": "binary" } }-``` +``` |
v1.0 | Intune Androidforwork Androidforworkappconfigurationschema | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkappconfigurationschema.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Androidforwork Androidforworkappconfigurationschemaitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkappconfigurationschemaitem.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Androidforwork Androidforworkappconfigurationschemaitemdatatype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkappconfigurationschemaitemdatatype.md | Data type for a configuration item inside an Android for Work application's cust |multiselect|4|| |bundle|5|| |bundleArray|6||-|hidden|7|| +|hidden|7|| |
v1.0 | Intune Androidforwork Androidforworkbindstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkbindstatus.md | Bind status of the tenant with the Google EMM API |notBound|0|| |bound|1|| |boundAndValidated|2||-|unbinding|3|| +|unbinding|3|| |
v1.0 | Intune Androidforwork Androidforworkenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkenrollmentprofile.md | Here is a JSON representation of the resource. "value": "binary" } }-``` +``` |
v1.0 | Intune Androidforwork Androidforworkenrollmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkenrollmenttarget.md | Android for Work device management targeting type for the account |none|0|| |all|1|| |targeted|2||-|targetedAsEnrollmentRestrictions|3|| +|targetedAsEnrollmentRestrictions|3|| |
v1.0 | Intune Androidforwork Androidforworksettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworksettings.md | Here is a JSON representation of the resource. ], "deviceOwnerManagementEnabled": true }-``` +``` |
v1.0 | Intune Androidforwork Androidforworksyncstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworksyncstatus.md | Sync status of the tenant with the Google EMM API |androidForWorkApiError|2|| |managementServiceError|3|| |unknownError|4||-|none|5|| +|none|5|| |
v1.0 | Intune Androidforwork Androidmanagedstoreaccountappsyncstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreaccountappsyncstatus.md | Sync status of the tenant with the Google EMM API |androidForWorkApiError|2|| |managementServiceError|3|| |unknownError|4||-|none|5|| +|none|5|| |
v1.0 | Intune Androidforwork Androidmanagedstoreaccountbindstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreaccountbindstatus.md | Bind status of the tenant with the Google EMM API |notBound|0|| |bound|1|| |boundAndValidated|2||-|unbinding|3|| +|unbinding|3|| |
v1.0 | Intune Androidforwork Androidmanagedstoreaccountenrollmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreaccountenrollmenttarget.md | Android for Work device management targeting type for the account |none|0|| |all|1|| |targeted|2||-|targetedAsEnrollmentRestrictions|3|| +|targetedAsEnrollmentRestrictions|3|| |
v1.0 | Intune Androidforwork Androidmanagedstoreaccountenterprisesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreaccountenterprisesettings.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Androidforwork Androidmanagedstoreappconfigurationschema | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreappconfigurationschema.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Androidforwork Androidmanagedstoreappconfigurationschemaitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreappconfigurationschemaitem.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Androidforwork Androidmanagedstoreappconfigurationschemaitemdatatype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreappconfigurationschemaitemdatatype.md | Data type for a configuration item inside an Android application's custom config |multiselect|4|| |bundle|5|| |bundleArray|6||-|hidden|7|| +|hidden|7|| |
v1.0 | Intune Androidforwork Aospwifisecuritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-aospwifisecuritytype.md | This enum represents Wi-Fi Security Types for Android Device Owner AOSP Scenario |:|:|:| |none|0|No security type.| |wpa|1|WPA-Pre-shared-key|-|wep|2|WEP-Pre-shared-key| +|wep|2|WEP-Pre-shared-key| |
v1.0 | Intune Androidforwork Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-devicemanagement.md | Singleton entity that acts as a container for Android for Work settings function ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-androidforwork-devicemanagement-get.md)|[deviceManagement](../resources/intune-androidforwork-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-androidforwork-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-androidforwork-devicemanagement-update.md)|[deviceManagement](../resources/intune-androidforwork-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-androidforwork-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-androidforwork-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-androidforwork-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Androidforwork Keyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-keyvaluepair.md | Here is a JSON representation of the resource. "name": "String", "value": "String" }-``` +``` |
v1.0 | Intune Androidfotaservice Androidfotadeploymentassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-androidfotadeploymentassignment.md | Here is a JSON representation of the resource. "groupId": "String" } }-``` +``` |
v1.0 | Intune Androidfotaservice Androidfotadeploymentassignmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-androidfotadeploymentassignmenttarget.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.androidFotaDeploymentAssignmentTarget", "groupId": "String" }-``` +``` |
v1.0 | Intune Androidfotaservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-devicemanagement.md | Singleton that acts as container for a collection of Resource Access entities. ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-androidfotaservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-androidfotaservice-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-androidfotaservice-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-androidfotaservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-androidfotaservice-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-androidfotaservice-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-androidfotaservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-androidfotaservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagement" }-``` +``` |
v1.0 | Intune Androidfotaservice Devicemanagementreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-devicemanagementreports.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementReports" }-``` +``` |
v1.0 | Intune Androidfotaservice Zebrafotaartifact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotaartifact.md | Here is a JSON representation of the resource. "releaseNotesUrl": "String", "description": "String" }-``` +``` |
v1.0 | Intune Androidfotaservice Zebrafotaconnector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotaconnector.md | Here is a JSON representation of the resource. "lastSyncDateTime": "String (timestamp)", "fotaAppsApproved": true }-``` +``` |
v1.0 | Intune Androidfotaservice Zebrafotaconnectorstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotaconnectorstate.md | Represents various states for Zebra FOTA connector. |none|0|Default value when the connector has not been setup (the feature has not been used yet).| |connected|1|Connected state indicates that Intune is linked to Zebra Update Services for the current tenant.| |disconnected|2|Disconnected state indicates that the account was connected in the past and later disconnected.|-|unknownFutureValue|99|Unknown future enum value.| +|unknownFutureValue|99|Unknown future enum value.| |
v1.0 | Intune Androidfotaservice Zebrafotadeployment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotadeployment.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Androidfotaservice Zebrafotadeploymentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotadeploymentsettings.md | Here is a JSON representation of the resource. "batteryRuleMinimumBatteryLevelPercentage": 1024, "batteryRuleRequireCharger": true }-``` +``` |
v1.0 | Intune Androidfotaservice Zebrafotadeploymentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotadeploymentstate.md | Represents the state of Zebra FOTA deployment. |completed|4|Deployment has completed or end date has passed.| |pendingCancel|5|Admin has requested to cancel a deployment but Zebra has not confirmed cancellation.| |canceled|6|Deployment has been successfully canceled by Zebra.|-|unknownFutureValue|99|Unknown future enum value.| +|unknownFutureValue|99|Unknown future enum value.| |
v1.0 | Intune Androidfotaservice Zebrafotadeploymentstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotadeploymentstatus.md | Here is a JSON representation of the resource. "cancelRequested": true, "lastUpdatedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Androidfotaservice Zebrafotaerrorcode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotaerrorcode.md | An error code indicating the failure reason, when the deployment state is create |noZebraFotaEnrolledDevicesFoundInSelectedAadGroups|4|This error indicates that no Zebra FOTA enrolled devices were found in the selected Azure Active Directory (AAD) Groups when creating a deployment. E.g.: a user has enrolled one or more devices in Zebra FOTA, but attempts to create a deployment targeting security groups that don't include any Zebra Devices.| |noZebraFotaDevicesFoundForSelectedDeviceModel|5|This error indicates that no Zebra FOTA devices were found that match the selected device model when creating a deployment. E.g.: a user selects `TC8300` device model, but no Zebra devices with the same device model were found in the targeted Azure Active Directory (AAD) security groups.| |zebraFotaCreateDeploymentRequestFailure|6|This error indicates that an external request to Zebra APIs failed when creating a deployment. The failure can be caused by a transient issue (e.g.: Network is down) or caused by a permanent server error.|-|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Androidfotaservice Zebrafotanetworktype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotanetworktype.md | Represents various network types for Zebra FOTA deployment. |wifi|1|The device will install the update only when connected to WiFi network.| |cellular|2|The device will install the update only when connected a Cellular network.| |wifiAndCellular|3|The device will install the update when connected both WiFi and Cellular.|-|unknownFutureValue|99|Unknown future enum value.| +|unknownFutureValue|99|Unknown future enum value.| |
v1.0 | Intune Androidfotaservice Zebrafotaschedulemode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotaschedulemode.md | Represents various schedule modes for Zebra FOTA deployment. |:|:|:| |installNow|0|Instructs the device to install the update as soon as it is received.| |scheduled|1|Schedule an update to be installed at a specified date and time.|-|unknownFutureValue|99|Unknown future enum value.| +|unknownFutureValue|99|Unknown future enum value.| |
v1.0 | Intune Androidfotaservice Zebrafotaupdatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotaupdatetype.md | Represents various update types for Zebra FOTA deployment. |custom|0|Custom update where the user selects specific BSP, OS version, and patch number to update to.| |latest|1|The latest released update becomes the target OS. Latest may update the device to a new Android version.| |auto|2|The device always looks for the latest package available in the repo and tries to update whenever a new package is available. This continues until the admin cancels the auto update.|-|unknownFutureValue|99|Unknown future enum value.| +|unknownFutureValue|99|Unknown future enum value.| |
v1.0 | Intune App Conceptual | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-app-conceptual.md | Microsoft Intune app protection policies help protect your company data and prev You can use Intune app protection policies to help protect your companyΓÇÖs data. Because Intune app protection policies can be used independent of any mobile-device management (MDM) solution, you can use it to protect your companyΓÇÖs data with or without enrolling devices in a device management solution. By implementing app-level policies, you can restrict access to company resources and keep data within the purview of your IT department. -Use Graph resources to manage app protection polices in Intune. See the table of content for a list of resources. +Use Graph resources to manage app protection polices in Intune. See the table of content for a list of resources. |
v1.0 | Intune Apps Androidforworkapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidforworkapp.md | Here is a JSON representation of the resource. "totalLicenseCount": 1024, "appStoreUrl": "String" }-``` +``` |
v1.0 | Intune Apps Androidforworkmobileappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidforworkmobileappconfiguration.md | Here is a JSON representation of the resource. "profileApplicability": "String", "connectedAppsEnabled": true }-``` +``` |
v1.0 | Intune Apps Androidlobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidlobapp.md | Here is a JSON representation of the resource. "versionCode": "String", "targetedPlatforms": "String" }-``` +``` |
v1.0 | Intune Apps Androidmanagedstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidmanagedstoreapp.md | Here is a JSON representation of the resource. ], "supportsOemConfig": true }-``` +``` |
v1.0 | Intune Apps Androidmanagedstoreappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidmanagedstoreappconfiguration.md | Here is a JSON representation of the resource. "profileApplicability": "String", "connectedAppsEnabled": true }-``` +``` |
v1.0 | Intune Apps Androidmanagedstoreapptrack | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidmanagedstoreapptrack.md | Here is a JSON representation of the resource. "trackId": "String", "trackAlias": "String" }-``` +``` |
v1.0 | Intune Apps Androidmanagedstorewebapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidmanagedstorewebapp.md | Here is a JSON representation of the resource. ], "supportsOemConfig": true }-``` +``` |
v1.0 | Intune Apps Androidminimumoperatingsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidminimumoperatingsystem.md | Here is a JSON representation of the resource. "v10_0": true, "v11_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 | Here is a JSON representation of the resource. "permission": "String", "action": "String" }-``` +``` |
v1.0 | Intune Apps Androidpermissionactiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidpermissionactiontype.md | Android action taken when an app requests a dangerous permission. |:|:|:| |prompt|0|| |autoGrant|1||-|autoDeny|2|| +|autoDeny|2|| |
v1.0 | Intune Apps Androidprofileapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidprofileapplicability.md | Android profile applicability |:|:|:| |default|0|| |androidWorkProfile|1||-|androidDeviceOwner|2|| +|androidDeviceOwner|2|| |
v1.0 | Intune Apps Androidstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidstoreapp.md | Here is a JSON representation of the resource. "v11_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 | Specifies which platform(s) can be targeted for a given Android LOB application |:|:|:| |androidDeviceAdministrator|1|Indicates the Android targeted platform is Android Device Administrator.| |androidOpenSourceProject|2|Indicates the Android targeted platform is Android Open Source Project.|-|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Apps Appconfigurationsettingitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-appconfigurationsettingitem.md | Here is a JSON representation of the resource. "appConfigKeyType": "String", "appConfigKeyValue": "String" }-``` +``` |
v1.0 | Intune Apps Certificatestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-certificatestatus.md | Namespace: microsoft.graph |Member|Value|Description| |:|:|:| |notProvisioned|0||-|provisioned|1|| +|provisioned|1|| |
v1.0 | Intune Apps Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-deviceappmanagement.md | + + Title: "deviceAppManagement resource type" +description: "Singleton entity that acts as a container for all device app management functionality." ++localization_priority: Normal ++++# 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 +|Method|Return Type|Description| +|:|:|:| +|[Get deviceAppManagement](../api/intune-apps-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| +|[Update deviceAppManagement](../api/intune-apps-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|Key of the entity.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|mobileApps|[mobileApp](../resources/intune-shared-mobileapp.md) collection|The mobile apps.| +|mobileAppCategories|[mobileAppCategory](../resources/intune-apps-mobileappcategory.md) collection|The mobile app categories.| +|enterpriseCodeSigningCertificates|[enterpriseCodeSigningCertificate](../resources/intune-apps-enterprisecodesigningcertificate.md) collection|The Windows Enterprise Code Signing Certificate.| +|iosLobAppProvisioningConfigurations|[iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) collection|The IOS Lob App Provisioning Configurations.| +|symantecCodeSigningCertificate|[symantecCodeSigningCertificate](../resources/intune-apps-symanteccodesigningcertificate.md)|The WinPhone Symantec Code Signing Certificate.| +|mobileAppConfigurations|[managedDeviceMobileAppConfiguration](../resources/intune-apps-manageddevicemobileappconfiguration.md) collection|The Managed Device Mobile Application Configurations.| ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.deviceAppManagement" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.deviceAppManagement", + "id": "String (identifier)" +} +``` |
v1.0 | Intune Apps Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-apps-devicemanagement-get.md)|[deviceManagement](../resources/intune-apps-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-apps-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-apps-devicemanagement-update.md)|[deviceManagement](../resources/intune-apps-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-apps-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-apps-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-apps-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Apps Enterprisecodesigningcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-enterprisecodesigningcertificate.md | Here is a JSON representation of the resource. "expirationDateTime": "String (timestamp)", "uploadDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Apps Excludedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-excludedapps.md | Here is a JSON representation of the resource. "visio": true, "word": true }-``` +``` |
v1.0 | Intune Apps Fileencryptioninfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-fileencryptioninfo.md | Here is a JSON representation of the resource. "fileDigest": "binary", "fileDigestAlgorithm": "String" }-``` +``` |
v1.0 | Intune Apps Iosdevicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosdevicetype.md | Here is a JSON representation of the resource. "iPad": true, "iPhoneAndIPod": true }-``` +``` |
v1.0 | Intune Apps Iosipadoswebclip | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosipadoswebclip.md | Here is a JSON representation of the resource. "preComposedIconEnabled": true, "ignoreManifestScope": true }-``` +``` |
v1.0 | Intune Apps Ioslobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-ioslobapp.md | Here is a JSON representation of the resource. "versionNumber": "String", "buildNumber": "String" }-``` +``` |
v1.0 | Intune Apps Ioslobappprovisioningconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-ioslobappprovisioningconfiguration.md | This topic provides descriptions of the declared methods, properties and relatio ## Methods |Method|Return Type|Description| |:|:|:|-|[List iosLobAppProvisioningConfigurations](../api/intune-apps-ioslobappprovisioningconfiguration-list.md)|[iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) collection|List properties and relationships of the [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) objects.| -|[Get iosLobAppProvisioningConfiguration](../api/intune-apps-ioslobappprovisioningconfiguration-get.md)|[iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md)|Read properties and relationships of the [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) object.| -|[Create iosLobAppProvisioningConfiguration](../api/intune-apps-ioslobappprovisioningconfiguration-create.md)|[iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md)|Create a new [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) object.| -|[Delete iosLobAppProvisioningConfiguration](../api/intune-apps-ioslobappprovisioningconfiguration-delete.md)|None|Deletes a [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md).| -|[Update iosLobAppProvisioningConfiguration](../api/intune-apps-ioslobappprovisioningconfiguration-update.md)|[iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md)|Update the properties of a [iosLobAppProvisioningConfiguration](../resources/intune-apps-ioslobappprovisioningconfiguration.md) object.| +|[List iosLobAppProvisioningConfigurations](../api/intune-apps-ioslobappprovisioningconfiguration-list.md)|[iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) collection|List properties and relationships of the [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) objects.| +|[Get iosLobAppProvisioningConfiguration](../api/intune-apps-ioslobappprovisioningconfiguration-get.md)|[iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md)|Read properties and relationships of the [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) object.| +|[Create iosLobAppProvisioningConfiguration](../api/intune-apps-ioslobappprovisioningconfiguration-create.md)|[iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md)|Create a new [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) object.| +|[Delete iosLobAppProvisioningConfiguration](../api/intune-apps-ioslobappprovisioningconfiguration-delete.md)|None|Deletes a [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md).| +|[Update iosLobAppProvisioningConfiguration](../api/intune-apps-ioslobappprovisioningconfiguration-update.md)|[iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md)|Update the properties of a [iosLobAppProvisioningConfiguration](../resources/intune-shared-ioslobappprovisioningconfiguration.md) object.| |[assign action](../api/intune-apps-ioslobappprovisioningconfiguration-assign.md)|None|| ## Properties Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Apps Ioslobappprovisioningconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-ioslobappprovisioningconfigurationassignment.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterType": "String" } }-``` +``` |
v1.0 | Intune Apps Iosminimumoperatingsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosminimumoperatingsystem.md | Here is a JSON representation of the resource. "v16_0": true, "v17_0": true }-``` +``` |
v1.0 | Intune Apps Iosmobileappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosmobileappconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Apps Iosstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosstoreapp.md | Here is a JSON representation of the resource. "v17_0": true } }-``` +``` |
v1.0 | Intune Apps Iosvppapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosvppapp.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Apps Iosvppappassigneddevicelicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosvppappassigneddevicelicense.md | Here is a JSON representation of the resource. "managedDeviceId": "String", "deviceName": "String" }-``` +``` |
v1.0 | Intune Apps Iosvppappassignedlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosvppappassignedlicense.md | Here is a JSON representation of the resource. "userName": "String", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Apps Iosvppappassigneduserlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosvppappassigneduserlicense.md | Here is a JSON representation of the resource. "userName": "String", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Apps Iosvppapprevokelicensesactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosvppapprevokelicensesactionresult.md | Here is a JSON representation of the resource. "startDateTime": "String (timestamp)", "lastUpdatedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Apps Macosappscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosappscript.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.macOSAppScript", "scriptContent": "String" }-``` +``` |
v1.0 | Intune Apps Macosdmgapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosdmgapp.md | Here is a JSON representation of the resource. "v14_0": true } }-``` +``` |
v1.0 | Intune Apps Macosincludedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosincludedapp.md | Here is a JSON representation of the resource. "bundleId": "String", "bundleVersion": "String" }-``` +``` |
v1.0 | Intune Apps Macoslobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macoslobapp.md | Here is a JSON representation of the resource. "ignoreVersionDetection": true, "installAsManaged": true }-``` +``` |
v1.0 | Intune Apps Macoslobappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macoslobappassignmentsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.macOsLobAppAssignmentSettings", "uninstallOnDeviceRemoval": true }-``` +``` |
v1.0 | Intune Apps Macoslobchildapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macoslobchildapp.md | Here is a JSON representation of the resource. "buildNumber": "String", "versionNumber": "String" }-``` +``` |
v1.0 | Intune Apps Macosmdatpapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosmdatpapp.md | Here is a JSON representation of the resource. "supersedingAppCount": 1024, "supersededAppCount": 1024 }-``` +``` |
v1.0 | Intune Apps Macosmicrosoftdefenderapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosmicrosoftdefenderapp.md | Here is a JSON representation of the resource. "supersedingAppCount": 1024, "supersededAppCount": 1024 }-``` +``` |
v1.0 | Intune Apps Macosmicrosoftedgeapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosmicrosoftedgeapp.md | Here is a JSON representation of the resource. "supersededAppCount": 1024, "channel": "String" }-``` +``` |
v1.0 | Intune Apps Macosminimumoperatingsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosminimumoperatingsystem.md | Here is a JSON representation of the resource. "v13_0": true, "v14_0": true }-``` +``` |
v1.0 | Intune Apps Macosofficesuiteapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosofficesuiteapp.md | Here is a JSON representation of the resource. "supersedingAppCount": 1024, "supersededAppCount": 1024 }-``` +``` |
v1.0 | Intune Apps Macospkgapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macospkgapp.md | Here is a JSON representation of the resource. "scriptContent": "String" } }-``` +``` |
v1.0 | Intune Apps Macosvppapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosvppapp.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Apps Macosvppappassignedlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosvppappassignedlicense.md | Here is a JSON representation of the resource. "userName": "String", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Apps Macosvppappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosvppappassignmentsettings.md | Here is a JSON representation of the resource. "preventManagedAppBackup": true, "preventAutoAppUpdate": true }-``` +``` |
v1.0 | Intune Apps Macosvppapprevokelicensesactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosvppapprevokelicensesactionresult.md | Here is a JSON representation of the resource. "startDateTime": "String (timestamp)", "lastUpdatedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Apps Macoswebclip | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macoswebclip.md | Here is a JSON representation of the resource. "fullScreenEnabled": true, "preComposedIconEnabled": true }-``` +``` |
v1.0 | Intune Apps Managedandroidlobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedandroidlobapp.md | Here is a JSON representation of the resource. "versionCode": "String", "targetedPlatforms": "String" }-``` +``` |
v1.0 | Intune Apps Managedandroidstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedandroidstoreapp.md | Here is a JSON representation of the resource. "v11_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 | Here is a JSON representation of the resource. "appAvailability": "String", "version": "String" }-``` +``` |
v1.0 | Intune Apps Managedappavailability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedappavailability.md | A managed (MAM) application's availability. |Member|Value|Description| |:|:|:| |global|0|A globally available app to all tenants.|-|lineOfBusiness|1|A line of business apps private to an organization.| +|lineOfBusiness|1|A line of business apps private to an organization.| |
v1.0 | Intune Apps Manageddevicemobileappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfiguration.md | Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Apps Manageddevicemobileappconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfigurationassignment.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterType": "String" } }-``` +``` |
v1.0 | Intune Apps Manageddevicemobileappconfigurationdevicestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfigurationdevicestatus.md | Here is a JSON representation of the resource. "lastReportedDateTime": "String (timestamp)", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Apps Manageddevicemobileappconfigurationdevicesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfigurationdevicesummary.md | Here is a JSON representation of the resource. "lastUpdateDateTime": "String (timestamp)", "configurationVersion": 1024 }-``` +``` |
v1.0 | Intune Apps Manageddevicemobileappconfigurationuserstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfigurationuserstatus.md | Here is a JSON representation of the resource. "lastReportedDateTime": "String (timestamp)", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Apps Manageddevicemobileappconfigurationusersummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfigurationusersummary.md | Here is a JSON representation of the resource. "lastUpdateDateTime": "String (timestamp)", "configurationVersion": 1024 }-``` +``` |
v1.0 | Intune Apps Managedioslobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedioslobapp.md | Here is a JSON representation of the resource. "buildNumber": "String", "identityVersion": "String" }-``` +``` |
v1.0 | Intune Apps Managediosstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managediosstoreapp.md | Here is a JSON representation of the resource. "v17_0": true } }-``` +``` |
v1.0 | Intune Apps Managedmobilelobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedmobilelobapp.md | Here is a JSON representation of the resource. "fileName": "String", "size": 1024 }-``` +``` |
v1.0 | Intune Apps Mdmappconfigkeytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mdmappconfigkeytype.md | App configuration key types. |integerType|1|| |realType|2|| |booleanType|3||-|tokenType|4|| +|tokenType|4|| |
v1.0 | Intune Apps Microsoftedgechannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-microsoftedgechannel.md | The enum to specify the channels for Microsoft Edge apps. |dev|0|The Dev Channel is intended to help you plan and develop with the latest capabilities of Microsoft Edge.| |beta|1|The Beta Channel is intended for production deployment to a representative sample set of users. New features ship about every 4 weeks. Security and quality updates ship as needed.| |stable|2|The Stable Channel is intended for broad deployment within organizations, and it's the channel that most users should be on. New features ship about every 4 weeks. Security and quality updates ship as needed.|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Apps Microsoftstoreforbusinessapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-microsoftstoreforbusinessapp.md | Here is a JSON representation of the resource. "supportsDeviceLicensing": true } }-``` +``` |
v1.0 | Intune Apps Microsoftstoreforbusinesscontainedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-microsoftstoreforbusinesscontainedapp.md | Here is a JSON representation of the resource. "id": "String (identifier)", "appUserModelId": "String" }-``` +``` |
v1.0 | Intune Apps Microsoftstoreforbusinesslicensetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-microsoftstoreforbusinesslicensetype.md | Namespace: microsoft.graph |Member|Value|Description| |:|:|:| |offline|0||-|online|1|| +|online|1|| |
v1.0 | Intune Apps Mobileapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapp.md | An abstract class containing the base properties for Intune mobile apps. Note: L ## Methods |Method|Return Type|Description| |:|:|:|-|[List mobileApps](../api/intune-apps-mobileapp-list.md)|[mobileApp](../resources/intune-apps-mobileapp.md) collection|List properties and relationships of the [mobileApp](../resources/intune-apps-mobileapp.md) objects.| -|[Get mobileApp](../api/intune-apps-mobileapp-get.md)|[mobileApp](../resources/intune-apps-mobileapp.md)|Read properties and relationships of the [mobileApp](../resources/intune-apps-mobileapp.md) object.| +|[List mobileApps](../api/intune-apps-mobileapp-list.md)|[mobileApp](../resources/intune-shared-mobileapp.md) collection|List properties and relationships of the [mobileApp](../resources/intune-shared-mobileapp.md) objects.| +|[Get mobileApp](../api/intune-apps-mobileapp-get.md)|[mobileApp](../resources/intune-shared-mobileapp.md)|Read properties and relationships of the [mobileApp](../resources/intune-shared-mobileapp.md) object.| |[assign action](../api/intune-apps-mobileapp-assign.md)|None|| |[validateXml action](../api/intune-apps-mobileapp-validatexml.md)|String||-|[convertMobileAppCatalogPackageToMobileApp function](../api/intune-apps-mobileapp-convertmobileappcatalogpackagetomobileapp.md)|[mobileApp](../resources/intune-apps-mobileapp.md)|| -|[createCatalogApp action](../api/intune-apps-mobileapp-createcatalogapp.md)|[mobileApp](../resources/intune-apps-mobileapp.md)|| -|[convertFromMobileAppCatalogPackage function](../api/intune-apps-mobileapp-convertfrommobileappcatalogpackage.md)|[mobileApp](../resources/intune-apps-mobileapp.md)|| +|[createCatalogApp action](../api/intune-apps-mobileapp-createcatalogapp.md)|[mobileApp](../resources/intune-shared-mobileapp.md)|| +|[convertFromMobileAppCatalogPackage function](../api/intune-apps-mobileapp-convertfrommobileappcatalogpackage.md)|[mobileApp](../resources/intune-shared-mobileapp.md)|| |[updateRelationships action](../api/intune-apps-mobileapp-updaterelationships.md)|None|| |[getPublishingConstraints function](../api/intune-apps-mobileapp-getpublishingconstraints.md)|[mobileAppPublishingConstraints](../resources/intune-apps-mobileapppublishingconstraints.md)|| Here is a JSON representation of the resource. "supersedingAppCount": 1024, "supersededAppCount": 1024 }-``` +``` |
v1.0 | Intune Apps Mobileappassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappassignment.md | Here is a JSON representation of the resource. "source": "String", "sourceId": "String" }-``` +``` |
v1.0 | Intune Apps Mobileappcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappcategory.md | Here is a JSON representation of the resource. "displayName": "String", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Apps Mobileappcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappcontent.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.mobileAppContent", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Apps Mobileappcontentfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappcontentfile.md | Here is a JSON representation of the resource. "isFrameworkFile": true, "isDependency": true }-``` +``` |
v1.0 | Intune Apps Mobileappcontentfileuploadstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappcontentfileuploadstate.md | Contains properties for upload request states. |commitFileSuccess|300|| |commitFilePending|301|| |commitFileFailed|302||-|commitFileTimedOut|303|| +|commitFileTimedOut|303|| |
v1.0 | Intune Apps Mobileappdependency | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappdependency.md | Here is a JSON representation of the resource. "dependentAppCount": 1024, "dependsOnAppCount": 1024 }-``` +``` |
v1.0 | Intune Apps Mobileappdependencytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappdependencytype.md | Indicates the dependency type associated with a relationship between two mobile |Member|Value|Description| |:|:|:| |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.| +|autoInstall|1|Indicates that the child app should be installed before installing the parent app.| |
v1.0 | Intune Apps Mobileappinstallstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappinstallstatus.md | Contains properties for the installation state of a mobile app for a device. Thi |deviceName|String|Device name| |deviceId|String|Device ID| |lastSyncDateTime|DateTimeOffset|Last sync date time|-|mobileAppInstallStatusValue|[resultantAppState](../resources/intune-apps-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| -|installState|[resultantAppState](../resources/intune-apps-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| +|mobileAppInstallStatusValue|[resultantAppState](../resources/intune-shared-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| +|installState|[resultantAppState](../resources/intune-shared-resultantappstate.md)|The install state of the app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| |installStateDetail|[resultantAppStateDetail](../resources/intune-apps-resultantappstatedetail.md)|The install state detail of the app. Possible values are: `noAdditionalDetails`, `dependencyFailedToInstall`, `dependencyWithRequirementsNotMet`, `dependencyPendingReboot`, `dependencyWithAutoInstallDisabled`, `supersededAppUninstallFailed`, `supersededAppUninstallPendingReboot`, `removingSupersededApps`, `iosAppStoreUpdateFailedToInstall`, `vppAppHasUpdateAvailable`, `userRejectedUpdate`, `uninstallPendingReboot`, `supersedingAppsDetected`, `supersededAppsDetected`, `seeInstallErrorCode`, `autoInstallDisabled`, `managedAppNoLongerPresent`, `userRejectedInstall`, `userIsNotLoggedIntoAppStore`, `untargetedSupersedingAppsDetected`, `appRemovedBySupersedence`, `seeUninstallErrorCode`, `pendingReboot`, `installingDependencies`, `contentDownloaded`, `supersedingAppsNotApplicable`, `powerShellScriptRequirementNotMet`, `registryRequirementNotMet`, `fileSystemRequirementNotMet`, `platformNotApplicable`, `minimumCpuSpeedNotMet`, `minimumLogicalProcessorCountNotMet`, `minimumPhysicalMemoryNotMet`, `minimumOsVersionNotMet`, `minimumDiskSpaceNotMet`, `processorArchitectureNotApplicable`.| |errorCode|Int32|The error code for install or uninstall failures.| |osVersion|String|OS Version| Here is a JSON representation of the resource. "userPrincipalName": "String", "displayVersion": "String" }-``` +``` |
v1.0 | Intune Apps Mobileappinstallsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappinstallsummary.md | Here is a JSON representation of the resource. "notInstalledUserCount": 1024, "pendingInstallUserCount": 1024 }-``` +``` |
v1.0 | Intune Apps Mobileappprovisioningconfiggroupassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappprovisioningconfiggroupassignment.md | Here is a JSON representation of the resource. "targetGroupId": "String", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Apps Mobileapppublishingconstraints | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapppublishingconstraints.md | Here is a JSON representation of the resource. "maxContentFileSizeInBytes": 1024 } }-``` +``` |
v1.0 | Intune Apps Mobileapppublishingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapppublishingstate.md | Indicates the publishing state of an app. |:|:|:| |notPublished|0|The app is not yet published.| |processing|1|The app is pending service-side processing.|-|published|2|The app is published.| +|published|2|The app is published.| |
v1.0 | Intune Apps Mobileapprelationship | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapprelationship.md | Here is a JSON representation of the resource. "targetPublisher": "String", "targetType": "String" }-``` +``` |
v1.0 | Intune Apps Mobileapprelationshipstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapprelationshipstate.md | Describes the installation status details of the child app in the context of UPN |targetId|String|The related target app's id.| |targetDisplayName|String|The related target app's display name.| |deviceId|String|The corresponding device id.|-|installState|[resultantAppState](../resources/intune-apps-resultantappstate.md)|The install state of the app of target app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| +|installState|[resultantAppState](../resources/intune-shared-resultantappstate.md)|The install state of the app of target app. Possible values are: `installed`, `failed`, `notInstalled`, `uninstallFailed`, `pendingInstall`, `unknown`, `notApplicable`.| |installStateDetail|[resultantAppStateDetail](../resources/intune-apps-resultantappstatedetail.md)|The install state detail of the app. Possible values are: `noAdditionalDetails`, `dependencyFailedToInstall`, `dependencyWithRequirementsNotMet`, `dependencyPendingReboot`, `dependencyWithAutoInstallDisabled`, `supersededAppUninstallFailed`, `supersededAppUninstallPendingReboot`, `removingSupersededApps`, `iosAppStoreUpdateFailedToInstall`, `vppAppHasUpdateAvailable`, `userRejectedUpdate`, `uninstallPendingReboot`, `supersedingAppsDetected`, `supersededAppsDetected`, `seeInstallErrorCode`, `autoInstallDisabled`, `managedAppNoLongerPresent`, `userRejectedInstall`, `userIsNotLoggedIntoAppStore`, `untargetedSupersedingAppsDetected`, `appRemovedBySupersedence`, `seeUninstallErrorCode`, `pendingReboot`, `installingDependencies`, `contentDownloaded`, `supersedingAppsNotApplicable`, `powerShellScriptRequirementNotMet`, `registryRequirementNotMet`, `fileSystemRequirementNotMet`, `platformNotApplicable`, `minimumCpuSpeedNotMet`, `minimumLogicalProcessorCountNotMet`, `minimumPhysicalMemoryNotMet`, `minimumOsVersionNotMet`, `minimumDiskSpaceNotMet`, `processorArchitectureNotApplicable`.| |errorCode|Int32|The error code for install or uninstall failures of target app.| |targetLastSyncDateTime|DateTimeOffset|The last sync time of the target app.| Here is a JSON representation of the resource. "errorCode": 1024, "targetLastSyncDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Apps Mobileapprelationshiptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapprelationshiptype.md | Indicates whether the target of a relationship is the parent or the child in the |Member|Value|Description| |:|:|:| |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.| +|parent|1|Indicates that the target of a relationship is the parent in the relationship.| |
v1.0 | Intune Apps Mobileappsupersedence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappsupersedence.md | Here is a JSON representation of the resource. "supersededAppCount": 1024, "supersedingAppCount": 1024 }-``` +``` |
v1.0 | Intune Apps Mobileappsupersedencetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappsupersedencetype.md | Indicates the supersedence type associated with a relationship between two mobil |Member|Value|Description| |:|:|:| |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.| +|replace|1|Indicates that the child app should be uninstalled before installing the parent app.| |
v1.0 | Intune Apps Mobilecontainedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobilecontainedapp.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.mobileContainedApp", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Apps Mobilelobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobilelobapp.md | Here is a JSON representation of the resource. "fileName": "String", "size": 1024 }-``` +``` |
v1.0 | Intune Apps Officeproductid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-officeproductid.md | The Enum to specify the Office365 ProductIds that represent the Office365 Suite |o365ProPlusRetail|0|| |o365BusinessRetail|1|| |visioProRetail|2||-|projectProRetail|3|| +|projectProRetail|3|| |
v1.0 | Intune Apps Officesuiteapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-officesuiteapp.md | Here is a JSON representation of the resource. "updateVersion": "String", "officeConfigurationXml": "binary" }-``` +``` |
v1.0 | Intune Apps Officesuitedefaultfileformattype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-officesuitedefaultfileformattype.md | Describes the OfficeSuiteApp file format types that can be selected. |notConfigured|0|No file format selected| |officeOpenXMLFormat|1|Office Open XML Format selected| |officeOpenDocumentFormat|2|Office Open Document Format selected|-|unknownFutureValue|99|Placeholder for evolvable enum.| +|unknownFutureValue|99|Placeholder for evolvable enum.| |
v1.0 | Intune Apps Officesuiteinstallprogressdisplaylevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-officesuiteinstallprogressdisplaylevel.md | The Enum to specify the level of display for the Installation Progress Setup UI |Member|Value|Description| |:|:|:| |none|0||-|full|1|| +|full|1|| |
v1.0 | Intune Apps Officeupdatechannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-officeupdatechannel.md | The Enum to specify the Office365 Updates Channel. |deferred|2|| |firstReleaseCurrent|3|| |firstReleaseDeferred|4||-|monthlyEnterprise|5|| +|monthlyEnterprise|5|| |
v1.0 | Intune Apps Resultantappstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-resultantappstate.md | A list of possible states for application status on an individual device. When d |uninstallFailed|4|The application failed to uninstall.| |pendingInstall|5|The installation of the application is in progress.| |unknown|99|The status of the application is unknown.|-|notApplicable|-1|The application is not applicable.| +|notApplicable|-1|The application is not applicable.| |
v1.0 | Intune Apps Resultantappstatedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-resultantappstatedetail.md | Enum indicating additional details regarding why an application has a particular |minimumPhysicalMemoryNotMet|-1003|Amount of RAM on the target device is less than the configured minimum.| |minimumOsVersionNotMet|-1002|OS version on the target device is less than the configured minimum.| |minimumDiskSpaceNotMet|-1001|Available disk space on the target device is less than the configured minimum.|-|processorArchitectureNotApplicable|-1000|Device architecture (e.g. x86/amd64) is not applicable for the application.| +|processorArchitectureNotApplicable|-1000|Device architecture (e.g. x86/amd64) is not applicable for the application.| |
v1.0 | Intune Apps Runasaccounttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-runasaccounttype.md | Indicates the type of execution context the app runs in. |Member|Value|Description| |:|:|:| |system|0|System context|-|user|1|User context| +|user|1|User context| |
v1.0 | Intune Apps Symanteccodesigningcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-symanteccodesigningcertificate.md | Here is a JSON representation of the resource. "expirationDateTime": "String (timestamp)", "uploadDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Apps Userappinstallstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-userappinstallstatus.md | Here is a JSON representation of the resource. "failedDeviceCount": 1024, "notInstalledDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Apps Vpplicensingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-vpplicensingtype.md | Here is a JSON representation of the resource. "supportsUserLicensing": true, "supportsDeviceLicensing": true }-``` +``` |
v1.0 | Intune Apps Webapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-webapp.md | Here is a JSON representation of the resource. "appUrl": "String", "useManagedBrowser": true }-``` +``` |
v1.0 | Intune Apps Win32lobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapp.md | Here is a JSON representation of the resource. "displayVersion": "String", "allowAvailableUninstall": true }-``` +``` |
v1.0 | Intune Apps Win32lobappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappassignmentsettings.md | Inherits from [mobileAppAssignmentSettings](../resources/intune-shared-mobileapp |restartSettings|[win32LobAppRestartSettings](../resources/intune-shared-win32lobapprestartsettings.md)|The reboot settings to apply for this app assignment.| |installTimeSettings|[mobileAppInstallTimeSettings](../resources/intune-shared-mobileappinstalltimesettings.md)|The install time settings to apply for this app assignment.| |deliveryOptimizationPriority|[win32LobAppDeliveryOptimizationPriority](../resources/intune-shared-win32lobappdeliveryoptimizationpriority.md)|The delivery optimization priority for this app assignment. This setting is not supported in National Cloud environments. Possible values are: `notConfigured`, `foreground`.|-|autoUpdateSettings|[win32LobAppAutoUpdateSettings](../resources/intune-apps-win32lobappautoupdatesettings.md)|The auto-update settings to apply for this app assignment.| +|autoUpdateSettings|[win32LobAppAutoUpdateSettings](../resources/intune-shared-win32lobappautoupdatesettings.md)|The auto-update settings to apply for this app assignment.| ## Relationships None Here is a JSON representation of the resource. "deliveryOptimizationPriority": "String", "autoUpdateSettings": { "@odata.type": "microsoft.graph.win32LobAppAutoUpdateSettings",- "autoUpdateSupersededApps": "String" + "autoUpdateSupersededApps": "String", + "autoUpdateSupersededAppsState": "String" } }-``` +``` |
v1.0 | Intune Apps Win32lobappautoupdatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappautoupdatesettings.md | Contains properties used to perform the auto-update of an application. ## Properties |Property|Type|Description| |:|:|:|-|autoUpdateSupersededApps|[win32LobAppAutoUpdateSupersededApps](../resources/intune-apps-win32lobappautoupdatesupersededapps.md)|The auto-update superseded apps setting for the app assignment. Possible values are notConfigured and enabled. Default value is notConfigured. Possible values are: `notConfigured`, `enabled`, `unknownFutureValue`.| +|autoUpdateSupersededApps|[win32LobAppAutoUpdateSupersededApps](../resources/intune-shared-win32lobappautoupdatesupersededapps.md)|The auto-update superseded apps setting for the app assignment. Possible values are notConfigured and enabled. Default value is notConfigured. Starting from April, 2024 (Intune Release 2404), this property will no longer be supported and will be marked as deprecated. Possible values are: `notConfigured`, `enabled`, `unknownFutureValue`.| +|autoUpdateSupersededAppsState|[win32LobAutoUpdateSupersededAppsState](../resources/intune-apps-win32lobautoupdatesupersededappsstate.md)|The auto-update superseded apps state setting for the app assignment. Possible values are notConfigured and enabled. Default value is notConfigured. Possible values are: `notConfigured`, `enabled`, `unknownFutureValue`.| ## Relationships None Here is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.win32LobAppAutoUpdateSettings",- "autoUpdateSupersededApps": "String" + "autoUpdateSupersededApps": "String", + "autoUpdateSupersededAppsState": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappautoupdatesupersededapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappautoupdatesupersededapps.md | Contains value for auto-update superseded apps. |:|:|:| |notConfigured|0|Indicates that the auto-update superseded apps is not configured and the app will not auto-update the superseded apps.| |enabled|1|Indicates that the auto-update superseded apps is enabled and the app will auto-update the superseded apps if the superseded apps are installed on the device.|-|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Apps Win32lobappdetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappdetection.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.win32LobAppDetection" }-``` +``` |
v1.0 | Intune Apps Win32lobappdetectionoperator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappdetectionoperator.md | Contains properties for detection operator. |greaterThan|4|Greater than operator.| |greaterThanOrEqual|5|Greater than or equal operator.| |lessThan|8|Less than operator.|-|lessThanOrEqual|9|Less than or equal operator.| +|lessThanOrEqual|9|Less than or equal operator.| |
v1.0 | Intune Apps Win32lobappfilesystemdetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappfilesystemdetection.md | Here is a JSON representation of the resource. "operator": "String", "detectionValue": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappfilesystemdetectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappfilesystemdetectiontype.md | Contains all supported file system detection type. |createdDate|3|Created date.| |version|4|Version value type.| |sizeInMB|5|Size detection type.|-|doesNotExist|6|The specified file or folder does not exist.| +|doesNotExist|6|The specified file or folder does not exist.| |
v1.0 | Intune Apps Win32lobappfilesystemoperationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappfilesystemoperationtype.md | A list of possible operations for rules used to make determinations about an app |doesNotExist|6|Indicates that the rule evaluates whether the specified file or folder does not exist. It is the functional inverse of an equivalent rule that uses operation type `exists`.| |sizeInBytes|7|Indicates that the rule compares the size of the file in bytes against a provided comparison value by integer comparison.| |appVersion|8|Indicates that the rule compares the detected version of the file against a provided comparison value via version semantics (both operand values will be parsed as versions and directly compared). If the detected version of the file is not discovered to be in version-compatible format, a string comparison will be used instead. This is similar to a rule with operation type `version`, but it also collects and reports the detected version value to report as the discovered version of the app installed on the device when the rule evaluates to `true`. Only one rule with this type may be specified.|-|unknownFutureValue|9|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|9|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Apps Win32lobappfilesystemrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappfilesystemrequirement.md | Here is a JSON representation of the resource. "check32BitOn64System": true, "detectionType": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappfilesystemrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappfilesystemrule.md | Here is a JSON representation of the resource. "operator": "String", "comparisonValue": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappinstallexperience | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappinstallexperience.md | Here is a JSON representation of the resource. "maxRunTimeInMinutes": 1024, "deviceRestartBehavior": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappmsiinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappmsiinformation.md | Here is a JSON representation of the resource. "productName": "String", "publisher": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappmsipackagetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappmsipackagetype.md | Indicates the package type of an MSI Win32LobApp. |:|:|:| |perMachine|0|Indicates a per-machine app package.| |perUser|1|Indicates a per-user app package.|-|dualPurpose|2|Indicates a dual-purpose app package.| +|dualPurpose|2|Indicates a dual-purpose app package.| |
v1.0 | Intune Apps Win32lobapppowershellscriptdetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppowershellscriptdetection.md | Here is a JSON representation of the resource. "runAs32Bit": true, "scriptContent": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobapppowershellscriptdetectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppowershellscriptdetectiontype.md | Contains all supported Powershell Script output detection type. |integer|3|Output data type is integer.| |float|4|Output data type is float.| |version|5|Output data type is version.|-|boolean|6|Output data type is boolean.| +|boolean|6|Output data type is boolean.| |
v1.0 | Intune Apps Win32lobapppowershellscriptrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppowershellscriptrequirement.md | Here is a JSON representation of the resource. "scriptContent": "String", "detectionType": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobapppowershellscriptrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppowershellscriptrule.md | Here is a JSON representation of the resource. "operator": "String", "comparisonValue": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobapppowershellscriptruleoperationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppowershellscriptruleoperationtype.md | Contains all supported Powershell Script output detection type. |integer|3|Output data type is integer.| |float|4|Output data type is float.| |version|5|Output data type is version.|-|boolean|6|Output data type is boolean.| +|boolean|6|Output data type is boolean.| |
v1.0 | Intune Apps Win32lobappproductcodedetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappproductcodedetection.md | Here is a JSON representation of the resource. "productVersionOperator": "String", "productVersion": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappproductcoderule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappproductcoderule.md | Here is a JSON representation of the resource. "productVersionOperator": "String", "productVersion": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobapppublishingconstraints | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppublishingconstraints.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.win32LobAppPublishingConstraints", "maxContentFileSizeInBytes": 1024 }-``` +``` |
v1.0 | Intune Apps Win32lobappregistrydetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappregistrydetection.md | Here is a JSON representation of the resource. "operator": "String", "detectionValue": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappregistrydetectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappregistrydetectiontype.md | Contains all supported registry data detection type. |doesNotExist|2|The specified registry key or value does not exist.| |string|3|String value type.| |integer|4|Integer value type.|-|version|5|Version value type.| +|version|5|Version value type.| |
v1.0 | Intune Apps Win32lobappregistryrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappregistryrequirement.md | Here is a JSON representation of the resource. "valueName": "String", "detectionType": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappregistryrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappregistryrule.md | Here is a JSON representation of the resource. "operator": "String", "comparisonValue": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappregistryruleoperationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappregistryruleoperationtype.md | A list of possible operations for rules used to make determinations about an app |integer|4|Indicates that the rule compares the value read at the given registry value against a provided comparison value by integer comparison.| |version|5|Indicates that the rule compares the value read at the given registry value against a provided comparison value via version semantics (both operand values will be parsed as versions and directly compared). If the value read at the given registry value is not discovered to be in version-compatible format, a string comparison will be used instead.| |appVersion|7|Indicates that the rule compares the data read at the given registry value against a provided comparison value via version semantics (both operand values will be parsed as versions and directly compared). If the data read at the given registry value is not discovered to be in a version-compatible format, a string comparison will be used instead. The rule will be resolved as not detected if the given registry value does not exist. This is similar to a rule with operation type `version`, but it also collects and reports the detected version value to report as the discovered version of the app installed on the device when the rule evaluates to `true`. Only one rule with this type may be specified.|-|unknownFutureValue|8|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|8|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Apps Win32lobapprequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapprequirement.md | Here is a JSON representation of the resource. "operator": "String", "detectionValue": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobapprestartbehavior | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapprestartbehavior.md | Indicates the type of restart action. |basedOnReturnCode|0|Intune will restart the device after running the app installation if the operation returns a reboot code.| |allow|1|Intune will not take any specific action on reboot codes resulting from app installations. Intune will not attempt to suppress restarts for MSI apps.| |suppress|2|Intune will attempt to suppress restarts for MSI apps.|-|force|3|Intune will force the device to restart immediately after the app installation operation.| +|force|3|Intune will force the device to restart immediately after the app installation operation.| |
v1.0 | Intune Apps Win32lobappreturncode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappreturncode.md | Here is a JSON representation of the resource. "returnCode": 1024, "type": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappreturncodetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappreturncodetype.md | Indicates the type of return code. |success|1|Success.| |softReboot|2|Soft-reboot is required.| |hardReboot|3|Hard-reboot is required.|-|retry|4|Retry.| +|retry|4|Retry.| |
v1.0 | Intune Apps Win32lobapprule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapprule.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.win32LobAppRule", "ruleType": "String" }-``` +``` |
v1.0 | Intune Apps Win32lobappruleoperator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappruleoperator.md | Contains properties for detection operator. |greaterThan|4|Greater than operator.| |greaterThanOrEqual|5|Greater than or equal operator.| |lessThan|8|Less than operator.|-|lessThanOrEqual|9|Less than or equal operator.| +|lessThanOrEqual|9|Less than or equal operator.| |
v1.0 | Intune Apps Win32lobappruletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappruletype.md | Contains rule types for Win32 LOB apps. |Member|Value|Description| |:|:|:| |detection|0|Detection rule.|-|requirement|1|Requirement rule.| +|requirement|1|Requirement rule.| |
v1.0 | Intune Apps Win32lobautoupdatesupersededappsstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobautoupdatesupersededappsstate.md | + + Title: "win32LobAutoUpdateSupersededAppsState enum type" +description: "Contains value for auto-update superseded apps." ++localization_priority: Normal ++++# 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 +|Member|Value|Description| +|:|:|:| +|notConfigured|0|Indicates that the auto-update superseded apps state is not configured and the app will not auto-update the superseded apps.| +|enabled|1|Indicates that the auto-update superseded apps state is enabled and the app will auto-update the superseded apps if the superseded apps are installed on the device.| +|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Apps Windowsappx | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsappx.md | Here is a JSON representation of the resource. }, "identityVersion": "String" }-``` +``` |
v1.0 | Intune Apps Windowsappxappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsappxappassignmentsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsAppXAppAssignmentSettings", "useDeviceContext": true }-``` +``` |
v1.0 | Intune Apps Windowsarchitecture | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsarchitecture.md | Contains properties for Windows architecture. |x64|2|Whether or not the X64 Windows architecture type is supported.| |arm|4|Whether or not the Arm Windows architecture type is supported.| |neutral|8|Whether or not the Neutral Windows architecture type is supported.|-|arm64|16|Whether or not the Arm64 Windows architecture type is supported.| +|arm64|16|Whether or not the Arm64 Windows architecture type is supported.| |
v1.0 | Intune Apps Windowsdevicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsdevicetype.md | Contains properties for Windows device type. Multiple values can be selected. De |mobile|2|Indicates support for Mobile Windows device type.| |holographic|4|Indicates support for Holographic Windows device type.| |team|8|Indicates support for Team Windows device type.|-|unknownFutureValue|16|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|16|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Apps Windowsmicrosoftedgeapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsmicrosoftedgeapp.md | Here is a JSON representation of the resource. "channel": "String", "displayLanguageLocale": "String" }-``` +``` |
v1.0 | Intune Apps Windowsminimumoperatingsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsminimumoperatingsystem.md | Here is a JSON representation of the resource. "v10_2H20": true, "v10_21H1": true }-``` +``` |
v1.0 | Intune Apps Windowsmobilemsi | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsmobilemsi.md | Here is a JSON representation of the resource. "identityVersion": "String", "useDeviceContext": true }-``` +``` |
v1.0 | Intune Apps Windowspackageinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowspackageinformation.md | Here is a JSON representation of the resource. "v10_21H1": true } }-``` +``` |
v1.0 | Intune Apps Windowsphone81appx | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsphone81appx.md | Here is a JSON representation of the resource. "phonePublisherId": "String", "identityVersion": "String" }-``` +``` |
v1.0 | Intune Apps Windowsphone81appxbundle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsphone81appxbundle.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Apps Windowsphone81storeapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsphone81storeapp.md | Here is a JSON representation of the resource. "supersededAppCount": 1024, "appStoreUrl": "String" }-``` +``` |
v1.0 | Intune Apps Windowsphonexap | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsphonexap.md | Here is a JSON representation of the resource. "productIdentifier": "String", "identityVersion": "String" }-``` +``` |
v1.0 | Intune Apps Windowsstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsstoreapp.md | Here is a JSON representation of the resource. "supersededAppCount": 1024, "appStoreUrl": "String" }-``` +``` |
v1.0 | Intune Apps Windowsuniversalappx | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsuniversalappx.md | Here is a JSON representation of the resource. }, "identityVersion": "String" }-``` +``` |
v1.0 | Intune Apps Windowsuniversalappxappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsuniversalappxappassignmentsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsUniversalAppXAppAssignmentSettings", "useDeviceContext": true }-``` +``` |
v1.0 | Intune Apps Windowsuniversalappxcontainedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsuniversalappxcontainedapp.md | Here is a JSON representation of the resource. "id": "String (identifier)", "appUserModelId": "String" }-``` +``` |
v1.0 | Intune Apps Windowswebapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowswebapp.md | Here is a JSON representation of the resource. "supersededAppCount": 1024, "appUrl": "String" }-``` +``` |
v1.0 | Intune Apps Wingetapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-wingetapp.md | Here is a JSON representation of the resource. "runAsAccount": "String" } }-``` +``` |
v1.0 | Intune Apps Wingetappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-wingetappassignmentsettings.md | Inherits from [mobileAppAssignmentSettings](../resources/intune-shared-mobileapp ## Properties |Property|Type|Description| |:|:|:|-|notifications|[winGetAppNotification](../resources/intune-apps-wingetappnotification.md)|The notification status for this app assignment. Possible values are: `showAll`, `showReboot`, `hideAll`, `unknownFutureValue`.| -|restartSettings|[winGetAppRestartSettings](../resources/intune-apps-wingetapprestartsettings.md)|The reboot settings to apply for this app assignment.| -|installTimeSettings|[winGetAppInstallTimeSettings](../resources/intune-apps-wingetappinstalltimesettings.md)|The install time settings to apply for this app assignment.| +|notifications|[winGetAppNotification](../resources/intune-shared-wingetappnotification.md)|The notification status for this app assignment. Possible values are: `showAll`, `showReboot`, `hideAll`, `unknownFutureValue`.| +|restartSettings|[winGetAppRestartSettings](../resources/intune-shared-wingetapprestartsettings.md)|The reboot settings to apply for this app assignment.| +|installTimeSettings|[winGetAppInstallTimeSettings](../resources/intune-shared-wingetappinstalltimesettings.md)|The install time settings to apply for this app assignment.| ## Relationships None Here is a JSON representation of the resource. "deadlineDateTime": "String (timestamp)" } }-``` +``` |
v1.0 | Intune Apps Wingetappinstallexperience | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-wingetappinstallexperience.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.winGetAppInstallExperience", "runAsAccount": "String" }-``` +``` |
v1.0 | Intune Apps Wingetappinstalltimesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-wingetappinstalltimesettings.md | Here is a JSON representation of the resource. "useLocalTime": true, "deadlineDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Apps Wingetappnotification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-wingetappnotification.md | Contains value for notification status. |showAll|0|Show all notifications.| |showReboot|1|Only show restart notification and suppress other notifications.| |hideAll|2|Hide all notifications.|-|unknownFutureValue|3|Unknown future value, reserved for future usage as expandable enum.| +|unknownFutureValue|3|Unknown future value, reserved for future usage as expandable enum.| |
v1.0 | Intune Apps Wingetapprestartsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-wingetapprestartsettings.md | Here is a JSON representation of the resource. "countdownDisplayBeforeRestartInMinutes": 1024, "restartNotificationSnoozeDurationInMinutes": 1024 }-``` +``` |
v1.0 | Intune Auditing Auditactor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-auditactor.md | Here is a JSON representation of the resource. "remoteTenantId": "String", "remoteUserId": "String" }-``` +``` |
v1.0 | Intune Auditing Auditevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-auditevent.md | Here is a JSON representation of the resource. ], "category": "String" }-``` +``` |
v1.0 | Intune Auditing Auditproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-auditproperty.md | Here is a JSON representation of the resource. "oldValue": "String", "newValue": "String" }-``` +``` |
v1.0 | Intune Auditing Auditresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-auditresource.md | Here is a JSON representation of the resource. "auditResourceType": "String", "resourceId": "String" }-``` +``` |
v1.0 | Intune Auditing Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-devicemanagement.md | Singleton entity that acts as a container for all device app management function ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-auditing-devicemanagement-get.md)|[deviceManagement](../resources/intune-auditing-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-auditing-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-auditing-devicemanagement-update.md)|[deviceManagement](../resources/intune-auditing-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-auditing-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-auditing-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-auditing-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Auditing Rolescopetaginfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-rolescopetaginfo.md | Here is a JSON representation of the resource. "displayName": "String", "roleScopeTagId": "String" }-``` +``` |
v1.0 | Intune Books Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-deviceappmanagement.md | Singleton entity that acts as a container for all device app management function ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceAppManagement](../api/intune-books-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-books-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-books-deviceappmanagement.md) object.| -|[Update deviceAppManagement](../api/intune-books-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-books-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-books-deviceappmanagement.md) object.| +|[Get deviceAppManagement](../api/intune-books-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| +|[Update deviceAppManagement](../api/intune-books-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceAppManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Books Deviceinstallstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-deviceinstallstate.md | Here is a JSON representation of the resource. "osDescription": "String", "userName": "String" }-``` +``` |
v1.0 | Intune Books Ebookinstallsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-ebookinstallsummary.md | Here is a JSON representation of the resource. "failedUserCount": 1024, "notInstalledUserCount": 1024 }-``` +``` |
v1.0 | Intune Books Installstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-installstate.md | Possible values for install state. |failed|2|Failed.| |notInstalled|3|Not Installed.| |uninstallFailed|4|Uninstall Failed.|-|unknown|5|Unknown.| +|unknown|5|Unknown.| |
v1.0 | Intune Books Iosvppebook | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-iosvppebook.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Books Iosvppebookassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-iosvppebookassignment.md | Here is a JSON representation of the resource. }, "installIntent": "String" }-``` +``` |
v1.0 | Intune Books Managedebook | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-managedebook.md | Here is a JSON representation of the resource. "informationUrl": "String", "privacyInformationUrl": "String" }-``` +``` |
v1.0 | Intune Books Managedebookassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-managedebookassignment.md | Here is a JSON representation of the resource. }, "installIntent": "String" }-``` +``` |
v1.0 | Intune Books Managedebookcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-managedebookcategory.md | Here is a JSON representation of the resource. "displayName": "String", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Books Userinstallstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-userinstallstatesummary.md | Here is a JSON representation of the resource. "failedDeviceCount": 1024, "notInstalledDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Chromebooksync Chromeosonboardingsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-chromebooksync-chromeosonboardingsettings.md | Here is a JSON representation of the resource. "lastModifiedDateTime": "String (timestamp)", "lastDirectorySyncDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Chromebooksync Chromeosonboardingstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-chromebooksync-chromeosonboardingstatus.md | The onboarding status of the tenant. |onboarded|2|Onboarded| |failed|3|Failed| |offboarding|4|Offboarding|-|unknownFutureValue|99|UnknownFutureValue| +|unknownFutureValue|99|UnknownFutureValue| |
v1.0 | Intune Chromebooksync Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-chromebooksync-devicemanagement.md | Singleton that acts as container for a collection of Resource Access entities. ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-chromebooksync-devicemanagement-get.md)|[deviceManagement](../resources/intune-chromebooksync-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-chromebooksync-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-chromebooksync-devicemanagement-update.md)|[deviceManagement](../resources/intune-chromebooksync-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-chromebooksync-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-chromebooksync-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-chromebooksync-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Chromebooksync Onboardingstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-chromebooksync-onboardingstatus.md | The onboarding status of the tenant. |onboarded|2|Onboarded| |failed|3|Failed| |offboarding|4|Offboarding|-|unknownFutureValue|99|UnknownFutureValue| +|unknownFutureValue|99|UnknownFutureValue| |
v1.0 | Intune Company Conceptual | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-company-conceptual.md | You can deploy Intune terms and conditions to user groups to explain how enrollm You can create and deploy multiple policies containing different terms and conditions. You can also produce versions of the same terms and conditions in different languages and then deploy these to their appropriate groups. -Use Graph resources to manage company terms and conditions in Intune. See the table of content for a list of resources. +Use Graph resources to manage company terms and conditions in Intune. See the table of content for a list of resources. |
v1.0 | Intune Companyterms Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-companyterms-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-companyterms-devicemanagement-get.md)|[deviceManagement](../resources/intune-companyterms-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-companyterms-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-companyterms-devicemanagement-update.md)|[deviceManagement](../resources/intune-companyterms-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-companyterms-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-companyterms-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-companyterms-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Companyterms Termsandconditions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-companyterms-termsandconditions.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Companyterms Termsandconditionsacceptancestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-companyterms-termsandconditionsacceptancestatus.md | Here is a JSON representation of the resource. "acceptedDateTime": "String (timestamp)", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Companyterms Termsandconditionsassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-companyterms-termsandconditionsassignment.md | Here is a JSON representation of the resource. "entraObjectId": "String" } }-``` +``` |
v1.0 | Intune Companyterms Termsandconditionsgroupassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-companyterms-termsandconditionsgroupassignment.md | Here is a JSON representation of the resource. "id": "String (identifier)", "targetGroupId": "String" }-``` +``` |
v1.0 | Intune Device Cfg Conceptual | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-device-cfg-conceptual.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. -Use the Microsoft Intune Device Configuration workload to manage settings and features on all of the devices you manage. See the table of content for a list of resources. +Use the Microsoft Intune Device Configuration workload to manage settings and features on all of the devices you manage. See the table of content for a list of resources. |
v1.0 | Intune Device Mgt Conceptual | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-device-mgt-conceptual.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. -Use the Microsoft Intune Device Management workload to manage settings and features on all of the devices you manage. See the table of content for a list of resources. +Use the Microsoft Intune Device Management workload to manage settings and features on all of the devices you manage. See the table of content for a list of resources. |
v1.0 | Intune Deviceconfig Administratorconfigureddevicecompliancestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-administratorconfigureddevicecompliancestate.md | Administrator configured device compliance state Enum |Member|Value|Description| |:|:|:| |basedOnDeviceCompliancePolicy|0|Set compliance state based on other compliance polices|-|nonCompliant|1|Set compliance to nonCompliant| +|nonCompliant|1|Set compliance to nonCompliant| |
v1.0 | Intune Deviceconfig Advancedbitlockerstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-advancedbitlockerstate.md | Advanced BitLocker State |windowsRecoveryEnvironmentNotConfigured|4096|WinRE is not configured| |tpmNotAvailable|8192|TPM is not available for BitLocker. This means TPM is not present, or TPM unavailable registry override is set or host OS is on portable/rome-able drive| |tpmNotReady|16384|TPM is not ready for BitLocker|-|networkError|32768|Network not available. This is required for recovery key backup. This is reported for Drive Encryption capable devices| +|networkError|32768|Network not available. This is required for recovery key backup. This is reported for Drive Encryption capable devices| |
v1.0 | Intune Deviceconfig Advancedthreatprotectiononboardingdevicesettingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-advancedthreatprotectiononboardingdevicesettingstate.md | Here is a JSON representation of the resource. "state": "String", "complianceGracePeriodExpirationDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceconfig Advancedthreatprotectiononboardingstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-advancedthreatprotectiononboardingstatesummary.md | Here is a JSON representation of the resource. "conflictDeviceCount": 1024, "notAssignedDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Airprintdestination | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-airprintdestination.md | Here is a JSON representation of the resource. "port": 1024, "forceTls": true }-``` +``` |
v1.0 | Intune Deviceconfig Androidcertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidcertificateprofilebase.md | Inherits from [deviceConfiguration](../resources/intune-shared-deviceconfigurati |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period.| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| ## Relationships |Relationship|Type|Description| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androidcompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidcompliancepolicy.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androidcustomconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidcustomconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerappautoupdatepolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerappautoupdatepolicytype.md | Android Device Owner possible values for states of the device's app auto update |userChoice|1|The user can control auto-updates.| |never|2|Apps are never auto-updated.| |wiFiOnly|3|Apps are auto-updated over Wi-Fi only.|-|always|4|Apps are auto-updated at any time. Data charges may apply.| +|always|4|Apps are auto-updated at any time. Data charges may apply.| |
v1.0 | Intune Deviceconfig Androiddeviceownerbatterypluggedmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerbatterypluggedmode.md | Android Device Owner possible values for states of the device's plugged-in power |notConfigured|0|Not configured; this value is ignored.| |ac|1|Power source is an AC charger.| |usb|2|Power source is a USB port.|-|wireless|3|Power source is wireless.| +|wireless|3|Power source is wireless.| |
v1.0 | Intune Deviceconfig Androiddeviceownercertificateaccesstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownercertificateaccesstype.md | An enum representing possible values for cross profile data sharing. |:|:|:| |userApproval|0|Require user approval for all apps| |specificApps|1|Pre-grant certificate access for specific apps (require user approval for other apps).|-|unknownFutureValue|2|Unknown future value for evolvable enum patterns.| +|unknownFutureValue|2|Unknown future value for evolvable enum patterns.| |
v1.0 | Intune Deviceconfig Androiddeviceownercertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md | Inherits from [deviceConfiguration](../resources/intune-shared-deviceconfigurati |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period.| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| ## Relationships Here is a JSON representation of the resource. ], "subjectAlternativeNameType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownercompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownercompliancepolicy.md | Here is a JSON representation of the resource. "requireNoPendingSystemUpdates": true, "securityRequiredAndroidSafetyNetEvaluationType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownercrossprofiledatasharing | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownercrossprofiledatasharing.md | An enum representing possible values for cross profile data sharing. |crossProfileDataSharingBlocked|1|Data cannot be shared from both the personal profile to work profile and the work profile to the personal profile.| |dataSharingFromWorkToPersonalBlocked|2|Prevents users from sharing data from the work profile to apps in the personal profile. Personal data can be shared with work apps.| |crossProfileDataSharingAllowed|3|Data from either profile can be shared with the other profile.|-|unkownFutureValue|4|Unknown future value (reserved, not used right now)| +|unkownFutureValue|4|Unknown future value (reserved, not used right now)| |
v1.0 | Intune Deviceconfig Androiddeviceownerdefaultapppermissionpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerdefaultapppermissionpolicytype.md | Android Device Owner default app permission policy type. |deviceDefault|0|Device default value, no intent.| |prompt|1|Prompt.| |autoGrant|2|Auto grant.|-|autoDeny|3|Auto deny.| +|autoDeny|3|Auto deny.| |
v1.0 | Intune Deviceconfig Androiddeviceownerdelegatedappscopetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerdelegatedappscopetype.md | An enum representing possible values for delegated app scope. |certificateInstall|1|Specifies that the admin has given app permission to install and manage certificates on device.| |captureNetworkActivityLog|2|Specifies that the admin has given app permission to capture network activity logs on device. More info on Network activity logs: https://developer.android.com/work/dpc/logging | |captureSecurityLog|3|Specified that the admin has given permission to capture security logs on device. More info on Security logs: https://developer.android.com/work/dpc/security#log_enterprise_device_activity|-|unknownFutureValue|4|Unknown future value (reserved, not used right now)| +|unknownFutureValue|4|Unknown future value (reserved, not used right now)| |
v1.0 | Intune Deviceconfig Androiddeviceownerdelegatedscopeappsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerdelegatedscopeappsetting.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerderivedcredentialauthenticationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerderivedcredentialauthenticationconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerenrollmentprofiletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerenrollmentprofiletype.md | Android Device Owner Enrollment Profile types. |:|:|:| |notConfigured|0|Not configured; this value is ignored.| |dedicatedDevice|1|Dedicated device.|-|fullyManaged|2|Fully managed.| +|fullyManaged|2|Fully managed.| |
v1.0 | Intune Deviceconfig Androiddeviceownerenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerenterprisewificonfiguration.md | Here is a JSON representation of the resource. "innerAuthenticationProtocolForPeap": "String", "outerIdentityPrivacyTemporaryValue": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownergeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownergeneraldeviceconfiguration.md | Here is a JSON representation of the resource. "shareDeviceLocationDisabled": true, "deviceLocationMode": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerglobalproxy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerglobalproxy.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.androidDeviceOwnerGlobalProxy" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerglobalproxyautoconfig | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerglobalproxyautoconfig.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.androidDeviceOwnerGlobalProxyAutoConfig", "proxyAutoConfigURL": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerglobalproxydirect | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerglobalproxydirect.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerimportedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerimportedpfxcertificateprofile.md | Inherits from [androidDeviceOwnerCertificateProfileBase](../resources/intune-dev |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |intendedPurpose|[intendedPurpose](../resources/intune-deviceconfig-intendedpurpose.md)|Intended Purpose of the Certificate Profile - which could be Unassigned, SmimeEncryption, SmimeSigning etc. Possible values are: `unassigned`, `smimeEncryption`, `smimeSigning`, `vpn`, `wifi`.| |certificateAccessType|[androidDeviceOwnerCertificateAccessType](../resources/intune-deviceconfig-androiddeviceownercertificateaccesstype.md)|Certificate access type. Possible values are: `userApproval`, `specificApps`, `unknownFutureValue`.| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskcustomizationstatusbar | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskcustomizationstatusbar.md | An enum representing possible values for kiosk customization system navigation. |:|:|:| |notConfigured|0|Not configured; this value defaults to STATUS_BAR_UNSPECIFIED.| |notificationsAndSystemInfoEnabled|1|System info and notifications are shown on the status bar in kiosk mode.|-|systemInfoOnly|2|Only system info is shown on the status bar in kiosk mode.| +|systemInfoOnly|2|Only system info is shown on the status bar in kiosk mode.| |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskcustomizationsystemnavigation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskcustomizationsystemnavigation.md | An enum representing possible values for kiosk customization system navigation. |:|:|:| |notConfigured|0|Not configured; this value defaults to NAVIGATION_DISABLED.| |navigationEnabled|1|Home and overview buttons are enabled.|-|homeButtonOnly|2| Only the home button is enabled.| +|homeButtonOnly|2| Only the home button is enabled.| |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodeapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodeapp.md | Here is a JSON representation of the resource. "package": "String", "className": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodeapppositionitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodeapppositionitem.md | Here is a JSON representation of the resource. "link": "String" } }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodefoldericon | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodefoldericon.md | Android Device Owner Kiosk Mode folder icon type. |darkSquare|1|Folder icon appears as dark square.| |darkCircle|2|Folder icon appears as dark circle.| |lightSquare|3|Folder icon appears as light square.|-|lightCircle|4|Folder icon appears as light circle .| +|lightCircle|4|Folder icon appears as light circle .| |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodefolderitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodefolderitem.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.androidDeviceOwnerKioskModeFolderItem" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodehomescreenitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodehomescreenitem.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.androidDeviceOwnerKioskModeHomeScreenItem" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodeiconsize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodeiconsize.md | Android Device Owner Kiosk Mode managed home screen icon size. |small|2|Small icon size.| |regular|3|Regular icon size.| |large|4|Large icon size.|-|largest|5|Largest icon size.| +|largest|5|Largest icon size.| |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodemanagedfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodemanagedfolder.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodemanagedfolderreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodemanagedfolderreference.md | Here is a JSON representation of the resource. "folderName": "String", "folderIdentifier": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodescreenorientation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodescreenorientation.md | Android Device Owner Kiosk Mode managed home screen orientation. |notConfigured|0|Not configured; this value is ignored.| |portrait|1|Portrait orientation.| |landscape|2|Landscape orientation.|-|autoRotate|3|Auto rotate between portrait and landscape orientations.| +|autoRotate|3|Auto rotate between portrait and landscape orientations.| |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodeweblink | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodeweblink.md | Here is a JSON representation of the resource. "label": "String", "link": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerlocationmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerlocationmode.md | Android Device Owner Location Mode Type |:|:|:| |notConfigured|0|No restrictions on the location setting and no specific behavior is set or enforced. This is the default| |disabled|1|Location setting is disabled on the device|-|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use| +|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use| |
v1.0 | Intune Deviceconfig Androiddeviceownerpkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerpkcscertificateprofile.md | Inherits from [androidDeviceOwnerCertificateProfileBase](../resources/intune-dev |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerplaystoremode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerplaystoremode.md | Android Device Owner Play Store mode type. |:|:|:| |notConfigured|0|Not Configured| |allowList|1|Only apps that are in the policy are available and any app not in the policy will be automatically uninstalled from the device.|-|blockList|2|All apps are available and any app that should not be on the device should be explicitly marked as 'BLOCKED' in the applications policy.| +|blockList|2|All apps are available and any app that should not be on the device should be explicitly marked as 'BLOCKED' in the applications policy.| |
v1.0 | Intune Deviceconfig Androiddeviceownerrequiredpasswordtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerrequiredpasswordtype.md | Android Device Owner policy required password type. |alphanumeric|5|At least alphanumeric password| |alphanumericWithSymbols|6|At least alphanumeric with symbols.| |lowSecurityBiometric|7|Low security biometrics based password required.|-|customPassword|8|Custom password set by the admin.| +|customPassword|8|Custom password set by the admin.| |
v1.0 | Intune Deviceconfig Androiddeviceownerrequiredpasswordunlock | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerrequiredpasswordunlock.md | An enum representing possible values for required password unlock. |:|:|:| |deviceDefault|0|Timeout period before strong authentication is required is set to the device's default.| |daily|1|Timeout period before strong authentication is required is set to 24 hours.|-|unkownFutureValue|2|Unknown future value (reserved, not used right now)| +|unkownFutureValue|2|Unknown future value (reserved, not used right now)| |
v1.0 | Intune Deviceconfig Androiddeviceownerscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerscepcertificateprofile.md | Inherits from [androidDeviceOwnerCertificateProfileBase](../resources/intune-dev |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownersilentcertificateaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownersilentcertificateaccess.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.androidDeviceOwnerSilentCertificateAccess", "packageId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownersystemupdatefreezeperiod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownersystemupdatefreezeperiod.md | Here is a JSON representation of the resource. "endMonth": 1024, "endDay": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownersystemupdateinstalltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownersystemupdateinstalltype.md | System Update Types for Android Device Owner. |deviceDefault|0|Device default behavior, which typically prompts the user to accept system updates.| |postpone|1|Postpone automatic install of updates up to 30 days.| |windowed|2|Install automatically inside a daily maintenance window.|-|automatic|3|Automatically install updates as soon as possible.| +|automatic|3|Automatically install updates as soon as possible.| |
v1.0 | Intune Deviceconfig Androiddeviceownertrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownertrustedrootcertificate.md | Here is a JSON representation of the resource. "trustedRootCertificate": "binary", "certFileName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceowneruserfacingmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceowneruserfacingmessage.md | Here is a JSON representation of the resource. ], "defaultMessage": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownervirtualhomebuttontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownervirtualhomebuttontype.md | Android Device Owner Kiosk Mode managed home screen virtual home button type. |:|:|:| |notConfigured|0|Not configured; this value is ignored.| |swipeUp|1|Swipe-up for home button.|-|floating|2|Floating home button.| +|floating|2|Floating home button.| |
v1.0 | Intune Deviceconfig Androiddeviceownervpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownervpnconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerwificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerwificonfiguration.md | Here is a JSON representation of the resource. "proxyExclusionList": "String", "macAddressRandomizationMode": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androiddeviceownerwifisecuritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerwifisecuritytype.md | Wi-Fi Security Types for Android Device Owner. |open|0|Open (No Authentication).| |wep|1|WEP Encryption.| |wpaPersonal|2|WPA-Personal/WPA2-Personal.|-|wpaEnterprise|4|WPA-Enterprise/WPA2-Enterprise. Must use AndroidDeviceOwnerEnterpriseWifiConfiguration type to configure enterprise options.| +|wpaEnterprise|4|WPA-Enterprise/WPA2-Enterprise. Must use AndroidDeviceOwnerEnterpriseWifiConfiguration type to configure enterprise options.| |
v1.0 | Intune Deviceconfig Androideaptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androideaptype.md | Extensible Authentication Protocol (EAP) Configuration Types. |:|:|:| |eapTls|13|Extensible Authentication Protocol-Transport Layer Security (EAP-TLS).| |eapTtls|21|Extensible Authentication Protocol-Tunneled Transport Layer Security (EAP-TTLS).|-|peap|25|Protected Extensible Authentication Protocol (PEAP).| +|peap|25|Protected Extensible Authentication Protocol (PEAP).| |
v1.0 | Intune Deviceconfig Androideasemailprofileconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androideasemailprofileconfiguration.md | Here is a JSON representation of the resource. "userDomainNameSource": "String", "customDomainName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidenterprisewificonfiguration.md | Here is a JSON representation of the resource. "passwordFormatString": "String", "preSharedKey": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkcertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkcertificateprofilebase.md | Inherits from [deviceConfiguration](../resources/intune-shared-deviceconfigurati |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period.| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| ## Relationships Here is a JSON representation of the resource. ], "subjectAlternativeNameType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkcompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkcompliancepolicy.md | Here is a JSON representation of the resource. "securityRequireCompanyPortalAppIntegrity": true, "securityRequiredAndroidSafetyNetEvaluationType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkcrossprofiledatasharingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkcrossprofiledatasharingtype.md | Android For Work cross profile data sharing type. |deviceDefault|0|Device default value, no intent.| |preventAny|1|Prevent any sharing.| |allowPersonalToWork|2|Allow data sharing request from personal profile to work profile.|-|noRestrictions|3|No restrictions on sharing.| +|noRestrictions|3|No restrictions on sharing.| |
v1.0 | Intune Deviceconfig Androidforworkcustomconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkcustomconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkdefaultapppermissionpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkdefaultapppermissionpolicytype.md | Android For Work default app permission policy type. |deviceDefault|0|Device default value, no intent.| |prompt|1|Prompt.| |autoGrant|2|Auto grant.|-|autoDeny|3|Auto deny.| +|autoDeny|3|Auto deny.| |
v1.0 | Intune Deviceconfig Androidforworkeasemailprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkeasemailprofilebase.md | Here is a JSON representation of the resource. "requireSsl": true, "usernameSource": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkenterprisewificonfiguration.md | Here is a JSON representation of the resource. "innerAuthenticationProtocolForPeap": "String", "outerIdentityPrivacyTemporaryValue": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkgeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkgeneraldeviceconfiguration.md | Here is a JSON representation of the resource. ], "blockUnifiedPasswordForWorkProfile": true }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkgmaileasconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkgmaileasconfiguration.md | Here is a JSON representation of the resource. "requireSsl": true, "usernameSource": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkimportedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkimportedpfxcertificateprofile.md | Inherits from [androidCertificateProfileBase](../resources/intune-deviceconfig-a |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |intendedPurpose|[intendedPurpose](../resources/intune-deviceconfig-intendedpurpose.md)|Intended Purpose of the Certificate Profile - which could be Unassigned, SmimeEncryption, SmimeSigning etc. Possible values are: `unassigned`, `smimeEncryption`, `smimeSigning`, `vpn`, `wifi`.| ## Relationships Here is a JSON representation of the resource. ], "intendedPurpose": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworknineworkeasconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworknineworkeasconfiguration.md | Here is a JSON representation of the resource. "syncContacts": true, "syncTasks": true }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkpkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkpkcscertificateprofile.md | Inherits from [androidForWorkCertificateProfileBase](../resources/intune-devicec |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| Here is a JSON representation of the resource. "certificateTemplateName": "String", "subjectAlternativeNameFormatString": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkrequiredpasswordtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkrequiredpasswordtype.md | Android For Work required password type. |numericComplex|4|Numeric complex password required.| |atLeastAlphabetic|5|At least alphabetic password required.| |atLeastAlphanumeric|6|At least alphanumeric password required.|-|alphanumericWithSymbols|7|At least alphanumeric with symbols password required.| +|alphanumericWithSymbols|7|At least alphanumeric with symbols password required.| |
v1.0 | Intune Deviceconfig Androidforworkscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkscepcertificateprofile.md | Inherits from [androidForWorkCertificateProfileBase](../resources/intune-devicec |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidForWorkCertificateProfileBase](../resources/intune-deviceconfig-androidforworkcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworktrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworktrustedrootcertificate.md | Here is a JSON representation of the resource. "trustedRootCertificate": "binary", "certFileName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkvpnconfiguration.md | Here is a JSON representation of the resource. ], "authenticationMethod": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidforworkvpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkvpnconnectiontype.md | Android For Work VPN connection type. |f5EdgeClient|2|F5 Edge Client.| |dellSonicWallMobileConnect|3|Dell SonicWALL Mobile Connection.| |checkPointCapsuleVpn|4|Check Point Capsule VPN.|-|citrix|5|Citrix| +|citrix|5|Citrix| |
v1.0 | Intune Deviceconfig Androidforworkwificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkwificonfiguration.md | Here is a JSON representation of the resource. "connectWhenNetworkNameIsHidden": true, "wiFiSecurityType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidgeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidgeneraldeviceconfiguration.md | Here is a JSON representation of the resource. ], "securityRequireVerifyApps": true }-``` +``` |
v1.0 | Intune Deviceconfig Androidimportedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidimportedpfxcertificateprofile.md | Inherits from [androidCertificateProfileBase](../resources/intune-deviceconfig-a |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |intendedPurpose|[intendedPurpose](../resources/intune-deviceconfig-intendedpurpose.md)|Intended Purpose of the Certificate Profile - which could be Unassigned, SmimeEncryption, SmimeSigning etc. Possible values are: `unassigned`, `smimeEncryption`, `smimeSigning`, `vpn`, `wifi`.| ## Relationships Here is a JSON representation of the resource. ], "intendedPurpose": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidkeyguardfeature | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidkeyguardfeature.md | Android keyguard feature. |allFeatures|7|All keyguard features when on secure keyguard screens.| |face|8|Face authentication on secure keyguard screens.| |iris|9|Iris authentication on secure keyguard screens.|-|biometrics|10|All biometric authentication on secure keyguard screens.| +|biometrics|10|All biometric authentication on secure keyguard screens.| |
v1.0 | Intune Deviceconfig Androidomacpconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidomacpconfiguration.md | Here is a JSON representation of the resource. "version": 1024, "configurationXml": "binary" }-``` +``` |
v1.0 | Intune Deviceconfig Androidpkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidpkcscertificateprofile.md | Inherits from [androidCertificateProfileBase](../resources/intune-deviceconfig-a |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| |certificateTemplateName|String|PKCS Certificate Template Name| Here is a JSON representation of the resource. "certificateTemplateName": "String", "subjectAlternativeNameFormatString": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidrequiredpasswordcomplexity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidrequiredpasswordcomplexity.md | The password complexity types that can be set on Android. One of: NONE, LOW, MED |none|0|Device default value, no password.| |low|1|The required password complexity on the device is of type low as defined by the Android documentation.| |medium|2|The required password complexity on the device is of type medium as defined by the Android documentation.|-|high|3|The required password complexity on the device is of type high as defined by the Android documentation.| +|high|3|The required password complexity on the device is of type high as defined by the Android documentation.| |
v1.0 | Intune Deviceconfig Androidrequiredpasswordtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidrequiredpasswordtype.md | Android required password type. |lowSecurityBiometric|4|Low security biometrics based password required.| |numeric|5|Numeric password required.| |numericComplex|6|Numeric complex password required.|-|any|7|A password or pattern is required, and any is acceptable.| +|any|7|A password or pattern is required, and any is acceptable.| |
v1.0 | Intune Deviceconfig Androidsafetynetevaluationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidsafetynetevaluationtype.md | An enum representing the Android Play Integrity API evaluation types. |Member|Value|Description| |:|:|:| |basic|0|Default value. Typical measurements and reference data were used.|-|hardwareBacked|1|Strong Integrity checks (such as a hardware-backed proof of boot integrity) were used.| +|hardwareBacked|1|Strong Integrity checks (such as a hardware-backed proof of boot integrity) were used.| |
v1.0 | Intune Deviceconfig Androidscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidscepcertificateprofile.md | Inherits from [androidCertificateProfileBase](../resources/intune-deviceconfig-a |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidCertificateProfileBase](../resources/intune-deviceconfig-androidcertificateprofilebase.md)| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| Here is a JSON representation of the resource. "hashAlgorithm": "String", "subjectAlternativeNameFormatString": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidtrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidtrustedrootcertificate.md | Here is a JSON representation of the resource. "trustedRootCertificate": "binary", "certFileName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidusernamesource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidusernamesource.md | Android username source. |username|0|The username.| |userPrincipalName|1|The user principal name.| |samAccountName|2|The user sam account name.|-|primarySmtpAddress|3|Primary SMTP address.| +|primarySmtpAddress|3|Primary SMTP address.| |
v1.0 | Intune Deviceconfig Androidvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidvpnconfiguration.md | Here is a JSON representation of the resource. ], "authenticationMethod": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidvpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidvpnconnectiontype.md | Android VPN connection type. |citrix|5|Citrix| |microsoftTunnel|7|Microsoft Tunnel.| |netMotionMobility|8|NetMotion Mobility.|-|microsoftProtect|9|Microsoft Protect.| +|microsoftProtect|9|Microsoft Protect.| |
v1.0 | Intune Deviceconfig Androidwificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidwificonfiguration.md | Here is a JSON representation of the resource. "connectWhenNetworkNameIsHidden": true, "wiFiSecurityType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidwifisecuritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidwifisecuritytype.md | Wi-Fi Security Types for Android. |:|:|:| |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.| +|wpa2Enterprise|2|WPA2-Enterprise. Must use AndroidEnterpriseWifiConfiguration type to configure enterprise options.| |
v1.0 | Intune Deviceconfig Androidworkprofileaccountuse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofileaccountuse.md | An enum representing possible values for account use in work profile. |allowAllExceptGoogleAccounts|0|Allow additon of all accounts except Google accounts in Android Work Profile.| |blockAll|1|Block any account from being added in Android Work Profile. | |allowAll|2|Allow addition of all accounts (including Google accounts) in Android Work Profile.|-|unknownFutureValue|3|Unknown future value for evolvable enum patterns.| +|unknownFutureValue|3|Unknown future value for evolvable enum patterns.| |
v1.0 | Intune Deviceconfig Androidworkprofilecertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md | Inherits from [deviceConfiguration](../resources/intune-shared-deviceconfigurati |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period.| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| ## Relationships Here is a JSON representation of the resource. ], "subjectAlternativeNameType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilecompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilecompliancepolicy.md | Here is a JSON representation of the resource. "securityRequireCompanyPortalAppIntegrity": true, "securityRequiredAndroidSafetyNetEvaluationType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilecrossprofiledatasharingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilecrossprofiledatasharingtype.md | Android Work Profile cross profile data sharing type. |deviceDefault|0|Device default value, no intent.| |preventAny|1|Prevent any sharing.| |allowPersonalToWork|2|Allow data sharing request from personal profile to work profile.|-|noRestrictions|3|No restrictions on sharing.| +|noRestrictions|3|No restrictions on sharing.| |
v1.0 | Intune Deviceconfig Androidworkprofilecustomconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilecustomconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofiledefaultapppermissionpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofiledefaultapppermissionpolicytype.md | Android Work Profile default app permission policy type. |deviceDefault|0|Device default value, no intent.| |prompt|1|Prompt.| |autoGrant|2|Auto grant.|-|autoDeny|3|Auto deny.| +|autoDeny|3|Auto deny.| |
v1.0 | Intune Deviceconfig Androidworkprofileeasemailprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofileeasemailprofilebase.md | Here is a JSON representation of the resource. "requireSsl": true, "usernameSource": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofileenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofileenterprisewificonfiguration.md | Here is a JSON representation of the resource. "proxySettings": "String", "proxyAutomaticConfigurationUrl": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilegeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilegeneraldeviceconfiguration.md | Here is a JSON representation of the resource. ], "blockUnifiedPasswordForWorkProfile": true }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilegmaileasconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilegmaileasconfiguration.md | Here is a JSON representation of the resource. "requireSsl": true, "usernameSource": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilenineworkeasconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilenineworkeasconfiguration.md | Here is a JSON representation of the resource. "syncContacts": true, "syncTasks": true }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilepkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilepkcscertificateprofile.md | Inherits from [androidWorkProfileCertificateProfileBase](../resources/intune-dev |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilerequiredpasswordtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilerequiredpasswordtype.md | Android Work Profile required password type. |numericComplex|4|Numeric complex password required.| |atLeastAlphabetic|5|At least alphabetic password required.| |atLeastAlphanumeric|6|At least alphanumeric password required.|-|alphanumericWithSymbols|7|At least alphanumeric with symbols password required.| +|alphanumericWithSymbols|7|At least alphanumeric with symbols password required.| |
v1.0 | Intune Deviceconfig Androidworkprofilescepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilescepcertificateprofile.md | Inherits from [androidWorkProfileCertificateProfileBase](../resources/intune-dev |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [androidWorkProfileCertificateProfileBase](../resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofiletrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofiletrustedrootcertificate.md | Here is a JSON representation of the resource. "trustedRootCertificate": "binary", "certFileName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilevpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilevpnconfiguration.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Androidworkprofilevpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilevpnconnectiontype.md | Android Work Profile VPN connection type. |paloAltoGlobalProtect|6|Palo Alto Networks GlobalProtect.| |microsoftTunnel|7|Microsoft Tunnel.| |netMotionMobility|8|NetMotion Mobility.|-|microsoftProtect|9|Microsoft Protect.| +|microsoftProtect|9|Microsoft Protect.| |
v1.0 | Intune Deviceconfig Androidworkprofilewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilewificonfiguration.md | Here is a JSON representation of the resource. "connectWhenNetworkNameIsHidden": true, "wiFiSecurityType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownercertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md | Inherits from [deviceConfiguration](../resources/intune-shared-deviceconfigurati |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. This collection can contain a maximum of 500 elements. Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period.| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. This collection can contain a maximum of 500 elements. Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| ## Relationships Here is a JSON representation of the resource. ], "subjectAlternativeNameType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownercompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownercompliancepolicy.md | Here is a JSON representation of the resource. "passwordMinimumLength": 1024, "storageRequireEncryption": true }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownerdeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerdeviceconfiguration.md | Here is a JSON representation of the resource. "storageBlockUsbFileTransfer": true, "wifiBlockEditConfigurations": true }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownerenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerenterprisewificonfiguration.md | Here is a JSON representation of the resource. "innerAuthenticationProtocolForPeap": "String", "outerIdentityPrivacyTemporaryValue": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownerpkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md | Inherits from [aospDeviceOwnerCertificateProfileBase](../resources/intune-device |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificationAuthority|String|PKCS Certification Authority| |certificationAuthorityName|String|PKCS Certification Authority Name| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownerscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerscepcertificateprofile.md | Inherits from [aospDeviceOwnerCertificateProfileBase](../resources/intune-device |subjectNameFormat|[subjectNameFormat](../resources/intune-shared-subjectnameformat.md)|Certificate Subject Name Format. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `commonName`, `commonNameIncludingEmail`, `commonNameAsEmail`, `custom`, `commonNameAsIMEI`, `commonNameAsSerialNumber`, `commonNameAsAadDeviceId`, `commonNameAsIntuneDeviceId`, `commonNameAsDurableDeviceId`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md)| |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. This collection can contain a maximum of 500 elements. Inherited from [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |scepServerUrls|String collection|SCEP Server Url(s)| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownertrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md | Here is a JSON representation of the resource. "trustedRootCertificate": "binary", "certFileName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownerwificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerwificonfiguration.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Aospdeviceownerwifisecuritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerwifisecuritytype.md | Wi-Fi Security Types for AOSP Device Owner. |open|0|Open (No Authentication).| |wep|1|WEP Encryption.| |wpaPersonal|2|WPA-Personal/WPA2-Personal.|-|wpaEnterprise|4|WPA-Enterprise/WPA2-Enterprise. Must use AOSPDeviceOwnerEnterpriseWifiConfiguration type to configure enterprise options.| +|wpaEnterprise|4|WPA-Enterprise/WPA2-Enterprise. Must use AOSPDeviceOwnerEnterpriseWifiConfiguration type to configure enterprise options.| |
v1.0 | Intune Deviceconfig Appinstallcontroltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-appinstallcontroltype.md | App Install control Setting |anywhere|1|Turn off app recommendations| |storeOnly|2|Allow apps from Store only| |recommendations|3|Show me app recommendations|-|preferStore|4|Warn me before installing apps from outside the Store| +|preferStore|4|Warn me before installing apps from outside the Store| |
v1.0 | Intune Deviceconfig Appleapplistitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-appleapplistitem.md | Here is a JSON representation of the resource. "appStoreUrl": "String", "appId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Appledeploymentchannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-appledeploymentchannel.md | Indicates the channel used to deploy the configuration profile. Available choice |Member|Value|Description| |:|:|:| |deviceChannel|0|Send payload down over Device Channel.|-|userChannel|1|Send payload down over User Channel.| +|userChannel|1|Send payload down over User Channel.| |
v1.0 | Intune Deviceconfig Appledevicefeaturesconfigurationbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-appledevicefeaturesconfigurationbase.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Appleexpeditedcheckinconfigurationbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-appleexpeditedcheckinconfigurationbase.md | Here is a JSON representation of the resource. "version": 1024, "enableExpeditedCheckin": true }-``` +``` |
v1.0 | Intune Deviceconfig Applesubjectnameformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applesubjectnameformat.md | Subject Name Format Options for Apple devices. |custom|2|Custom subject name format.| |commonNameIncludingEmail|3|Common Name Including Email.| |commonNameAsIMEI|5|Common Name As IMEI.|-|commonNameAsSerialNumber|6|Common Name As Serial Number.| +|commonNameAsSerialNumber|6|Common Name As Serial Number.| |
v1.0 | Intune Deviceconfig Applevpnalwaysonconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applevpnalwaysonconfiguration.md | Here is a JSON representation of the resource. "natKeepAliveIntervalInSeconds": 1024, "natKeepAliveOffloadEnable": true }-``` +``` |
v1.0 | Intune Deviceconfig Applevpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applevpnconfiguration.md | Here is a JSON representation of the resource. }, "optInToDeviceIdSharing": true }-``` +``` |
v1.0 | Intune Deviceconfig Applevpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applevpnconnectiontype.md | Apple VPN connection type. |alwaysOn|15|AlwaysOn.| |microsoftTunnel|16|Microsoft Tunnel.| |netMotionMobility|17|NetMotion Mobility.|-|microsoftProtect|18|Microsoft Protect.| +|microsoftProtect|18|Microsoft Protect.| |
v1.0 | Intune Deviceconfig Applicationguardblockclipboardsharingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applicationguardblockclipboardsharingtype.md | Possible values for applicationGuardBlockClipboardSharingType |blockBoth|1|Block clipboard to share data both from Host to Container and from Container to Host| |blockHostToContainer|2|Block clipboard to share data from Host to Container| |blockContainerToHost|3|Block clipboard to share data from Container to Host|-|blockNone|4|Block clipboard to share data neither from Host to Container nor from Container to Host| +|blockNone|4|Block clipboard to share data neither from Host to Container nor from Container to Host| |
v1.0 | Intune Deviceconfig Applicationguardblockfiletransfertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applicationguardblockfiletransfertype.md | Possible values for applicationGuardBlockFileTransfer |blockImageAndTextFile|1|Block clipboard to transfer Image and Text file| |blockImageFile|2|Block clipboard to transfer Image file| |blockNone|3|Neither of text file or image file is blocked from transferring|-|blockTextFile|4|Block clipboard to transfer Text file| +|blockTextFile|4|Block clipboard to transfer Text file| |
v1.0 | Intune Deviceconfig Applicationguardenabledoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applicationguardenabledoptions.md | Possible values for ApplicationGuardEnabledOptions |notConfigured|0|Not Configured| |enabledForEdge|1|Enabled For Edge| |enabledForOffice|2|Enabled For Office|-|enabledForEdgeAndOffice|3|Enabled For Edge And Office| +|enabledForEdgeAndOffice|3|Enabled For Edge And Office| |
v1.0 | Intune Deviceconfig Applistitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applistitem.md | Here is a JSON representation of the resource. "appStoreUrl": "String", "appId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Applisttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applisttype.md | Possible values of the compliance app list. |:|:|:| |none|0|Default value, no intent.| |appsInListCompliant|1|The list represents the apps that will be considered compliant (only apps on the list are compliant).|-|appsNotInListCompliant|2|The list represents the apps that will be considered non compliant (all apps are compliant except apps on the list).| +|appsNotInListCompliant|2|The list represents the apps that will be considered non compliant (all apps are compliant except apps on the list).| |
v1.0 | Intune Deviceconfig Applockerapplicationcontroltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applockerapplicationcontroltype.md | Possible values of AppLocker Application Control Types |enforceComponentsAndStoreApps|1|Enforce Windows component and store apps.| |auditComponentsAndStoreApps|2|Audit Windows component and store apps.| |enforceComponentsStoreAppsAndSmartlocker|3|Enforce Windows components, store apps and smart locker.|-|auditComponentsStoreAppsAndSmartlocker|4|Audit Windows components, store apps and smart lockerΓÇï.| +|auditComponentsStoreAppsAndSmartlocker|4|Audit Windows components, store apps and smart lockerΓÇï.| |
v1.0 | Intune Deviceconfig Authenticationtransformconstant | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-authenticationtransformconstant.md | Authentication transform values for Windows10 VPN policies with IKEv2 connection |sha_256_128|2|SHA256128| |aes128Gcm|3|GCMAES128| |aes192Gcm|4|GCMAES192|-|aes256Gcm|5|GCMAES256| +|aes256Gcm|5|GCMAES256| |
v1.0 | Intune Deviceconfig Automaticupdatemode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-automaticupdatemode.md | Possible values for automatic update mode. |autoInstallAndRebootAtMaintenanceTime|3|Auto-install and reboot at maintenance time.| |autoInstallAndRebootAtScheduledTime|4|Auto-install and reboot at scheduled time.| |autoInstallAndRebootWithoutEndUserControl|5|Auto-install and restart without end-user control|-|windowsDefault|6|Reset to Windows default value.| +|windowsDefault|6|Reset to Windows default value.| |
v1.0 | Intune Deviceconfig Autorestartnotificationdismissalmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-autorestartnotificationdismissalmethod.md | Auto restart required notification dismissal method |notConfigured|0|Not configured| |automatic|1|Auto dismissal Indicates that the notification is automatically dismissed without user intervention| |user|2|User dismissal. Allows the user to dismiss the notification|-|unknownFutureValue|3|Evolvable enum member| +|unknownFutureValue|3|Evolvable enum member| |
v1.0 | Intune Deviceconfig Bitlockerencryptionmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerencryptionmethod.md | BitLockerEncryptionMethod types |aesCbc128|3|AES-CBC 128-bit.| |aesCbc256|4|AES-CBC 256-bit.| |xtsAes128|6|XTS-AES 128-bit.|-|xtsAes256|7|XTS-AES 256-bit.| +|xtsAes256|7|XTS-AES 256-bit.| |
v1.0 | Intune Deviceconfig Bitlockerfixeddrivepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerfixeddrivepolicy.md | Here is a JSON representation of the resource. "enableBitLockerAfterRecoveryInformationToStore": true } }-``` +``` |
v1.0 | Intune Deviceconfig Bitlockerrecoveryinformationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerrecoveryinformationtype.md | BitLockerRecoveryInformationType types |Member|Value|Description| |:|:|:| |passwordAndKey|1|Store recovery passwords and key packages.|-|passwordOnly|2|Store recovery passwords only.| +|passwordOnly|2|Store recovery passwords only.| |
v1.0 | Intune Deviceconfig Bitlockerrecoveryoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerrecoveryoptions.md | Here is a JSON representation of the resource. "recoveryInformationToStore": "String", "enableBitLockerAfterRecoveryInformationToStore": true }-``` +``` |
v1.0 | Intune Deviceconfig Bitlockerrecoverypasswordrotationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerrecoverypasswordrotationtype.md | BitLocker recovery password rotation type |notConfigured|0|Not configured| |disabled|1|Recovery password rotation off| |enabledForAzureAd|2|Recovery password rotation on for Azure AD joined devices|-|enabledForAzureAdAndHybrid|3|Recovery password rotation on for both Azure AD joined and hybrid joined devices| +|enabledForAzureAdAndHybrid|3|Recovery password rotation on for both Azure AD joined and hybrid joined devices| |
v1.0 | Intune Deviceconfig Bitlockerremovabledrivepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerremovabledrivepolicy.md | Here is a JSON representation of the resource. "requireEncryptionForWriteAccess": true, "blockCrossOrganizationWriteAccess": true }-``` +``` |
v1.0 | Intune Deviceconfig Bitlockersystemdrivepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockersystemdrivepolicy.md | Here is a JSON representation of the resource. "prebootRecoveryMessage": "String", "prebootRecoveryUrl": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Browsersyncsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-browsersyncsetting.md | Allow(Not Configured) or prevent(Block) the syncing of Microsoft Edge Browser se |:|:|:| |notConfigured|0|Default ΓÇô Allow syncing of browser settings across devices.| |blockedWithUserOverride|1|Prevent syncing of browser settings across user devices, allow user override of setting.|-|blocked|2|Absolutely prevent syncing of browser settings across user devices.| +|blocked|2|Absolutely prevent syncing of browser settings across user devices.| |
v1.0 | Intune Deviceconfig Carttoclassassociation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-carttoclassassociation.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Certificateissuancestates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-certificateissuancestates.md | Certificate Issuance State Options. |deleteFailed|19|| |deleted|20|| |renewalRequested|21||-|requested|22|| +|requested|22|| |
v1.0 | Intune Deviceconfig Certificaterevocationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-certificaterevocationstatus.md | Certificate Revocation Status. |pending|1|Revocation pending.| |issued|2|Revocation command issued.| |failed|3|Revocation failed.|-|revoked|4|Revoked.| +|revoked|4|Revoked.| |
v1.0 | Intune Deviceconfig Changeuefisettingspermission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-changeuefisettingspermission.md | Defines the permission level granted to users to enable them change Uefi setting |Member|Value|Description| |:|:|:| |notConfiguredOnly|0|Device default value, no intent.|-|none|1|Prevent change of UEFI setting permission| +|none|1|Prevent change of UEFI setting permission| |
v1.0 | Intune Deviceconfig Code | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-code.md | Error code for rule validation. |duplicateLocales|28|Duplicate locales error.| |unrecognizedLocale|29|Unrecognized locale error.| |unknown|30|Unknown error.|-|remediationStringsMissing|31|Remediation strings missing error.| +|remediationStringsMissing|31|Remediation strings missing error.| |
v1.0 | Intune Deviceconfig Configurationusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-configurationusage.md | Possible values of the ConfigurationUsage list. |blocked|0|Disallowed.| |required|1|Required.| |allowed|2|Optional.|-|notConfigured|3|Not Configured.| +|notConfigured|3|Not Configured.| |
v1.0 | Intune Deviceconfig Credentialsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-credentialsinglesignonextension.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Cryptographysuite | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-cryptographysuite.md | Here is a JSON representation of the resource. "authenticationTransformConstants": "String", "pfsGroup": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Customsubjectalternativename | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-customsubjectalternativename.md | Here is a JSON representation of the resource. "sanType": "String", "name": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Customupdatetimewindow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-customupdatetimewindow.md | Here is a JSON representation of the resource. "startTime": "String (time of day)", "endTime": "String (time of day)" }-``` +``` |
v1.0 | Intune Deviceconfig Datatype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-datatype.md | Data types for rules. |doubleArray|11|Double array data type.| |stringArray|12|String array data type.| |dateTimeArray|13|DateTime array data type.|-|versionArray|14|Version array data type.| +|versionArray|14|Version array data type.| |
v1.0 | Intune Deviceconfig Dayofweek | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-dayofweek.md | Possible values for a weekday |wednesday|3|Wednesday.| |thursday|4|Thursday.| |friday|5|Friday.|-|saturday|6|Saturday.| +|saturday|6|Saturday.| |
v1.0 | Intune Deviceconfig Defaultdevicecompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defaultdevicecompliancepolicy.md | Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Defenderattacksurfacetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderattacksurfacetype.md | Possible values of Defender Attack Surface Reduction Rules |block|1|Enable the attack surface reduction rule.| |auditMode|2|Evaluate how the ASR rule would impact your organization if enabled. Does not change functionality but generate logs.| |warn|6|Warning message to end user with ability to bypass block from attack surface reduction rule.|-|disable|99|Disable the attack surface reduction rule| +|disable|99|Disable the attack surface reduction rule| |
v1.0 | Intune Deviceconfig Defendercloudblockleveltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defendercloudblockleveltype.md | Possible values of Cloud Block Level |notConfigured|0|Default value, uses the default Windows Defender Antivirus blocking level and provides strong detection without increasing the risk of detecting legitimate files| |high|1|High applies a strong level of detection.| |highPlus|2|High + uses the High level and applies addition protection measures|-|zeroTolerance|3|Zero tolerance blocks all unknown executables| +|zeroTolerance|3|Zero tolerance blocks all unknown executables| |
v1.0 | Intune Deviceconfig Defenderdetectedmalwareactions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderdetectedmalwareactions.md | Here is a JSON representation of the resource. "highSeverity": "String", "severeSeverity": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Defendermonitorfileactivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defendermonitorfileactivity.md | Possible values for monitoring file activity. |disable|1|Disable monitoring file activity.| |monitorAllFiles|2|Monitor all files.| |monitorIncomingFilesOnly|3| Monitor incoming files only.|-|monitorOutgoingFilesOnly|4|Monitor outgoing files only.| +|monitorOutgoingFilesOnly|4|Monitor outgoing files only.| |
v1.0 | Intune Deviceconfig Defenderpotentiallyunwantedappaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderpotentiallyunwantedappaction.md | DefenderΓÇÖs action to take on detected Potentially Unwanted Application (PUA). |:|:|:| |deviceDefault|0|PUA Protection is off. Defender will not protect against potentially unwanted applications.| |block|1|PUA Protection is on. Detected items are blocked. They will show in history along with other threats.|-|audit|2|Audit mode. Defender will detect potentially unwanted applications, but take no actions. You can review information about applications Defender would have taken action against by searching for events created by Defender in the Event Viewer.| +|audit|2|Audit mode. Defender will detect potentially unwanted applications, but take no actions. You can review information about applications Defender would have taken action against by searching for events created by Defender in the Event Viewer.| |
v1.0 | Intune Deviceconfig Defenderpromptforsamplesubmission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderpromptforsamplesubmission.md | Possible values for prompting user for samples submission. |alwaysPrompt|1|Always prompt.| |promptBeforeSendingPersonalData|2|Send safe samples automatically.| |neverSendData|3|Never send data.|-|sendAllDataWithoutPrompting|4|Send all data without prompting.| +|sendAllDataWithoutPrompting|4|Send all data without prompting.| |
v1.0 | Intune Deviceconfig Defenderprotectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderprotectiontype.md | Possible values of Defender PUA Protection |enable|1|Block functionality.| |auditMode|2|Allow functionality but generate logs.| |warn|6|Warning message to end user with ability to bypass block from attack surface reduction rule.|-|notConfigured|99|Not configured.| +|notConfigured|99|Not configured.| |
v1.0 | Intune Deviceconfig Defenderrealtimescandirection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderrealtimescandirection.md | Possible values for monitoring file activity. |:|:|:| |monitorAllFiles|0|0 (default) ΓÇô Monitor all files(bi-directional)| |monitorIncomingFilesOnly|1|Monitor incoming files only.|-|monitorOutgoingFilesOnly|2|Monitor outgoing files only.| +|monitorOutgoingFilesOnly|2|Monitor outgoing files only.| |
v1.0 | Intune Deviceconfig Defenderscantype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderscantype.md | Possible values for system scan type. |userDefined|0|User Defined, default value, no intent.| |disabled|1|System scan disabled.| |quick|2|Quick system scan.|-|full|3|Full system scan.| +|full|3|Full system scan.| |
v1.0 | Intune Deviceconfig Defendersecuritycenteritcontactdisplaytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defendersecuritycenteritcontactdisplaytype.md | Possible values for defenderSecurityCenterITContactDisplay |notConfigured|0|Not Configured| |displayInAppAndInNotifications|1|Display in app and in notifications| |displayOnlyInApp|2|Display only in app|-|displayOnlyInNotifications|3|Display only in notifications| +|displayOnlyInNotifications|3|Display only in notifications| |
v1.0 | Intune Deviceconfig Defendersecuritycenternotificationsfromapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defendersecuritycenternotificationsfromapptype.md | Possible values for defenderSecurityCenterNotificationsFromApp |:|:|:| |notConfigured|0|Not Configured| |blockNoncriticalNotifications|1|Block non-critical notifications|-|blockAllNotifications|2|Block all notifications| +|blockAllNotifications|2|Block all notifications| |
v1.0 | Intune Deviceconfig Defendersubmitsamplesconsenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defendersubmitsamplesconsenttype.md | Possible values for DefenderSubmitSamplesConsentType |sendSafeSamplesAutomatically|0|Send safe samples automatically| |alwaysPrompt|1|Always prompt| |neverSend|2|Never send|-|sendAllSamplesAutomatically|3|Send all samples automatically| +|sendAllSamplesAutomatically|3|Send all samples automatically| |
v1.0 | Intune Deviceconfig Defenderthreataction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderthreataction.md | DefenderΓÇÖs default action to take on detected Malware threats. |remove|3|Remove the detected threat.| |allow|4|Allow the detected threat.| |userDefined|5|Allow the user to determine the action to take with the detected threat.|-|block|6|Block the detected threat.| +|block|6|Block the detected threat.| |
v1.0 | Intune Deviceconfig Deliveryoptimizationbandwidth | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationbandwidth.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deliveryOptimizationBandwidth" }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationbandwidthabsolute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationbandwidthabsolute.md | Here is a JSON representation of the resource. "maximumDownloadBandwidthInKilobytesPerSecond": 1024, "maximumUploadBandwidthInKilobytesPerSecond": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationbandwidthbusinesshourslimit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationbandwidthbusinesshourslimit.md | Here is a JSON representation of the resource. "bandwidthPercentageDuringBusinessHours": 1024, "bandwidthPercentageOutsideBusinessHours": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationbandwidthhourswithpercentage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationbandwidthhourswithpercentage.md | Here is a JSON representation of the resource. "bandwidthPercentageOutsideBusinessHours": 1024 } }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationbandwidthpercentage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationbandwidthpercentage.md | Here is a JSON representation of the resource. "maximumBackgroundBandwidthPercentage": 1024, "maximumForegroundBandwidthPercentage": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationgroupidcustom | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationgroupidcustom.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deliveryOptimizationGroupIdCustom", "groupIdCustom": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationgroupidoptionstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationgroupidoptionstype.md | Possible values for the DeliveryOptimizationGroupIdOptionsType setting. |adSite|1|Active Directory site.| |authenticatedDomainSid|2|Authenticated domain SID.| |dhcpUserOption|3|DHCP user option.|-|dnsSuffix|4|DNS suffix.| +|dnsSuffix|4|DNS suffix.| |
v1.0 | Intune Deviceconfig Deliveryoptimizationgroupidsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationgroupidsource.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deliveryOptimizationGroupIdSource" }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationgroupidsourceoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationgroupidsourceoptions.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deliveryOptimizationGroupIdSourceOptions", "groupIdSourceOption": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationmaxcachesize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationmaxcachesize.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deliveryOptimizationMaxCacheSize" }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationmaxcachesizeabsolute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationmaxcachesizeabsolute.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deliveryOptimizationMaxCacheSizeAbsolute", "maximumCacheSizeInGigabytes": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationmaxcachesizepercentage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationmaxcachesizepercentage.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deliveryOptimizationMaxCacheSizePercentage", "maximumCacheSizePercentage": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deliveryoptimizationrestrictpeerselectionbyoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationrestrictpeerselectionbyoptions.md | Values to restrict peer selection by. |Member|Value|Description| |:|:|:| |notConfigured|0|Not configured.|-|subnetMask|1|Subnet mask.| +|subnetMask|1|Subnet mask.| |
v1.0 | Intune Deviceconfig Derivedcredentialprovidertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-derivedcredentialprovidertype.md | Provider type for Derived Credentials. |entrustDataCard|1|Entrust.| |purebred|2|Purebred - Defense Information Systems Agency.| |xTec|3|Xtec - AuthentX.|-|intercede|4|Intercede.| +|intercede|4|Intercede.| |
v1.0 | Intune Deviceconfig Devicecomplianceactionitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecomplianceactionitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Devicecomplianceactiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecomplianceactiontype.md | Scheduled Action Type Enum |wipe|4|Wipe the device| |removeResourceAccessProfiles|5|Remove Resource Access Profiles from the device| |pushNotification|9|Send push notification to device|-|remoteLock|10|Remotely lock the device| +|remoteLock|10|Remotely lock the device| |
v1.0 | Intune Deviceconfig Devicecompliancedeviceoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancedeviceoverview.md | Here is a JSON representation of the resource. "lastUpdateDateTime": "String (timestamp)", "configurationVersion": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancedevicestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancedevicestatus.md | Here is a JSON representation of the resource. "lastReportedDateTime": "String (timestamp)", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicy.md | This is the base class for Compliance policy. Compliance policies are platform s ## Methods |Method|Return Type|Description| |:|:|:|-|[List deviceCompliancePolicies](../api/intune-deviceconfig-devicecompliancepolicy-list.md)|[deviceCompliancePolicy](../resources/intune-deviceconfig-devicecompliancepolicy.md) collection|List properties and relationships of the [deviceCompliancePolicy](../resources/intune-deviceconfig-devicecompliancepolicy.md) objects.| -|[Get deviceCompliancePolicy](../api/intune-deviceconfig-devicecompliancepolicy-get.md)|[deviceCompliancePolicy](../resources/intune-deviceconfig-devicecompliancepolicy.md)|Read properties and relationships of the [deviceCompliancePolicy](../resources/intune-deviceconfig-devicecompliancepolicy.md) object.| +|[List deviceCompliancePolicies](../api/intune-deviceconfig-devicecompliancepolicy-list.md)|[deviceCompliancePolicy](../resources/intune-shared-devicecompliancepolicy.md) collection|List properties and relationships of the [deviceCompliancePolicy](../resources/intune-shared-devicecompliancepolicy.md) objects.| +|[Get deviceCompliancePolicy](../api/intune-deviceconfig-devicecompliancepolicy-get.md)|[deviceCompliancePolicy](../resources/intune-shared-devicecompliancepolicy.md)|Read properties and relationships of the [deviceCompliancePolicy](../resources/intune-shared-devicecompliancepolicy.md) object.| |[assign action](../api/intune-deviceconfig-devicecompliancepolicy-assign.md)|[deviceCompliancePolicyAssignment](../resources/intune-deviceconfig-devicecompliancepolicyassignment.md) collection|| |[validateComplianceScript action](../api/intune-deviceconfig-devicecompliancepolicy-validatecompliancescript.md)|[deviceComplianceScriptValidationResult](../resources/intune-deviceconfig-devicecompliancescriptvalidationresult.md)|| |[scheduleActionsForRules action](../api/intune-deviceconfig-devicecompliancepolicy-scheduleactionsforrules.md)|None|| Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancepolicyassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicyassignment.md | Here is a JSON representation of the resource. "source": "String", "sourceId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancepolicydevicestatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicydevicestatesummary.md | Here is a JSON representation of the resource. "errorDeviceCount": 1024, "conflictDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancepolicyscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicyscript.md | Here is a JSON representation of the resource. "deviceComplianceScriptId": "String", "rulesContent": "binary" }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancepolicysettingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicysettingstate.md | Here is a JSON representation of the resource. "currentValue": "String", "settingInstanceId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancepolicysettingstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicysettingstatesummary.md | Here is a JSON representation of the resource. "errorDeviceCount": 1024, "conflictDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancescheduledactionforrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescheduledactionforrule.md | Here is a JSON representation of the resource. "id": "String (identifier)", "ruleName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancescripterror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescripterror.md | Here is a JSON representation of the resource. "deviceComplianceScriptRulesValidationError": "String", "message": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancescriptrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptrule.md | Here is a JSON representation of the resource. "deviceComplianceScriptRuleDataType": "String", "operand": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancescriptruledatatype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptruledatatype.md | Data types for rules. |doubleArray|11|Double array data type.| |stringArray|12|String array data type.| |dateTimeArray|13|DateTime array data type.|-|versionArray|14|Version array data type.| +|versionArray|14|Version array data type.| |
v1.0 | Intune Deviceconfig Devicecompliancescriptruleerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptruleerror.md | Here is a JSON representation of the resource. "message": "String", "settingName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancescriptrulesvalidationerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptrulesvalidationerror.md | Error code for rule validation. |duplicateLocales|28|Duplicate locales error.| |unrecognizedLocale|29|Unrecognized locale error.| |unknown|30|Unknown error.|-|remediationStringsMissing|31|Remediation strings missing error.| +|remediationStringsMissing|31|Remediation strings missing error.| |
v1.0 | Intune Deviceconfig Devicecompliancescriptruloperator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptruloperator.md | Operator for rules. |setEquals|21|SetEquals operator.| |orderedSetEquals|22|OrderedSetEquals operator.| |subsetOf|23|SubsetOf operator.|-|excludesAll|24|ExcludesAll operator.| +|excludesAll|24|ExcludesAll operator.| |
v1.0 | Intune Deviceconfig Devicecompliancescriptvalidationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptvalidationresult.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Devicecompliancesettingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancesettingstate.md | Here is a JSON representation of the resource. "state": "String", "complianceGracePeriodExpirationDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceconfig Devicecomplianceuseroverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecomplianceuseroverview.md | Here is a JSON representation of the resource. "lastUpdateDateTime": "String (timestamp)", "configurationVersion": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Devicecomplianceuserstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecomplianceuserstatus.md | Here is a JSON representation of the resource. "lastReportedDateTime": "String (timestamp)", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigassignmentintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigassignmentintent.md | The administrator intent for the assignment of the profile. |Member|Value|Description| |:|:|:| |apply|0|Ensure that the configuration profile is applied to the devices in the assignment.|-|remove|1|Ensure that the configuration profile is removed from devices that have previously installed the configuration profile.| +|remove|1|Ensure that the configuration profile is removed from devices that have previously installed the configuration profile.| |
v1.0 | Intune Deviceconfig Deviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfiguration.md | Device Configuration. ## Methods |Method|Return Type|Description| |:|:|:|-|[List deviceConfigurations](../api/intune-deviceconfig-deviceconfiguration-list.md)|[deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md) collection|List properties and relationships of the [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md) objects.| -|[Get deviceConfiguration](../api/intune-deviceconfig-deviceconfiguration-get.md)|[deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)|Read properties and relationships of the [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md) object.| +|[List deviceConfigurations](../api/intune-deviceconfig-deviceconfiguration-list.md)|[deviceConfiguration](../resources/intune-shared-deviceconfiguration.md) collection|List properties and relationships of the [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md) objects.| +|[Get deviceConfiguration](../api/intune-deviceconfig-deviceconfiguration-get.md)|[deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)|Read properties and relationships of the [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md) object.| |[assign action](../api/intune-deviceconfig-deviceconfiguration-assign.md)|[deviceConfigurationAssignment](../resources/intune-deviceconfig-deviceconfigurationassignment.md) collection|| |[getOmaSettingPlainTextValue function](../api/intune-deviceconfig-deviceconfiguration-getomasettingplaintextvalue.md)|String|| |[windowsPrivacyAccessControls action](../api/intune-deviceconfig-deviceconfiguration-windowsprivacyaccesscontrols.md)|None|| Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationassignment.md | Here is a JSON representation of the resource. "sourceId": "String", "intent": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationconflictsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationconflictsummary.md | Here is a JSON representation of the resource. ], "deviceCheckinsImpacted": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationdeviceoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationdeviceoverview.md | Here is a JSON representation of the resource. "lastUpdateDateTime": "String (timestamp)", "configurationVersion": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationdevicestatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationdevicestatesummary.md | Here is a JSON representation of the resource. "errorDeviceCount": 1024, "conflictDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationdevicestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationdevicestatus.md | Here is a JSON representation of the resource. "lastReportedDateTime": "String (timestamp)", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationgroupassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationgroupassignment.md | Here is a JSON representation of the resource. "targetGroupId": "String", "excludeGroup": true }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationsettingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationsettingstate.md | Here is a JSON representation of the resource. "currentValue": "String", "settingInstanceId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationtargeteduseranddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationtargeteduseranddevice.md | Here is a JSON representation of the resource. "userPrincipalName": "String", "lastCheckinDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationuseroverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationuseroverview.md | Here is a JSON representation of the resource. "lastUpdateDateTime": "String (timestamp)", "configurationVersion": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationuserstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationuserstatesummary.md | Here is a JSON representation of the resource. "errorUserCount": 1024, "conflictUserCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Deviceconfigurationuserstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationuserstatus.md | Here is a JSON representation of the resource. "lastReportedDateTime": "String (timestamp)", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Deviceguardlocalsystemauthoritycredentialguardtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceguardlocalsystemauthoritycredentialguardtype.md | Possible values of Credential Guard settings. |notConfigured|0|Turns off Credential Guard remotely if configured previously without UEFI Lock.| |enableWithUEFILock|1|Turns on Credential Guard with UEFI lock.| |enableWithoutUEFILock|2|Turns on Credential Guard without UEFI lock.|-|disable|3|Disables Credential Guard. This is the default OS value.| +|disable|3|Disables Credential Guard. This is the default OS value.| |
v1.0 | Intune Deviceconfig Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagement.md | + + Title: "deviceManagement resource type" +description: "Singleton entity that acts as a container for all device management functionality." ++localization_priority: Normal ++++# 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-deviceconfig-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-deviceconfig-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[enableUnlicensedAdminstrators action](../api/intune-deviceconfig-devicemanagement-enableunlicensedadminstrators.md)|None|Upon enabling, users assigned as administrators via Role Assignment Memberships will no longer require an assigned Intune license. You are limited to 350 unlicensed direct members for each AAD security group in a role assignment, but you can assign multiple AAD security groups to a role if you need to support more than 350 unlicensed administrators. Licensed administrators will continue to function as-is in that transitive memberships apply and are not subject to the 350 member limit.| +|[enableLegacyPcManagement action](../api/intune-deviceconfig-devicemanagement-enablelegacypcmanagement.md)|None|| +|[enableAndroidDeviceAdministratorEnrollment action](../api/intune-deviceconfig-devicemanagement-enableandroiddeviceadministratorenrollment.md)|None|| +|[enableEndpointPrivilegeManagement action](../api/intune-deviceconfig-devicemanagement-enableendpointprivilegemanagement.md)|None|Triggers onboarding of tenant to Microsoft Managed Platform - Cloud (MMP-C).| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|Unique Identifier| +|settings|[deviceManagementSettings](../resources/intune-deviceconfig-devicemanagementsettings.md)|Account level settings.| +|maximumDepTokens|Int32|Maximum number of dep tokens allowed per-tenant.| +|intuneAccountId|Guid|Intune Account Id for given tenant| +|lastReportAggregationDateTime|DateTimeOffset|The last modified time of reporting for this account. This property is read-only.| +|deviceComplianceReportSummarizationDateTime|DateTimeOffset|The last requested time of device compliance reporting for this account. This property is read-only.| +|legacyPcManangementEnabled|Boolean|The property to enable Non-MDM managed legacy PC management for this account. This property is read-only.| +|unlicensedAdminstratorsEnabled|Boolean|When enabled, users assigned as administrators via Role Assignment Memberships do not require an assigned Intune license. Prior to this, only Intune licensed users were granted permissions with an Intune role unless they were assigned a role via Azure Active Directory. You are limited to 350 unlicensed direct members for each AAD security group in a role assignment, but you can assign multiple AAD security groups to a role if you need to support more than 350 unlicensed administrators. Licensed administrators are unaffected, do not have to be direct members, nor does the 350 member limit apply. This property is read-only.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|deviceConfigurations|[deviceConfiguration](../resources/intune-shared-deviceconfiguration.md) collection|The device configurations.| +|deviceCompliancePolicies|[deviceCompliancePolicy](../resources/intune-shared-devicecompliancepolicy.md) collection|The device compliance policies.| +|softwareUpdateStatusSummary|[softwareUpdateStatusSummary](../resources/intune-deviceconfig-softwareupdatestatussummary.md)|The software update status summary.| +|deviceCompliancePolicyDeviceStateSummary|[deviceCompliancePolicyDeviceStateSummary](../resources/intune-deviceconfig-devicecompliancepolicydevicestatesummary.md)|The device compliance state summary for this account.| +|deviceCompliancePolicySettingStateSummaries|[deviceCompliancePolicySettingStateSummary](../resources/intune-deviceconfig-devicecompliancepolicysettingstatesummary.md) collection|The summary states of compliance policy settings for this account.| +|advancedThreatProtectionOnboardingStateSummary|[advancedThreatProtectionOnboardingStateSummary](../resources/intune-deviceconfig-advancedthreatprotectiononboardingstatesummary.md)|The summary state of ATP onboarding state for this account.| +|deviceConfigurationDeviceStateSummaries|[deviceConfigurationDeviceStateSummary](../resources/intune-deviceconfig-deviceconfigurationdevicestatesummary.md)|The device configuration device state summary for this account.| +|deviceConfigurationUserStateSummaries|[deviceConfigurationUserStateSummary](../resources/intune-deviceconfig-deviceconfigurationuserstatesummary.md)|The device configuration user state summary for this account.| +|cartToClassAssociations|[cartToClassAssociation](../resources/intune-deviceconfig-carttoclassassociation.md) collection|The Cart To Class Associations.| +|iosUpdateStatuses|[iosUpdateDeviceStatus](../resources/intune-deviceconfig-iosupdatedevicestatus.md) collection|The IOS software update installation statuses for this account.| +|ndesConnectors|[ndesConnector](../resources/intune-deviceconfig-ndesconnector.md) collection|The collection of Ndes connectors for this account.| +|deviceConfigurationRestrictedAppsViolations|[restrictedAppsViolation](../resources/intune-deviceconfig-restrictedappsviolation.md) collection|Restricted apps violations for this account.| +|managedDeviceEncryptionStates|[managedDeviceEncryptionState](../resources/intune-deviceconfig-manageddeviceencryptionstate.md) collection|Encryption report for devices in this account| +|deviceConfigurationConflictSummary|[deviceConfigurationConflictSummary](../resources/intune-deviceconfig-deviceconfigurationconflictsummary.md) collection|Summary of policies in conflict state for this account.| +|deviceConfigurationsAllManagedDeviceCertificateStates|[managedAllDeviceCertificateState](../resources/intune-deviceconfig-managedalldevicecertificatestate.md) collection|Summary of all certificates for all devices.| +|macOSSoftwareUpdateAccountSummaries|[macOSSoftwareUpdateAccountSummary](../resources/intune-deviceconfig-macossoftwareupdateaccountsummary.md) collection|The MacOS software update account summaries for this account.| +|hardwareConfigurations|[hardwareConfiguration](../resources/intune-deviceconfig-hardwareconfiguration.md) collection|The hardware configurations for this account.| +|hardwarePasswordInfo|[hardwarePasswordInfo](../resources/intune-deviceconfig-hardwarepasswordinfo.md) collection|The hardware password info for this 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)", + "settings": { + "@odata.type": "microsoft.graph.deviceManagementSettings", + "deviceComplianceCheckinThresholdDays": 1024, + "isScheduledActionEnabled": true, + "secureByDefault": true, + "enhancedJailBreak": true, + "deviceInactivityBeforeRetirementInDay": 1024, + "derivedCredentialProvider": "String", + "derivedCredentialUrl": "String", + "androidDeviceAdministratorEnrollmentEnabled": true, + "ignoreDevicesForUnsupportedSettingsEnabled": true, + "enableLogCollection": true, + "enableAutopilotDiagnostics": true, + "enableEnhancedTroubleshootingExperience": true, + "enableDeviceGroupMembershipReport": true, + "m365AppDiagnosticsEnabled": true + }, + "maximumDepTokens": 1024, + "intuneAccountId": "Guid", + "lastReportAggregationDateTime": "String (timestamp)", + "deviceComplianceReportSummarizationDateTime": "String (timestamp)", + "legacyPcManangementEnabled": true, + "unlicensedAdminstratorsEnabled": true +} +``` |
v1.0 | Intune Deviceconfig Devicemanagementapplicabilityruledevicemode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md | Here is a JSON representation of the resource. "name": "String", "ruleType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicemanagementapplicabilityruleosedition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md | Here is a JSON representation of the resource. "name": "String", "ruleType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicemanagementapplicabilityruleosversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md | Here is a JSON representation of the resource. "name": "String", "ruleType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicemanagementapplicabilityruletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementapplicabilityruletype.md | Supported Applicability rule types for Device Configuration |Member|Value|Description| |:|:|:| |include|0|Include|-|exclude|1|Exclude| +|exclude|1|Exclude| |
v1.0 | Intune Deviceconfig Devicemanagementcertificationauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementcertificationauthority.md | Device Management Certification Authority Types. |:|:|:| |notConfigured|0|Not configured.| |microsoft|1|Microsoft Certification Authority type.|-|digiCert|2|DigiCert Certification Authority type.| +|digiCert|2|DigiCert Certification Authority type.| |
v1.0 | Intune Deviceconfig Devicemanagementderivedcredentialsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md | Namespace: microsoft.graph ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagementDerivedCredentialSettings](../api/intune-deviceconfig-devicemanagementderivedcredentialsettings-get.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md)|Read properties and relationships of the [deviceManagementDerivedCredentialSettings](../resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md) object.| -|[Update deviceManagementDerivedCredentialSettings](../api/intune-deviceconfig-devicemanagementderivedcredentialsettings-update.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md)|Update the properties of a [deviceManagementDerivedCredentialSettings](../resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md) object.| +|[Get deviceManagementDerivedCredentialSettings](../api/intune-deviceconfig-devicemanagementderivedcredentialsettings-get.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md)|Read properties and relationships of the [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object.| +|[Update deviceManagementDerivedCredentialSettings](../api/intune-deviceconfig-devicemanagementderivedcredentialsettings-update.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md)|Update the properties of a [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementDerivedCredentialSettings", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Deviceconfig Devicemanagementsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementsettings.md | Here is a JSON representation of the resource. "enableDeviceGroupMembershipReport": true, "m365AppDiagnosticsEnabled": true }-``` +``` |
v1.0 | Intune Deviceconfig Devicemanagementuserrightslocaluserorgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementuserrightslocaluserorgroup.md | Here is a JSON representation of the resource. "description": "String", "securityIdentifier": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Devicemanagementuserrightssetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementuserrightssetting.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceplatformtype.md | Supported platform types. |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.|-|windowsMobileApplicationManagement|13|Indicates device platform type associated with Mobile Application Management (MAM) for Windows devices.| +|windowsMobileApplicationManagement|13|Indicates device platform type associated with Mobile Application Management (MAM) for Windows devices.| |
v1.0 | Intune Deviceconfig Devicethreatprotectionlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicethreatprotectionlevel.md | Device threat protection levels for the Device Threat Protection API. |low|2|Device Threat Protection level requirement: Low. Low represents a severity of threat that poses minimal risk to the device or device data.| |medium|3|Device Threat Protection level requirement: Medium. Medium represents a severity of threat that poses moderate risk to the device or device data.| |high|4|Device Threat Protection level requirement: High. High represents a severity of threat that poses severe risk to the device or device data.|-|notSet|10|Device Threat Protection level requirement: Not Set. Not set represents that there is no requirement for the device to meet a Threat Protection level.| +|notSet|10|Device Threat Protection level requirement: Not Set. Not set represents that there is no requirement for the device to meet a Threat Protection level.| |
v1.0 | Intune Deviceconfig Devicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicetype.md | Device type. |blackberry|100|Blackberry.| |palm|101|Palm.| |unknown|255|Represents that the device type is unknown.|-|cloudPC|257|Cloud PC device.| +|cloudPC|257|Cloud PC device.| |
v1.0 | Intune Deviceconfig Devicetypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicetypes.md | Device type. |androidEnterprise|18|Android enterprise device.| |blackberry|100|Blackberry.| |palm|101|Palm.|-|unknown|255|Represents that the device type is unknown.| +|unknown|255|Represents that the device type is unknown.| |
v1.0 | Intune Deviceconfig Diagnosticdatasubmissionmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-diagnosticdatasubmissionmode.md | Allow the device to send diagnostic and usage telemetry data, such as Watson. |none|1|No telemetry data is sent from OS components. Note: This value is only applicable to enterprise and server devices. Using this setting on other devices is equivalent to setting the value of 1.| |basic|2|Sends basic telemetry data.| |enhanced|3|Sends enhanced telemetry data including usage and insights data.|-|full|4|Sends full telemetry data including diagnostic data, such as system state.| +|full|4|Sends full telemetry data including diagnostic data, such as system state.| |
v1.0 | Intune Deviceconfig Diffiehellmangroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-diffiehellmangroup.md | Diffie Hellman Group values for Windows10 VPN policies with IKEv2 connection typ |group14|2|Group14| |ecp256|3|ECP256| |ecp384|4|ECP384|-|group24|5|Group24| +|group24|5|Group24| |
v1.0 | Intune Deviceconfig Dmaguarddeviceenumerationpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-dmaguarddeviceenumerationpolicytype.md | Possible values of the DmaGuardDeviceEnumerationPolicy. |:|:|:| |deviceDefault|0|Default value. Devices with DMA remapping incompatible drivers will only be enumerated after the user unlocks the screen.| |blockAll|1|Devices with DMA remapping incompatible drivers will never be allowed to start and perform DMA at any time.|-|allowAll|2|All external DMA capable PCIe devices will be enumerated at any time.| +|allowAll|2|All external DMA capable PCIe devices will be enumerated at any time.| |
v1.0 | Intune Deviceconfig Domainnamesource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-domainnamesource.md | Domainname source. |Member|Value|Description| |:|:|:| |fullDomainName|0|Full domain name.|-|netBiosDomainName|1|net bios domain name.| +|netBiosDomainName|1|net bios domain name.| |
v1.0 | Intune Deviceconfig Eapfastconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-eapfastconfiguration.md | Available settings for EAP-FAST Configuration. |noProtectedAccessCredential|0|Use EAP-FAST without Protected Access Credential (PAC).| |useProtectedAccessCredential|1|Use Protected Access Credential (PAC).| |useProtectedAccessCredentialAndProvision|2|Use Protected Access Credential (PAC) and Provision PAC.|-|useProtectedAccessCredentialAndProvisionAnonymously|3|Use Protected Access Credential (PAC), Provision PAC, and do so anonymously.| +|useProtectedAccessCredentialAndProvisionAnonymously|3|Use Protected Access Credential (PAC), Provision PAC, and do so anonymously.| |
v1.0 | Intune Deviceconfig Eaptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-eaptype.md | Extensible Authentication Protocol (EAP) configuration types. |eapTtls|21|EAP-Tunneled Transport Layer Security (EAP-TTLS).| |peap|25|Protected Extensible Authentication Protocol (PEAP).| |eapFast|43|EAP-Flexible Authentication via Secure Tunneling (EAP-FAST).|-|teap|55|Tunnel Extensible Authentication Protocol (TEAP).| +|teap|55|Tunnel Extensible Authentication Protocol (TEAP).| |
v1.0 | Intune Deviceconfig Easauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-easauthenticationmethod.md | Exchange Active Sync authentication method. |:|:|:| |usernameAndPassword|0|Authenticate with a username and password.| |certificate|1|Authenticate with a certificate.|-|derivedCredential|2|Authenticate with derived credential.| +|derivedCredential|2|Authenticate with derived credential.| |
v1.0 | Intune Deviceconfig Easemailprofileconfigurationbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-easemailprofileconfigurationbase.md | Here is a JSON representation of the resource. "userDomainNameSource": "String", "customDomainName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Easservices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-easservices.md | Exchange Active Sync services. |contacts|2|Enables synchronization of contacts.| |email|4|Enables synchronization of email.| |notes|8|Enables synchronization of notes.|-|reminders|16|Enables synchronization of reminders.| +|reminders|16|Enables synchronization of reminders.| |
v1.0 | Intune Deviceconfig Edgecookiepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgecookiepolicy.md | Possible values to specify which cookies are allowed in Microsoft Edge. |userDefined|0|Allow the user to set.| |allow|1|Allow.| |blockThirdParty|2|Block only third party cookies.|-|blockAll|3|Block all cookies.| +|blockAll|3|Block all cookies.| |
v1.0 | Intune Deviceconfig Edgehomebuttonconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgehomebuttonconfiguration.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.edgeHomeButtonConfiguration" }-``` +``` |
v1.0 | Intune Deviceconfig Edgehomebuttonhidden | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgehomebuttonhidden.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.edgeHomeButtonHidden" }-``` +``` |
v1.0 | Intune Deviceconfig Edgehomebuttonloadsstartpage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgehomebuttonloadsstartpage.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.edgeHomeButtonLoadsStartPage" }-``` +``` |
v1.0 | Intune Deviceconfig Edgehomebuttonopenscustomurl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgehomebuttonopenscustomurl.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.edgeHomeButtonOpensCustomURL", "homeButtonCustomURL": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Edgehomebuttonopensnewtab | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgehomebuttonopensnewtab.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.edgeHomeButtonOpensNewTab" }-``` +``` |
v1.0 | Intune Deviceconfig Edgekioskmoderestrictiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgekioskmoderestrictiontype.md | Specify how the Microsoft Edge settings are restricted based on kiosk mode. |digitalSignage|1|Interactive/Digital signage in single-app mode.| |normalMode|2|Normal mode (full version of Microsoft Edge).| |publicBrowsingSingleApp|3|Public browsing in single-app mode.|-|publicBrowsingMultiApp|4|Public browsing (inPrivate) in multi-app mode.| +|publicBrowsingMultiApp|4|Public browsing (inPrivate) in multi-app mode.| |
v1.0 | Intune Deviceconfig Edgeopenoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgeopenoptions.md | Possible values for the EdgeOpensWith setting. |startPage|1|StartPage.| |newTabPage|2|NewTabPage.| |previousPages|3|PreviousPages.|-|specificPages|4|SpecificPages.| +|specificPages|4|SpecificPages.| |
v1.0 | Intune Deviceconfig Edgesearchengine | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgesearchengine.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.edgeSearchEngine", "edgeSearchEngineType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Edgesearchenginebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgesearchenginebase.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.edgeSearchEngineBase" }-``` +``` |
v1.0 | Intune Deviceconfig Edgesearchenginecustom | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgesearchenginecustom.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.edgeSearchEngineCustom", "edgeSearchEngineOpenSearchXmlUrl": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Edgesearchenginetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgesearchenginetype.md | Allows IT admind to set a predefined default search engine for MDM-Controlled de |Member|Value|Description| |:|:|:| |default|0|Uses factory settings of Edge to assign the default search engine as per the user market|-|bing|1|Sets Bing as the default search engine| +|bing|1|Sets Bing as the default search engine| |
v1.0 | Intune Deviceconfig Edgetelemetrymode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgetelemetrymode.md | Type of browsing data sent to Microsoft 365 analytics |notConfigured|0|Default ΓÇô No telemetry data collected or sent| |intranet|1|Allow sending intranet history only: Only send browsing history data for intranet sites| |internet|2|Allow sending internet history only: Only send browsing history data for internet sites|-|intranetAndInternet|3|Allow sending both intranet and internet history: Send browsing history data for intranet and internet sites| +|intranetAndInternet|3|Allow sending both intranet and internet history: Send browsing history data for intranet and internet sites| |
v1.0 | Intune Deviceconfig Editionupgradeconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-editionupgradeconfiguration.md | Here is a JSON representation of the resource. "productKey": "String", "windowsSMode": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Editionupgradelicensetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-editionupgradelicensetype.md | Edition Upgrade License type |:|:|:| |productKey|0|Product Key Type| |licenseFile|1|License File Type|-|notConfigured|2|NotConfigured| +|notConfigured|2|NotConfigured| |
v1.0 | Intune Deviceconfig Emailcertificatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-emailcertificatetype.md | Supported certificate sources for email signing and encryption. |:|:|:| |none|0|Do not use a certificate as a source.| |certificate|1|Use an certificate for certificate source.|-|derivedCredential|2|Use a derived credential for certificate source.| +|derivedCredential|2|Use a derived credential for certificate source.| |
v1.0 | Intune Deviceconfig Emailsyncduration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-emailsyncduration.md | Possible values for email sync duration. |oneWeek|3|Sync one week of email.| |twoWeeks|4|Sync two weeks of email.| |oneMonth|5|Sync one month of email.|-|unlimited|6|Sync an unlimited duration of email.| +|unlimited|6|Sync an unlimited duration of email.| |
v1.0 | Intune Deviceconfig Emailsyncschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-emailsyncschedule.md | Possible values for email sync schedule. |fifteenMinutes|3|Sync every fifteen minutes.| |thirtyMinutes|4|Sync every thirty minutes.| |sixtyMinutes|5|Sync every sixty minutes.|-|basedOnMyUsage|6|Sync based on my usage.| +|basedOnMyUsage|6|Sync based on my usage.| |
v1.0 | Intune Deviceconfig Enablement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-enablement.md | Possible values of a property |:|:|:| |notConfigured|0|Device default value, no intent.| |enabled|1|Enables the setting on the device.|-|disabled|2|Disables the setting on the device.| +|disabled|2|Disables the setting on the device.| |
v1.0 | Intune Deviceconfig Encryptionreadinessstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-encryptionreadinessstate.md | Encryption readiness state |Member|Value|Description| |:|:|:| |notReady|0|Not ready|-|ready|1|Ready| +|ready|1|Ready| |
v1.0 | Intune Deviceconfig Encryptionreportpolicydetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-encryptionreportpolicydetails.md | Here is a JSON representation of the resource. "policyId": "String", "policyName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Encryptionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-encryptionstate.md | Encryption state |Member|Value|Description| |:|:|:| |notEncrypted|0|Not encrypted|-|encrypted|1|Encrypted| +|encrypted|1|Encrypted| |
v1.0 | Intune Deviceconfig Extendedkeyusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-extendedkeyusage.md | Here is a JSON representation of the resource. "name": "String", "objectIdentifier": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Filevaultstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-filevaultstate.md | FileVault State |success|0|FileVault State Success| |driveEncryptedByUser|1|FileVault has been enabled by user and is not being managed by policy| |userDeferredEncryption|2|FileVault policy is successfully installed but user has not started encryption|-|escrowNotEnabled|4|FileVault recovery key escrow is not enabled| +|escrowNotEnabled|4|FileVault recovery key escrow is not enabled| |
v1.0 | Intune Deviceconfig Firewallcertificaterevocationlistcheckmethodtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-firewallcertificaterevocationlistcheckmethodtype.md | Possible values for firewallCertificateRevocationListCheckMethod |deviceDefault|0|No value configured by Intune, do not override the user-configured device default value| |none|1|Do not check certificate revocation list| |attempt|2|Attempt CRL check and allow a certificate only if the certificate is confirmed by the check|-|require|3|Require a successful CRL check before allowing a certificate| +|require|3|Require a successful CRL check before allowing a certificate| |
v1.0 | Intune Deviceconfig Firewallpacketqueueingmethodtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-firewallpacketqueueingmethodtype.md | Possible values for firewallPacketQueueingMethod |disabled|1|Disable packet queuing| |queueInbound|2|Queue inbound encrypted packets| |queueOutbound|3|Queue decrypted outbound packets for forwarding|-|queueBoth|4|Queue both inbound and outbound packets| +|queueBoth|4|Queue both inbound and outbound packets| |
v1.0 | Intune Deviceconfig Firewallpresharedkeyencodingmethodtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-firewallpresharedkeyencodingmethodtype.md | Possible values for firewallPreSharedKeyEncodingMethod |:|:|:| |deviceDefault|0|No value configured by Intune, do not override the user-configured device default value| |none|1|Preshared key is not encoded. Instead, it is kept in its wide-character format|-|utF8|2|Encode the preshared key using UTF-8| +|utF8|2|Encode the preshared key using UTF-8| |
v1.0 | Intune Deviceconfig Folderprotectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-folderprotectiontype.md | Possible values of Folder Protection |enable|1|Block functionality.| |auditMode|2|Allow functionality but generate logs.| |blockDiskModification|3|Block untrusted apps from writing to disk sectors.|-|auditDiskModification|4|Generate logs when untrusted apps write to disk sectors.| +|auditDiskModification|4|Generate logs when untrusted apps write to disk sectors.| |
v1.0 | Intune Deviceconfig Hardwareconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfiguration.md | Title: "hardwareConfiguration resource type" -description: "Intune will provide customer the ability to configure hardware/bios settings on the enrolled windows 10 Azure Active Directory joined devices." +description: "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." localization_priority: Normal 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. -Intune will provide customer the ability to configure hardware/bios settings on the enrolled windows 10 Azure Active Directory joined devices. +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. ## Methods |Method|Return Type|Description| Intune will provide customer the ability to configure hardware/bios settings on ## Properties |Property|Type|Description| |:|:|:|-|id|String|Unique Identifier for the hardware configuration| -|version|Int32|Version of the hardware configuration (E.g. 1, 2, 3 ...)| -|displayName|String|Name of the hardware configuration| -|description|String|Description of the hardware configuration| -|createdDateTime|DateTimeOffset|Timestamp of when the hardware configuration was created. This property is read-only.| -|lastModifiedDateTime|DateTimeOffset|Timestamp of when the hardware configuration was modified. This property is read-only.| -|fileName|String|File name of the hardware configuration| -|configurationFileContent|Binary|File content of the hardware configuration| -|hardwareConfigurationFormat|[hardwareConfigurationFormat](../resources/intune-deviceconfig-hardwareconfigurationformat.md)|Oem type of the hardware configuration (E.g. DELL, HP, Surface and SurfaceDock). Possible values are: `dell`, `surface`, `surfaceDock`.| -|roleScopeTagIds|String collection|List of Scope Tag IDs for the hardware configuration| -|perDevicePasswordDisabled|Boolean|A value indicating whether per devcive pasword disabled| +|id|String|The unique identifier of the hardware BIOS configuration profile for the enrolled devices. This id is and is autogenerated and assigned when new hardware BIOS configuration profile is created. This distinguishes profiles from each other and cannot be null. Returned by default. Read-Only.| +|version|Int32|The version of the hardware configuration (E.g. 1, 2, 3 ...). This is incremented after a change to the BIOS configuration profile's settings file name (FileName property), settings file content (ConfigurationFileContent property), or the PerDevicePasswordDisabled property. Read-Only.| +|displayName|String|The name of the hardware BIOS configuration profile. It serves as user-friendly name to identify hardware BIOS configuration profiles. Max length is 150 characters. Required. Read-Only.| +|description|String|The description of the hardware configuration. Use this to provide context, purpose, applications, etc of the BIOS configuration profile for your organization's admins. Max length is 1000 characters. Optional.| +|createdDateTime|DateTimeOffset|The date and time of when the BIOS configuration profile was created. The value cannot be modified and is automatically populated when the device is enrolled. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-Only. This property is read-only.| +|lastModifiedDateTime|DateTimeOffset|The date and time of when the BIOS configuration profile was last modified. The value cannot be modified and is automatically populated when the device is enrolled. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-Only. Read-Only. This property is read-only.| +|fileName|String|The file name for the BIOS configuration profile's ConfigurationFileContent. Max length is 150 characters. Required.| +|configurationFileContent|Binary|The file content contains custom hardware settings that will be applied to the assigned devices' BIOS. Max allowed file size is 5KB. Represented as bytes. Required.| +|hardwareConfigurationFormat|[hardwareConfigurationFormat](../resources/intune-deviceconfig-hardwareconfigurationformat.md)|The OEM type associated with BIOS configuration profile's custom hardware settings. All devices that adheres to profile must be from the same selected OEM. Possible values are Dell, Surface, and Surface dock. Required. Possible values are: `dell`, `surface`, `surfaceDock`.| +|roleScopeTagIds|String collection|A list of unique Scope Tag IDs associated with the hardware configuration. Optional.| +|perDevicePasswordDisabled|Boolean|When TRUE, indicates whether the policy-assigned devices' passwords are disabled. When FALSE, indicates they are enabled. Default is FALSE. Required.| ## Relationships |Relationship|Type|Description| |:|:|:|-|assignments|[hardwareConfigurationAssignment](../resources/intune-deviceconfig-hardwareconfigurationassignment.md) collection|List of the Azure AD user group ids that hardware configuration will be applied to. Only security groups and Office 365 Groups are supported.| -|runSummary|[hardwareConfigurationRunSummary](../resources/intune-deviceconfig-hardwareconfigurationrunsummary.md)|A summary of the results from an attempt to configure hardware settings| -|deviceRunStates|[hardwareConfigurationDeviceState](../resources/intune-deviceconfig-hardwareconfigurationdevicestate.md) collection|List of run states for the hardware configuration across all devices| -|userRunStates|[hardwareConfigurationUserState](../resources/intune-deviceconfig-hardwareconfigurationuserstate.md) collection|List of run states for the hardware configuration across all users| +|assignments|[hardwareConfigurationAssignment](../resources/intune-deviceconfig-hardwareconfigurationassignment.md) collection|A list of the Entra user group ids that hardware configuration will be applied to. Only security groups and Office 365 Groups are supported. Optional.| +|runSummary|[hardwareConfigurationRunSummary](../resources/intune-deviceconfig-hardwareconfigurationrunsummary.md)|A summary of the results from an attempt to configure hardware settings. Read-Only.| +|deviceRunStates|[hardwareConfigurationDeviceState](../resources/intune-deviceconfig-hardwareconfigurationdevicestate.md) collection|List of run states for the hardware configuration across all devices. Read-Only.| +|userRunStates|[hardwareConfigurationUserState](../resources/intune-deviceconfig-hardwareconfigurationuserstate.md) collection|List of run states for the hardware configuration across all users. Read-Only.| ## JSON Representation Here is a JSON representation of the resource. Here is a JSON representation of the resource. ], "perDevicePasswordDisabled": true }-``` +``` |
v1.0 | Intune Deviceconfig Hardwareconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfigurationassignment.md | Here is a JSON representation of the resource. "entraObjectId": "String" } }-``` +``` |
v1.0 | Intune Deviceconfig Hardwareconfigurationdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfigurationdevicestate.md | Here is a JSON representation of the resource. "assignmentFilterIds": "String", "userId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Hardwareconfigurationformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfigurationformat.md | Indicates the supported oems of hardware configuration |:|:|:| |dell|1|Dell| |surface|2|Surface|-|surfaceDock|3|Surface dock| +|surfaceDock|3|Surface dock| |
v1.0 | Intune Deviceconfig Hardwareconfigurationrunsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfigurationrunsummary.md | Here is a JSON representation of the resource. "unknownUserCount": 1024, "lastRunDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceconfig Hardwareconfigurationuserstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfigurationuserstate.md | Here is a JSON representation of the resource. "notApplicableDeviceCount": 1024, "unknownDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Hardwarepasswordinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwarepasswordinfo.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Inkaccesssetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-inkaccesssetting.md | Values for the InkWorkspaceAccess setting. |:|:|:| |notConfigured|0|Not configured.| |enabled|1|Enabled.|-|disabled|2|Disabled.| +|disabled|2|Disabled.| |
v1.0 | Intune Deviceconfig Intendedpurpose | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-intendedpurpose.md | PFX Import Options. |smimeEncryption|2|SmimeEncryption| |smimeSigning|3|SmimeSigning| |vpn|4|VPN|-|wifi|5|Wifi| +|wifi|5|Wifi| |
v1.0 | Intune Deviceconfig Internetexplorermessagesetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-internetexplorermessagesetting.md | What message will be displayed by Edge before switching to Internet Explorer. |notConfigured|0|Not configured.| |disabled|1|Disabled.| |enabled|2|Enabled.|-|keepGoing|3|KeepGoing.| +|keepGoing|3|KeepGoing.| |
v1.0 | Intune Deviceconfig Internetsitesecuritylevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-internetsitesecuritylevel.md | Possible values for internet site security level. |userDefined|0|User Defined, default value, no intent.| |medium|1|Medium.| |mediumHigh|2|Medium-High.|-|high|3|High.| +|high|3|High.| |
v1.0 | Intune Deviceconfig Iosazureadsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosazureadsinglesignonextension.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Iosbookmark | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosbookmark.md | Here is a JSON representation of the resource. "bookmarkFolder": "String", "displayName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Ioscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioscertificateprofile.md | Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Ioscertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioscertificateprofilebase.md | Here is a JSON representation of the resource. "certificateValidityPeriodValue": 1024, "certificateValidityPeriodScale": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Ioscompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioscompliancepolicy.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Ioscredentialsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioscredentialsinglesignonextension.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Ioscustomconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioscustomconfiguration.md | Here is a JSON representation of the resource. "payloadFileName": "String", "payload": "binary" }-``` +``` |
v1.0 | Intune Deviceconfig Iosderivedcredentialauthenticationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosderivedcredentialauthenticationconfiguration.md | Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Iosdevicefeaturesconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosdevicefeaturesconfiguration.md | Here is a JSON representation of the resource. "managedAppsInBundleIdACLIncluded": true } }-``` +``` |
v1.0 | Intune Deviceconfig Ioseasemailprofileconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioseasemailprofileconfiguration.md | Here is a JSON representation of the resource. "encryptionCertificateType": "String", "perAppVPNProfileId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Ioseducationdeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioseducationdeviceconfiguration.md | Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Ioseducertificatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioseducertificatesettings.md | Here is a JSON representation of the resource. "certificateValidityPeriodValue": 1024, "certificateValidityPeriodScale": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Iosedudeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosedudeviceconfiguration.md | Here is a JSON representation of the resource. "certificateValidityPeriodScale": "String" } }-``` +``` |
v1.0 | Intune Deviceconfig Iosenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosenterprisewificonfiguration.md | Here is a JSON representation of the resource. "usernameFormatString": "String", "passwordFormatString": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Iosexpeditedcheckinconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosexpeditedcheckinconfiguration.md | Here is a JSON representation of the resource. "version": 1024, "enableExpeditedCheckin": true }-``` +``` |
v1.0 | Intune Deviceconfig Iosgeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosgeneraldeviceconfiguration.md | Here is a JSON representation of the resource. "iCloudPrivateRelayBlocked": true, "kioskModeAppType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Ioshomescreenapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioshomescreenapp.md | Here is a JSON representation of the resource. "bundleID": "String", "isWebClip": true }-``` +``` |
v1.0 | Intune Deviceconfig Ioshomescreenfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioshomescreenfolder.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Ioshomescreenfolderpage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioshomescreenfolderpage.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Ioshomescreenitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioshomescreenitem.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.iosHomeScreenItem", "displayName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Ioshomescreenpage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioshomescreenpage.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Iosikev2vpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosikev2vpnconfiguration.md | Here is a JSON representation of the resource. "enableAlwaysOnConfiguration": true, "mtuSizeInBytes": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Iosimportedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosimportedpfxcertificateprofile.md | Here is a JSON representation of the resource. "version": 1024, "intendedPurpose": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Ioskerberossinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioskerberossinglesignonextension.md | Here is a JSON representation of the resource. "signInHelpText": "String", "managedAppsInBundleIdACLIncluded": true }-``` +``` |
v1.0 | Intune Deviceconfig Ioskioskmodeapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioskioskmodeapptype.md | App source options for iOS kiosk mode. |notConfigured|0|Device default value, no intent.| |appStoreApp|1|The app to be run comes from the app store.| |managedApp|2|The app to be run is built into the device.|-|builtInApp|3|The app to be run is a managed app.| +|builtInApp|3|The app to be run is a managed app.| |
v1.0 | Intune Deviceconfig Iosnetworkusagerule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosnetworkusagerule.md | Here is a JSON representation of the resource. "cellularDataBlockWhenRoaming": true, "cellularDataBlocked": true }-``` +``` |
v1.0 | Intune Deviceconfig Iosnotificationalerttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosnotificationalerttype.md | Notification Settings Alert Type. |deviceDefault|0|Device default value, no intent.| |banner|1|Banner.| |modal|2|Modal.|-|none|3|None.| +|none|3|None.| |
v1.0 | Intune Deviceconfig Iosnotificationpreviewvisibility | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosnotificationpreviewvisibility.md | Determines when notification previews are visible on an iOS device. Previews can |notConfigured|0|Notification preview settings will not be overwritten.| |alwaysShow|1|Always show notification previews.| |hideWhenLocked|2|Only show notification previews when the device is unlocked.|-|neverShow|3|Never show notification previews.| +|neverShow|3|Never show notification previews.| |
v1.0 | Intune Deviceconfig Iosnotificationsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosnotificationsettings.md | Here is a JSON representation of the resource. "soundsEnabled": true, "previewVisibility": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Iospkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iospkcscertificateprofile.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Iosredirectsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosredirectsinglesignonextension.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Iosscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosscepcertificateprofile.md | Inherits from [iosCertificateProfileBase](../resources/intune-deviceconfig-iosce |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| |keySize|[keySize](../resources/intune-shared-keysize.md)|SCEP Key Size. Possible values are: `size1024`, `size2048`, `size4096`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. The OnPremisesUserPrincipalName variable is support as well as others documented here: https://go.microsoft.com/fwlink/?LinkId=2027630. This collection can contain a maximum of 500 elements.| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Iossinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iossinglesignonextension.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.iosSingleSignOnExtension" }-``` +``` |
v1.0 | Intune Deviceconfig Iossinglesignonsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iossinglesignonsettings.md | Here is a JSON representation of the resource. "kerberosPrincipalName": "String", "kerberosRealm": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Iossoftwareupdatescheduletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iossoftwareupdatescheduletype.md | Update schedule type for iOS software updates. |updateOutsideOfActiveHours|0|Update outside of active hours.| |alwaysUpdate|1|Always update.| |updateDuringTimeWindows|2|Update during time windows.|-|updateOutsideOfTimeWindows|3|Update outside of time windows.| +|updateOutsideOfTimeWindows|3|Update outside of time windows.| |
v1.0 | Intune Deviceconfig Iostrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iostrustedrootcertificate.md | Here is a JSON representation of the resource. "trustedRootCertificate": "binary", "certFileName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Iosupdateconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosupdateconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Iosupdatedevicestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosupdatedevicestatus.md | Here is a JSON representation of the resource. "lastReportedDateTime": "String (timestamp)", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Iosupdatesinstallstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosupdatesinstallstatus.md | Namespace: microsoft.graph |sharedDeviceUserLoggedInError|-2016330699|| |updateError|-2016330697|| |deviceOsHigherThanDesiredOsVersion|-2016330696||-|updateScanFailed|-2016324062|| +|updateScanFailed|-2016324062|| |
v1.0 | Intune Deviceconfig Iosvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosvpnconfiguration.md | Here is a JSON representation of the resource. ], "microsoftTunnelSiteId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Iosvpnsecurityassociationparameters | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosvpnsecurityassociationparameters.md | Here is a JSON representation of the resource. "securityDiffieHellmanGroup": 1024, "lifetimeInMinutes": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Ioswallpaperdisplaylocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioswallpaperdisplaylocation.md | An enum type for wallpaper display location specifier. |notConfigured|0|No location specified for wallpaper display.| |lockScreen|1|A configured wallpaper image is displayed on Lock screen.| |homeScreen|2|A configured wallpaper image is displayed on Home (icon list) screen.|-|lockAndHomeScreens|3|A configured wallpaper image is displayed on Lock screen and Home screen.| +|lockAndHomeScreens|3|A configured wallpaper image is displayed on Lock screen and Home screen.| |
v1.0 | Intune Deviceconfig Ioswebcontentfilterautofilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioswebcontentfilterautofilter.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Ioswebcontentfilterbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioswebcontentfilterbase.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.iosWebContentFilterBase" }-``` +``` |
v1.0 | Intune Deviceconfig Ioswebcontentfilterspecificwebsitesaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioswebcontentfilterspecificwebsitesaccess.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Ioswificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioswificonfiguration.md | Here is a JSON representation of the resource. "disableMacAddressRandomization": true, "preSharedKey": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Kerberossinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-kerberossinglesignonextension.md | Here is a JSON representation of the resource. "blockActiveDirectorySiteAutoDiscovery": true, "passwordChangeUrl": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Keybooleanvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keybooleanvaluepair.md | Here is a JSON representation of the resource. "key": "String", "value": true }-``` +``` |
v1.0 | Intune Deviceconfig Keyintegervaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keyintegervaluepair.md | Here is a JSON representation of the resource. "key": "String", "value": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Keyrealvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keyrealvaluepair.md | Here is a JSON representation of the resource. "key": "String", "value": "4.2" }-``` +``` |
v1.0 | Intune Deviceconfig Keystringvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keystringvaluepair.md | Here is a JSON representation of the resource. "key": "String", "value": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Keytypedvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keytypedvaluepair.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.keyTypedValuePair", "key": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Keyvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keyvalue.md | Here is a JSON representation of the resource. "key": "String", "value": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Keyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keyvaluepair.md | Here is a JSON representation of the resource. "name": "String", "value": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Kioskmodemanagedhomescreenpincomplexity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-kioskmodemanagedhomescreenpincomplexity.md | Complexity of PIN for Managed Home Screen sign-in session. |:|:|:| |notConfigured|0|Not configured.| |simple|1|Numeric values only.|-|complex|2|Alphanumerical value.| +|complex|2|Alphanumerical value.| |
v1.0 | Intune Deviceconfig Kioskmodetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-kioskmodetype.md | Possible values of Android Kiosk Mode. |:|:|:| |notConfigured|0|Not configured| |singleAppMode|1|Run in single-app mode|-|multiAppMode|2|Run in multi-app mode| +|multiAppMode|2|Run in multi-app mode| |
v1.0 | Intune Deviceconfig Lanmanagerauthenticationlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-lanmanagerauthenticationlevel.md | Possible values for LanManagerAuthenticationLevel |lmAndNtlmOnly|2|Send LM & NTLM responses only| |lmAndNtlmV2|3|Send LM & NTLMv2 responses only| |lmNtlmV2AndNotLm|4|Send LM & NTLMv2 responses only. Refuse LM|-|lmNtlmV2AndNotLmOrNtm|5|Send LM & NTLMv2 responses only. Refuse LM & NTLM| +|lmNtlmV2AndNotLmOrNtm|5|Send LM & NTLMv2 responses only. Refuse LM & NTLM| |
v1.0 | Intune Deviceconfig Licensetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-licensetype.md | Indicates whether tenant has a valid Intune Endpoint Privilege Management licens |notPaid|0|Indicates the tenant has neither trial or paid license.| |paid|1|Indicates the tenant has paid Endpoint Privilege Management license.| |trial|2|Indicates the tenant has trial Endpoint Privilege Management license.|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Deviceconfig Localsecurityoptionsadministratorelevationpromptbehaviortype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsadministratorelevationpromptbehaviortype.md | Possible values for LocalSecurityOptionsAdministratorElevationPromptBehavior |promptForConsentOnTheSecureDesktop|3|Prompt for consent on the secure desktop| |promptForCredentials|4|Prompt for credentials| |promptForConsent|5|Prompt for consent|-|promptForConsentForNonWindowsBinaries|6|Prompt for consent for non-Windows binaries| +|promptForConsentForNonWindowsBinaries|6|Prompt for consent for non-Windows binaries| |
v1.0 | Intune Deviceconfig Localsecurityoptionsformatandejectofremovablemediaallowedusertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsformatandejectofremovablemediaallowedusertype.md | Possible values for LocalSecurityOptionsFormatAndEjectOfRemovableMediaAllowedUse |notConfigured|0|Not Configured| |administrators|1|Administrators| |administratorsAndPowerUsers|2|Administrators and Power Users|-|administratorsAndInteractiveUsers|3|Administrators and Interactive Users | +|administratorsAndInteractiveUsers|3|Administrators and Interactive Users | |
v1.0 | Intune Deviceconfig Localsecurityoptionsinformationdisplayedonlockscreentype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsinformationdisplayedonlockscreentype.md | Possible values for LocalSecurityOptionsInformationDisplayedOnLockScreen |notConfigured|0|Not Configured| |administrators|1|User display name, domain and user names| |administratorsAndPowerUsers|2|User display name only|-|administratorsAndInteractiveUsers|3|Do not display user information| +|administratorsAndInteractiveUsers|3|Do not display user information| |
v1.0 | Intune Deviceconfig Localsecurityoptionsinformationshownonlockscreentype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsinformationshownonlockscreentype.md | Possible values for LocalSecurityOptionsInformationShownOnLockScreenType |notConfigured|0|Not Configured| |userDisplayNameDomainUser|1|User display name, domain and user names| |userDisplayNameOnly|2|User display name only|-|doNotDisplayUser|3|Do not display user information| +|doNotDisplayUser|3|Do not display user information| |
v1.0 | Intune Deviceconfig Localsecurityoptionsminimumsessionsecurity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsminimumsessionsecurity.md | Possible values for LocalSecurityOptionsMinimumSessionSecurity |none|0|Send LM & NTLM responses| |requireNtmlV2SessionSecurity|1|Send LM & NTLM-use NTLMv2 session security if negotiated| |require128BitEncryption|2|Send LM & NTLM responses only|-|ntlmV2And128BitEncryption|3|Send LM & NTLMv2 responses only| +|ntlmV2And128BitEncryption|3|Send LM & NTLMv2 responses only| |
v1.0 | Intune Deviceconfig Localsecurityoptionssmartcardremovalbehaviortype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionssmartcardremovalbehaviortype.md | Possible values for LocalSecurityOptionsSmartCardRemovalBehaviorType |noAction|0|No Action| |lockWorkstation|1|Lock Workstation| |forceLogoff|2|Force Logoff|-|disconnectRemoteDesktopSession|3|Disconnect if a remote Remote Desktop Services session| +|disconnectRemoteDesktopSession|3|Disconnect if a remote Remote Desktop Services session| |
v1.0 | Intune Deviceconfig Localsecurityoptionsstandarduserelevationpromptbehaviortype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsstandarduserelevationpromptbehaviortype.md | Possible values for LocalSecurityOptionsStandardUserElevationPromptBehavior |notConfigured|0|Not Configured| |automaticallyDenyElevationRequests|1|Automatically deny elevation requests| |promptForCredentialsOnTheSecureDesktop|2|Prompt for credentials on the secure desktop|-|promptForCredentials|3|Prompt for credentials| +|promptForCredentials|3|Prompt for credentials| |
v1.0 | Intune Deviceconfig Macaddressrandomizationmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macaddressrandomizationmode.md | An enum representing the possible values of Android MAC Address Randomization Mo |:|:|:| |automatic|0|Indicates the Wi-Fi framework to automatically decide the MAC randomization strategy. This can either be persistent or non-persistent randomly generated MAC addresses which are used while connecting to the network. In case of Persistent randomization, android generates a persistent randomized MAC address based on the parameters of the network profile. This MAC address remains the same until factory reset. On the other hand under the non-persistent randomization type, which is used for some networks in Android 12 or higher, the Wi-Fi module re-randomizes the MAC address at the start of every connection or the framework uses the existing randomized MAC address to connect to the network. More info: https://source.android.com/docs/core/connect/wifi-mac-randomization-behavior#types| |hardware|1|Indicates MAC randomization is disabled and the factory MAC address is used when connecting to the internet.|-|unknownFutureValue|2|Indicates evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|2|Indicates evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Deviceconfig Macosappleeventreceiver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosappleeventreceiver.md | Here is a JSON representation of the resource. "identifierType": "String", "allowed": true }-``` +``` |
v1.0 | Intune Deviceconfig Macosassociateddomainsitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosassociateddomainsitem.md | Here is a JSON representation of the resource. ], "directDownloadsEnabled": true }-``` +``` |
v1.0 | Intune Deviceconfig Macosazureadsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosazureadsinglesignonextension.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Macoscertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscertificateprofilebase.md | Here is a JSON representation of the resource. "certificateValidityPeriodValue": 1024, "certificateValidityPeriodScale": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Macoscompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscompliancepolicy.md | Here is a JSON representation of the resource. "firewallBlockAllIncoming": true, "firewallEnableStealthMode": true }-``` +``` |
v1.0 | Intune Deviceconfig Macoscontentcachingclientpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscontentcachingclientpolicy.md | Determines which clients a content cache will serve. |clientsInLocalNetwork|1|Content caches will provide content to devices only in their immediate local network.| |clientsWithSamePublicIpAddress|2|Content caches will provide content to devices that share the same public IP address.| |clientsInCustomLocalNetworks|3|Content caches will provide content to devices in contentCachingClientListenRanges.|-|clientsInCustomLocalNetworksWithFallback|4|Content caches will provide content to devices in contentCachingClientListenRanges, contentCachingPeerListenRanges, and contentCachingParents.| +|clientsInCustomLocalNetworksWithFallback|4|Content caches will provide content to devices in contentCachingClientListenRanges, contentCachingPeerListenRanges, and contentCachingParents.| |
v1.0 | Intune Deviceconfig Macoscontentcachingparentselectionpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscontentcachingparentselectionpolicy.md | Determines how content caches select a parent cache. |firstAvailable|2|Always use the first available parent in the Parents list. Use this policy to designate permanent primary, secondary, and subsequent parents.| |urlPathHash|3|Hash the path part of the requested URL so that the same parent is always used for the same URL. This is useful for maximizing the size of the combined caches of the parents.| |random|4|Choose a parent at random. Use this policy for load balancing.|-|stickyAvailable|5|Use the first available parent that is available in the Parents list until it becomes unavailable, then advance to the next one. Use this policy for designating floating primary, secondary, and subsequent parents.| +|stickyAvailable|5|Use the first available parent that is available in the Parents list until it becomes unavailable, then advance to the next one. Use this policy for designating floating primary, secondary, and subsequent parents.| |
v1.0 | Intune Deviceconfig Macoscontentcachingpeerpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscontentcachingpeerpolicy.md | Determines which content caches other content caches will peer with. |notConfigured|0|Defaults to peers in local network.| |peersInLocalNetwork|1|Content caches will only peer with caches in their immediate local network.| |peersWithSamePublicIpAddress|2|Content caches will only peer with caches that share the same public IP address.|-|peersInCustomLocalNetworks|3|Content caches will use contentCachingPeerFilterRanges and contentCachingPeerListenRanges to determine which caches to peer with.| +|peersInCustomLocalNetworks|3|Content caches will use contentCachingPeerFilterRanges and contentCachingPeerListenRanges to determine which caches to peer with.| |
v1.0 | Intune Deviceconfig Macoscontentcachingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscontentcachingtype.md | Indicates the type of content allowed to be cached by Apple's content caching se |:|:|:| |notConfigured|0|Default. Both user iCloud data and non-iCloud data will be cached.| |userContentOnly|1|Allow Apple's content caching service to cache user iCloud data.|-|sharedContentOnly|2|Allow Apple's content caching service to cache non-iCloud data (e.g. app and software updates).| +|sharedContentOnly|2|Allow Apple's content caching service to cache non-iCloud data (e.g. app and software updates).| |
v1.0 | Intune Deviceconfig Macoscredentialsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscredentialsinglesignonextension.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Macoscustomappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscustomappconfiguration.md | Here is a JSON representation of the resource. "fileName": "String", "configurationXml": "binary" }-``` +``` |
v1.0 | Intune Deviceconfig Macoscustomconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscustomconfiguration.md | Here is a JSON representation of the resource. "payload": "binary", "deploymentChannel": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Macosdevicefeaturesconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosdevicefeaturesconfiguration.md | Here is a JSON representation of the resource. "contentCachingKeepAwake": true, "contentCachingPort": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Macosendpointprotectionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosendpointprotectionconfiguration.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Macosenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosenterprisewificonfiguration.md | Here is a JSON representation of the resource. "innerAuthenticationProtocolForEapTtls": "String", "outerIdentityPrivacyTemporaryValue": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Macosextensionsconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosextensionsconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Macosfilevaultrecoverykeytypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosfilevaultrecoverykeytypes.md | Recovery key types for macOS FileVault |:|:|:| |notConfigured|0|Device default value, no intent.| |institutionalRecoveryKey|1|An institutional recovery key is like a ΓÇ£masterΓÇ¥ recovery key that can be used to unlock any device whose password has been lost.|-|personalRecoveryKey|2|A personal recovery key is a unique code that can be used to unlock the userΓÇÖs device, even if the password to the device is lost.| +|personalRecoveryKey|2|A personal recovery key is a unique code that can be used to unlock the userΓÇÖs device, even if the password to the device is lost.| |
v1.0 | Intune Deviceconfig Macosfirewallapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosfirewallapplication.md | Here is a JSON representation of the resource. "bundleId": "String", "allowsIncomingConnections": true }-``` +``` |
v1.0 | Intune Deviceconfig Macosgatekeeperappsources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosgatekeeperappsources.md | App source options for macOS Gatekeeper. |notConfigured|0|Device default value, no intent.| |macAppStore|1|Only apps from the Mac AppStore can be run.| |macAppStoreAndIdentifiedDevelopers|2|Only apps from the Mac AppStore and identified developers can be run.|-|anywhere|3|Apps from anywhere can be run.| +|anywhere|3|Apps from anywhere can be run.| |
v1.0 | Intune Deviceconfig Macosgeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosgeneraldeviceconfiguration.md | Here is a JSON representation of the resource. "iCloudDesktopAndDocumentsBlocked": true, "activationLockWhenSupervisedAllowed": true }-``` +``` |
v1.0 | Intune Deviceconfig Macosimportedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosimportedpfxcertificateprofile.md | Here is a JSON representation of the resource. "certificateValidityPeriodScale": "String", "intendedPurpose": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Macoskerberossinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoskerberossinglesignonextension.md | Here is a JSON representation of the resource. ], "tlsForLDAPRequired": true }-``` +``` |
v1.0 | Intune Deviceconfig Macoskernelextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoskernelextension.md | Here is a JSON representation of the resource. "teamIdentifier": "String", "bundleId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Macoslaunchitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoslaunchitem.md | Here is a JSON representation of the resource. "path": "String", "hide": true }-``` +``` |
v1.0 | Intune Deviceconfig Macospkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macospkcscertificateprofile.md | Here is a JSON representation of the resource. ], "allowAllAppsAccess": true }-``` +``` |
v1.0 | Intune Deviceconfig Macospriority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macospriority.md | The scheduling priority options for downloading and preparing the requested mac |:|:|:| |low|0|Indicates low scheduling priority for downloading and preparing the requested update| |high|1|Indicates high scheduling priority for downloading and preparing the requested update|-|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Deviceconfig Macosprivacyaccesscontrolitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosprivacyaccesscontrolitem.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Macosprocessidentifiertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosprocessidentifiertype.md | Process identifier types for MacOS Privacy Preferences |Member|Value|Description| |:|:|:| |bundleID|1|Indicates an app with a bundle ID.|-|path|2|Indicates a file path for a process.| +|path|2|Indicates a file path for a process.| |
v1.0 | Intune Deviceconfig Macosredirectsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosredirectsinglesignonextension.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Macosscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosscepcertificateprofile.md | Inherits from [macOSCertificateProfileBase](../resources/intune-deviceconfig-mac |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| |keySize|[keySize](../resources/intune-shared-keysize.md)|SCEP Key Size. Possible values are: `size1024`, `size2048`, `size4096`.| |hashAlgorithm|[hashAlgorithms](../resources/intune-shared-hashalgorithms.md)|SCEP Hash Algorithm. Possible values are: `sha1`, `sha2`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements.| Here is a JSON representation of the resource. ], "allowAllAppsAccess": true }-``` +``` |
v1.0 | Intune Deviceconfig Macossinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossinglesignonextension.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.macOSSingleSignOnExtension" }-``` +``` |
v1.0 | Intune Deviceconfig Macossoftwareupdateaccountsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdateaccountsummary.md | Here is a JSON representation of the resource. "totalUpdateCount": 1024, "lastUpdatedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceconfig Macossoftwareupdatebehavior | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatebehavior.md | Update behavior options for macOS software updates. |downloadOnly|2|Download the software update without installing it.| |installASAP|3|Install an already downloaded software update.| |notifyOnly|4|Download the software update and notify the user via the App Store.|-|installLater|5|Download the software update and install it at a later time.| +|installLater|5|Download the software update and install it at a later time.| |
v1.0 | Intune Deviceconfig Macossoftwareupdatecategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatecategory.md | MacOS Software Update Category |critical|0|A critical update| |configurationDataFile|1|A configuration data file update| |firmware|2|A firmware update|-|other|3|All other update types| +|other|3|All other update types| |
v1.0 | Intune Deviceconfig Macossoftwareupdatecategorysummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatecategorysummary.md | Here is a JSON representation of the resource. "totalUpdateCount": 1024, "lastUpdatedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceconfig Macossoftwareupdateconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdateconfiguration.md | Here is a JSON representation of the resource. "maxUserDeferralsCount": 1024, "priority": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Macossoftwareupdatedelaypolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatedelaypolicy.md | Flag enum to determine whether to delay software updates for macOS. |delayOSUpdateVisibility|1|Force delays for OS software updates.| |delayAppUpdateVisibility|2|Force delays for app software updates.| |unknownFutureValue|4|Sentinel member for cases where the client cannot handle the new enum values.|-|delayMajorOsUpdateVisibility|8|Force delays for major OS software updates.| +|delayMajorOsUpdateVisibility|8|Force delays for major OS software updates.| |
v1.0 | Intune Deviceconfig Macossoftwareupdatescheduletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatescheduletype.md | Update schedule type for macOS software updates. |:|:|:| |alwaysUpdate|0|Always update.| |updateDuringTimeWindows|1|Update during time windows.|-|updateOutsideOfTimeWindows|2|Update outside of time windows.| +|updateOutsideOfTimeWindows|2|Update outside of time windows.| |
v1.0 | Intune Deviceconfig Macossoftwareupdatestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatestate.md | MacOS Software Update State |installInsufficientSpace|2004|There is not enough space to install the update| |installInsufficientPower|2005|There is not enough power to install the update| |installFailed|2006|Installation has failed for an unspecified reason|-|commandFailed|2007|The schedule update command has failed for an unspecified reason| +|commandFailed|2007|The schedule update command has failed for an unspecified reason| |
v1.0 | Intune Deviceconfig Macossoftwareupdatestatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatestatesummary.md | Here is a JSON representation of the resource. "state": "String", "lastUpdatedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceconfig Macossystemextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossystemextension.md | Here is a JSON representation of the resource. "teamIdentifier": "String", "bundleId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Macossystemextensiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossystemextensiontype.md | Flag enum representing the allowed macOS system extension types. |:|:|:| |driverExtensionsAllowed|1|Enables driver extensions.| |networkExtensionsAllowed|2|Enables network extensions.|-|endpointSecurityExtensionsAllowed|4|Enables endpoint security extensions.| +|endpointSecurityExtensionsAllowed|4|Enables endpoint security extensions.| |
v1.0 | Intune Deviceconfig Macossystemextensiontypemapping | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossystemextensiontypemapping.md | Here is a JSON representation of the resource. "teamIdentifier": "String", "allowedTypes": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Macostrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macostrustedrootcertificate.md | Here is a JSON representation of the resource. "trustedRootCertificate": "binary", "certFileName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Macosvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosvpnconfiguration.md | Here is a JSON representation of the resource. }, "optInToDeviceIdSharing": true }-``` +``` |
v1.0 | Intune Deviceconfig Macoswificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoswificonfiguration.md | Here is a JSON representation of the resource. "proxyAutomaticConfigurationUrl": "String", "preSharedKey": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Macoswirednetworkconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoswirednetworkconfiguration.md | Here is a JSON representation of the resource. "nonEapAuthenticationMethodForEapTtls": "String", "enableOuterIdentityPrivacy": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Managedalldevicecertificatestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-managedalldevicecertificatestate.md | Here is a JSON representation of the resource. "certificateExtendedKeyUsages": "String", "certificateIssuanceDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceconfig Manageddevicecertificatestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-manageddevicecertificatestate.md | Here is a JSON representation of the resource. "certificateIssuanceDateTime": "String (timestamp)", "certificateErrorCode": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Manageddeviceencryptionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-manageddeviceencryptionstate.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Manageddevicemobileappconfigurationsettingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-manageddevicemobileappconfigurationsettingstate.md | Here is a JSON representation of the resource. "currentValue": "String", "settingInstanceId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Manageddevicereportedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-manageddevicereportedapp.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.managedDeviceReportedApp", "appId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Managementagenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-managementagenttype.md | Management agent type. |googleCloudDevicePolicyController|64|The device is managed by Google's CloudDPC.| |microsoft365ManagedMdm|258|This device is managed by Microsoft 365 through Intune.| |msSense|1024||-|intuneAosp|2048|This device is managed by Intune's MDM for AOSP (Android Open Source Project) devices| +|intuneAosp|2048|This device is managed by Intune's MDM for AOSP (Android Open Source Project) devices| |
v1.0 | Intune Deviceconfig Mediacontentratingaustralia | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingaustralia.md | Here is a JSON representation of the resource. "movieRating": "String", "tvRating": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Mediacontentratingcanada | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingcanada.md | Here is a JSON representation of the resource. "movieRating": "String", "tvRating": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Mediacontentratingfrance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingfrance.md | Here is a JSON representation of the resource. "movieRating": "String", "tvRating": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Mediacontentratinggermany | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratinggermany.md | Here is a JSON representation of the resource. "movieRating": "String", "tvRating": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Mediacontentratingireland | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingireland.md | Here is a JSON representation of the resource. "movieRating": "String", "tvRating": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Mediacontentratingjapan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingjapan.md | Here is a JSON representation of the resource. "movieRating": "String", "tvRating": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Mediacontentratingnewzealand | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingnewzealand.md | Here is a JSON representation of the resource. "movieRating": "String", "tvRating": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Mediacontentratingunitedkingdom | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingunitedkingdom.md | Here is a JSON representation of the resource. "movieRating": "String", "tvRating": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Mediacontentratingunitedstates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingunitedstates.md | Here is a JSON representation of the resource. "movieRating": "String", "tvRating": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Meteredconnectionlimittype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-meteredconnectionlimittype.md | Metered Connection Limit Settings. |:|:|:| |unrestricted|0|Unrestricted| |fixed|1|Fixed|-|variable|2|Variable| +|variable|2|Variable| |
v1.0 | Intune Deviceconfig Microsoftlauncherdockpresence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-microsoftlauncherdockpresence.md | Microsoft Launcher Dock Presence selection. |notConfigured|0|Not configured; this value is ignored.| |show|1|Indicates the device's dock will be displayed on the device.| |hide|2|Indicates the device's dock will be hidden on the device, but the user can access the dock by dragging the handler on the bottom of the screen.|-|disabled|3|Indicates the device's dock will be disabled on the device.| +|disabled|3|Indicates the device's dock will be disabled on the device.| |
v1.0 | Intune Deviceconfig Microsoftlaunchersearchbarplacement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-microsoftlaunchersearchbarplacement.md | Microsoft Launcher Search Bar Placement selection. |notConfigured|0|Not configured; this value is ignored.| |top|1|Indicates that the search bar will be displayed on the top of the device.| |bottom|2|Indicates that the search bar will be displayed on the bottom of the device.|-|hide|3|Indicates that the search bar will be hidden on the device.| +|hide|3|Indicates that the search bar will be hidden on the device.| |
v1.0 | Intune Deviceconfig Miracastchannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-miracastchannel.md | Possible values for Miracast channel. |oneHundredFiftyThree|153|OneHundredFifty-Three.| |oneHundredFiftySeven|157|OneHundredFifty-Seven.| |oneHundredSixtyOne|161|OneHundredSixty-One.|-|oneHundredSixtyFive|165|OneHundredSixty-Five.| +|oneHundredSixtyFive|165|OneHundredSixty-Five.| |
v1.0 | Intune Deviceconfig Ndesconnector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ndesconnector.md | Here is a JSON representation of the resource. ], "connectorVersion": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Ndesconnectorstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ndesconnectorstate.md | The current status of the Ndes Connector. |:|:|:| |none|0|State not available yet for this connector.| |active|1|Ndes connector has connected recently|-|inactive|2|No recent activity for the Ndes connector| +|inactive|2|No recent activity for the Ndes connector| |
v1.0 | Intune Deviceconfig Networksinglesignontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-networksinglesignontype.md | Wi-Fi Network Single Sign On Type Settings. |:|:|:| |disabled|0|Disabled| |prelogon|1|Pre-Logon|-|postlogon|2|Post-Logon| +|postlogon|2|Post-Logon| |
v1.0 | Intune Deviceconfig Noneapauthenticationmethodforeapttlstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-noneapauthenticationmethodforeapttlstype.md | Non-EAP methods for authentication. |unencryptedPassword|0|Unencrypted password (PAP).| |challengeHandshakeAuthenticationProtocol|1|Challenge Handshake Authentication Protocol (CHAP).| |microsoftChap|2| Microsoft CHAP (MS-CHAP).|-|microsoftChapVersionTwo|3|Microsoft CHAP Version 2 (MS-CHAP v2).| +|microsoftChapVersionTwo|3|Microsoft CHAP Version 2 (MS-CHAP v2).| |
v1.0 | Intune Deviceconfig Noneapauthenticationmethodforpeap | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-noneapauthenticationmethodforpeap.md | Non-EAP methods for authentication when PEAP is the selected EAP type. |Member|Value|Description| |:|:|:| |none|0|None.|-|microsoftChapVersionTwo|1|Microsoft CHAP Version 2 (MS-CHAP v2).| +|microsoftChapVersionTwo|1|Microsoft CHAP Version 2 (MS-CHAP v2).| |
v1.0 | Intune Deviceconfig Numberrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-numberrange.md | Here is a JSON representation of the resource. "lowerNumber": 1024, "upperNumber": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Omasetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasetting.md | Here is a JSON representation of the resource. "secretReferenceValueId": "String", "isEncrypted": true }-``` +``` |
v1.0 | Intune Deviceconfig Omasettingbase64 | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingbase64.md | Here is a JSON representation of the resource. "fileName": "String", "value": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Omasettingboolean | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingboolean.md | Here is a JSON representation of the resource. "isEncrypted": true, "value": true }-``` +``` |
v1.0 | Intune Deviceconfig Omasettingdatetime | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingdatetime.md | Here is a JSON representation of the resource. "isEncrypted": true, "value": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceconfig Omasettingfloatingpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingfloatingpoint.md | Here is a JSON representation of the resource. "isEncrypted": true, "value": 4.2 }-``` +``` |
v1.0 | Intune Deviceconfig Omasettinginteger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettinginteger.md | Here is a JSON representation of the resource. "value": 1024, "isReadOnly": true }-``` +``` |
v1.0 | Intune Deviceconfig Omasettingstring | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingstring.md | Here is a JSON representation of the resource. "isEncrypted": true, "value": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Omasettingstringxml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingstringxml.md | Here is a JSON representation of the resource. "fileName": "String", "value": "binary" }-``` +``` |
v1.0 | Intune Deviceconfig Operatingsystemversionrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-operatingsystemversionrange.md | Here is a JSON representation of the resource. "lowestVersion": "String", "highestVersion": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Operator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-operator.md | Operator for rules. |setEquals|21|SetEquals operator.| |orderedSetEquals|22|OrderedSetEquals operator.| |subsetOf|23|SubsetOf operator.|-|excludesAll|24|ExcludesAll operator.| +|excludesAll|24|ExcludesAll operator.| |
v1.0 | Intune Deviceconfig Perfectforwardsecrecygroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-perfectforwardsecrecygroup.md | Forward Secrecy Group values for Windows10 VPN policies with IKEv2 connection ty |ecp256|3|ECP256| |ecp384|4|ECP384| |pfsMM|5|PFSMM|-|pfs24|6|PFS24| +|pfs24|6|PFS24| |
v1.0 | Intune Deviceconfig Personalprofilepersonalplaystoremode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-personalprofilepersonalplaystoremode.md | Used together with personalApplications to control how apps in the personal prof |:|:|:| |notConfigured|0|Not configured.| |blockedApps|1|Blocked Apps.|-|allowedApps|2|Allowed Apps.| +|allowedApps|2|Allowed Apps.| |
v1.0 | Intune Deviceconfig Policyplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-policyplatformtype.md | Supported platform types for policies. |androidWorkProfile|7|AndroidWorkProfile.| |windows10XProfile|8|Windows10XProfile.| |androidAOSP|9|AndroidAOSPProfile.|-|all|100|All platforms.| +|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 | Power action types |noAction|1|No action| |sleep|2|Put device in sleep state| |hibernate|3|Put device in hibernate state|-|shutdown|4|Shutdown device| +|shutdown|4|Shutdown device| |
v1.0 | Intune Deviceconfig Prereleasefeatures | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-prereleasefeatures.md | Possible values for pre-release features. |userDefined|0|User Defined, default value, no intent.| |settingsOnly|1|Settings only pre-release features.| |settingsAndExperimentations|2|Settings and experimentations pre-release features.|-|notAllowed|3|Pre-release features not allowed.| +|notAllowed|3|Pre-release features not allowed.| |
v1.0 | Intune Deviceconfig Ratingappstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingappstype.md | Apps rating as in media content |agesAbove4|2|4+, age 4 and above| |agesAbove9|3|9+, age 9 and above| |agesAbove12|4|12+, age 12 and above |-|agesAbove17|5|17+, age 17 and above| +|agesAbove17|5|17+, age 17 and above| |
v1.0 | Intune Deviceconfig Ratingaustraliamoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingaustraliamoviestype.md | Movies rating labels in Australia |parentalGuidance|3|The PG recommends viewers under 15 with guidance from parents or guardians| |mature|4|The M classification is not recommended for viewers under 15| |agesAbove15|5|The MA15+ classification is not suitable for viewers under 15|-|agesAbove18|6|The R18+ classification is not suitable for viewers under 18| +|agesAbove18|6|The R18+ classification is not suitable for viewers under 18| |
v1.0 | Intune Deviceconfig Ratingaustraliatelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingaustraliatelevisiontype.md | TV content rating labels in Australia |parentalGuidance|5|The PG classification is recommended for young viewers| |mature|6|The M classification is recommended for viewers over 15| |agesAbove15|7|The MA15+ classification is not suitable for viewers under 15|-|agesAbove15AdultViolence|8|The AV15+ classification is not suitable for viewers under 15, adult violence-specific| +|agesAbove15AdultViolence|8|The AV15+ classification is not suitable for viewers under 15, adult violence-specific| |
v1.0 | Intune Deviceconfig Ratingcanadamoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingcanadamoviestype.md | Movies rating labels in Canada |parentalGuidance|3|The PG classification advises parental guidance| |agesAbove14|4|The 14A classification is suitable for viewers above 14 or older| |agesAbove18|5|The 18A classification is suitable for viewers above 18 or older|-|restricted|6|The R classification is restricted to 18 years and older| +|restricted|6|The R classification is restricted to 18 years and older| |
v1.0 | Intune Deviceconfig Ratingcanadatelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingcanadatelevisiontype.md | TV content rating labels in Canada |general|4|The G classification is suitable for general audience| |parentalGuidance|5|PG, Parental Guidance| |agesAbove14|6|The 14+ classification is intended for viewers ages 14 and older|-|agesAbove18|7|The 18+ classification is intended for viewers ages 18 and older| +|agesAbove18|7|The 18+ classification is intended for viewers ages 18 and older| |
v1.0 | Intune Deviceconfig Ratingfrancemoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingfrancemoviestype.md | Movies rating labels in France |agesAbove10|2|The 10 classification prohibits the screening of the film to minors under 10| |agesAbove12|3|The 12 classification prohibits the screening of the film to minors under 12| |agesAbove16|4|The 16 classification prohibits the screening of the film to minors under 16|-|agesAbove18|5|The 18 classification prohibits the screening to minors under 18| +|agesAbove18|5|The 18 classification prohibits the screening to minors under 18| |
v1.0 | Intune Deviceconfig Ratingfrancetelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingfrancetelevisiontype.md | TV content rating labels in France |agesAbove10|2|The -10 classification is not recommended for children under 10| |agesAbove12|3|The -12 classification is not recommended for children under 12| |agesAbove16|4|The -16 classification is not recommended for children under 16|-|agesAbove18|5|The -18 classification is not recommended for persons under 18| +|agesAbove18|5|The -18 classification is not recommended for persons under 18| |
v1.0 | Intune Deviceconfig Ratinggermanymoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratinggermanymoviestype.md | Movies rating labels in Germany |agesAbove6|3|Ab 6 Jahren, ages 6 and older| |agesAbove12|4|Ab 12 Jahren, ages 12 and older| |agesAbove16|5|Ab 16 Jahren, ages 16 and older|-|adults|6|Ab 18 Jahren, adults only| +|adults|6|Ab 18 Jahren, adults only| |
v1.0 | Intune Deviceconfig Ratinggermanytelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratinggermanytelevisiontype.md | TV content rating labels in Germany |agesAbove6|3|Ab 6 Jahren, ages 6 and older| |agesAbove12|4|Ab 12 Jahren, ages 12 and older| |agesAbove16|5|Ab 16 Jahren, ages 16 and older|-|adults|6|Ab 18 Jahren, adults only| +|adults|6|Ab 18 Jahren, adults only| |
v1.0 | Intune Deviceconfig Ratingirelandmoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingirelandmoviestype.md | Movies rating labels in Ireland |agesAbove12|4|The 12A classification is suitable for viewers of 12 or older| |agesAbove15|5|The 15A classification is suitable for viewers of 15 or older| |agesAbove16|6|The 16 classification is suitable for viewers of 16 or older|-|adults|7|The 18 classification, suitable only for adults| +|adults|7|The 18 classification, suitable only for adults| |
v1.0 | Intune Deviceconfig Ratingirelandtelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingirelandtelevisiontype.md | TV content rating labels in Ireland |children|3|The CH classification is suitable for children| |youngAdults|4|The YA classification is suitable for teenage audience| |parentalSupervision|5|The PS classification invites parents and guardians to consider restriction childrenΓÇÖs access|-|mature|6|The MA classification is suitable for adults| +|mature|6|The MA classification is suitable for adults| |
v1.0 | Intune Deviceconfig Ratingjapanmoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingjapanmoviestype.md | Movies rating labels in Japan |general|2|Suitable for all ages| |parentalGuidance|3|The PG-12 classification requests parental guidance for young people under 12| |agesAbove15|4|The R15+ classification is suitable for viewers of 15 or older|-|agesAbove18|5|The R18+ classification is suitable for viewers of 18 or older| +|agesAbove18|5|The R18+ classification is suitable for viewers of 18 or older| |
v1.0 | Intune Deviceconfig Ratingjapantelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingjapantelevisiontype.md | TV content rating labels in Japan |:|:|:| |allAllowed|0|Default value, allow all TV shows content| |allBlocked|1|Do not allow any TV shows content|-|explicitAllowed|2|All TV content is explicitly allowed| +|explicitAllowed|2|All TV content is explicitly allowed| |
v1.0 | Intune Deviceconfig Ratingnewzealandmoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingnewzealandmoviestype.md | Movies rating labels in New Zealand |agesAbove16|7|The R16 classification is restricted to persons 16 years and over| |agesAbove18|8|The R18 classification is restricted to persons 18 years and over| |restricted|9|The R classification is restricted to a certain audience|-|agesAbove16Restricted|10|The RP16 classification requires viewers under 16 accompanied by a parent or an adult| +|agesAbove16Restricted|10|The RP16 classification requires viewers under 16 accompanied by a parent or an adult| |
v1.0 | Intune Deviceconfig Ratingnewzealandtelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingnewzealandtelevisiontype.md | TV content rating labels in New Zealand |allBlocked|1|Do not allow any TV shows content| |general|2|The G classification excludes materials likely to harm children under 14| |parentalGuidance|3|The PGR classification encourages parents and guardians to supervise younger viewers|-|adults|4|The AO classification is not suitable for children| +|adults|4|The AO classification is not suitable for children| |
v1.0 | Intune Deviceconfig Ratingunitedkingdommoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingunitedkingdommoviestype.md | Movies rating labels in United Kingdom |agesAbove12Video|5|12, video release suitable for 12 years and over| |agesAbove12Cinema|6|12A, cinema release suitable for 12 years and over| |agesAbove15|7|15, suitable only for 15 years and older|-|adults|8|Suitable only for adults| +|adults|8|Suitable only for adults| |
v1.0 | Intune Deviceconfig Ratingunitedkingdomtelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingunitedkingdomtelevisiontype.md | TV content rating labels in United Kingdom |:|:|:| |allAllowed|0|Default value, allow all TV shows content| |allBlocked|1|Do not allow any TV shows content|-|caution|2|Allowing TV contents with a warning message| +|caution|2|Allowing TV contents with a warning message| |
v1.0 | Intune Deviceconfig Ratingunitedstatesmoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingunitedstatesmoviestype.md | Movies rating labels in United States |parentalGuidance|3|PG, some material may not be suitable for children| |parentalGuidance13|4|PG13, some material may be inappropriate for children under 13| |restricted|5|R, viewers under 17 require accompanying parent or adult guardian|-|adults|6|NC17, adults only| +|adults|6|NC17, adults only| |
v1.0 | Intune Deviceconfig Ratingunitedstatestelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingunitedstatestelevisiontype.md | TV content rating labels in United States |general|4|TV-G, suitable for all ages| |parentalGuidance|5|TV-PG, parental guidance| |childrenAbove14|6|TV-14, children age 14 and above|-|adults|7|TV-MA, adults only| +|adults|7|TV-MA, adults only| |
v1.0 | Intune Deviceconfig Redirectsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-redirectsinglesignonextension.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-report.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.report", "content": "Stream" }-``` +``` |
v1.0 | Intune Deviceconfig Reportroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-reportroot.md | The resource that represents an instance of History Reports. ## Methods |Method|Return Type|Description| |:|:|:|-|[Get reportRoot](../api/intune-deviceconfig-reportroot-get.md)|[reportRoot](../resources/intune-deviceconfig-reportroot.md)|Read properties and relationships of the [reportRoot](../resources/intune-deviceconfig-reportroot.md) object.| -|[Update reportRoot](../api/intune-deviceconfig-reportroot-update.md)|[reportRoot](../resources/intune-deviceconfig-reportroot.md)|Update the properties of a [reportRoot](../resources/intune-deviceconfig-reportroot.md) object.| -|[deviceConfigurationUserActivity function](../api/intune-deviceconfig-reportroot-deviceconfigurationuseractivity.md)|[report](../resources/intune-deviceconfig-report.md)|Metadata for the device configuration user activity report| -|[deviceConfigurationDeviceActivity function](../api/intune-deviceconfig-reportroot-deviceconfigurationdeviceactivity.md)|[report](../resources/intune-deviceconfig-report.md)|Metadata for the device configuration device activity report| +|[Get reportRoot](../api/intune-deviceconfig-reportroot-get.md)|[reportRoot](../resources/intune-shared-reportroot.md)|Read properties and relationships of the [reportRoot](../resources/intune-shared-reportroot.md) object.| +|[Update reportRoot](../api/intune-deviceconfig-reportroot-update.md)|[reportRoot](../resources/intune-shared-reportroot.md)|Update the properties of a [reportRoot](../resources/intune-shared-reportroot.md) object.| +|[deviceConfigurationUserActivity function](../api/intune-deviceconfig-reportroot-deviceconfigurationuseractivity.md)|[report](../resources/intune-shared-report.md)|Metadata for the device configuration user activity report| +|[deviceConfigurationDeviceActivity function](../api/intune-deviceconfig-reportroot-deviceconfigurationdeviceactivity.md)|[report](../resources/intune-shared-report.md)|Metadata for the device configuration device activity report| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.reportRoot", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Deviceconfig Requiredpasswordtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-requiredpasswordtype.md | Possible values of required passwords. |:|:|:| |deviceDefault|0|Device default value, no intent.| |alphanumeric|1|Alphanumeric password required.|-|numeric|2|Numeric password required.| +|numeric|2|Numeric password required.| |
v1.0 | Intune Deviceconfig Restrictedappsstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-restrictedappsstate.md | Restricted apps state |Member|Value|Description| |:|:|:| |prohibitedApps|0|Prohibited apps|-|notApprovedApps|1|Not approved apps| +|notApprovedApps|1|Not approved apps| |
v1.0 | Intune Deviceconfig Restrictedappsviolation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-restrictedappsviolation.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Retirescheduledmanageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-retirescheduledmanageddevice.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Runstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-runstate.md | Indicates the type of execution status of the device management script. |fail|2|Script failed to run.| |scriptError|3|Discovery script hits error.| |pending|4|Script is pending to execute.|-|notApplicable|5|Script is not applicable for this device.| +|notApplicable|5|Script is not applicable for this device.| |
v1.0 | Intune Deviceconfig Safesearchfiltertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-safesearchfiltertype.md | Specifies what level of safe search (filtering adult content) is required |:|:|:| |userDefined|0|User Defined, default value, no intent.| |strict|1|Strict, highest filtering against adult content.|-|moderate|2|Moderate filtering against adult content (valid search results will not be filtered).| +|moderate|2|Moderate filtering against adult content (valid search results will not be filtered).| |
v1.0 | Intune Deviceconfig Scheduledretirestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-scheduledretirestate.md | Cancel or confirm scheduled retire |:|:|:| |cancelRetire|0|CancelRetire| |confirmRetire|1|ConfirmRetire|-|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Deviceconfig Secureassessmentaccounttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-secureassessmentaccounttype.md | Type of accounts that are allowed for Windows10SecureAssessment ConfigurationAcc |azureADAccount|0|Indicates an Azure AD account in format of AzureAD\username@tenant.com.| |domainAccount|1|Indicates a domain account in format of domain\user or user@domain.com.| |localAccount|2|Indicates a local account in format of username.|-|localGuestAccount|3|Indicates a local guest account in format of test name.| +|localGuestAccount|3|Indicates a local guest account in format of test name.| |
v1.0 | Intune Deviceconfig Securebootwithdmatype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-securebootwithdmatype.md | Possible values of Secure Boot with DMA |:|:|:| |notConfigured|0|Not configured, no operation| |withoutDMA|1|Turns on VBS with Secure Boot|-|withDMA|3|Turns on VBS with Secure Boot and DMA| +|withDMA|3|Turns on VBS with Secure Boot and DMA| |
v1.0 | Intune Deviceconfig Servicestarttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-servicestarttype.md | Possible values of xbox service start type |:|:|:| |manual|0|Manual service start type(default)| |automatic|1|Automatic service start type|-|disabled|2|Service start type disabled| +|disabled|2|Service start type disabled| |
v1.0 | Intune Deviceconfig Settingsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-settingsource.md | Here is a JSON representation of the resource. "displayName": "String", "sourceType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Settingstatedevicesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-settingstatedevicesummary.md | Here is a JSON representation of the resource. "errorDeviceCount": 1024, "conflictDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Sharedpcaccountdeletionpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-sharedpcaccountdeletionpolicytype.md | Possible values for when accounts are deleted on a shared PC. |:|:|:| |immediate|0|Delete immediately.| |diskSpaceThreshold|1|Delete at disk space threshold.|-|diskSpaceThresholdOrInactiveThreshold|2|Delete at disk space threshold or inactive threshold.| +|diskSpaceThresholdOrInactiveThreshold|2|Delete at disk space threshold or inactive threshold.| |
v1.0 | Intune Deviceconfig Sharedpcaccountmanagerpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-sharedpcaccountmanagerpolicy.md | Here is a JSON representation of the resource. "inactiveThresholdDays": 1024, "removeAccountsBelowDiskFreePercentage": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Sharedpcallowedaccounttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-sharedpcallowedaccounttype.md | Type of accounts that are allowed to share the PC. |:|:|:| |notConfigured|0|Not configured. Default value.| |guest|1|Only guest accounts.|-|domain|2|Only domain-joined accounts.| +|domain|2|Only domain-joined accounts.| |
v1.0 | Intune Deviceconfig Sharedpcconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-sharedpcconfiguration.md | Here is a JSON representation of the resource. "maintenanceStartTime": "String (time of day)", "fastFirstSignIn": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Signinassistantoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-signinassistantoptions.md | Values for the SignInAssistantSettings. |Member|Value|Description| |:|:|:| |notConfigured|0|Not configured - wlidsvc Start will be set to SERVICE_DEMAND_START.|-|disabled|1|Disabled - wlidsvc Start will be set to SERVICE_DISABLED.| +|disabled|1|Disabled - wlidsvc Start will be set to SERVICE_DISABLED.| |
v1.0 | Intune Deviceconfig Singlesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-singlesignonextension.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.singleSignOnExtension" }-``` +``` |
v1.0 | Intune Deviceconfig Sitesecuritylevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-sitesecuritylevel.md | Possible values for site security level. |mediumLow|2|Medium-low.| |medium|3|Medium.| |mediumHigh|4|Medium-high.|-|high|5|High.| +|high|5|High.| |
v1.0 | Intune Deviceconfig Softwareupdatestatussummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-softwareupdatestatussummary.md | Here is a JSON representation of the resource. "conflictUserCount": 1024, "notApplicableUserCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Specifiedcaptivenetworkplugins | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-specifiedcaptivenetworkplugins.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Statemanagementsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-statemanagementsetting.md | State Management Setting. |:|:|:| |notConfigured|0|Not configured.| |blocked|1|Blocked.|-|allowed|2|Allowed.| +|allowed|2|Allowed.| |
v1.0 | Intune Deviceconfig Subjectnameformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-subjectnameformat.md | Subject Name Format Options. |commonNameAsSerialNumber|6|Common Name As Serial Number.| |commonNameAsAadDeviceId|7|Common Name As Serial Number.| |commonNameAsIntuneDeviceId|8|Common Name As Serial Number.|-|commonNameAsDurableDeviceId|9|Common Name As Serial Number.| +|commonNameAsDurableDeviceId|9|Common Name As Serial Number.| |
v1.0 | Intune Deviceconfig Unsupporteddeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-unsupporteddeviceconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Unsupporteddeviceconfigurationdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-unsupporteddeviceconfigurationdetail.md | Here is a JSON representation of the resource. "message": "String", "propertyName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Updateclassification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-updateclassification.md | Possible values for automatic update classification. |userDefined|0|User Defined, default value, no intent.| |recommendedAndImportant|1|Recommended and important.| |important|2|Important.|-|none|3|None.| +|none|3|None.| |
v1.0 | Intune Deviceconfig Useremailsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-useremailsource.md | Possible values for username source or email source. |Member|Value|Description| |:|:|:| |userPrincipalName|0|User principal name.|-|primarySmtpAddress|1|Primary SMTP address.| +|primarySmtpAddress|1|Primary SMTP address.| |
v1.0 | Intune Deviceconfig Usernamesource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-usernamesource.md | Username source. |:|:|:| |userPrincipalName|0|User principal name.| |primarySmtpAddress|1|Primary SMTP address.|-|samAccountName|2|The user sam account name.| +|samAccountName|2|The user sam account name.| |
v1.0 | Intune Deviceconfig Visibilitysetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-visibilitysetting.md | Generic visibility state. |:|:|:| |notConfigured|0|Not configured.| |hide|1|Hide.|-|show|2|Show.| +|show|2|Show.| |
v1.0 | Intune Deviceconfig Vpnauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnauthenticationmethod.md | VPN Authentication Method. |usernameAndPassword|1|Use username and password for authentication.| |sharedSecret|2|Use Shared Secret for Authentication. Only valid for iOS IKEv2.| |derivedCredential|3|Use Derived Credential for Authentication.|-|azureAD|4|Use Azure AD for authentication.| +|azureAD|4|Use Azure AD for authentication.| |
v1.0 | Intune Deviceconfig Vpnclientauthenticationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnclientauthenticationtype.md | The type of VPN client authentication type |Member|Value|Description| |:|:|:| |userAuthentication|0|User Authentication|-|deviceAuthentication|1|Device Authentication| +|deviceAuthentication|1|Device Authentication| |
v1.0 | Intune Deviceconfig Vpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Vpndeadpeerdetectionrate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpndeadpeerdetectionrate.md | Determines how often to check if a peer connection is still alive |medium|0|Medium| |none|1|None| |low|2|Low|-|high|3|High| +|high|3|High| |
v1.0 | Intune Deviceconfig Vpndnsrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpndnsrule.md | Here is a JSON representation of the resource. "autoTrigger": true, "persistent": true }-``` +``` |
v1.0 | Intune Deviceconfig Vpnencryptionalgorithmtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnencryptionalgorithmtype.md | The type of VPN security association encryption algorithm |aes256Gcm|5|AES-256-GCM| |aes192|6|AES-192| |aes192Gcm|7|AES-192-GCM|-|chaCha20Poly1305|8|ChaCha20Poly1305| +|chaCha20Poly1305|8|ChaCha20Poly1305| |
v1.0 | Intune Deviceconfig Vpnintegrityalgorithmtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnintegrityalgorithmtype.md | The type of VPN security association integrity algorithm |sha1_160|2|SHA1-160| |sha2_384|3|SHA2-384| |sha2_512|4|SHA2-512|-|md5|5|MD5| +|md5|5|MD5| |
v1.0 | Intune Deviceconfig Vpnlocalidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnlocalidentifier.md | The type of VPN local identifier |:|:|:| |deviceFQDN|0|Device Fully Qualified Domain Name| |empty|1|Empty|-|clientCertificateSubjectName|2|Client Certificate Subject Name| +|clientCertificateSubjectName|2|Client Certificate Subject Name| |
v1.0 | Intune Deviceconfig Vpnondemandrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnondemandrule.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Vpnondemandruleconnectionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnondemandruleconnectionaction.md | VPN On-Demand Rule Connection Action. |connect|0|Connect.| |evaluateConnection|1|Evaluate Connection.| |ignore|2|Ignore.|-|disconnect|3|Disconnect.| +|disconnect|3|Disconnect.| |
v1.0 | Intune Deviceconfig Vpnondemandruleconnectiondomainaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnondemandruleconnectiondomainaction.md | VPN On-Demand Rule Connection Domain Action. |Member|Value|Description| |:|:|:| |connectIfNeeded|0|Connect if needed.|-|neverConnect|1|Never connect.| +|neverConnect|1|Never connect.| |
v1.0 | Intune Deviceconfig Vpnondemandruleinterfacetypematch | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnondemandruleinterfacetypematch.md | VPN On-Demand Rule Connection network interface type. |notConfigured|0|NotConfigured| |ethernet|1|Ethernet.| |wiFi|2|WiFi.|-|cellular|3|Cellular.| +|cellular|3|Cellular.| |
v1.0 | Intune Deviceconfig Vpnprovidertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnprovidertype.md | Provider type for per-app VPN. |:|:|:| |notConfigured|0|Tunnel traffic is not explicitly configured.| |appProxy|1|Tunnel traffic at the application layer.|-|packetTunnel|2|Tunnel traffic at the IP layer.| +|packetTunnel|2|Tunnel traffic at the IP layer.| |
v1.0 | Intune Deviceconfig Vpnproxyserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnproxyserver.md | Here is a JSON representation of the resource. "address": "String", "port": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Vpnroute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnroute.md | Here is a JSON representation of the resource. "destinationPrefix": "String", "prefixSize": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Vpnserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnserver.md | Here is a JSON representation of the resource. "address": "String", "isDefaultServer": true }-``` +``` |
v1.0 | Intune Deviceconfig Vpnservercertificatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnservercertificatetype.md | The type of certificate the VPN server will present to the VPN client for authen |rsa|0|RSA| |ecdsa256|1|ECDSA256| |ecdsa384|2|ECDSA384|-|ecdsa521|3|ECDSA521| +|ecdsa521|3|ECDSA521| |
v1.0 | Intune Deviceconfig Vpnserviceexceptionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnserviceexceptionaction.md | The VPN action to take for a specific service. |:|:|:| |forceTrafficViaVPN|0|Make all traffic from that service go through the VPN| |allowTrafficOutside|1|Allow the service outside of the VPN|-|dropTraffic|2|Drop all traffic from the service| +|dropTraffic|2|Drop all traffic from the service| |
v1.0 | Intune Deviceconfig Vpntrafficdirection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpntrafficdirection.md | Specify whether the rule applies to inbound traffic or outbound traffic. |:|:|:| |outbound|0|The rule applies to all outbound traffic.| |inbound|1|The rule applies to all inbound traffic.|-|unknownFutureValue|2|Evolvable enum member| +|unknownFutureValue|2|Evolvable enum member| |
v1.0 | Intune Deviceconfig Vpntrafficrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpntrafficrule.md | Here is a JSON representation of the resource. "claims": "String", "vpnTrafficDirection": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Vpntrafficruleapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpntrafficruleapptype.md | Indicates the type of app that a VPN traffic rule is associated with. |:|:|:| |none|0|The traffic rule is not associated with an app.| |desktop|1|The traffic rule is associated with a desktop app.|-|universal|2|The traffic rule is associated with a Universal app.| +|universal|2|The traffic rule is associated with a Universal app.| |
v1.0 | Intune Deviceconfig Vpntrafficruleroutingpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpntrafficruleroutingpolicytype.md | Specifies the routing policy for a VPN traffic rule. |:|:|:| |none|0|No routing policy specified.| |splitTunnel|1|Network traffic for the specified app will be routed through the VPN.|-|forceTunnel|2|All network traffic will be routed through the VPN.| +|forceTunnel|2|All network traffic will be routed through the VPN.| |
v1.0 | Intune Deviceconfig Vpntunnelconfigurationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpntunnelconfigurationtype.md | The type of tunnels that will be present to the VPN client for configuration |:|:|:| |wifiAndCellular|0|WiFi and Cellular Tunnels| |cellular|1|Cellular Tunnel Only|-|wifi|2|WiFi Tunnel Only| +|wifi|2|WiFi Tunnel Only| |
v1.0 | Intune Deviceconfig Webbrowsercookiesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-webbrowsercookiesettings.md | Web Browser Cookie Settings. |blockAlways|1|Always block cookies.| |allowCurrentWebSite|2|Allow cookies from current Web site.| |allowFromWebsitesVisited|3|Allow Cookies from websites visited.|-|allowAlways|4|Always allow cookies.| +|allowAlways|4|Always allow cookies.| |
v1.0 | Intune Deviceconfig Weeklyschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-weeklyschedule.md | Possible values for a weekly schedule. |thursday|6|Thursday.| |friday|7|Friday.| |saturday|8|Saturday.|-|noScheduledScan|9|No Scheduled Scan| +|noScheduledScan|9|No Scheduled Scan| |
v1.0 | Intune Deviceconfig Welcomescreenmeetinginformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-welcomescreenmeetinginformation.md | Possible values for welcome screen meeting information. |:|:|:| |userDefined|0|User Defined, default value, no intent.| |showOrganizerAndTimeOnly|1|Show organizer and time only.|-|showOrganizerAndTimeAndSubject|2|Show organizer, time and subject (subject is hidden for private meetings).| +|showOrganizerAndTimeAndSubject|2|Show organizer, time and subject (subject is hidden for private meetings).| |
v1.0 | Intune Deviceconfig Wifiauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wifiauthenticationmethod.md | Wi-Fi authentication method. |:|:|:| |certificate|0|Use an identity certificate for authentication.| |usernameAndPassword|1|Use username and password for authentication.|-|derivedCredential|2|Use Derived Credential for authentication.| +|derivedCredential|2|Use Derived Credential for authentication.| |
v1.0 | Intune Deviceconfig Wifiauthenticationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wifiauthenticationtype.md | Wi-Fi Authentication Type Settings. |user|1|User Authentication| |machine|2|Machine Authentication| |machineOrUser|3|Machine or User Authentication|-|guest|4|Guest Authentication| +|guest|4|Guest Authentication| |
v1.0 | Intune Deviceconfig Wifiproxysetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wifiproxysetting.md | Wi-Fi Proxy Settings. |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.| +|unknownFutureValue|3|Unknown future value for evolvable enum patterns.| |
v1.0 | Intune Deviceconfig Wifisecuritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wifisecuritytype.md | Wi-Fi Security Types. |wpaEnterprise|2|WPA-Enterprise. Must use IOSEnterpriseWifiConfiguration type to configure enterprise options.| |wep|3|WEP Encryption.| |wpa2Personal|4|WPA2-Personal.|-|wpa2Enterprise|5|WPA2-Enterprise. Must use WindowsWifiEnterpriseEAPConfiguration type to configure enterprise options.| +|wpa2Enterprise|5|WPA2-Enterprise. Must use WindowsWifiEnterpriseEAPConfiguration type to configure enterprise options.| |
v1.0 | Intune Deviceconfig Windows10appsforceupdateschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10appsforceupdateschedule.md | Here is a JSON representation of the resource. "recurrence": "String", "runImmediatelyIfAfterStartDateTime": true }-``` +``` |
v1.0 | Intune Deviceconfig Windows10appsupdaterecurrence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10appsupdaterecurrence.md | Possible values for App update on Windows10 recurrence. |none|0|Default value, specifies a single occurence.| |daily|1|Daily.| |weekly|2|Weekly.|-|monthly|3|Monthly.| +|monthly|3|Monthly.| |
v1.0 | Intune Deviceconfig Windows10apptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10apptype.md | Windows 10 Application type. |Member|Value|Description| |:|:|:| |desktop|0|Desktop.|-|universal|1|Universal.| +|universal|1|Universal.| |
v1.0 | Intune Deviceconfig Windows10associatedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10associatedapps.md | Here is a JSON representation of the resource. "appType": "String", "identifier": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows10certificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10certificateprofilebase.md | Here is a JSON representation of the resource. "certificateValidityPeriodValue": 1024, "certificateValidityPeriodScale": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows10compliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10compliancepolicy.md | Here is a JSON representation of the resource. "rulesContent": "binary" } }-``` +``` |
v1.0 | Intune Deviceconfig Windows10customconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10customconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windows10devicefirmwareconfigurationinterface | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10devicefirmwareconfigurationinterface.md | Here is a JSON representation of the resource. "wakeOnLAN": "String", "wakeOnPower": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows10devicemodetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10devicemodetype.md | Windows 10 Device Mode type. |Member|Value|Description| |:|:|:| |standardConfiguration|0|Standard Configuration|-|sModeConfiguration|1|S Mode Configuration| +|sModeConfiguration|1|S Mode Configuration| |
v1.0 | Intune Deviceconfig Windows10easemailprofileconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10easemailprofileconfiguration.md | Here is a JSON representation of the resource. "hostName": "String", "requireSsl": true }-``` +``` |
v1.0 | Intune Deviceconfig Windows10editiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10editiontype.md | Windows 10 Edition type. |windows10HomeSingleLanguage|16|Windows 10 Home Single Language| |windows10Mobile|17|Windows 10 Mobile| |windows10IoTCore|18|Windows 10 IoT Core|-|windows10IoTCoreCommercial|19|Windows 10 IoT Core Commercial| +|windows10IoTCoreCommercial|19|Windows 10 IoT Core Commercial| |
v1.0 | Intune Deviceconfig Windows10endpointprotectionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10endpointprotectionconfiguration.md | Here is a JSON representation of the resource. "severeSeverity": "String" } }-``` +``` |
v1.0 | Intune Deviceconfig Windows10enterprisemodernappmanagementconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10enterprisemodernappmanagementconfiguration.md | Here is a JSON representation of the resource. "version": 1024, "uninstallBuiltInApps": true }-``` +``` |
v1.0 | Intune Deviceconfig Windows10generalconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10generalconfiguration.md | Here is a JSON representation of the resource. "uninstallBuiltInApps": true, "configureTimeZone": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows10importedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10importedpfxcertificateprofile.md | Here is a JSON representation of the resource. "certificateValidityPeriodScale": "String", "intendedPurpose": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows10mobilecompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10mobilecompliancepolicy.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windows10networkboundaryconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10networkboundaryconfiguration.md | Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Deviceconfig Windows10networkproxyserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10networkproxyserver.md | Here is a JSON representation of the resource. ], "useForLocalAddresses": true }-``` +``` |
v1.0 | Intune Deviceconfig Windows10pfximportcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10pfximportcertificateprofile.md | Here is a JSON representation of the resource. "version": 1024, "keyStorageProvider": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows10pkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10pkcscertificateprofile.md | Inherits from [windows10CertificateProfileBase](../resources/intune-deviceconfig |certificationAuthorityName|String|PKCS Certification Authority Name| |certificateTemplateName|String|PKCS Certificate Template Name| |subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements.| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windows10secureassessmentconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10secureassessmentconfiguration.md | Here is a JSON representation of the resource. "localGuestAccountName": "String", "assessmentAppUserModelId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows10teamgeneralconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10teamgeneralconfiguration.md | Here is a JSON representation of the resource. "welcomeScreenBackgroundImageUrl": "String", "welcomeScreenMeetingInformation": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows10vpnauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10vpnauthenticationmethod.md | Windows 10 VPN connection types. |certificate|0|Authenticate with a certificate.| |usernameAndPassword|1|Use username and password for authentication.| |customEapXml|2|Authentication method is specified in custom EAP XML.|-|derivedCredential|3|Use Derived Credential for authentication.| +|derivedCredential|3|Use Derived Credential for authentication.| |
v1.0 | Intune Deviceconfig Windows10vpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10vpnconfiguration.md | Inherits from [windowsVpnConfiguration](../resources/intune-deviceconfig-windows |rememberUserCredentials|Boolean|Remember user credentials.| |enableConditionalAccess|Boolean|Enable conditional access.| |enableSingleSignOnWithAlternateCertificate|Boolean|Enable single sign-on (SSO) with alternate certificate.|-|singleSignOnEku|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md)|Single sign-on Extended Key Usage (EKU).| +|singleSignOnEku|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md)|Single sign-on Extended Key Usage (EKU).| |singleSignOnIssuerHash|String|Single sign-on issuer hash.| |eapXml|Binary|Extensible Authentication Protocol (EAP) XML. (UTF8 encoded byte array)| |proxyServer|[windows10VpnProxyServer](../resources/intune-deviceconfig-windows10vpnproxyserver.md)|Proxy Server.| Here is a JSON representation of the resource. "pfsGroup": "String" } }-``` +``` |
v1.0 | Intune Deviceconfig Windows10vpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10vpnconnectiontype.md | VPN connection types. |paloAltoGlobalProtect|9|Palo Alto Networks GlobalProtect.| |ciscoAnyConnect|10|Cisco AnyConnect| |unknownFutureValue|11|Sentinel member for cases where the client cannot handle the new enum values.|-|microsoftTunnel|12|Microsoft Tunnel connection type| +|microsoftTunnel|12|Microsoft Tunnel connection type| |
v1.0 | Intune Deviceconfig Windows10vpnprofiletarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10vpnprofiletarget.md | Windows 10 VPN profile target types. |:|:|:| |user|0|User targeted VPN profile.| |device|1|Device targeted VPN profile.|-|autoPilotDevice|2|AutoPilot Device targeted VPN profile.| +|autoPilotDevice|2|AutoPilot Device targeted VPN profile.| |
v1.0 | Intune Deviceconfig Windows10vpnproxyserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10vpnproxyserver.md | Here is a JSON representation of the resource. "port": 1024, "bypassProxyServerForLocalAddress": true }-``` +``` |
v1.0 | Intune Deviceconfig Windows81certificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81certificateprofilebase.md | Inherits from [windowsCertificateProfileBase](../resources/intune-deviceconfig-w |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements.| ## Relationships Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windows81compliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81compliancepolicy.md | Here is a JSON representation of the resource. "osMaximumVersion": "String", "storageRequireEncryption": true }-``` +``` |
v1.0 | Intune Deviceconfig Windows81generalconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81generalconfiguration.md | Here is a JSON representation of the resource. "userAccountControlSettings": "String", "workFoldersUrl": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows81scepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81scepcertificateprofile.md | Inherits from [windows81CertificateProfileBase](../resources/intune-deviceconfig |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period Inherited from [windowsCertificateProfileBase](../resources/intune-deviceconfig-windowscertificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windows81CertificateProfileBase](../resources/intune-deviceconfig-windows81certificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windows81CertificateProfileBase](../resources/intune-deviceconfig-windows81certificateprofilebase.md)| |customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements. Inherited from [windows81CertificateProfileBase](../resources/intune-deviceconfig-windows81certificateprofilebase.md)| |scepServerUrls|String collection|SCEP Server Url(s).| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| Here is a JSON representation of the resource. "subjectAlternativeNameFormatString": "String", "certificateStore": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows81trustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81trustedrootcertificate.md | Here is a JSON representation of the resource. "certFileName": "String", "destinationStore": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windows81vpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81vpnconfiguration.md | Here is a JSON representation of the resource. "bypassProxyServerForLocalAddress": true } }-``` +``` |
v1.0 | Intune Deviceconfig Windows81vpnproxyserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81vpnproxyserver.md | Here is a JSON representation of the resource. "automaticallyDetectProxySettings": true, "bypassProxyServerForLocalAddress": true }-``` +``` |
v1.0 | Intune Deviceconfig Windows81wifiimportconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81wifiimportconfiguration.md | Here is a JSON representation of the resource. "profileName": "String", "payload": "binary" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsappstartlayouttilesize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsappstartlayouttilesize.md | The tile size of Windows app in the start layout. |small|1|Small 1x1.| |medium|2|Medium 2x2.| |wide|3|Wide 4x2.|-|large|4|Large 4x4.| +|large|4|Large 4x4.| |
v1.0 | Intune Deviceconfig Windowscertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowscertificateprofilebase.md | Here is a JSON representation of the resource. "certificateValidityPeriodValue": 1024, "certificateValidityPeriodScale": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsdefenderadvancedthreatprotectionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsdefenderadvancedthreatprotectionconfiguration.md | Here is a JSON representation of the resource. "advancedThreatProtectionOffboardingBlob": "String", "advancedThreatProtectionOffboardingFilename": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsdefendertamperprotectionoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsdefendertamperprotectionoptions.md | Defender TamperProtection setting options |:|:|:| |notConfigured|0|Not Configured| |enable|1|Enable windows defender tamper protection|-|disable|2|Disable windows defender tamper protection| +|disable|2|Disable windows defender tamper protection| |
v1.0 | Intune Deviceconfig Windowsdeliveryoptimizationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsdeliveryoptimizationconfiguration.md | Here is a JSON representation of the resource. "cacheServerForegroundDownloadFallbackToHttpDelayInSeconds": 1024, "cacheServerBackgroundDownloadFallbackToHttpDelayInSeconds": 1024 }-``` +``` |
v1.0 | Intune Deviceconfig Windowsdeliveryoptimizationmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsdeliveryoptimizationmode.md | Delivery optimization mode for peer distribution |httpWithPeeringPrivateGroup|3|HTTP blended with peering across a private group| |httpWithInternetPeering|4|HTTP blended with Internet peering| |simpleDownload|99|Simple download mode with no peering|-|bypassMode|100|Bypass mode. Do not use Delivery Optimization and use BITS instead| +|bypassMode|100|Bypass mode. Do not use Delivery Optimization and use BITS instead| |
v1.0 | Intune Deviceconfig Windowsdomainjoinconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsdomainjoinconfiguration.md | Namespace: microsoft.graph Windows Domain Join device configuration. -Inherits from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md) +Inherits from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md) ## Methods |Method|Return Type|Description| |:|:|:|-|[List windowsDomainJoinConfigurations](../api/intune-deviceconfig-windowsdomainjoinconfiguration-list.md)|[windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) collection|List properties and relationships of the [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) objects.| -|[Get windowsDomainJoinConfiguration](../api/intune-deviceconfig-windowsdomainjoinconfiguration-get.md)|[windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md)|Read properties and relationships of the [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) object.| -|[Create windowsDomainJoinConfiguration](../api/intune-deviceconfig-windowsdomainjoinconfiguration-create.md)|[windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md)|Create a new [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) object.| -|[Delete windowsDomainJoinConfiguration](../api/intune-deviceconfig-windowsdomainjoinconfiguration-delete.md)|None|Deletes a [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md).| -|[Update windowsDomainJoinConfiguration](../api/intune-deviceconfig-windowsdomainjoinconfiguration-update.md)|[windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md)|Update the properties of a [windowsDomainJoinConfiguration](../resources/intune-deviceconfig-windowsdomainjoinconfiguration.md) object.| +|[List windowsDomainJoinConfigurations](../api/intune-deviceconfig-windowsdomainjoinconfiguration-list.md)|[windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) collection|List properties and relationships of the [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) objects.| +|[Get windowsDomainJoinConfiguration](../api/intune-deviceconfig-windowsdomainjoinconfiguration-get.md)|[windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md)|Read properties and relationships of the [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object.| +|[Create windowsDomainJoinConfiguration](../api/intune-deviceconfig-windowsdomainjoinconfiguration-create.md)|[windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md)|Create a new [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object.| +|[Delete windowsDomainJoinConfiguration](../api/intune-deviceconfig-windowsdomainjoinconfiguration-delete.md)|None|Deletes a [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md).| +|[Update windowsDomainJoinConfiguration](../api/intune-deviceconfig-windowsdomainjoinconfiguration-update.md)|[windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md)|Update the properties of a [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object.| ## Properties |Property|Type|Description| |:|:|:|-|id|String|Key of the entity. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|lastModifiedDateTime|DateTimeOffset|DateTime the object was last modified. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|supportsScopeTags|Boolean|Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceManagementApplicabilityRuleOsEdition|[deviceManagementApplicabilityRuleOsEdition](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md)|The OS edition applicability for this Policy. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceManagementApplicabilityRuleOsVersion|[deviceManagementApplicabilityRuleOsVersion](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md)|The OS version applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceManagementApplicabilityRuleDeviceMode|[deviceManagementApplicabilityRuleDeviceMode](../resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md)|The device mode applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|createdDateTime|DateTimeOffset|DateTime the object was created. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| +|id|String|Key of the entity. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|lastModifiedDateTime|DateTimeOffset|DateTime the object was last modified. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|supportsScopeTags|Boolean|Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsEdition|[deviceManagementApplicabilityRuleOsEdition](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md)|The OS edition applicability for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsVersion|[deviceManagementApplicabilityRuleOsVersion](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md)|The OS version applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleDeviceMode|[deviceManagementApplicabilityRuleDeviceMode](../resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md)|The device mode applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|createdDateTime|DateTimeOffset|DateTime the object was created. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |computerNameStaticPrefix|String|Fixed prefix to be used for computer name.| |computerNameSuffixRandomCharCount|Int32|Dynamically generated characters used as suffix for computer name. Valid values 3 to 14| |activeDirectoryDomainName|String|Active Directory domain name to join.| Inherits from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfi ## Relationships |Relationship|Type|Description| |:|:|:|-|groupAssignments|[deviceConfigurationGroupAssignment](../resources/intune-deviceconfig-deviceconfigurationgroupassignment.md) collection|The list of group assignments for the device configuration profile. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|assignments|[deviceConfigurationAssignment](../resources/intune-deviceconfig-deviceconfigurationassignment.md) collection|The list of assignments for the device configuration profile. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceStatuses|[deviceConfigurationDeviceStatus](../resources/intune-deviceconfig-deviceconfigurationdevicestatus.md) collection|Device configuration installation status by device. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|userStatuses|[deviceConfigurationUserStatus](../resources/intune-deviceconfig-deviceconfigurationuserstatus.md) collection|Device configuration installation status by user. Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceStatusOverview|[deviceConfigurationDeviceOverview](../resources/intune-deviceconfig-deviceconfigurationdeviceoverview.md)|Device Configuration devices status overview Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|userStatusOverview|[deviceConfigurationUserOverview](../resources/intune-deviceconfig-deviceconfigurationuseroverview.md)|Device Configuration users status overview Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|deviceSettingStateSummaries|[settingStateDeviceSummary](../resources/intune-deviceconfig-settingstatedevicesummary.md) collection|Device Configuration Setting State Device Summary Inherited from [deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md)| -|networkAccessConfigurations|[deviceConfiguration](../resources/intune-deviceconfig-deviceconfiguration.md) collection|Reference to device configurations required for network connectivity. This collection can contain a maximum of 2 elements.| +|groupAssignments|[deviceConfigurationGroupAssignment](../resources/intune-deviceconfig-deviceconfigurationgroupassignment.md) collection|The list of group assignments for the device configuration profile. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|assignments|[deviceConfigurationAssignment](../resources/intune-deviceconfig-deviceconfigurationassignment.md) collection|The list of assignments for the device configuration profile. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceStatuses|[deviceConfigurationDeviceStatus](../resources/intune-deviceconfig-deviceconfigurationdevicestatus.md) collection|Device configuration installation status by device. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|userStatuses|[deviceConfigurationUserStatus](../resources/intune-deviceconfig-deviceconfigurationuserstatus.md) collection|Device configuration installation status by user. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceStatusOverview|[deviceConfigurationDeviceOverview](../resources/intune-deviceconfig-deviceconfigurationdeviceoverview.md)|Device Configuration devices status overview Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|userStatusOverview|[deviceConfigurationUserOverview](../resources/intune-deviceconfig-deviceconfigurationuseroverview.md)|Device Configuration users status overview Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceSettingStateSummaries|[settingStateDeviceSummary](../resources/intune-deviceconfig-settingstatedevicesummary.md) collection|Device Configuration Setting State Device Summary Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|networkAccessConfigurations|[deviceConfiguration](../resources/intune-shared-deviceconfiguration.md) collection|Reference to device configurations required for network connectivity. This collection can contain a maximum of 2 elements.| ## JSON Representation Here is a JSON representation of the resource. Here is a JSON representation of the resource. "activeDirectoryDomainName": "String", "organizationalUnit": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsedgekiosktype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsedgekiosktype.md | Edge kiosk type |Member|Value|Description| |:|:|:| |publicBrowsing|0|public-browsing|-|fullScreen|1|fullscreen| +|fullScreen|1|fullscreen| |
v1.0 | Intune Deviceconfig Windowsfirewallnetworkprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsfirewallnetworkprofile.md | Here is a JSON representation of the resource. "policyRulesFromGroupPolicyMerged": true, "policyRulesFromGroupPolicyNotMerged": true }-``` +``` |
v1.0 | Intune Deviceconfig Windowsfirewallrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsfirewallrule.md | Here is a JSON representation of the resource. "edgeTraversal": "String", "localUserAuthorizations": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsfirewallruleinterfacetypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsfirewallruleinterfacetypes.md | Flags representing firewall rule interface types. |notConfigured|0|No flags set.| |remoteAccess|1|The Remote Access interface type.| |wireless|2|The Wireless interface type.|-|lan|4|The LAN interface type.| +|lan|4|The LAN interface type.| |
v1.0 | Intune Deviceconfig Windowsfirewallrulenetworkprofiletypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsfirewallrulenetworkprofiletypes.md | Flags representing which network profile types apply to a firewall rule. |notConfigured|0|No flags set.| |domain|1|The profile for networks that are connected to domains.| |private|2|The profile for private networks.|-|public|4|The profile for public networks.| +|public|4|The profile for public networks.| |
v1.0 | Intune Deviceconfig Windowsfirewallruletrafficdirectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsfirewallruletrafficdirectiontype.md | Firewall rule traffic directions. |:|:|:| |notConfigured|0|Not configured.| |out|1|The rule applies to outbound traffic.|-|in|2|The rule applies to inbound traffic.| +|in|2|The rule applies to inbound traffic.| |
v1.0 | Intune Deviceconfig Windowshealthmonitoringconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowshealthmonitoringconfiguration.md | Here is a JSON representation of the resource. "configDeviceHealthMonitoringScope": "String", "configDeviceHealthMonitoringCustomScope": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowshealthmonitoringscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowshealthmonitoringscope.md | Device health monitoring scope |healthMonitoring|1|Basic events for windows device health monitoring| |bootPerformance|2|Boot performance events| |windowsUpdates|4|Windows updates events|-|privilegeManagement|8|PrivilegeManagement| +|privilegeManagement|8|PrivilegeManagement| |
v1.0 | Intune Deviceconfig Windowsidentityprotectionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsidentityprotectionconfiguration.md | Here is a JSON representation of the resource. "useCertificatesForOnPremisesAuthEnabled": true, "windowsHelloForBusinessBlocked": true }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskactivedirectorygroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskactivedirectorygroup.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsKioskActiveDirectoryGroup", "groupName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskappbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskappbase.md | Here is a JSON representation of the resource. "appType": "String", "autoLaunch": true }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskappconfiguration.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.windowsKioskAppConfiguration" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskapptype.md | The type of Windows kiosk app. |unknown|0|Unknown.| |store|1|Store App.| |desktop|2|Desktop App.|-|aumId|3|Input by AUMID.| +|aumId|3|Input by AUMID.| |
v1.0 | Intune Deviceconfig Windowskioskautologon | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskautologon.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.windowsKioskAutologon" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskazureadgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskazureadgroup.md | Here is a JSON representation of the resource. "displayName": "String", "groupId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskazureaduser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskazureaduser.md | Here is a JSON representation of the resource. "userId": "String", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskconfiguration.md | Here is a JSON representation of the resource. "runImmediatelyIfAfterStartDateTime": true } }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskdesktopapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskdesktopapp.md | Here is a JSON representation of the resource. "desktopApplicationId": "String", "desktopApplicationLinkPath": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskforceupdateschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskforceupdateschedule.md | Here is a JSON representation of the resource. "dayofMonth": 1024, "runImmediatelyIfAfterStartDateTime": true }-``` +``` |
v1.0 | Intune Deviceconfig Windowskiosklocalgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskiosklocalgroup.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsKioskLocalGroup", "groupName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskiosklocaluser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskiosklocaluser.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsKioskLocalUser", "userName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskmultipleapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskmultipleapps.md | Here is a JSON representation of the resource. "disallowDesktopApps": true, "startMenuLayoutXml": "binary" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskprofile.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windowskiosksingleuwpapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskiosksingleuwpapp.md | Here is a JSON representation of the resource. "containedAppId": "String" } }-``` +``` |
v1.0 | Intune Deviceconfig Windowskiosksinglewin32app | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskiosksinglewin32app.md | Here is a JSON representation of the resource. "edgeKiosk": "String" } }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskuser.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.windowsKioskUser" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskuwpapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskuwpapp.md | Here is a JSON representation of the resource. "appId": "String", "containedAppId": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskvisitor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskvisitor.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.windowsKioskVisitor" }-``` +``` |
v1.0 | Intune Deviceconfig Windowskioskwin32app | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskwin32app.md | Here is a JSON representation of the resource. "edgeKioskType": "String", "edgeKiosk": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsnetworkisolationpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsnetworkisolationpolicy.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphone81certificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81certificateprofilebase.md | Inherits from [deviceConfiguration](../resources/intune-shared-deviceconfigurati |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validtiy Period.| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements.| ## Relationships |Relationship|Type|Description| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphone81compliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81compliancepolicy.md | Here is a JSON representation of the resource. "osMaximumVersion": "String", "storageRequireEncryption": true }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphone81customconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81customconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphone81generalconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81generalconfiguration.md | Here is a JSON representation of the resource. "wifiBlockHotspotReporting": true, "windowsStoreBlocked": true }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphone81importedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81importedpfxcertificateprofile.md | Here is a JSON representation of the resource. "certificateValidityPeriodScale": "String", "intendedPurpose": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphone81scepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81scepcertificateprofile.md | Inherits from [windowsPhone81CertificateProfileBase](../resources/intune-devicec |subjectAlternativeNameType|[subjectAlternativeNameType](../resources/intune-shared-subjectalternativenametype.md)|Certificate Subject Alternative Name Type. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md). Possible values are: `none`, `emailAddress`, `userPrincipalName`, `customAzureADAttribute`, `domainNameService`, `universalResourceIdentifier`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validtiy Period. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md)| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md). Possible values are: `days`, `months`, `years`.|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-deviceconfig-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md)| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings. This collection can contain a maximum of 500 elements. Inherited from [windowsPhone81CertificateProfileBase](../resources/intune-deviceconfig-windowsphone81certificateprofilebase.md)| |scepServerUrls|String collection|SCEP Server Url(s).| |subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| |keyUsage|[keyUsages](../resources/intune-shared-keyusages.md)|SCEP Key Usage. Possible values are: `keyEncipherment`, `digitalSignature`.| Here is a JSON representation of the resource. "hashAlgorithm": "String", "subjectAlternativeNameFormatString": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphone81trustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81trustedrootcertificate.md | Here is a JSON representation of the resource. "trustedRootCertificate": "binary", "certFileName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphone81vpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81vpnconfiguration.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfig Windowsphoneeasemailprofileconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphoneeasemailprofileconfiguration.md | Here is a JSON representation of the resource. "hostName": "String", "requireSsl": true }-``` +``` |
v1.0 | Intune Deviceconfig Windowsprivacydataaccesscontrolitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsprivacydataaccesscontrolitem.md | Here is a JSON representation of the resource. "appPackageFamilyName": "String", "appDisplayName": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsprivacydataaccesslevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsprivacydataaccesslevel.md | Determine the access level to specific Windows privacy data category. |notConfigured|0|No access level specified, no intents. Device may behave either as in UserInControl or ForceAllow. It may depend on the privacy data been accessed, Windows versions and other factors.| |forceAllow|1|Apps will be allowed to access the specified privacy data.| |forceDeny|2|Apps will be denied to access specified privacy data.|-|userInControl|3|Users will be prompted when apps try to access specified privacy data.| +|userInControl|3|Users will be prompted when apps try to access specified privacy data.| |
v1.0 | Intune Deviceconfig Windowsprivacydatacategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsprivacydatacategory.md | Windows privacy data category specifier for privacy data access. |radios|15|Let apps use radios, including Bluetooth, to send and receive data. Added in Windows 10, version 1607.| |tasks|16|Let apps access Task Scheduler. Added in Windows 10, version 1703.| |syncWithDevices|17|Let apps automatically share and sync info with wireless devices that donΓÇÖt explicitly pair with userΓÇÖs device. Added in Windows 10, version 1607.|-|trustedDevices|18|Let apps access trusted devices. Added in Windows 10, version 1607.| +|trustedDevices|18|Let apps access trusted devices. Added in Windows 10, version 1607.| |
v1.0 | Intune Deviceconfig Windowssmodeconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowssmodeconfiguration.md | The possible options to configure S mode unlock |:|:|:| |noRestriction|0|This option will remove all restrictions to unlock S mode - default| |block|1|This option will block the user to unlock the device from S mode|-|unlock|2|This option will unlock the device from S mode| +|unlock|2|This option will unlock the device from S mode| |
v1.0 | Intune Deviceconfig Windowsspotlightenablementsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsspotlightenablementsettings.md | Allows IT admind to set a predefined default search engine for MDM-Controlled de |:|:|:| |notConfigured|0|Spotlight on lock screen is not configured| |disabled|1|Disable Windows Spotlight on lock screen|-|enabled|2|Enable Windows Spotlight on lock screen| +|enabled|2|Enable Windows Spotlight on lock screen| |
v1.0 | Intune Deviceconfig Windowsstartmenuapplistvisibilitytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsstartmenuapplistvisibilitytype.md | Type of start menu app list visibility. |userDefined|0|User defined. Default value.| |collapse|1|Collapse the app list on the start menu.| |remove|2|Removes the app list entirely from the start menu.|-|disableSettingsApp|4|Disables the corresponding toggle (Collapse or Remove) in the Settings app.| +|disableSettingsApp|4|Disables the corresponding toggle (Collapse or Remove) in the Settings app.| |
v1.0 | Intune Deviceconfig Windowsstartmenumodetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsstartmenumodetype.md | Type of display modes for the start menu. |:|:|:| |userDefined|0|User defined. Default value.| |fullScreen|1|Full screen.|-|nonFullScreen|2|Non-full screen.| +|nonFullScreen|2|Non-full screen.| |
v1.0 | Intune Deviceconfig Windowsupdateactivehoursinstall | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdateactivehoursinstall.md | Here is a JSON representation of the resource. "activeHoursStart": "String (time of day)", "activeHoursEnd": "String (time of day)" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsupdateforbusinessconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdateforbusinessconfiguration.md | Here is a JSON representation of the resource. "updateNotificationLevel": "String", "allowWindows11Upgrade": true }-``` +``` |
v1.0 | Intune Deviceconfig Windowsupdateforbusinessupdateweeks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdateforbusinessupdateweeks.md | Scheduled the update installation on the weeks of the month |thirdWeek|4|Scheduled the update installation on the third week of the month| |fourthWeek|8|Scheduled the update installation on the fourth week of the month| |everyWeek|15|Scheduled the update installation on every week of the month|-|unknownFutureValue|22|Evolvable enum member| +|unknownFutureValue|22|Evolvable enum member| |
v1.0 | Intune Deviceconfig Windowsupdateinstallscheduletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdateinstallscheduletype.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.windowsUpdateInstallScheduleType" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsupdatenotificationdisplayoption | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdatenotificationdisplayoption.md | Windows Update Notification Display Options |defaultNotifications|1|Use the default Windows Update notifications.| |restartWarningsOnly|2|Turn off all notifications, excluding restart warnings.| |disableAllNotifications|3|Turn off all notifications, including restart warnings.|-|unknownFutureValue|4|Evolvable enum member| +|unknownFutureValue|4|Evolvable enum member| |
v1.0 | Intune Deviceconfig Windowsupdatescheduledinstall | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdatescheduledinstall.md | Here is a JSON representation of the resource. "scheduledInstallDay": "String", "scheduledInstallTime": "String (time of day)" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsupdatestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdatestatus.md | Windows update for business configuration device states |upToDate|0|There are no pending updates, no pending reboot updates and no failed updates.| |pendingInstallation|1|There are updates thatΓÇÖs pending installation which includes updates that are not approved. There are no Pending reboot updates, no failed updates.| |pendingReboot|2|There are updates that requires reboot. There are not failed updates.|-|failed|3|There are updates failed to install on the device.| +|failed|3|There are updates failed to install on the device.| |
v1.0 | Intune Deviceconfig Windowsupdatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdatetype.md | Which branch devices will receive their updates from |businessReadyOnly|2|Semi-annual Channel. Device gets feature updates from Semi-annual Channel.| |windowsInsiderBuildFast|3|Windows Insider build - Fast| |windowsInsiderBuildSlow|4|Windows Insider build - Slow|-|windowsInsiderBuildRelease|5|Release Windows Insider build| +|windowsInsiderBuildRelease|5|Release Windows Insider build| |
v1.0 | Intune Deviceconfig Windowsuseraccountcontrolsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsuseraccountcontrolsettings.md | Possible values for Windows user account control settings. |alwaysNotify|1|Always notify.| |notifyOnAppChanges|2|Notify on app changes.| |notifyOnAppChangesWithoutDimming|3|Notify on app changes without dimming desktop.|-|neverNotify|4|Never notify.| +|neverNotify|4|Never notify.| |
v1.0 | Intune Deviceconfig Windowsvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsvpnconfiguration.md | Here is a JSON representation of the resource. ], "customXml": "binary" }-``` +``` |
v1.0 | Intune Deviceconfig Windowsvpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsvpnconnectiontype.md | Windows VPN connection type. |pulseSecure|0|Pulse Secure.| |f5EdgeClient|1|F5 Edge Client.| |dellSonicWallMobileConnect|2|Dell SonicWALL Mobile Connection.|-|checkPointCapsuleVpn|3|Check Point Capsule VPN.| +|checkPointCapsuleVpn|3|Check Point Capsule VPN.| |
v1.0 | Intune Deviceconfig Windowswificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowswificonfiguration.md | Here is a JSON representation of the resource. "proxyAutomaticConfigurationUrl": "String", "forceFIPSCompliance": true }-``` +``` |
v1.0 | Intune Deviceconfig Windowswifienterpriseeapconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowswifienterpriseeapconfiguration.md | Here is a JSON representation of the resource. "cacheCredentials": true, "authenticationType": "String" }-``` +``` |
v1.0 | Intune Deviceconfig Windowswirednetworkconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowswirednetworkconfiguration.md | Here is a JSON representation of the resource. "requireCryptographicBinding": true, "forceFIPSCompliance": true }-``` +``` |
v1.0 | Intune Deviceconfig Wirednetworkauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wirednetworkauthenticationmethod.md | Wired Network authentication method. |certificate|0|Use an identity certificate for authentication.| |usernameAndPassword|1|Use username and password for authentication.| |derivedCredential|2|Use Derived Credential for authentication.|-|unknownFutureValue|3|Sentinel member for cases where the client cannot handle the new enum values.| +|unknownFutureValue|3|Sentinel member for cases where the client cannot handle the new enum values.| |
v1.0 | Intune Deviceconfig Wirednetworkauthenticationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wirednetworkauthenticationtype.md | Wired Network Authentication Type Settings. |machine|2|Machine Authentication| |machineOrUser|3|Machine or User Authentication| |guest|4|Guest Authentication|-|unknownFutureValue|5|Sentinel member for cases where the client cannot handle the new enum values.| +|unknownFutureValue|5|Sentinel member for cases where the client cannot handle the new enum values.| |
v1.0 | Intune Deviceconfig Wirednetworkinterface | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wirednetworkinterface.md | Apple network interface type. |thirdActiveEthernet|3|Third active Ethernet.| |firstEthernet|4|First Ethernet.| |secondEthernet|5|Second Ethernet.|-|thirdEthernet|6|Third Ethernet.| +|thirdEthernet|6|Third Ethernet.| |
v1.0 | Intune Deviceconfigv2 Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagement.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementcomplianceactionitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementcomplianceactionitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementcomplianceactiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementcomplianceactiontype.md | Scheduled Action Type Enum |wipe|4|Wipe the device| |removeResourceAccessProfiles|5|Remove Resource Access Profiles from the device| |pushNotification|9|Send push notification to device|-|remoteLock|10|Remotely lock the device| +|remoteLock|10|Remotely lock the device| |
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 |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|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.| 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 | Here is a JSON representation of the resource. "id": "String (identifier)", "ruleName": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationapplicationsettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationapplicationsettingapplicability.md | Inherits from [deviceManagementConfigurationSettingApplicability](../resources/i |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`.| |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`, `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`.| ## Relationships None Here is a JSON representation of the resource. "deviceMode": "String", "technologies": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationazureadtrusttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationazureadtrusttype.md | Required AAD Trust Type |none|0|No AAD Trust Type specified| |azureAdJoined|1|AAD Joined Trust Type| |addWorkAccount|2|AddWorkAccount|-|mdmOnly|4|MDM only| +|mdmOnly|4|MDM only| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationcategory.md | Device Management Configuration Policy |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| -|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`.| +|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`.| +|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.| |childCategoryIds|String collection|List of child ids of the category.| Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingcollectiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectiondefinition.md | Inherits from [deviceManagementConfigurationChoiceSettingDefinition](../resource |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)| Here is a JSON representation of the resource. "maximumCount": 1024, "minimumCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectioninstance.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingcollectioninstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectioninstancetemplate.md | Here is a JSON representation of the resource. ], "allowUnmanagedValues": true }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingdefinition.md | Inherits from [deviceManagementConfigurationSettingDefinition](../resources/intu |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)| Here is a JSON representation of the resource. ], "defaultOptionId": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettinginstance.md | Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettinginstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettinginstancetemplate.md | Here is a JSON representation of the resource. "settingValueTemplateId": "String" } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingvalue.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingvalueconstantdefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingvalueconstantdefaulttemplate.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingvaluedefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingvaluedefaulttemplate.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementConfigurationChoiceSettingValueDefaultTemplate" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingvaluedefinitiontemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingvaluedefinitiontemplate.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingvaluetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingvaluetemplate.md | Here is a JSON representation of the resource. }, "settingValueTemplateId": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationcontroltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationcontroltype.md | Setting control type representation in the UX |toggle|4|Allow for toggle control type.| |multiheaderGrid|5|Allow for multiheader grid control type.| |contextPane|6|Allow for context pane control type.|-|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationdependenton | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationdependenton.md | Here is a JSON representation of the resource. "dependentOn": "String", "parentSettingId": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationdevicemode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationdevicemode.md | Describes applicability for the mode the device is in |Member|Value|Description| |:|:|:| |none|0|No Device Mode specified|-|kiosk|1|Device must be in kiosk mode for this setting to apply| +|kiosk|1|Device must be in kiosk mode for this setting to apply| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationexchangeonlinesettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationexchangeonlinesettingapplicability.md | Inherits from [deviceManagementConfigurationSettingApplicability](../resources/i |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`.| |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`, `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`.| ## Relationships None Here is a JSON representation of the resource. "deviceMode": "String", "technologies": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettingcollectioninstance.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettingcollectioninstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettingcollectioninstancetemplate.md | Here is a JSON representation of the resource. ], "allowUnmanagedValues": true }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettinginstance.md | Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettinginstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettinginstancetemplate.md | Here is a JSON representation of the resource. "settingValueTemplateId": "String" } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettingvalue.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettingvaluetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettingvaluetemplate.md | Here is a JSON representation of the resource. ], "settingValueTemplateId": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvalue.md | Here is a JSON representation of the resource. }, "value": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvalueconstantdefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvalueconstantdefaulttemplate.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementConfigurationIntegerSettingValueConstantDefaultTemplate", "constantValue": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvaluedefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvaluedefaulttemplate.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementConfigurationIntegerSettingValueDefaultTemplate" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvaluedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvaluedefinition.md | Here is a JSON representation of the resource. "maximumValue": 1024, "minimumValue": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvaluedefinitiontemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvaluedefinitiontemplate.md | Here is a JSON representation of the resource. "minValue": 1024, "maxValue": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvaluetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvaluetemplate.md | Here is a JSON representation of the resource. "maxValue": 1024 } }-``` +``` |
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." --localization_priority: Normal --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 or Organization Unit (Ou). Default value : unknown. Possible values are: `unknown`, `entraSecurityGroup`, `organizationalUnit`, `unknownFutureValue`.| -|target|String collection|A list of unique identifiers representing static Entra Security Group IDs or Organizational Units 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 or Organizational Unit (OU)) used to create the just-in-time assignment." --localization_priority: Normal --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 or Organizational Unit (OU)) used to create the just-in-time assignment. --## Members -|Member|Value|Description| -|:|:|:| -|unknown|0|Default value. Do not use.| -|entraSecurityGroup|1|Entra security group.| -|organizationalUnit|2|Organizational unit.| -|unknownFutureValue|3|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 | Here is a JSON representation of the resource. "name": "String", "displayName": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationoptiondefinitiontemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationoptiondefinitiontemplate.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationplatforms | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md | Supported platform types. |windows10X|16|Windows 10 X.| |windows10|32|Settings for Windows 10 platform.| |linux|128|Settings for Linux platform.|-|unknownFutureValue|256|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|256|Evolvable enumeration sentinel value. Do not use.| |
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 |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|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| |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 Devicemanagementconfigurationpolicyassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md | - Title: "deviceManagementConfigurationPolicyAssignment resource type" -description: "The DeviceManagementConfigurationPolicyAssignment entity assigns a specific DeviceManagementConfigurationPolicy to an AAD group." --localization_priority: Normal --doc_type: resourcePageType ---# deviceManagementConfigurationPolicyAssignment resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 DeviceManagementConfigurationPolicyAssignment entity assigns a specific DeviceManagementConfigurationPolicy to an AAD group. --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List deviceManagementConfigurationPolicyAssignments](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment-list.md)|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection|List properties and relationships of the [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) objects.| -|[Get deviceManagementConfigurationPolicyAssignment](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment-get.md)|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md)|Read properties and relationships of the [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) object.| -|[Create deviceManagementConfigurationPolicyAssignment](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment-create.md)|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md)|Create a new [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) object.| -|[Delete deviceManagementConfigurationPolicyAssignment](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment-delete.md)|None|Deletes a [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md).| -|[Update deviceManagementConfigurationPolicyAssignment](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment-update.md)|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md)|Update the properties of a [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) object.| --## Properties -|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.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.deviceManagementConfigurationPolicyAssignment" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "String (identifier)", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "String", - "deviceAndAppManagementAssignmentFilterType": "String", - "targetType": "String", - "entraObjectId": "String" - }, - "source": "String", - "sourceId": "String" -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationpolicytemplate.md | Device Management Configuration Policy Template |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`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|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`.| |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.| Here is a JSON representation of the resource. "allowUnmanagedSettings": true, "settingTemplateCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicytemplatereference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationpolicytemplatereference.md | Here is a JSON representation of the resource. "templateDisplayName": "String", "templateDisplayVersion": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationredirectsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationredirectsettingdefinition.md | Inherits from [deviceManagementConfigurationSettingDefinition](../resources/intu |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)| Here is a JSON representation of the resource. "redirectMessage": "String", "redirectReason": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationreferencesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationreferencesettingvalue.md | Here is a JSON representation of the resource. "value": "String", "note": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationreferredsettinginformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationreferredsettinginformation.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementConfigurationReferredSettingInformation", "settingDefinitionId": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsecretsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsecretsettingvalue.md | Here is a JSON representation of the resource. "value": "String", "valueState": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsecretsettingvaluestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsecretsettingvaluestate.md | type tracking the encryption state of a secret setting value |:|:|:| |invalid|0|default invalid value| |notEncrypted|1|secret value is not encrypted|-|encryptedValueToken|2|a token for the encrypted value is returned by the service| +|encryptedValueToken|2|a token for the encrypted value is returned by the service| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsetting.md | Here is a JSON representation of the resource. } } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingaccesstypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingaccesstypes.md | Namespace: microsoft.graph |delete|4|| |get|8|| |replace|16||-|execute|32|| +|execute|32|| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md | Namespace: microsoft.graph |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`.| |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`, `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`.| ## Relationships None Here is a JSON representation of the resource. "deviceMode": "String", "technologies": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md | Namespace: microsoft.graph |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.| Here is a JSON representation of the resource. "displayName": "String", "version": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingdependedonby | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdependedonby.md | Here is a JSON representation of the resource. "dependedOnBy": "String", "required": true }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupcollectiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupcollectiondefinition.md | Inherits from [deviceManagementConfigurationSettingGroupDefinition](../resources |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)| Here is a JSON representation of the resource. "maximumCount": 1024, "minimumCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupcollectioninstance.md | Here is a JSON representation of the resource. "settingInstanceTemplateId": "String" } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupdefinition.md | Inherits from [deviceManagementConfigurationSettingDefinition](../resources/intu |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)| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupinstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupinstance.md | Here is a JSON representation of the resource. "settingInstanceTemplateId": "String" } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettinginstance.md | Here is a JSON representation of the resource. "settingInstanceTemplateId": "String" } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinginstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettinginstancetemplate.md | Here is a JSON representation of the resource. "settingDefinitionId": "String", "isRequired": true }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinginstancetemplatereference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettinginstancetemplatereference.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementConfigurationSettingInstanceTemplateReference", "settingInstanceTemplateId": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingoccurrence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingoccurrence.md | Here is a JSON representation of the resource. "minDeviceOccurrence": 1024, "maxDeviceOccurrence": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingtemplate.md | Here is a JSON representation of the resource. } } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md | Supported setting types |configuration|1|Configuration setting type.| |compliance|2|Compliance setting type.| |unknownFutureValue|8|Evolvable enumeration sentinel value. Do not use.|+|inventory|16|Inventory Setting type.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvalue.md | Here is a JSON representation of the resource. "useTemplateDefault": true } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingvaluedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvaluedefinition.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementConfigurationSettingValueDefinition" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingvaluetemplatereference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvaluetemplatereference.md | Here is a JSON representation of the resource. "settingValueTemplateId": "String", "useTemplateDefault": true }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingvisibility | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md | Supported setting types |settingsCatalog|1|Visible to setting catalog policy type.| |template|2|Visible to template policy type.| |unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.|+|inventoryCatalog|8|Visible to inventory catalog policy type.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingcollectiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectiondefinition.md | Inherits from [deviceManagementConfigurationSimpleSettingDefinition](../resource |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)| Here is a JSON representation of the resource. "maximumCount": 1024, "minimumCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectioninstance.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingcollectioninstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectioninstancetemplate.md | Here is a JSON representation of the resource. ], "allowUnmanagedValues": true }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingdefinition.md | Inherits from [deviceManagementConfigurationSettingDefinition](../resources/intu |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)| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettinginstance.md | Here is a JSON representation of the resource. "value": "String" } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettinginstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettinginstancetemplate.md | Here is a JSON representation of the resource. } } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingvalue.md | Here is a JSON representation of the resource. "useTemplateDefault": true } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingvaluetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingvaluetemplate.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementConfigurationSimpleSettingValueTemplate", "settingValueTemplateId": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringformat.md | Namespace: microsoft.graph |dateTime|13|Indicates a string that is expected to be a valid Datetime.| |surfaceHub|14|Indicates a Windows SKU applicability value that maps to Intune.| |bashScript|19|String whose value is a bash script|-|unknownFutureValue|20|Sentinel member for cases where the client cannot handle the new enum values.| +|unknownFutureValue|20|Sentinel member for cases where the client cannot handle the new enum values.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringsettingvalue.md | Here is a JSON representation of the resource. }, "value": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringsettingvalueconstantdefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringsettingvalueconstantdefaulttemplate.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementConfigurationStringSettingValueConstantDefaultTemplate", "constantValue": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringsettingvaluedefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringsettingvaluedefaulttemplate.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementConfigurationStringSettingValueDefaultTemplate" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringsettingvaluedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringsettingvaluedefinition.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringsettingvaluetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringsettingvaluetemplate.md | Here is a JSON representation of the resource. "constantValue": "String" } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationtechnologies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md | Describes which technology this setting can be deployed with |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| |unknownFutureValue|16384|Evolvable enumeration sentinel value. Do not use.|-|windowsOsRecovery|32768|Setting can be deployed using the Operating System Recovery channel| +|windowsOsRecovery|32768|Setting can be deployed using the Operating System Recovery channel| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationtemplatefamily | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationtemplatefamily.md | Describes the TemplateFamily for the Template entity |deviceConfigurationScripts|22|Template Family for device configuration scripts| |deviceConfigurationPolicies|23|Template Family for device configuration policies| |windowsOsRecoveryPolicies|24|Template Family for windowsOsRecovery that can be applied during a Windows operating system recovery|-|companyPortal|25|Template Family for Company Portal settings| +|companyPortal|25|Template Family for Company Portal settings| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationwindowssettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationwindowssettingapplicability.md | Inherits from [deviceManagementConfigurationSettingApplicability](../resources/i |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`.| |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`, `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`.| |configurationServiceProviderVersion|String|Version of CSP setting is a part of| |maximumSupportedVersion|String|Maximum supported version of Windows| |minimumSupportedVersion|String|Minimum supported version of Windows| Here is a JSON representation of the resource. "requiresAzureAd": true, "requiredAzureAdTrustType": "String" }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationwindowsskus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationwindowsskus.md | Namespace: microsoft.graph |holoLensEnterprise|11|| |holographicForBusiness|12|| |windowsMultiSession|13||-|surfaceHub|14|| +|surfaceHub|14|| |
v1.0 | Intune Deviceconfigv2 Devicemanagementprioritymetadata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementprioritymetadata.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementPriorityMetaData", "priority": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementreusablepolicysetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementreusablepolicysetting.md | Here is a JSON representation of the resource. "version": 1024, "referencingConfigurationPolicyCount": 1024 }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementsettinginsightsdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementsettinginsightsdefinition.md | Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementtemplateinsightsdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementtemplateinsightsdefinition.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementtemplatelifecyclestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementtemplatelifecyclestate.md | Describes current lifecycle state of a template |active|20|Active| |superseded|30|Superseded| |deprecated|40|Deprecated|-|retired|50|Retired| +|retired|50|Retired| |
v1.0 | Intune Deviceintent Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagement.md | Singleton entity that acts as a Container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-deviceintent-devicemanagement-get.md)|[deviceManagement](../resources/intune-deviceintent-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-deviceintent-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-deviceintent-devicemanagement-update.md)|[deviceManagement](../resources/intune-deviceintent-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-deviceintent-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-deviceintent-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-deviceintent-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementabstractcomplexsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementabstractcomplexsettingdefinition.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementabstractcomplexsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementabstractcomplexsettinginstance.md | Here is a JSON representation of the resource. "valueJson": "String", "implementationId": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementbooleansettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementbooleansettinginstance.md | Here is a JSON representation of the resource. "valueJson": "String", "value": true }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementcollectionsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementcollectionsettingdefinition.md | Here is a JSON representation of the resource. ], "elementDefinitionId": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementcollectionsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementcollectionsettinginstance.md | Here is a JSON representation of the resource. "definitionId": "String", "valueJson": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementcomparisonresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementcomparisonresult.md | Setting comparison result type |equal|1|The setting values are equal| |notEqual|2|The setting values are not equal| |added|3|The setting is added|-|removed|4|The setting is removed| +|removed|4|The setting is removed| |
v1.0 | Intune Deviceintent Devicemanagementcomplexsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementcomplexsettingdefinition.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementcomplexsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementcomplexsettinginstance.md | Here is a JSON representation of the resource. "definitionId": "String", "valueJson": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementconstraint.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementConstraint" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementenumconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementenumconstraint.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementenumvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementenumvalue.md | Here is a JSON representation of the resource. "value": "String", "displayName": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintegersettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintegersettinginstance.md | Here is a JSON representation of the resource. "valueJson": "String", "value": 1024 }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintent.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintentassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentassignment.md | Here is a JSON representation of the resource. "collectionId": "String" } }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintentcustomizedsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentcustomizedsetting.md | Here is a JSON representation of the resource. "defaultJson": "String", "customizedJson": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintentdevicesettingstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentdevicesettingstatesummary.md | Here is a JSON representation of the resource. "notApplicableCount": 1024, "remediatedCount": 1024 }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintentdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentdevicestate.md | Here is a JSON representation of the resource. "state": "String", "deviceId": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintentdevicestatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentdevicestatesummary.md | Here is a JSON representation of the resource. "notApplicablePlatformCount": 1024, "successCount": 1024 }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintentsettingcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentsettingcategory.md | Here is a JSON representation of the resource. "displayName": "String", "hasRequiredSetting": true }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintentsettingsecretconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentsettingsecretconstraint.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementIntentSettingSecretConstraint" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintentuserstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentuserstate.md | Here is a JSON representation of the resource. "lastReportedDateTime": "String (timestamp)", "state": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementintentuserstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentuserstatesummary.md | Here is a JSON representation of the resource. "notApplicableCount": 1024, "successCount": 1024 }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingabstractimplementationconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingabstractimplementationconstraint.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingappconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingappconstraint.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingbooleanconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingbooleanconstraint.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementSettingBooleanConstraint", "value": true }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingcategory.md | Here is a JSON representation of the resource. "displayName": "String", "hasRequiredSetting": true }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingcollectionconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingcollectionconstraint.md | Here is a JSON representation of the resource. "minimumLength": 1024, "maximumLength": 1024 }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingcomparison | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingcomparison.md | Here is a JSON representation of the resource. "newValueJson": "String", "comparisonResult": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingdefinition.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingdependency | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingdependency.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingenrollmenttypeconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingenrollmenttypeconstraint.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingfileconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingfileconstraint.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettinginstance.md | Here is a JSON representation of the resource. "definitionId": "String", "valueJson": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingintegerconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingintegerconstraint.md | Here is a JSON representation of the resource. "minimumValue": 1024, "maximumValue": 1024 }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingprofileconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingprofileconstraint.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingregexconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingregexconstraint.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementSettingRegexConstraint", "regex": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingrequiredconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingrequiredconstraint.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementSettingRequiredConstraint", "notConfiguredValue": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingsddlconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingsddlconstraint.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementSettingSddlConstraint" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingstringlengthconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingstringlengthconstraint.md | Here is a JSON representation of the resource. "minimumLength": 1024, "maximumLength": 1024 }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementsettingxmlconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingxmlconstraint.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementSettingXmlConstraint" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementstringsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementstringsettinginstance.md | Here is a JSON representation of the resource. "valueJson": "String", "value": "String" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementtemplate.md | Here is a JSON representation of the resource. "templateSubtype": "String", "publishedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementtemplatesettingcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementtemplatesettingcategory.md | Here is a JSON representation of the resource. "displayName": "String", "hasRequiredSetting": true }-``` +``` |
v1.0 | Intune Deviceintent Devicemanagementtemplatesubtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementtemplatesubtype.md | Template subtype |antivirus|6|Endpoint security anitivirus subtype| |firewallSharedAppList|7|Endpoint security firewall shared app subtype| |firewallSharedIpList|8|Endpoint security firewall shared ip range list subtype|-|firewallSharedPortlist|9|Endpoint security firewall shared port range list subtype| +|firewallSharedPortlist|9|Endpoint security firewall shared port range list subtype| |
v1.0 | Intune Deviceintent Devicemanagementtemplatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementtemplatetype.md | Template type |deviceCompliance|8|Device compliance template| |deviceConfigurationForOffice365|9|Device Configuration for Microsoft Office 365 settings| |cloudPC|10|Windows 365 security baseline template|-|firewallSharedSettings|11|Firewall Shared Object templates for reference settings| +|firewallSharedSettings|11|Firewall Shared Object templates for reference settings| |
v1.0 | Intune Deviceintent Devicemanangementintentvaluetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanangementintentvaluetype.md | Namespace: microsoft.graph |string|2|The setting value is a string| |complex|3|The setting value is a complex object| |collection|4|The setting value is a collection|-|abstractComplex|5|The setting value is an abstract complex object| +|abstractComplex|5|The setting value is an abstract complex object| |
v1.0 | Intune Deviceintent Policyplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-policyplatformtype.md | Supported platform types for policies. |windows10AndLater|6|Windows 10 and later.| |androidWorkProfile|7|AndroidWorkProfile.| |windows10XProfile|8|Windows10XProfile.|-|all|100|All platforms.| +|all|100|All platforms.| |
v1.0 | Intune Deviceintent Securitybaselinecategorystatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinecategorystatesummary.md | Here is a JSON representation of the resource. "notApplicableCount": 1024, "displayName": "String" }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinecompliancestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinecompliancestate.md | Security Baseline Compliance State |notApplicable|2|Not applicable state| |notSecure|3|Not secure state| |error|4|Error state|-|conflict|5|Conflict state| +|conflict|5|Conflict state| |
v1.0 | Intune Deviceintent Securitybaselinecontributingpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinecontributingpolicy.md | Here is a JSON representation of the resource. "displayName": "String", "sourceType": "String" }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinedevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinedevicestate.md | Here is a JSON representation of the resource. "state": "String", "lastReportedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinepolicysourcetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinepolicysourcetype.md | Authoring source of a policy |Member|Value|Description| |:|:|:| |deviceConfiguration|0||-|deviceIntent|1|| +|deviceIntent|1|| |
v1.0 | Intune Deviceintent Securitybaselinestatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinestatesummary.md | Here is a JSON representation of the resource. "conflictCount": 1024, "notApplicableCount": 1024 }-``` +``` |
v1.0 | Intune Deviceintent Securitybaselinetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinetemplate.md | Here is a JSON representation of the resource. "templateSubtype": "String", "publishedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Activatedeviceesimactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-activatedeviceesimactionresult.md | Here is a JSON representation of the resource. "lastUpdatedDateTime": "String (timestamp)", "carrierUrl": "String" }-``` +``` |
v1.0 | Intune Devices Adminconsent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-adminconsent.md | Here is a JSON representation of the resource. "shareAPNSData": "String", "shareUserExperienceAnalyticsData": "String" }-``` +``` |
v1.0 | Intune Devices Adminconsentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-adminconsentstate.md | Admin consent state. |:|:|:| |notConfigured|0|Admin did not configure the item| |granted|1|Admin granted item|-|notGranted|2|Admin deos not grant item| +|notGranted|2|Admin deos not grant item| |
v1.0 | Intune Devices Applepushnotificationcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-applepushnotificationcertificate.md | Here is a JSON representation of the resource. "certificateSerialNumber": "String", "certificate": "String" }-``` +``` |
v1.0 | Intune Devices Applogcollectiondownloaddetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-applogcollectiondownloaddetails.md | Here is a JSON representation of the resource. "decryptionKey": "String", "appLogDecryptionAlgorithm": "String" }-``` +``` |
v1.0 | Intune Devices Applogcollectionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-applogcollectionrequest.md | Here is a JSON representation of the resource. ], "completedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Applogdecryptionalgorithm | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-applogdecryptionalgorithm.md | Namespace: microsoft.graph |Member|Value|Description| |:|:|:| |aes256|0|decrypting using Aes256.|-|unknownFutureValue|1|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|1|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Apploguploadstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-apploguploadstate.md | AppLogUploadStatus |pending|0|Default. Indicates that request is waiting to be processed or under processing.| |completed|1|Indicates that request is completed with file uploaded to Azure blob for download.| |failed|2|Indicates that request is completed with file uploaded to Azure blob for download.|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Azureattestationsettingstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-azureattestationsettingstatus.md | A list of possible Azure Attestation states for a device. Azure Attestation sett |notApplicable|0|Indicates that the device is not a Windows 11 device.| |enabled|1|Indicates that the device has the Azure attestation setting enabled.| |disabled|2|Indicates that the device has the Azure attestation setting disabled.|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Bulkmanageddeviceactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-bulkmanageddeviceactionresult.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Chassistype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-chassistype.md | Chassis type. |phone|100|Phone.| |tablet|101|Mobile tablet.| |mobileOther|102|Other mobile.|-|mobileUnknown|103|Unknown mobile.| +|mobileUnknown|103|Unknown mobile.| |
v1.0 | Intune Devices Chromeosdeviceproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-chromeosdeviceproperty.md | Here is a JSON representation of the resource. "valueType": "String", "updatable": true }-``` +``` |
v1.0 | Intune Devices Cloudpcconnectivityissue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-cloudpcconnectivityissue.md | Here is a JSON representation of the resource. "errorDescription": "String", "recommendedAction": "String" }-``` +``` |
v1.0 | Intune Devices Comanageddevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-comanageddevicessummary.md | Here is a JSON representation of the resource. "officeAppsCount": 1024, "totalComanagedCount": 1024 }-``` +``` |
v1.0 | Intune Devices Comanagementeligibledevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-comanagementeligibledevice.md | Here is a JSON representation of the resource. "userName": "String", "status": "String" }-``` +``` |
v1.0 | Intune Devices Comanagementeligibledevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-comanagementeligibledevicessummary.md | Here is a JSON representation of the resource. "needsOsUpdateCount": 1024, "ineligibleCount": 1024 }-``` +``` |
v1.0 | Intune Devices Comanagementeligibletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-comanagementeligibletype.md | Namespace: microsoft.graph |needsOsUpdate|4|| |ineligible|5|| |scheduledForEnrollment|6|Devices scheduled for Co-Management enrollment|-|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Compliancestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-compliancestate.md | Compliance state. |conflict|3|Conflict with other rules.| |error|4|Error.| |inGracePeriod|254|Device is non-compliant but still has access to corporate resources|-|configManager|255|Managed by Config Manager| +|configManager|255|Managed by Config Manager| |
v1.0 | Intune Devices Configurationmanageraction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanageraction.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.configurationManagerAction", "action": "String" }-``` +``` |
v1.0 | Intune Devices Configurationmanageractiondeliverystatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanageractiondeliverystatus.md | Delivery state of Configuration Manager device action |pendingDelivery|1|Pending to deliver the action to ConfigurationManager| |deliveredToConnectorService|2|Action is sent to ConfigurationManager Connector service (cloud)| |failedToDeliverToConnectorService|3|Failed to send the action to ConfigurationManager Connector service (cloud)|-|deliveredToOnPremisesServer|4|Action is delivered to ConfigurationManager on-prem server| +|deliveredToOnPremisesServer|4|Action is delivered to ConfigurationManager on-prem server| |
v1.0 | Intune Devices Configurationmanageractionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanageractionresult.md | Here is a JSON representation of the resource. "actionDeliveryStatus": "String", "errorCode": 1024 }-``` +``` |
v1.0 | Intune Devices Configurationmanageractiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanageractiontype.md | Action type on Configuration Manager client |appEvaluation|3|Evaluation application policy on Configuration Manager client| |quickScan|5|Evaluation application policy on Configuration Manager client| |fullScan|6|Evaluation application policy on Configuration Manager client|-|windowsDefenderUpdateSignatures|7|Evaluation application policy on Configuration Manager client| +|windowsDefenderUpdateSignatures|7|Evaluation application policy on Configuration Manager client| |
v1.0 | Intune Devices Configurationmanagerclientenabledfeatures | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanagerclientenabledfeatures.md | Here is a JSON representation of the resource. "endpointProtection": true, "officeApps": true }-``` +``` |
v1.0 | Intune Devices Configurationmanagerclienthealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanagerclienthealthstate.md | Here is a JSON representation of the resource. "errorCode": 1024, "lastSyncDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Configurationmanagerclientinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanagerclientinformation.md | Here is a JSON representation of the resource. "isBlocked": true, "clientVersion": "String" }-``` +``` |
v1.0 | Intune Devices Configurationmanagerclientstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanagerclientstate.md | Configuration manager client state |healthy|7|This device was able to check in with the configuration manager service successfully.| |installFailed|8|The configuration manager agent failed to install.| |updateFailed|11|The update from version x to version y of the configuration manager agent failed. |-|communicationError|19|The configuration manager agent was able to reach the configuration manager service in the past but is now no longer able to. | +|communicationError|19|The configuration manager agent was able to reach the configuration manager service in the past but is now no longer able to. | |
v1.0 | Intune Devices Dataprocessorserviceforwindowsfeaturesonboarding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-dataprocessorserviceforwindowsfeaturesonboarding.md | Here is a JSON representation of the resource. "hasValidWindowsLicense": true, "areDataProcessorServiceForWindowsFeaturesEnabled": true }-``` +``` |
v1.0 | Intune Devices Datasharingconsent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-datasharingconsent.md | Here is a JSON representation of the resource. "grantedByUpn": "String", "grantedByUserId": "String" }-``` +``` |
v1.0 | Intune Devices Deleteuserfromsharedappledeviceactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deleteuserfromsharedappledeviceactionresult.md | Here is a JSON representation of the resource. "lastUpdatedDateTime": "String (timestamp)", "userPrincipalName": "String" }-``` +``` |
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 | Indicates the operating system / platform of the discovered application. Some p |androidDeviceAdministrator|8|Indicates that the platform of the detected application is Android device administrator.| |androidWorkProfile|9|Indicates that the platform of the detected application is Android work profile.| |androidDedicatedAndFullyManaged|10|Indicates that the platform of the detected application is Android dedicated and fully managed.|-|unknownFutureValue|11|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|11|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Deviceactionpayload | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceactionpayload.md | Here is a JSON representation of the resource. "errorCode": 1024, "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Deviceactionpayloadintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceactionpayloadintent.md | A list of possible intent values on the policy or app when executing this action |:|:|:| |remove|0|Default. Indicates that the deployed policy or app is intended to be removed on the managed device| |restore|1|Indicates that the policy or app already intended to remove through previous actions and is now intended to be restored on the managed device|-|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use| +|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use| |
v1.0 | Intune Devices Deviceactionpayloadstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceactionpayloadstatus.md | A list of possible status values for the policy or app regarding their executed |removed|1|Indicates that the policy or app has been successfully removed on the managed device| |error|2|Indicates that the policy or app has failed to be removed or restored on the managed device. The error may be retriable depending on the detail and error code| |succeeded|3|Indicates that the policy or app has been successfully restored on the managed device|-|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use| |
v1.0 | Intune Devices Deviceactionpayloadtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceactionpayloadtype.md | A list of possible payload types to execute this action on the managed device. P |application|0|Default. Indicates that the payload type for the action is graph.mobileApp. Application is uninstalled on removal and installed back on restoration| |deviceConfiguration|1|Indicates that the payload type for the action is graph.deviceConfiguration. DeviceConfiguration corresponding settings are removed on removal and added back on restoration| |deviceManagementConfigurationPolicy|2|Indicates that the payload type for the action is graph.deviceManagementConfigurationPolicy. DeviceManagementConfigurationPolicy corresponding settings are removed on removal and added back on restoration|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use| |
v1.0 | Intune Devices Deviceactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceactionresult.md | Here is a JSON representation of the resource. "startDateTime": "String (timestamp)", "lastUpdatedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceappmanagement.md | Singleton entity that acts as a container for all device app management function ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceAppManagement](../api/intune-devices-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-devices-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-devices-deviceappmanagement.md) object.| -|[Update deviceAppManagement](../api/intune-devices-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-devices-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-devices-deviceappmanagement.md) object.| +|[Get deviceAppManagement](../api/intune-devices-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| +|[Update deviceAppManagement](../api/intune-devices-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceAppManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Devices Devicecategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecategory.md | Namespace: microsoft.graph ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceCategory](../api/intune-devices-devicecategory-get.md)|[deviceCategory](../resources/intune-devices-devicecategory.md)|Read properties and relationships of the [deviceCategory](../resources/intune-devices-devicecategory.md) object.| -|[Update deviceCategory](../api/intune-devices-devicecategory-update.md)|[deviceCategory](../resources/intune-devices-devicecategory.md)|Update the properties of a [deviceCategory](../resources/intune-devices-devicecategory.md) object.| +|[Get deviceCategory](../api/intune-devices-devicecategory-get.md)|[deviceCategory](../resources/intune-shared-devicecategory.md)|Read properties and relationships of the [deviceCategory](../resources/intune-shared-devicecategory.md) object.| +|[Update deviceCategory](../api/intune-devices-devicecategory-update.md)|[deviceCategory](../resources/intune-shared-devicecategory.md)|Update the properties of a [deviceCategory](../resources/intune-shared-devicecategory.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceCategory", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Devices Devicecleanupruleplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecleanupruleplatformtype.md | Define the platform type for which the admin wants to create the device clean up |macOS|7|Indicates that clean up rule is associated with MacOS managed device platforms.| |windows|8|Indicates that clean up rule is associated with Windows managed device platforms.| |windowsHolographic|9|Indicates that clean up rule is associated with Windows Holographic managed device platforms.|-|unknownFutureValue|10|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|10|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Devicecompliancescript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecompliancescript.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Devicecompliancescriptdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecompliancescriptdevicestate.md | 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 | Here is a JSON representation of the resource. "detectionScriptPendingDeviceCount": 1024, "lastScriptRunDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Devicecustomattributeshellscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecustomattributeshellscript.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Devicecustomattributevaluetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecustomattributevaluetype.md | Represents the expected type for a macOS custom attribute script value. |:|:|:| |integer|0|Indicates the value for a custom attribute script is an integer.| |string|1|Indicates the value for a custom attribute script is a string.|-|dateTime|2|Indicates the value for a custom attribute script is a date conforming to ISO 8601.| +|dateTime|2|Indicates the value for a custom attribute script is a date conforming to ISO 8601.| |
v1.0 | Intune Devices Deviceenrollmenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceenrollmenttype.md | Possible ways of adding a mobile device to management. |androidEnterpriseDedicatedDevice|15|Android Enterprise Dedicated Device| |androidEnterpriseFullyManaged|16|Android Enterprise Fully Managed| |androidEnterpriseCorporateWorkProfile|17|Android Enterprise Corporate Work Profile|+|androidAOSPUserOwnedDeviceEnrollment|18|Indicates the device enrollment is for android device owned by/associated with user using Android Open Source Project (AOSP) on a non-Google mobile services.| +|androidAOSPUserlessDeviceEnrollment|19|Indicates the device enrollment is for user less android device using Android Open Source Project (AOSP) on a non-Google mobile services.| |appleACMEBasicBYOD|20|Apple ACME BYOD enrollment| |appleACMEDEPUserless|21|Apple ACME DEP Userless enrollment| |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)| +|appleACMEDEPUDAModernAuth|24|Apple ACME DEP UDA enrollment at Setup Asst (Modern Auth)| |
v1.0 | Intune Devices Deviceeventlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceeventlevel.md | Indicates device event level. Possible values are: None, Verbose, Information, W |warning|3|Indicates that the device event level is warning.| |error|4|Indicates that the device event level is error.| |critical|5|Indicates that the device event level is critical.|-|unknownFutureValue|6|Placeholder value for future expansion.| +|unknownFutureValue|6|Placeholder value for future expansion.| |
v1.0 | Intune Devices Deviceexchangeaccessstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceexchangeaccessstatesummary.md | Here is a JSON representation of the resource. "unknownDeviceCount": 1024, "unavailableDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Devices Devicegeolocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicegeolocation.md | Here is a JSON representation of the resource. "heading": "4.2", "speed": "4.2" }-``` +``` |
v1.0 | Intune Devices Deviceguardlocalsystemauthoritycredentialguardstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceguardlocalsystemauthoritycredentialguardstate.md | Namespace: microsoft.graph |rebootRequired|1|Reboot required| |notLicensed|2|Not licensed for Credential Guard| |notConfigured|3|Not configured|-|virtualizationBasedSecurityNotRunning|4|Virtualization Based security is not running| +|virtualizationBasedSecurityNotRunning|4|Virtualization Based security is not running| |
v1.0 | Intune Devices Deviceguardvirtualizationbasedsecurityhardwarerequirementstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceguardvirtualizationbasedsecurityhardwarerequirementstate.md | Namespace: microsoft.graph |secureBootRequired|1|Secure boot required| |dmaProtectionRequired|2|DMA protection required| |hyperVNotSupportedForGuestVM|4|HyperV not supported for Guest VM|-|hyperVNotAvailable|8|HyperV feature is not available| +|hyperVNotAvailable|8|HyperV feature is not available| |
v1.0 | Intune Devices Deviceguardvirtualizationbasedsecuritystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceguardvirtualizationbasedsecuritystate.md | Namespace: microsoft.graph |notLicensed|3|Not licensed| |notConfigured|4|Not configured| |doesNotMeetHardwareRequirements|5|System does not meet hardware requirements|-|other|42|Other. Event logs in microsoft-Windows-DeviceGuard have more details.| +|other|42|Other. Event logs in microsoft-Windows-DeviceGuard have more details.| |
v1.0 | Intune Devices Devicehealthattestationstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthattestationstate.md | Here is a JSON representation of the resource. "systemManagementMode": "String", "securedCorePC": "String" }-``` +``` |
v1.0 | Intune Devices Devicehealthscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscript.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptassignment.md | Here is a JSON representation of the resource. "time": "String (time of day)" } }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptbooleanparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptbooleanparameter.md | Here is a JSON representation of the resource. "applyDefaultValueWhenNotAssigned": true, "defaultValue": true }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptdailyschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptdailyschedule.md | Here is a JSON representation of the resource. "useUtc": true, "time": "String (time of day)" }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptdevicestate.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Devicehealthscripthourlyschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscripthourlyschedule.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceHealthScriptHourlySchedule", "interval": 1024 }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptintegerparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptintegerparameter.md | Here is a JSON representation of the resource. "applyDefaultValueWhenNotAssigned": true, "defaultValue": 1024 }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptparameter.md | Here is a JSON representation of the resource. "isRequired": true, "applyDefaultValueWhenNotAssigned": true }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptpolicystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptpolicystate.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptremediationhistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptremediationhistory.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptremediationhistorydata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptremediationhistorydata.md | Here is a JSON representation of the resource. "noIssueDeviceCount": 1024, "detectFailedDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptremediationsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptremediationsummary.md | Here is a JSON representation of the resource. "scriptCount": 1024, "remediatedDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptrunonceschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptrunonceschedule.md | Here is a JSON representation of the resource. "time": "String (time of day)", "date": "String (Date)" }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptrunschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptrunschedule.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceHealthScriptRunSchedule", "interval": 1024 }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptrunsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptrunsummary.md | Here is a JSON representation of the resource. "lastScriptRunDateTime": "String (timestamp)", "issueRemediatedCumulativeDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Devices Devicehealthscriptstringparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptstringparameter.md | Here is a JSON representation of the resource. "applyDefaultValueWhenNotAssigned": true, "defaultValue": "String" }-``` +``` |
v1.0 | Intune Devices Devicehealthscripttimeschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscripttimeschedule.md | Here is a JSON representation of the resource. "useUtc": true, "time": "String (time of day)" }-``` +``` |
v1.0 | Intune Devices Devicehealthscripttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscripttype.md | Indicates the type of device script. |Member|Value|Description| |:|:|:| |deviceHealthScript|0|Indicates this is a device health script.|-|managedInstallerScript|1|Indicates this is a managed installer script.| +|managedInstallerScript|1|Indicates this is a managed installer script.| |
v1.0 | Intune Devices Deviceidentityattestationdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceidentityattestationdetail.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceIdentityAttestationDetail", "deviceIdentityAttestationStatus": "String" }-``` +``` |
v1.0 | Intune Devices Deviceidentityattestationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceidentityattestationstatus.md | Indicates the state of the anomaly. Eg: anomaly severity can be new, active, dis |unTrusted|2|Indicates that the Device attestation is supported on the device, it was attempted on the device and the attestation has failed. The device is untrusted| |notSupported|3|Indicates that the device does not support Attestation. This could be because of missing hardware or software support.| |incompleteData|4|Indicates that the device did not provide with the data that were required to perform attestation.|-|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Devicelicensingstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicelicensingstatus.md | Indicates the device licensing status after Windows device based subscription ha |deviceLicenseRemoveSucceed|12|This status is set when the device license removing succeeds.| |deviceLicenseRemoveFailed|13|This status is set when the device license removing fails.| |unknownFutureValue|14|This is put here as a place holder for future extension.|-|unknown|-1|Default. Set to unknown when status cannot be determined.| +|unknown|-1|Default. Set to unknown when status cannot be determined.| |
v1.0 | Intune Devices Devicelogcollectionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicelogcollectionrequest.md | Here is a JSON representation of the resource. "id": "String (identifier)", "templateType": "String" }-``` +``` |
v1.0 | Intune Devices Devicelogcollectionresponse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicelogcollectionresponse.md | Windows Log Collection request entity. |[Delete deviceLogCollectionResponse](../api/intune-devices-devicelogcollectionresponse-delete.md)|None|Deletes a [deviceLogCollectionResponse](../resources/intune-devices-devicelogcollectionresponse.md).| |[Update deviceLogCollectionResponse](../api/intune-devices-devicelogcollectionresponse-update.md)|[deviceLogCollectionResponse](../resources/intune-devices-devicelogcollectionresponse.md)|Update the properties of a [deviceLogCollectionResponse](../resources/intune-devices-devicelogcollectionresponse.md) object.| |[createDownloadUrl action](../api/intune-devices-devicelogcollectionresponse-createdownloadurl.md)|String||+|[downloadDeviceLogs action](../api/intune-devices-devicelogcollectionresponse-downloaddevicelogs.md)|String|| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "sizeInKB": "4.2", "enrolledByUser": "String" }-``` +``` |
v1.0 | Intune Devices Devicelogcollectionresponsev2 | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicelogcollectionresponsev2.md | Here is a JSON representation of the resource. "sizeInKB": "4.2", "enrolledByUserPrincipalName": "String" }-``` +``` |
v1.0 | Intune Devices Devicelogcollectiontemplatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicelogcollectiontemplatetype.md | Enum for the template type used for collecting logs |Member|Value|Description| |:|:|:| |predefined|0|Predefined template for what will be collected|-|unknownFutureValue|1|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|1|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagement.md | + + Title: "deviceManagement resource type" +description: "Singleton entity that acts as a container for all device management functionality." ++localization_priority: Normal ++++# 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-devices-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-devices-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[sendCustomNotificationToCompanyPortal action](../api/intune-devices-devicemanagement-sendcustomnotificationtocompanyportal.md)|None|| +|[userExperienceAnalyticsSummarizeWorkFromAnywhereDevices function](../api/intune-devices-devicemanagement-userexperienceanalyticssummarizeworkfromanywheredevices.md)|[userExperienceAnalyticsWorkFromAnywhereDevicesSummary](../resources/intune-devices-userexperienceanalyticsworkfromanywheredevicessummary.md)|| +|[userExperienceAnalyticsSummarizedDeviceScopes function](../api/intune-devices-devicemanagement-userexperienceanalyticssummarizeddevicescopes.md)|[userExperienceAnalyticsDeviceScopeSummary](../resources/intune-devices-userexperienceanalyticsdevicescopesummary.md)|| +|[getComanagedDevicesSummary function](../api/intune-devices-devicemanagement-getcomanageddevicessummary.md)|[comanagedDevicesSummary](../resources/intune-devices-comanageddevicessummary.md)|| +|[getComanagementEligibleDevicesSummary function](../api/intune-devices-devicemanagement-getcomanagementeligibledevicessummary.md)|[comanagementEligibleDevicesSummary](../resources/intune-devices-comanagementeligibledevicessummary.md)|| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|Unique Identifier for the device| +|subscriptionState|[deviceManagementSubscriptionState](../resources/intune-devices-devicemanagementsubscriptionstate.md)|Tenant mobile device management subscription state. Possible values are: `pending`, `active`, `warning`, `disabled`, `deleted`, `blocked`, `lockedOut`.| +|subscriptions|[deviceManagementSubscriptions](../resources/intune-devices-devicemanagementsubscriptions.md)|Tenant's Subscription. Possible values are: `none`, `intune`, `office365`, `intunePremium`, `intune_EDU`, `intune_SMB`.| +|managedDeviceCleanupSettings|[managedDeviceCleanupSettings](../resources/intune-devices-manageddevicecleanupsettings.md)|Device cleanup rule| +|adminConsent|[adminConsent](../resources/intune-devices-adminconsent.md)|Admin consent information.| +|deviceProtectionOverview|[deviceProtectionOverview](../resources/intune-devices-deviceprotectionoverview.md)|Device protection overview.| +|windowsMalwareOverview|[windowsMalwareOverview](../resources/intune-devices-windowsmalwareoverview.md)|Malware overview for windows devices.| +|accountMoveCompletionDateTime|DateTimeOffset|The date & time when tenant data moved between scaleunits.| +|userExperienceAnalyticsSettings|[userExperienceAnalyticsSettings](../resources/intune-devices-userexperienceanalyticssettings.md)|User experience analytics device settings| +|dataProcessorServiceForWindowsFeaturesOnboarding|[dataProcessorServiceForWindowsFeaturesOnboarding](../resources/intune-devices-dataprocessorserviceforwindowsfeaturesonboarding.md)|A configuration entity for MEM features that utilize Data Processor Service for Windows (DPSW) data.| +|userExperienceAnalyticsAnomalySeverityOverview|[userExperienceAnalyticsAnomalySeverityOverview](../resources/intune-devices-userexperienceanalyticsanomalyseverityoverview.md)|The user experience analytics anomaly severity overview entity contains the count information for each severity of anomaly.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|remoteActionAudits|[remoteActionAudit](../resources/intune-devices-remoteactionaudit.md) collection|The list of device remote action audits with the tenant.| +|applePushNotificationCertificate|[applePushNotificationCertificate](../resources/intune-devices-applepushnotificationcertificate.md)|Apple push notification certificate.| +|deviceManagementScripts|[deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) collection|The list of device management scripts associated with the tenant.| +|deviceShellScripts|[deviceShellScript](../resources/intune-devices-deviceshellscript.md) collection|The list of device shell scripts associated with the tenant.| +|deviceCustomAttributeShellScripts|[deviceCustomAttributeShellScript](../resources/intune-devices-devicecustomattributeshellscript.md) collection|The list of device custom attribute shell scripts associated with the tenant.| +|deviceHealthScripts|[deviceHealthScript](../resources/intune-devices-devicehealthscript.md) collection|The list of device health scripts associated with the tenant.| +|deviceComplianceScripts|[deviceComplianceScript](../resources/intune-devices-devicecompliancescript.md) collection|The list of device compliance scripts associated with the tenant.| +|managedDeviceOverview|[managedDeviceOverview](../resources/intune-devices-manageddeviceoverview.md)|Device overview| +|managedDeviceCleanupRules|[managedDeviceCleanupRule](../resources/intune-devices-manageddevicecleanuprule.md) collection|Device cleanup rule V2| +|detectedApps|[detectedApp](../resources/intune-devices-detectedapp.md) collection|The list of detected apps associated with a device.| +|managedDevices|[managedDevice](../resources/intune-devices-manageddevice.md) collection|The list of managed devices.| +|windowsMalwareInformation|[windowsMalwareInformation](../resources/intune-devices-windowsmalwareinformation.md) collection|The list of affected malware in the tenant.| +|dataSharingConsents|[dataSharingConsent](../resources/intune-devices-datasharingconsent.md) collection|Data sharing consents.| +|mobileAppTroubleshootingEvents|[mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) collection|The collection property of MobileAppTroubleshootingEvent.| +|userExperienceAnalyticsOverview|[userExperienceAnalyticsOverview](../resources/intune-devices-userexperienceanalyticsoverview.md)|User experience analytics overview| +|userExperienceAnalyticsBaselines|[userExperienceAnalyticsBaseline](../resources/intune-devices-userexperienceanalyticsbaseline.md) collection|User experience analytics baselines| +|userExperienceAnalyticsCategories|[userExperienceAnalyticsCategory](../resources/intune-devices-userexperienceanalyticscategory.md) collection|User experience analytics categories| +|userExperienceAnalyticsDevicePerformance|[userExperienceAnalyticsDevicePerformance](../resources/intune-devices-userexperienceanalyticsdeviceperformance.md) collection|User experience analytics device performance| +|userExperienceAnalyticsDeviceStartupHistory|[userExperienceAnalyticsDeviceStartupHistory](../resources/intune-devices-userexperienceanalyticsdevicestartuphistory.md) collection|User experience analytics device Startup History| +|userExperienceAnalyticsDeviceStartupProcesses|[userExperienceAnalyticsDeviceStartupProcess](../resources/intune-devices-userexperienceanalyticsdevicestartupprocess.md) collection|User experience analytics device Startup Processes| +|userExperienceAnalyticsDeviceStartupProcessPerformance|[userExperienceAnalyticsDeviceStartupProcessPerformance](../resources/intune-devices-userexperienceanalyticsdevicestartupprocessperformance.md) collection|User experience analytics device Startup Process Performance| +|userExperienceAnalyticsScoreHistory|[userExperienceAnalyticsScoreHistory](../resources/intune-devices-userexperienceanalyticsscorehistory.md) collection|User experience analytics device Startup Score History| +|userExperienceAnalyticsMetricHistory|[userExperienceAnalyticsMetricHistory](../resources/intune-devices-userexperienceanalyticsmetrichistory.md) collection|User experience analytics metric history| +|userExperienceAnalyticsDeviceMetricHistory|[userExperienceAnalyticsMetricHistory](../resources/intune-devices-userexperienceanalyticsmetrichistory.md) collection|User experience analytics device metric history| +|userExperienceAnalyticsAppHealthApplicationPerformance|[userExperienceAnalyticsAppHealthApplicationPerformance](../resources/intune-devices-userexperienceanalyticsapphealthapplicationperformance.md) collection|User experience analytics appHealth Application Performance| +|userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion|[userExperienceAnalyticsAppHealthAppPerformanceByAppVersion](../resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversion.md) collection|User experience analytics appHealth Application Performance by App Version| +|userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails|[userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails](../resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondetails.md) collection|User experience analytics appHealth Application Performance by App Version details| +|userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDeviceId|[userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId](../resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondeviceid.md) collection|User experience analytics appHealth Application Performance by App Version Device Id| +|userExperienceAnalyticsAppHealthApplicationPerformanceByOSVersion|[userExperienceAnalyticsAppHealthAppPerformanceByOSVersion](../resources/intune-devices-userexperienceanalyticsapphealthappperformancebyosversion.md) collection|User experience analytics appHealth Application Performance by OS Version| +|userExperienceAnalyticsAppHealthDevicePerformance|[userExperienceAnalyticsAppHealthDevicePerformance](../resources/intune-devices-userexperienceanalyticsapphealthdeviceperformance.md) collection|User experience analytics appHealth Device Performance| +|userExperienceAnalyticsAppHealthDeviceModelPerformance|[userExperienceAnalyticsAppHealthDeviceModelPerformance](../resources/intune-devices-userexperienceanalyticsapphealthdevicemodelperformance.md) collection|User experience analytics appHealth Model Performance| +|userExperienceAnalyticsAppHealthOSVersionPerformance|[userExperienceAnalyticsAppHealthOSVersionPerformance](../resources/intune-devices-userexperienceanalyticsapphealthosversionperformance.md) collection|User experience analytics appHealth OS version Performance| +|userExperienceAnalyticsAppHealthOverview|[userExperienceAnalyticsCategory](../resources/intune-devices-userexperienceanalyticscategory.md)|User experience analytics appHealth overview| +|userExperienceAnalyticsAppHealthDevicePerformanceDetails|[userExperienceAnalyticsAppHealthDevicePerformanceDetails](../resources/intune-devices-userexperienceanalyticsapphealthdeviceperformancedetails.md) collection|User experience analytics device performance details| +|userExperienceAnalyticsDevicesWithoutCloudIdentity|[userExperienceAnalyticsDeviceWithoutCloudIdentity](../resources/intune-devices-userexperienceanalyticsdevicewithoutcloudidentity.md) collection|User experience analytics devices without cloud identity.| +|userExperienceAnalyticsNotAutopilotReadyDevice|[userExperienceAnalyticsNotAutopilotReadyDevice](../resources/intune-devices-userexperienceanalyticsnotautopilotreadydevice.md) collection|User experience analytics devices not Windows Autopilot ready.| +|userExperienceAnalyticsWorkFromAnywhereMetrics|[userExperienceAnalyticsWorkFromAnywhereMetric](../resources/intune-devices-userexperienceanalyticsworkfromanywheremetric.md) collection|User experience analytics work from anywhere metrics.| +|userExperienceAnalyticsWorkFromAnywhereHardwareReadinessMetric|[userExperienceAnalyticsWorkFromAnywhereHardwareReadinessMetric](../resources/intune-devices-userexperienceanalyticsworkfromanywherehardwarereadinessmetric.md)|User experience analytics work from anywhere hardware readiness metrics.| +|userExperienceAnalyticsWorkFromAnywhereModelPerformance|[userExperienceAnalyticsWorkFromAnywhereModelPerformance](../resources/intune-devices-userexperienceanalyticsworkfromanywheremodelperformance.md) collection|The user experience analytics work from anywhere model performance| +|comanagedDevices|[managedDevice](../resources/intune-devices-manageddevice.md) collection|The list of co-managed devices report| +|comanagementEligibleDevices|[comanagementEligibleDevice](../resources/intune-devices-comanagementeligibledevice.md) collection|The list of co-management eligible devices report| +|userExperienceAnalyticsResourcePerformance|[userExperienceAnalyticsResourcePerformance](../resources/intune-devices-userexperienceanalyticsresourceperformance.md) collection|User experience analytics resource performance| +|userExperienceAnalyticsRemoteConnection|[userExperienceAnalyticsRemoteConnection](../resources/intune-devices-userexperienceanalyticsremoteconnection.md) collection|User experience analytics remote connection| +|userExperienceAnalyticsImpactingProcess|[userExperienceAnalyticsImpactingProcess](../resources/intune-devices-userexperienceanalyticsimpactingprocess.md) collection|User experience analytics impacting process| +|userExperienceAnalyticsDeviceScores|[userExperienceAnalyticsDeviceScores](../resources/intune-devices-userexperienceanalyticsdevicescores.md) collection|User experience analytics device scores| +|userExperienceAnalyticsModelScores|[userExperienceAnalyticsModelScores](../resources/intune-devices-userexperienceanalyticsmodelscores.md) collection|User experience analytics model scores| +|cloudPCConnectivityIssues|[cloudPCConnectivityIssue](../resources/intune-devices-cloudpcconnectivityissue.md) collection|The list of CloudPC Connectivity Issue.| +|userExperienceAnalyticsBatteryHealthDevicePerformance|[userExperienceAnalyticsBatteryHealthDevicePerformance](../resources/intune-devices-userexperienceanalyticsbatteryhealthdeviceperformance.md) collection|User Experience Analytics Battery Health Device Performance| +|userExperienceAnalyticsBatteryHealthModelPerformance|[userExperienceAnalyticsBatteryHealthModelPerformance](../resources/intune-devices-userexperienceanalyticsbatteryhealthmodelperformance.md) collection|User Experience Analytics Battery Health Model Performance| +|userExperienceAnalyticsBatteryHealthOsPerformance|[userExperienceAnalyticsBatteryHealthOsPerformance](../resources/intune-devices-userexperienceanalyticsbatteryhealthosperformance.md) collection|User Experience Analytics Battery Health Os Performance| +|userExperienceAnalyticsBatteryHealthAppImpact|[userExperienceAnalyticsBatteryHealthAppImpact](../resources/intune-devices-userexperienceanalyticsbatteryhealthappimpact.md) collection|User Experience Analytics Battery Health App Impact| +|userExperienceAnalyticsBatteryHealthCapacityDetails|[userExperienceAnalyticsBatteryHealthCapacityDetails](../resources/intune-devices-userexperienceanalyticsbatteryhealthcapacitydetails.md)|User Experience Analytics Battery Health Capacity Details| +|userExperienceAnalyticsBatteryHealthRuntimeDetails|[userExperienceAnalyticsBatteryHealthRuntimeDetails](../resources/intune-devices-userexperienceanalyticsbatteryhealthruntimedetails.md)|User Experience Analytics Battery Health Runtime Details| +|userExperienceAnalyticsBatteryHealthDeviceAppImpact|[userExperienceAnalyticsBatteryHealthDeviceAppImpact](../resources/intune-devices-userexperienceanalyticsbatteryhealthdeviceappimpact.md) collection|User Experience Analytics Battery Health Device App Impact| +|userExperienceAnalyticsBatteryHealthDeviceRuntimeHistory|[userExperienceAnalyticsBatteryHealthDeviceRuntimeHistory](../resources/intune-devices-userexperienceanalyticsbatteryhealthdeviceruntimehistory.md) collection|User Experience Analytics Battery Health Device Runtime History| +|userExperienceAnalyticsDeviceScopes|[userExperienceAnalyticsDeviceScope](../resources/intune-devices-userexperienceanalyticsdevicescope.md) collection|The user experience analytics device scope entity contains device scope configuration use to apply filtering on the endpoint analytics reports.| +|userExperienceAnalyticsDeviceScope|[userExperienceAnalyticsDeviceScope](../resources/intune-devices-userexperienceanalyticsdevicescope.md)|The user experience analytics device scope entity endpoint to trigger on the service to either START or STOP computing metrics data based on a device scope configuration.| +|tenantAttachRBAC|[tenantAttachRBAC](../resources/intune-devices-tenantattachrbac.md)|TenantAttach RBAC Enablement| +|userExperienceAnalyticsAnomaly|[userExperienceAnalyticsAnomaly](../resources/intune-devices-userexperienceanalyticsanomaly.md) collection|The user experience analytics anomaly entity contains anomaly details.| +|userExperienceAnalyticsAnomalyDevice|[userExperienceAnalyticsAnomalyDevice](../resources/intune-devices-userexperienceanalyticsanomalydevice.md) collection|The user experience analytics anomaly entity contains device details.| +|userExperienceAnalyticsAnomalyCorrelationGroupOverview|[userExperienceAnalyticsAnomalyCorrelationGroupOverview](../resources/intune-devices-userexperienceanalyticsanomalycorrelationgroupoverview.md) collection|The user experience analytics anomaly correlation group overview entity contains the information for each correlation group of an anomaly.| +|userExperienceAnalyticsDeviceTimelineEvent|[userExperienceAnalyticsDeviceTimelineEvent](../resources/intune-devices-userexperienceanalyticsdevicetimelineevent.md) collection|The user experience analytics device events entity contains NRT device timeline event details.| +## 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)", + "subscriptionState": "String", + "subscriptions": "String", + "managedDeviceCleanupSettings": { + "@odata.type": "microsoft.graph.managedDeviceCleanupSettings", + "deviceInactivityBeforeRetirementInDays": "String" + }, + "adminConsent": { + "@odata.type": "microsoft.graph.adminConsent", + "shareAPNSData": "String", + "shareUserExperienceAnalyticsData": "String" + }, + "deviceProtectionOverview": { + "@odata.type": "microsoft.graph.deviceProtectionOverview", + "totalReportedDeviceCount": 1024, + "inactiveThreatAgentDeviceCount": 1024, + "unknownStateThreatAgentDeviceCount": 1024, + "pendingSignatureUpdateDeviceCount": 1024, + "cleanDeviceCount": 1024, + "pendingFullScanDeviceCount": 1024, + "pendingRestartDeviceCount": 1024, + "pendingManualStepsDeviceCount": 1024, + "pendingOfflineScanDeviceCount": 1024, + "criticalFailuresDeviceCount": 1024, + "pendingQuickScanDeviceCount": 1024 + }, + "windowsMalwareOverview": { + "@odata.type": "microsoft.graph.windowsMalwareOverview", + "malwareDetectedDeviceCount": 1024, + "totalMalwareCount": 1024, + "totalDistinctMalwareCount": 1024, + "malwareStateSummary": [ + { + "@odata.type": "microsoft.graph.windowsMalwareStateCount", + "state": "String", + "deviceCount": 1024, + "malwareDetectionCount": 1024, + "distinctMalwareCount": 1024, + "lastUpdateDateTime": "String (timestamp)" + } + ], + "malwareSeveritySummary": [ + { + "@odata.type": "microsoft.graph.windowsMalwareSeverityCount", + "severity": "String", + "malwareDetectionCount": 1024, + "distinctMalwareCount": 1024, + "lastUpdateDateTime": "String (timestamp)" + } + ], + "malwareExecutionStateSummary": [ + { + "@odata.type": "microsoft.graph.windowsMalwareExecutionStateCount", + "executionState": "String", + "deviceCount": 1024, + "lastUpdateDateTime": "String (timestamp)" + } + ], + "malwareCategorySummary": [ + { + "@odata.type": "microsoft.graph.windowsMalwareCategoryCount", + "category": "String", + "deviceCount": 1024, + "activeMalwareDetectionCount": 1024, + "distinctActiveMalwareCount": 1024, + "lastUpdateDateTime": "String (timestamp)" + } + ], + "malwareNameSummary": [ + { + "@odata.type": "microsoft.graph.windowsMalwareNameCount", + "malwareIdentifier": "String", + "name": "String", + "deviceCount": 1024, + "lastUpdateDateTime": "String (timestamp)" + } + ], + "osVersionsSummary": [ + { + "@odata.type": "microsoft.graph.osVersionCount", + "osVersion": "String", + "deviceCount": 1024, + "lastUpdateDateTime": "String (timestamp)" + } + ] + }, + "accountMoveCompletionDateTime": "String (timestamp)", + "userExperienceAnalyticsSettings": { + "@odata.type": "microsoft.graph.userExperienceAnalyticsSettings", + "configurationManagerDataConnectorConfigured": true + }, + "dataProcessorServiceForWindowsFeaturesOnboarding": { + "@odata.type": "microsoft.graph.dataProcessorServiceForWindowsFeaturesOnboarding", + "hasValidWindowsLicense": true, + "areDataProcessorServiceForWindowsFeaturesEnabled": true + }, + "userExperienceAnalyticsAnomalySeverityOverview": { + "@odata.type": "microsoft.graph.userExperienceAnalyticsAnomalySeverityOverview", + "lowSeverityAnomalyCount": 1024, + "mediumSeverityAnomalyCount": 1024, + "highSeverityAnomalyCount": 1024, + "informationalSeverityAnomalyCount": 1024 + } +} +``` |
v1.0 | Intune Devices Devicemanagementexchangeaccessstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementexchangeaccessstate.md | Device Exchange Access State. |unknown|1|Device access state to Exchange is unknown| |allowed|2|Device has access to Exchange| |blocked|3|Device is Blocked in Exchange|-|quarantined|4|Device is Quarantined in Exchange| +|quarantined|4|Device is Quarantined in Exchange| |
v1.0 | Intune Devices Devicemanagementexchangeaccessstatereason | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementexchangeaccessstatereason.md | Device Exchange Access State Reason. |mfaRequired|13|Access state due to MFA challenge| |azureADBlockDueToAccessPolicy|14|Access State revoked by AAD Access Policy| |compromisedPassword|15|Access State revoked by compromised password|-|deviceNotKnownWithManagedApp|16|Access state revoked by managed application challenge| +|deviceNotKnownWithManagedApp|16|Access state revoked by managed application challenge| |
v1.0 | Intune Devices Devicemanagementscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementscript.md | Intune will provide customer the ability to run their Powershell scripts on the ## Methods |Method|Return Type|Description| |:|:|:|-|[List deviceManagementScripts](../api/intune-devices-devicemanagementscript-list.md)|[deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) collection|List properties and relationships of the [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) objects.| -|[Get deviceManagementScript](../api/intune-devices-devicemanagementscript-get.md)|[deviceManagementScript](../resources/intune-devices-devicemanagementscript.md)|Read properties and relationships of the [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) object.| -|[Create deviceManagementScript](../api/intune-devices-devicemanagementscript-create.md)|[deviceManagementScript](../resources/intune-devices-devicemanagementscript.md)|Create a new [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) object.| -|[Delete deviceManagementScript](../api/intune-devices-devicemanagementscript-delete.md)|None|Deletes a [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md).| -|[Update deviceManagementScript](../api/intune-devices-devicemanagementscript-update.md)|[deviceManagementScript](../resources/intune-devices-devicemanagementscript.md)|Update the properties of a [deviceManagementScript](../resources/intune-devices-devicemanagementscript.md) object.| +|[List deviceManagementScripts](../api/intune-devices-devicemanagementscript-list.md)|[deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) collection|List properties and relationships of the [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) objects.| +|[Get deviceManagementScript](../api/intune-devices-devicemanagementscript-get.md)|[deviceManagementScript](../resources/intune-shared-devicemanagementscript.md)|Read properties and relationships of the [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) object.| +|[Create deviceManagementScript](../api/intune-devices-devicemanagementscript-create.md)|[deviceManagementScript](../resources/intune-shared-devicemanagementscript.md)|Create a new [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) object.| +|[Delete deviceManagementScript](../api/intune-devices-devicemanagementscript-delete.md)|None|Deletes a [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md).| +|[Update deviceManagementScript](../api/intune-devices-devicemanagementscript-update.md)|[deviceManagementScript](../resources/intune-shared-devicemanagementscript.md)|Update the properties of a [deviceManagementScript](../resources/intune-shared-devicemanagementscript.md) object.| |[assign action](../api/intune-devices-devicemanagementscript-assign.md)|None|| ## Properties Intune will provide customer the ability to run their Powershell scripts on the |scriptContent|Binary|The script content.| |createdDateTime|DateTimeOffset|The date and time the device management script was created. This property is read-only.| |lastModifiedDateTime|DateTimeOffset|The date and time the device management script was last modified. This property is read-only.|-|runAsAccount|[runAsAccountType](../resources/intune-devices-runasaccounttype.md)|Indicates the type of execution context. Possible values are: `system`, `user`.| +|runAsAccount|[runAsAccountType](../resources/intune-shared-runasaccounttype.md)|Indicates the type of execution context. Possible values are: `system`, `user`.| |fileName|String|Script file name.| |roleScopeTagIds|String collection|List of Scope Tag IDs for this PowerShellScript instance.| Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Devicemanagementscriptassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementscriptassignment.md | Here is a JSON representation of the resource. "collectionId": "String" } }-``` +``` |
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 | Here is a JSON representation of the resource. "id": "String (identifier)", "targetGroupId": "String" }-``` +``` |
v1.0 | Intune Devices Devicemanagementscriptrunsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementscriptrunsummary.md | Here is a JSON representation of the resource. "successUserCount": 1024, "errorUserCount": 1024 }-``` +``` |
v1.0 | Intune Devices Devicemanagementscriptuserstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementscriptuserstate.md | Here is a JSON representation of the resource. "errorDeviceCount": 1024, "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Devices Devicemanagementsubscriptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementsubscriptions.md | Tenant mobile device management subscriptions. |office365|2|Office365 Subscription| |intunePremium|4|Microsoft Intune Premium Subscription| |intune_EDU|8|Microsoft Intune for Education Subscription|-|intune_SMB|16|Microsoft Intune for Small Businesses Subscription| +|intune_SMB|16|Microsoft Intune for Small Businesses Subscription| |
v1.0 | Intune Devices Devicemanagementsubscriptionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementsubscriptionstate.md | Tenant mobile device management subscription state. |disabled|3|Disabled| |deleted|4|Deleted| |blocked|5|Blocked|-|lockedOut|8|LockedOut| +|lockedOut|8|LockedOut| |
v1.0 | Intune Devices Deviceoperatingsystemsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceoperatingsystemsummary.md | Here is a JSON representation of the resource. "linuxCount": 1024, "chromeOSCount": 1024 }-``` +``` |
v1.0 | Intune Devices Deviceprotectionoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceprotectionoverview.md | Here is a JSON representation of the resource. "criticalFailuresDeviceCount": 1024, "pendingQuickScanDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Devices Devicequeryresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicequeryresult.md | - Title: "deviceQueryResult resource type" -description: "Results of Intune Pivot device queries ran for this device." --localization_priority: Normal --doc_type: resourcePageType ---# deviceQueryResult resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Results of Intune Pivot device queries ran for this device. --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List deviceQueryResults](../api/intune-devices-devicequeryresult-list.md)|[deviceQueryResult](../resources/intune-devices-devicequeryresult.md) collection|List properties and relationships of the [deviceQueryResult](../resources/intune-devices-devicequeryresult.md) objects.| -|[Get deviceQueryResult](../api/intune-devices-devicequeryresult-get.md)|[deviceQueryResult](../resources/intune-devices-devicequeryresult.md)|Read properties and relationships of the [deviceQueryResult](../resources/intune-devices-devicequeryresult.md) object.| -|[Create deviceQueryResult](../api/intune-devices-devicequeryresult-create.md)|[deviceQueryResult](../resources/intune-devices-devicequeryresult.md)|Create a new [deviceQueryResult](../resources/intune-devices-devicequeryresult.md) object.| -|[Delete deviceQueryResult](../api/intune-devices-devicequeryresult-delete.md)|None|Deletes a [deviceQueryResult](../resources/intune-devices-devicequeryresult.md).| -|[Update deviceQueryResult](../api/intune-devices-devicequeryresult-update.md)|[deviceQueryResult](../resources/intune-devices-devicequeryresult.md)|Update the properties of a [deviceQueryResult](../resources/intune-devices-devicequeryresult.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier (ID) of an Intune Pivot device query.| -|status|[deviceQueryResultStatus](../resources/intune-devices-devicequeryresultstatus.md)|Indicates present status of an Intune Pivot device query. This property is read-only. Possible values are: `created`, `notified`, `pending`, `timedOut`, `internalServiceError`, `successful`, `failed`, `unknownFutureValue`.| -|createdDateTime|DateTimeOffset|Indicates creation time of an Intune Pivot device query. This property is read-only.| -|lastModifiedDateTime|DateTimeOffset|Last update time of an Intune Pivot device query. This property is read-only.| -|returnCode|Int32|Returned error code captured by an Intune Pivot device query. Valid values -2147483648 to 2147483647. This property is read-only.| -|errorMessage|String|Returned error message captured by an Intune Pivot device query. This property is read-only.| -|results|String|Results of Intune Pivot device query. 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.deviceQueryResult" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceQueryResult", - "id": "String (identifier)", - "status": "String", - "createdDateTime": "String (timestamp)", - "lastModifiedDateTime": "String (timestamp)", - "returnCode": 1024, - "errorMessage": "String", - "results": "String" -} -``` |
v1.0 | Intune Devices Devicequeryresultstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicequeryresultstatus.md | - Title: "deviceQueryResultStatus enum type" -description: "Status of Intune Pivot device query." --localization_priority: Normal --doc_type: enumPageType ---# deviceQueryResultStatus enum type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 Intune Pivot device query. --## Members -|Member|Value|Description| -|:|:|:| -|created|0|Created| -|notified|1|Notified| -|pending|2|Pending| -|timedOut|3|TimedOut| -|internalServiceError|4|InternalServiceError| -|successful|5|Successful| -|failed|6|Failed| -|unknownFutureValue|7|UnknownFutureValue| |
v1.0 | Intune Devices Deviceregistrationstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceregistrationstate.md | Device registration status. |approvalPending|5|The device is pending approval.| |certificateReset|6|The device certificate has been reset.| |notRegisteredPendingEnrollment|7|The device is not registered and pending enrollment.|-|unknown|8|The device registration status is unknown.| +|unknown|8|The device registration status is unknown.| |
v1.0 | Intune Devices Devicescopeaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopeaction.md | Trigger on the service to either START or STOP computing metrics data based on a |Member|Value|Description| |:|:|:| |stop|0|Stop computing metrics data| -|start|1|Start computing metrics data| +|start|1|Start computing metrics data| |
v1.0 | Intune Devices Devicescopeactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopeactionresult.md | Here is a JSON representation of the resource. "status": "String", "failedMessage": "String" }-``` +``` |
v1.0 | Intune Devices Devicescopeactionstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopeactionstatus.md | Indicates the status of the attempted device scope action |:|:|:| |failed|0|Indicates the device scope action failed to trigger.| |succeeded|1|Indicates the device scope action was successfully triggered.|-|unknownFutureValue|2|Placeholder value for future expansion.| +|unknownFutureValue|2|Placeholder value for future expansion.| |
v1.0 | Intune Devices Devicescopeoperator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopeoperator.md | Device scope configuration query operator. Possible values are: equals, notEqual |:|:|:| |none|0|No operator set for the device scope configuration.| |equals|1|Operator for the device configuration query to be used (Equals).|-|unknownFutureValue|2|Placeholder value for future expansion enums such as notEquals, contains, notContains, greaterThan, lessThan.| +|unknownFutureValue|2|Placeholder value for future expansion enums such as notEquals, contains, notContains, greaterThan, lessThan.| |
v1.0 | Intune Devices Devicescopeparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopeparameter.md | Device scope configuration parameter. It will be expend in future to add more pa |:|:|:| |none|0|Device Scope parameter is not set| |scopeTag|1|use Scope Tag as parameter for the device scope configuration.|-|unknownFutureValue|2|Placeholder value for future expansion.| +|unknownFutureValue|2|Placeholder value for future expansion.| |
v1.0 | Intune Devices Devicescopestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopestatus.md | Indicates the device scope status after the device scope has been enabled. Possi |computing|1|Indicates the device scope is enabled and report metrics data are being recalculated by the service.| |insufficientData|2|Indicates the device scope is enabled but there is insufficient data to calculate results. The system requires information from at least 5 devices before calculations can occur.| |completed|3|Device scope is enabled and finished recalculating the report metric. Device scope is now ready to be used.|-|unknownFutureValue|4|Placeholder value for future expansion.| +|unknownFutureValue|4|Placeholder value for future expansion.| |
v1.0 | Intune Devices Deviceshellscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceshellscript.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Devicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicetype.md | Device type. |blackberry|100|Blackberry.| |palm|101|Palm.| |unknown|255|Represents that the device type is unknown.|-|cloudPC|257|Cloud PC device.| +|cloudPC|257|Cloud PC device.| |
v1.0 | Intune Devices Disktype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-disktype.md | Namespace: microsoft.graph |unknown|0|Enum member for unknown or default diskType.| |hdd|1|Enum member for HDD devices.| |ssd|2|Enum member for SSD devices.|-|unknownFutureValue|3|Evolvable enumeration sentinel value.Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value.Do not use.| |
v1.0 | Intune Devices Firmwareprotectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-firmwareprotectiontype.md | A list of possible Firmware protection type for a device. Firmware protection is |systemGuardSecureLaunch|1|Indicates that System Guard Secure Launch is enabled for Firmware protection.| |firmwareAttackSurfaceReduction|2|Indicates that Firmware Attack Surface Reduction is enabled for Firmware protection. This is only applicable to Surface devices.| |disabled|3|Indicates that the device has Firmware protection disabled.|-|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Globaldevicehealthscriptstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-globaldevicehealthscriptstate.md | Indicates whether global device health scripts are enabled and are in which stat |:|:|:| |notConfigured|0|Global device health scripts are not configured| |pending|1|Global device health scripts are configured but not fully enabled|-|enabled|2|Global device health scripts are enabled and ready to use| +|enabled|2|Global device health scripts are enabled and ready to use| |
v1.0 | Intune Devices Hardwareinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-hardwareinformation.md | Here is a JSON representation of the resource. "deviceLicensingLastErrorCode": 1024, "deviceLicensingLastErrorDescription": "String" }-``` +``` |
v1.0 | Intune Devices Healthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-healthstate.md | Indicates health state of the Windows management app. |:|:|:| |unknown|0|Unknown state.| |healthy|1|Healthy state.|-|unhealthy|2|Unhealthy state.| +|unhealthy|2|Unhealthy state.| |
v1.0 | Intune Devices Insightvaluedouble | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-insightvaluedouble.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.insightValueDouble", "value": "4.2" }-``` +``` |
v1.0 | Intune Devices Insightvalueint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-insightvalueint.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.insightValueInt", "value": 1024 }-``` +``` |
v1.0 | Intune Devices Jointype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-jointype.md | Device enrollment join type. |unknown|0|Unknown enrollment join type.| |azureADJoined|1|The device is joined by Azure AD.| |azureADRegistered|2|The device is registered by Azure AD.|-|hybridAzureADJoined|3|The device is joined by hybrid Azure AD.| +|hybridAzureADJoined|3|The device is joined by hybrid Azure AD.| |
v1.0 | Intune Devices Locatedeviceactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-locatedeviceactionresult.md | Here is a JSON representation of the resource. "speed": "4.2" } }-``` +``` |
v1.0 | Intune Devices Loggedonuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-loggedonuser.md | Here is a JSON representation of the resource. "userId": "String", "lastLogOnDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Lostmodestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-lostmodestate.md | State of lost mode, indicating if lost mode is enabled or disabled |Member|Value|Description| |:|:|:| |disabled|0|Lost mode is disabled.|-|enabled|1|Lost mode is enabled.| +|enabled|1|Lost mode is enabled.| |
v1.0 | Intune Devices Malwarestateforwindowsdevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-malwarestateforwindowsdevice.md | Here is a JSON representation of the resource. "lastStateChangeDateTime": "String (timestamp)", "detectionCount": 1024 }-``` +``` |
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 |[initiateOnDemandProactiveRemediation action](../api/intune-devices-manageddevice-initiateondemandproactiveremediation.md)|None|Perform On Demand Proactive Remediation| |[rotateLocalAdminPassword action](../api/intune-devices-manageddevice-rotatelocaladminpassword.md)|None|Initiates a manual rotation for the local admin password on the device| |[pauseConfigurationRefresh action](../api/intune-devices-manageddevice-pauseconfigurationrefresh.md)|None|Initiates a command to pause config refresh for the device.|-|[syncPayloads action](../api/intune-devices-manageddevice-syncpayloads.md)|None|| +|[changeAssignments action](../api/intune-devices-manageddevice-changeassignments.md)|None|| |[appDiagnostics function](../api/intune-devices-manageddevice-appdiagnostics.md)|[powerliftIncidentMetadata](../resources/intune-devices-powerliftincidentmetadata.md) collection|| |[downloadAppDiagnostics action](../api/intune-devices-manageddevice-downloadappdiagnostics.md)|Stream|| |[createQuery action](../api/intune-devices-manageddevice-createquery.md)|[deviceQueryResult](../resources/intune-devices-devicequeryresult.md)|Allows user to send Intune Pivot device query to a managed device| Devices that are managed or pre-enrolled through Intune |deviceType|[deviceType](../resources/intune-shared-devicetype.md)|Platform of the device. Examples: Desktop, WindowsRT, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Possible values are: `desktop`, `windowsRT`, `winMO6`, `nokia`, `windowsPhone`, `mac`, `winCE`, `winEmbedded`, `iPhone`, `iPad`, `iPod`, `android`, `iSocConsumer`, `unix`, `macMDM`, `holoLens`, `surfaceHub`, `androidForWork`, `androidEnterprise`, `windows10x`, `androidnGMS`, `chromeOS`, `linux`, `blackberry`, `palm`, `unknown`, `cloudPC`.| |complianceState|[complianceState](../resources/intune-devices-compliancestate.md)|Compliance state of the device. Examples: Compliant, Conflict, Error, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Possible values are: `unknown`, `compliant`, `noncompliant`, `conflict`, `error`, `inGracePeriod`, `configManager`.| |jailBroken|String|Whether the device is jail broken or rooted. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only.|-|managementAgent|[managementAgentType](../resources/intune-devices-managementagenttype.md)|Management channel of the device. Examples: Intune, EAS, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`, `microsoft365ManagedMdm`, `msSense`, `intuneAosp`, `google`, `unknownFutureValue`.| +|managementAgent|[managementAgentType](../resources/intune-shared-managementagenttype.md)|Management channel of the device. Examples: Intune, EAS, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`, `microsoft365ManagedMdm`, `msSense`, `intuneAosp`, `google`, `unknownFutureValue`.| |osVersion|String|Operating system version of the device. This property is read-only.| |easActivated|Boolean|Whether the device is Exchange ActiveSync activated. This property is read-only.| |easDeviceId|String|Exchange ActiveSync Id of the device. This property is read-only.| |easActivationDateTime|DateTimeOffset|Exchange ActivationSync activation time of the device. This property is read-only.| |aadRegistered|Boolean|Whether the device is Azure Active Directory registered. This property is read-only.| |azureADRegistered|Boolean|Whether the device is Azure Active Directory registered. This property is read-only.|-|deviceEnrollmentType|[deviceEnrollmentType](../resources/intune-devices-deviceenrollmenttype.md)|Enrollment type of the device. This property is read-only. 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`.| +|deviceEnrollmentType|[deviceEnrollmentType](../resources/intune-devices-deviceenrollmenttype.md)|Enrollment type of the device. This property is read-only. Possible values are: `unknown`, `userEnrollment`, `deviceEnrollmentManager`, `appleBulkWithUser`, `appleBulkWithoutUser`, `windowsAzureADJoin`, `windowsBulkUserless`, `windowsAutoEnrollment`, `windowsBulkAzureDomainJoin`, `windowsCoManagement`, `windowsAzureADJoinUsingDeviceAuth`, `appleUserEnrollment`, `appleUserEnrollmentWithServiceAccount`, `azureAdJoinUsingAzureVmExtension`, `androidEnterpriseDedicatedDevice`, `androidEnterpriseFullyManaged`, `androidEnterpriseCorporateWorkProfile`, `androidAOSPUserOwnedDeviceEnrollment`, `androidAOSPUserlessDeviceEnrollment`, `appleACMEBasicBYOD`, `appleACMEDEPUserless`, `appleACMEDEPUDACompanyPortal`, `appleACMEDEPUDASetupAsstLegacy`, `appleACMEDEPUDAModernAuth`.| |lostModeState|[lostModeState](../resources/intune-devices-lostmodestate.md)|Indicates if Lost mode is enabled or disabled. This property is read-only. Possible values are: `disabled`, `enabled`.| |activationLockBypassCode|String|The code that allows the Activation Lock on managed device to be bypassed. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity in LIST call. 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.| |emailAddress|String|Email(s) for the user associated with the device. This property is read-only.| Devices that are managed or pre-enrolled through Intune |configurationManagerClientInformation|[configurationManagerClientInformation](../resources/intune-devices-configurationmanagerclientinformation.md)|Configuration manager client information, valid only for devices managed, duel-managed or tri-managed by ConfigMgr Agent| |ethernetMacAddress|String|Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only.| |physicalMemoryInBytes|Int64|Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only.|-|processorArchitecture|[managedDeviceArchitecture](../resources/intune-devices-manageddevicearchitecture.md)|Processor architecture. This property is read-only. Possible values are: `unknown`, `x86`, `x64`, `arm`, `arM64`.| +|processorArchitecture|[managedDeviceArchitecture](../resources/intune-shared-manageddevicearchitecture.md)|Processor architecture. This property is read-only. Possible values are: `unknown`, `x86`, `x64`, `arm`, `arM64`.| |specificationVersion|String|Specification version. This property is read-only.| |joinType|[joinType](../resources/intune-devices-jointype.md)|Device join type. Possible values are: `unknown`, `azureADJoined`, `azureADRegistered`, `hybridAzureADJoined`.| |skuFamily|String|Device sku family| Devices that are managed or pre-enrolled through Intune |users|[user](../resources/intune-shared-user.md) collection|The primary users associated with the managed device.| |logCollectionRequests|[deviceLogCollectionResponse](../resources/intune-devices-devicelogcollectionresponse.md) collection|List of log collection requests| |deviceHealthScriptStates|[deviceHealthScriptPolicyState](../resources/intune-devices-devicehealthscriptpolicystate.md) collection|Results of device health scripts that ran for this device. Default is empty list. This property is read-only.|-|queryResults|[deviceQueryResult](../resources/intune-devices-devicequeryresult.md) collection|Results of device query that ran for this device. Default is empty list. This property is read-only.| - ## JSON Representation Here is a JSON representation of the resource. <!-- { Here is a JSON representation of the resource. "deviceIdentityAttestationStatus": "String" } }-``` +``` |
v1.0 | Intune Devices Manageddevicearchitecture | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicearchitecture.md | Processor architecture |x86|1|X86| |x64|2|X64| |arm|3|ARM|-|arM64|4|ARM64| +|arM64|4|ARM64| |
v1.0 | Intune Devices Manageddevicecleanuprule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicecleanuprule.md | Here is a JSON representation of the resource. "lastModifiedDateTime": "String (timestamp)", "deviceInactivityBeforeRetirementInDays": 1024 }-``` +``` |
v1.0 | Intune Devices Manageddevicecleanupsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicecleanupsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.managedDeviceCleanupSettings", "deviceInactivityBeforeRetirementInDays": "String" }-``` +``` |
v1.0 | Intune Devices Manageddevicemanagementfeatures | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicemanagementfeatures.md | Device management features. |Member|Value|Description| |:|:|:| |none|0|Unknown device management features.|-|microsoftManagedDesktop|1|Microsoft Managed Desktop| +|microsoftManagedDesktop|1|Microsoft Managed Desktop| |
v1.0 | Intune Devices Manageddevicemodelsandmanufacturers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicemodelsandmanufacturers.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Manageddeviceoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddeviceoverview.md | Here is a JSON representation of the resource. }, "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Manageddevicepartnerreportedhealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicepartnerreportedhealthstate.md | Available health states for the Device Health API |highSeverity|6|Device is considered high threat by the mobile threat defense partner.| |unresponsive|7|Device is considered unresponsive by the mobile threat defense partner. The device health is not known.| |compromised|8|Device is considered compromised by the Threat Defense partner. This means the device has an active Threat or Risk which cannot be easily remediated by the end user and the user should contact their IT Admin.|-|misconfigured|9|Device is considered misconfigured with the Threat Defense partner. This means the device is missing a required profile or configuration for the Threat Defense Partner to function properly and is thus threat or risk analysis is not able to complete.| +|misconfigured|9|Device is considered misconfigured with the Threat Defense partner. This means the device is missing a required profile or configuration for the Threat Defense Partner to function properly and is thus threat or risk analysis is not able to complete.| |
v1.0 | Intune Devices Manageddeviceremoteaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddeviceremoteaction.md | Namespace: microsoft.graph |initiateMobileDeviceManagementKeyRecovery|16|Name of action to initiate MDM key recovery| |initiateOnDemandProactiveRemediation|17|Name of action to initiate On Demand Proactive Remediation| |unknownFutureValue|18|Evolvable enum member|-|initiateDeviceAttestation|19|Indicates remote device action to intiate Mobile Device Management (MDM) attestation if device is capable for it| +|initiateDeviceAttestation|19|Indicates remote device action to intiate Mobile Device Management (MDM) attestation if device is capable for it| |
v1.0 | Intune Devices Managedinstallerstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-managedinstallerstatus.md | ManagedInstallerStatus |Member|Value|Description| |:|:|:| |disabled|0|Managed Installer is Disabled|-|enabled|1|Managed Installer is Enabled| +|enabled|1|Managed Installer is Enabled| |
v1.0 | Intune Devices Managementagenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-managementagenttype.md | Management agent type. |msSense|1024|| |intuneAosp|2048|This device is managed by Intune's MDM for AOSP (Android Open Source Project) devices| |google|8192|Indicates the management agent to manage the device is Google.|-|unknownFutureValue|8193|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|8193|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Managementstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-managementstate.md | Management state of device in Microsoft Intune. |wipeIssued|8|A wipe command was issued for the device| |wipeCanceled|9|A wipe command for this device has been canceled| |retireCanceled|10|A retire command for this device has been canceled|-|discovered|11|The device is discovered but not fully enrolled.| +|discovered|11|The device is discovered but not fully enrolled.| |
v1.0 | Intune Devices Mobileapptroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-mobileapptroubleshootingevent.md | MobileAppTroubleshootingEvent Entity. ## Methods |Method|Return Type|Description| |:|:|:|-|[List mobileAppTroubleshootingEvents](../api/intune-devices-mobileapptroubleshootingevent-list.md)|[mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md) collection|List properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md) objects.| -|[Get mobileAppTroubleshootingEvent](../api/intune-devices-mobileapptroubleshootingevent-get.md)|[mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md)|Read properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md) object.| -|[Create mobileAppTroubleshootingEvent](../api/intune-devices-mobileapptroubleshootingevent-create.md)|[mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md)|Create a new [mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md) object.| -|[Delete mobileAppTroubleshootingEvent](../api/intune-devices-mobileapptroubleshootingevent-delete.md)|None|Deletes a [mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md).| -|[Update mobileAppTroubleshootingEvent](../api/intune-devices-mobileapptroubleshootingevent-update.md)|[mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md)|Update the properties of a [mobileAppTroubleshootingEvent](../resources/intune-devices-mobileapptroubleshootingevent.md) object.| +|[List mobileAppTroubleshootingEvents](../api/intune-devices-mobileapptroubleshootingevent-list.md)|[mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) collection|List properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) objects.| +|[Get mobileAppTroubleshootingEvent](../api/intune-devices-mobileapptroubleshootingevent-get.md)|[mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md)|Read properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object.| +|[Create mobileAppTroubleshootingEvent](../api/intune-devices-mobileapptroubleshootingevent-create.md)|[mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md)|Create a new [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object.| +|[Delete mobileAppTroubleshootingEvent](../api/intune-devices-mobileapptroubleshootingevent-delete.md)|None|Deletes a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md).| +|[Update mobileAppTroubleshootingEvent](../api/intune-devices-mobileapptroubleshootingevent-update.md)|[mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md)|Update the properties of a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.mobileAppTroubleshootingEvent", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Devices Obliterationbehavior | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-obliterationbehavior.md | In macOS 12 and later, this command uses Erase All Content and Settings (EACS) o |doNotObliterate|1|If Erase All Content and Settings (EACS) preflight fails, the device responds to the server with an Error status and doesnΓÇÖt attempt to erase itself. If EACS preflight succeeds but EACS fails, then the device doesnΓÇÖt attempt to erase itself.| |obliterateWithWarning|2|If Erase All Content and Settings (EACS) preflight fails, the device responds with an Acknowledged status and then attempts to erase itself. If EACS preflight succeeds but EACS fails, then the device attempts to erase itself.| |always|3|The system doesnΓÇÖt attempt Erase All Content and Settings (EACS). T2 and later devices always obliterate.|-|unknownFutureValue|999|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|999|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Operatingsystemupgradeeligibility | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-operatingsystemupgradeeligibility.md | Work From Anywhere windows device upgrade eligibility status. |unknown|1|Not enough data available to compute the eligibility of device for windows upgrade.| |notCapable|2|The device is not capable for windows upgrade.| |capable|3|The device is capable for windows upgrade.|-|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Osversioncount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-osversioncount.md | Here is a JSON representation of the resource. "deviceCount": 1024, "lastUpdateDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Powerliftdownloadrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-powerliftdownloadrequest.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Powerliftincidentmetadata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-powerliftincidentmetadata.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Privilegemanagementendusertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-privilegemanagementendusertype.md | The type of user account on Windows that was used to performed the elevation. |azureAd|1|The user who performed the elevation logged in using an Azure Active Directory (Azure AD) account.| |hybrid|2|The user who performed the elevation logged in using Hybrid Azure AD joined account.| |local|3|The user who performed the elevation logged in using a Windows local account.|-|unknownFutureValue|4|Evolvable emuneration sentinel value. Do not use.| +|unknownFutureValue|4|Evolvable emuneration sentinel value. Do not use.| |
v1.0 | Intune Devices Privilegemanagementprocesstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-privilegemanagementprocesstype.md | Indicates the type of elevated process |undefined|0|Default. If the type was unknown on the client for some reasons| |parent|1|The elevated process is a parent process| |child|2|The elevated process is a child process|-|unknownFutureValue|3|Evolvable emuneration sentinel value. Do not use| +|unknownFutureValue|3|Evolvable emuneration sentinel value. Do not use| |
v1.0 | Intune Devices Remediationstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-remediationstate.md | Indicates the type of execution status of the device management script. |success|2|Remediation script executed successfully and remediated the device state| |remediationFailed|3|Remediation script executed successfully but failed to remediated the device state| |scriptError|4|Remediation script execution encountered and error or timed out|-|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Remoteaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-remoteaction.md | Remote actions Intune supports. |pauseConfigurationRefresh|37|Indicates an action has been initiated to pause configuration refresh for the device.| |initiateDeviceAttestation|38|Indicates remote device action to intiate Mobile Device Management (MDM) attestation if device is capable for it.| |changeAssignments|39|Indicates remote device action to override assignments for a Device.|-|delete|40|Indicates remote device action to delete a device from Intune portal.| +|delete|40|Indicates remote device action to delete a device from Intune portal.| |
v1.0 | Intune Devices Remoteactionaudit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-remoteactionaudit.md | Here is a JSON representation of the resource. "actionState": "String", "managedDeviceId": "String" }-``` +``` |
v1.0 | Intune Devices Remotelockactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-remotelockactionresult.md | Here is a JSON representation of the resource. "lastUpdatedDateTime": "String (timestamp)", "unlockPin": "String" }-``` +``` |
v1.0 | Intune Devices Resetpasscodeactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-resetpasscodeactionresult.md | Here is a JSON representation of the resource. "passcode": "String", "errorCode": 1024 }-``` +``` |
v1.0 | Intune Devices Revokeapplevpplicensesactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-revokeapplevpplicensesactionresult.md | Here is a JSON representation of the resource. "totalLicensesCount": 1024, "failedLicensesCount": 1024 }-``` +``` |
v1.0 | Intune Devices Rotatebitlockerkeysdeviceactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-rotatebitlockerkeysdeviceactionresult.md | Here is a JSON representation of the resource. "lastUpdatedDateTime": "String (timestamp)", "errorCode": 1024 }-``` +``` |
v1.0 | Intune Devices Runasaccounttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-runasaccounttype.md | Indicates the type of execution context the device management script runs in. |Member|Value|Description| |:|:|:| |system|0||-|user|1|| +|user|1|| |
v1.0 | Intune Devices Runstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-runstate.md | Indicates the type of execution status of the device management script. |fail|2|Script failed to run.| |scriptError|3|Discovery script hits error.| |pending|4|Script is pending to execute.|-|notApplicable|5|Script is not applicable for this device.| +|notApplicable|5|Script is not applicable for this device.| |
v1.0 | Intune Devices Sharedappledeviceuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-sharedappledeviceuser.md | Here is a JSON representation of the resource. "dataQuota": 1024, "dataUsed": 1024 }-``` +``` |
v1.0 | Intune Devices Syncpayloadsactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-syncpayloadsactionresult.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Devices Systemmanagementmodelevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-systemmanagementmodelevel.md | A list of possible System Management Mode levels for a device. System Management |level1|1|Indicates that deny System Management Mode (SMM) read/write access to OS and Virtualization-based security (VBS) memory. The benefit is that by design System Management Mode (SMM) cannot modify security of or exfiltrate secrets from the OS (including Virtualization-based security).| |level2|2|Indicates that in addition to the System Management Mode (SMM) Level 1 protections, this level prevents System Management Mode (SMM) from tampering with Input-Output Memory Management Unit (IOMMU) config. The benefit is that by design System Management Mode (SMM) cannot disable Virtualization-based security (VBS) and kernel Direct memory access (DMA) protections.| |level3|3|Indicates that in addition to the System Management Mode (SMM) Level 2 protections, this level reduces System Management Mode (SMM) save state capabilities. The benefit is that by design System Management Mode (SMM) cannot exploit save state to modify security of or exfiltrate secrets from the OS (including Virtualization-based security).|-|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Tenantattachrbac | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-tenantattachrbac.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.tenantAttachRBAC", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Devices Tenantattachrbacstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-tenantattachrbacstate.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.tenantAttachRBACState", "enabled": true }-``` +``` |
v1.0 | Intune Devices Updatewindowsdeviceaccountactionparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-updatewindowsdeviceaccountactionparameter.md | Here is a JSON representation of the resource. "exchangeServer": "String", "sessionInitiationProtocalAddress": "String" }-``` +``` |
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-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.| +|[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.| |[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 | Here is a JSON representation of the resource. "assetVersion": "String", "assetPublisher": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsanomalycorrelationgroupfeature | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalycorrelationgroupfeature.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsanomalycorrelationgroupoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalycorrelationgroupoverview.md | Here is a JSON representation of the resource. "correlationGroupAnomalousDeviceCount": 1024, "correlationGroupAtRiskDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsanomalycorrelationgroupprevalence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalycorrelationgroupprevalence.md | Indicates the level of prevalence of the correlation group features in the anoma |high|0|Indicates that we have a high prevalence in the correlation between the anomaly and correlation group.| |medium|1|Indicates that we have a medium prevalence in the correlation between the anomaly and correlation group.| |low|2|Indicates that we have a low prevalence in the correlation between the anomaly and correlation group.|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticsanomalydevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalydevice.md | Here is a JSON representation of the resource. "correlationGroupId": "String", "deviceStatus": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsanomalydevicefeaturetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalydevicefeaturetype.md | Indicates the device's feature type. Possible values are: manufacturer, model, o |osVersion|2|Indicates the OS as a device feature type.| |application|3|Indicates the application as a device feature type.| |driver|4|Indicates the driver as a device feature type.|-|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticsanomalyseverity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalyseverity.md | Indicates the severity of the anomaly. Eg: anomaly severity can be high, medium, |low|2|Indicates the anomaly is of low severity.| |informational|3|Indicates the anomaly is of informational severity.| |other|4|Indicates the severity of anomaly is undefined.|-|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticsanomalyseverityoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalyseverityoverview.md | Here is a JSON representation of the resource. "highSeverityAnomalyCount": 1024, "informationalSeverityAnomalyCount": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsanomalystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalystate.md | Indicates the state of the anomaly. Eg: anomaly severity can be new, active, dis |disabled|2|Indicates the state of anomaly is disabled.| |removed|3|Indicates the state of anomaly is removed.| |other|4|Indicates the state of anomaly is undefined.|-|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticsanomalytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalytype.md | Indicates the category of the anomaly. Eg: anomaly type can be device, applicati |stopError|2|Indicates the detected anomaly is due to a specific stop error.| |driver|3|Indicates the detected anomaly is due to a specific driver.| |other|4|Indicates the category of detected anomaly is undefined.|-|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticsapphealthapplicationperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthapplicationperformance.md | Here is a JSON representation of the resource. "appCrashCount": 1024, "meanTimeToFailureInMinutes": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsapphealthappperformancebyappversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversion.md | Here is a JSON representation of the resource. "appCrashCount": 1024, "meanTimeToFailureInMinutes": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsapphealthappperformancebyappversiondetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondetails.md | Here is a JSON representation of the resource. "appVersion": "String", "appCrashCount": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsapphealthappperformancebyappversiondeviceid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondeviceid.md | Here is a JSON representation of the resource. "appVersion": "String", "appCrashCount": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsapphealthappperformancebyosversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthappperformancebyosversion.md | Here is a JSON representation of the resource. "appCrashCount": 1024, "meanTimeToFailureInMinutes": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsapphealthdevicemodelperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthdevicemodelperformance.md | Here is a JSON representation of the resource. "modelAppHealthStatus": "String", "healthStatus": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsapphealthdeviceperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthdeviceperformance.md | Here is a JSON representation of the resource. "deviceId": "String", "deviceDisplayName": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsapphealthdeviceperformancedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthdeviceperformancedetails.md | Here is a JSON representation of the resource. "deviceId": "String", "deviceDisplayName": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsapphealthosversionperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthosversionperformance.md | Here is a JSON representation of the resource. "osVersionAppHealthScore": "4.2", "osVersionAppHealthStatus": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsautopilotdevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsautopilotdevicessummary.md | Here is a JSON representation of the resource. "devicesWithoutAutopilotProfileAssigned": 1024, "totalWindows10DevicesWithoutTenantAttached": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsbaseline | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbaseline.md | Here is a JSON representation of the resource. "isBuiltIn": true, "createdDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthappimpact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthappimpact.md | Here is a JSON representation of the resource. "isForegroundApp": true, "batteryUsagePercentage": "4.2" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthcapacitydetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthcapacitydetails.md | Here is a JSON representation of the resource. "batteryCapacityPoor": 1024, "lastRefreshedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthdeviceappimpact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthdeviceappimpact.md | Here is a JSON representation of the resource. "isForegroundApp": true, "batteryUsagePercentage": "4.2" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthdeviceperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthdeviceperformance.md | Here is a JSON representation of the resource. "deviceBatteryHealthScore": 1024, "healthStatus": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthdeviceruntimehistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthdeviceruntimehistory.md | Here is a JSON representation of the resource. "runtimeDateTime": "String", "estimatedRuntimeInMinutes": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthmodelperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthmodelperformance.md | Here is a JSON representation of the resource. "modelBatteryHealthScore": 1024, "modelHealthStatus": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthosperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthosperformance.md | Here is a JSON representation of the resource. "osBatteryHealthScore": 1024, "osHealthStatus": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthruntimedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthruntimedetails.md | Here is a JSON representation of the resource. "batteryRuntimePoor": 1024, "lastRefreshedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticscategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticscategory.md | Here is a JSON representation of the resource. ], "state": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticscloudidentitydevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticscloudidentitydevicessummary.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.userExperienceAnalyticsCloudIdentityDevicesSummary", "deviceWithoutCloudIdentityCount": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticscloudmanagementdevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticscloudmanagementdevicessummary.md | Here is a JSON representation of the resource. "intuneDeviceCount": 1024, "tenantAttachDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicebatterydetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicebatterydetail.md | Here is a JSON representation of the resource. "maxCapacityPercentage": 1024, "fullBatteryDrainCount": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdeviceperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdeviceperformance.md | Here is a JSON representation of the resource. "startupPerformanceScore": "4.2", "modelStartupPerformanceScore": "4.2" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicescope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicescope.md | Here is a JSON representation of the resource. "createdDateTime": "String (timestamp)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicescopesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicescopesummary.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicescores | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicescores.md | Here is a JSON representation of the resource. "batteryHealthScore": "4.2", "healthStatus": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicestartuphistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicestartuphistory.md | Here is a JSON representation of the resource. "restartStopCode": "String", "restartFaultBucket": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicestartupprocess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicestartupprocess.md | Here is a JSON representation of the resource. "publisher": "String", "startupImpactInMs": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicestartupprocessperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicestartupprocessperformance.md | Here is a JSON representation of the resource. "medianImpactInMs": 1024, "totalImpactInMs": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicestatus.md | Indicates the status of the device in the correlation group. Eg: Device status c |anomalous|0|Indicates the the device is part of the anomaly.| |affected|1|Indicates the device is affected by the anomaly and is part of the correlation group.| |atRisk|2|Indicates the device is not part of the anomaly but is part of the correlation group.|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticsdevicetimelineevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicetimelineevent.md | Here is a JSON representation of the resource. "eventName": "String", "eventDetails": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicetimelineevents | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicetimelineevents.md | Here is a JSON representation of the resource. "eventDetails": "String", "eventAdditionalInformation": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsdevicewithoutcloudidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicewithoutcloudidentity.md | Here is a JSON representation of the resource. "deviceName": "String", "azureAdDeviceId": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticshealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticshealthstate.md | Namespace: microsoft.graph |insufficientData|1|Indicates that the health state is insufficient data.| |needsAttention|2|Indicates that the health state needs attention.| |meetingGoals|3|Indicates that the health state is meeting goals.|-|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticsimpactingprocess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsimpactingprocess.md | Here is a JSON representation of the resource. "publisher": "String", "impactValue": "4.2" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsinsight | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsinsight.md | Here is a JSON representation of the resource. ], "severity": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsinsightseverity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsinsightseverity.md | Indicates severity of insights. Possible values are: None, Informational, Warnin |informational|1|Indicates that the insight severity is informational.| |warning|2|Indicates that the insight severity is warning.| |error|3|Indicates that the insight severity is error.|-|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticsinsightvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsinsightvalue.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.userExperienceAnalyticsInsightValue" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsmachinetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsmachinetype.md | Indicates if machine is physical or virtual. Possible values are: physical or vi |unknown|0|Indicates that the type is unknown.| |physical|1|Indicates that the Machine is physical.| |virtual|2|Indicates that the machine is virtual.|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticsmetric | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsmetric.md | Here is a JSON representation of the resource. "value": "4.2", "unit": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsmetrichistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsmetrichistory.md | Here is a JSON representation of the resource. "metricDateTime": "String (timestamp)", "metricType": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsmodelscores | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsmodelscores.md | Here is a JSON representation of the resource. "meanResourceSpikeTimeScore": "4.2", "healthStatus": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsnotautopilotreadydevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsnotautopilotreadydevice.md | Here is a JSON representation of the resource. "azureAdRegistered": true, "azureAdJoinType": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsoperatingsystemrestartcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsoperatingsystemrestartcategory.md | Operating System restart category. |longPowerButtonPress|6|Indicates that the device operating system restart is due to update long power-button press.| |bootError|7|Indicates that the device operating system restart is due to boot error.| |update|8|Indicates that the device operating system restarted after an update.|-|unknownFutureValue|9|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|9|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticsoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsoverview.md | Here is a JSON representation of the resource. "resourcePerformanceHealthState": "String", "batteryHealthState": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsregressionsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsregressionsummary.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.userExperienceAnalyticsRegressionSummary", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsremoteconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsremoteconnection.md | Here is a JSON representation of the resource. "cloudPcFailurePercentage": "4.2", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsresourceperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsresourceperformance.md | Here is a JSON representation of the resource. "diskType": "String", "healthStatus": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsscorehistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsscorehistory.md | Here is a JSON representation of the resource. "batteryHealthTotalDevices": 1024, "restartScore": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticssettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticssettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.userExperienceAnalyticsSettings", "configurationManagerDataConnectorConfigured": true }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticssummarizedby | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticssummarizedby.md | Indicates type of summarization. Possible values are: None, Model, AllRegression |modelRegression|4|Indicates that the summarization is by model regression.| |manufacturerRegression|5|Indicates that the summarization is by manufacturer regression.| |operatingSystemVersionRegression|6|Indicates that the summarization is by operating system version regression.|-|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Devices Userexperienceanalyticswindows10devicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticswindows10devicessummary.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.userExperienceAnalyticsWindows10DevicesSummary", "unsupportedOSversionDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsworkfromanywheredevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsworkfromanywheredevice.md | Here is a JSON representation of the resource. "cloudProvisioningScore": "4.2", "healthStatus": "String" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsworkfromanywheredevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsworkfromanywheredevicessummary.md | Here is a JSON representation of the resource. "devicesNotAutopilotRegistered": 1024, "devicesWithoutAutopilotProfileAssigned": 1024 }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsworkfromanywherehardwarereadinessmetric | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsworkfromanywherehardwarereadinessmetric.md | Here is a JSON representation of the resource. "processor64BitCheckFailedPercentage": "4.2", "osCheckFailedPercentage": "4.2" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsworkfromanywheremetric | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsworkfromanywheremetric.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.userExperienceAnalyticsWorkFromAnywhereMetric", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsworkfromanywheremodelperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsworkfromanywheremodelperformance.md | Here is a JSON representation of the resource. "cloudProvisioningScore": "4.2", "healthStatus": "String" }-``` +``` |
v1.0 | Intune Devices Windowsdefenderproductstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdefenderproductstatus.md | Product Status of Windows Defender |platformUpdateInProgress|2097152|Platform update is in progress| |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| +|windowsSModeSignaturesInUseOnNonWin10SInstall|16777216|Windows SMode signatures still in use on non-Win10S install| |
v1.0 | Intune Devices Windowsdefenderscanactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdefenderscanactionresult.md | Here is a JSON representation of the resource. "lastUpdatedDateTime": "String (timestamp)", "scanType": "String" }-``` +``` |
v1.0 | Intune Devices Windowsdeviceaccount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdeviceaccount.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsDeviceAccount", "password": "String" }-``` +``` |
v1.0 | Intune Devices Windowsdeviceadaccount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdeviceadaccount.md | Here is a JSON representation of the resource. "domainName": "String", "userName": "String" }-``` +``` |
v1.0 | Intune Devices Windowsdeviceazureadaccount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdeviceazureadaccount.md | Here is a JSON representation of the resource. "password": "String", "userPrincipalName": "String" }-``` +``` |
v1.0 | Intune Devices Windowsdevicehealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdevicehealthstate.md | Computer endpoint protection state |rebootPending|2|Computer is in pending reboot state| |manualStepsPending|4|Computer is in pending manual steps state| |offlineScanPending|8|Computer is in pending offline scan state|-|critical|16|Computer is in critical failure state| +|critical|16|Computer is in critical failure state| |
v1.0 | Intune Devices Windowsdevicemalwarestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdevicemalwarestate.md | Here is a JSON representation of the resource. "detectionCount": 1024, "category": "String" }-``` +``` |
v1.0 | Intune Devices Windowsmalwarecategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarecategory.md | Malware category id |policy|48|Policy| |enterpriseUnwantedSoftware|49|Enterprise Unwanted Software| |ransom|50|Ransom|-|hipsRule|51|HIPS Rule| +|hipsRule|51|HIPS Rule| |
v1.0 | Intune Devices Windowsmalwarecategorycount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarecategorycount.md | Here is a JSON representation of the resource. "distinctActiveMalwareCount": 1024, "lastUpdateDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Windowsmalwareexecutionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareexecutionstate.md | Malware execution status |blocked|1|Blocked| |allowed|2|Allowed| |running|3|Running|-|notRunning|4|Not running| +|notRunning|4|Not running| |
v1.0 | Intune Devices Windowsmalwareexecutionstatecount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareexecutionstatecount.md | Here is a JSON representation of the resource. "deviceCount": 1024, "lastUpdateDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Windowsmalwareinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareinformation.md | Here is a JSON representation of the resource. "category": "String", "lastDetectionDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Windowsmalwarenamecount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarenamecount.md | Here is a JSON representation of the resource. "deviceCount": 1024, "lastUpdateDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Windowsmalwareoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareoverview.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Devices Windowsmalwareseverity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareseverity.md | Malware severity |low|1|Low| |moderate|2|Moderate| |high|4|High|-|severe|5|Severe| +|severe|5|Severe| |
v1.0 | Intune Devices Windowsmalwareseveritycount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareseveritycount.md | Here is a JSON representation of the resource. "distinctMalwareCount": 1024, "lastUpdateDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Windowsmalwarestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarestate.md | Malware current status |removeFailed|104|Remove failed| |allowFailed|105|Allow failed| |abandoned|106|Abandoned|-|blockFailed|107|Block failed| +|blockFailed|107|Block failed| |
v1.0 | Intune Devices Windowsmalwarestatecount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarestatecount.md | Here is a JSON representation of the resource. "distinctMalwareCount": 1024, "lastUpdateDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Devices Windowsmalwarethreatstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarethreatstate.md | Malware threat status |removed|7|Removed| |cleaned|8|Cleaned| |allowed|9|Allowed|-|noStatusCleared|10|No status cleared| +|noStatusCleared|10|No status cleared| |
v1.0 | Intune Devices Windowsmanageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmanageddevice.md | Inherits from [managedDevice](../resources/intune-devices-manageddevice.md) |deviceType|[deviceType](../resources/intune-shared-devicetype.md)|Platform of the device. Examples: Desktop, WindowsRT, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `desktop`, `windowsRT`, `winMO6`, `nokia`, `windowsPhone`, `mac`, `winCE`, `winEmbedded`, `iPhone`, `iPad`, `iPod`, `android`, `iSocConsumer`, `unix`, `macMDM`, `holoLens`, `surfaceHub`, `androidForWork`, `androidEnterprise`, `windows10x`, `androidnGMS`, `chromeOS`, `linux`, `blackberry`, `palm`, `unknown`, `cloudPC`.| |complianceState|[complianceState](../resources/intune-devices-compliancestate.md)|Compliance state of the device. Examples: Compliant, Conflict, Error, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `compliant`, `noncompliant`, `conflict`, `error`, `inGracePeriod`, `configManager`.| |jailBroken|String|Whether the device is jail broken or rooted. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)|-|managementAgent|[managementAgentType](../resources/intune-devices-managementagenttype.md)|Management channel of the device. Examples: Intune, EAS, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`, `microsoft365ManagedMdm`, `msSense`, `intuneAosp`, `google`, `unknownFutureValue`.| +|managementAgent|[managementAgentType](../resources/intune-shared-managementagenttype.md)|Management channel of the device. Examples: Intune, EAS, etc. Default is unknown. Supports $filter operator 'eq' and 'or'. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`, `microsoft365ManagedMdm`, `msSense`, `intuneAosp`, `google`, `unknownFutureValue`.| |osVersion|String|Operating system version of the device. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |easActivated|Boolean|Whether the device is Exchange ActiveSync activated. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |easDeviceId|String|Exchange ActiveSync Id of the device. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| Inherits from [managedDevice](../resources/intune-devices-manageddevice.md) |configurationManagerClientInformation|[configurationManagerClientInformation](../resources/intune-devices-configurationmanagerclientinformation.md)|Configuration manager client information, valid only for devices managed, duel-managed or tri-managed by ConfigMgr Agent Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |ethernetMacAddress|String|Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |physicalMemoryInBytes|Int64|Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)|-|processorArchitecture|[managedDeviceArchitecture](../resources/intune-devices-manageddevicearchitecture.md)|Processor architecture. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `x86`, `x64`, `arm`, `arM64`.| +|processorArchitecture|[managedDeviceArchitecture](../resources/intune-shared-manageddevicearchitecture.md)|Processor architecture. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `x86`, `x64`, `arm`, `arM64`.| |specificationVersion|String|Specification version. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |joinType|[joinType](../resources/intune-devices-jointype.md)|Device join type Inherited from [managedDevice](../resources/intune-devices-manageddevice.md). Possible values are: `unknown`, `azureADJoined`, `azureADRegistered`, `hybridAzureADJoined`.| |skuFamily|String|Device sku family Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| Inherits from [managedDevice](../resources/intune-devices-manageddevice.md) |users|[user](../resources/intune-shared-user.md) collection|The primary users associated with the managed device. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |logCollectionRequests|[deviceLogCollectionResponse](../resources/intune-devices-devicelogcollectionresponse.md) collection|List of log collection requests Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| |deviceHealthScriptStates|[deviceHealthScriptPolicyState](../resources/intune-devices-devicehealthscriptpolicystate.md) collection|Results of device health scripts that ran for this device. Default is empty list. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)|-|queryResults|[deviceQueryResult](../resources/intune-devices-devicequeryresult.md) collection|Results of device query that ran for this device. Default is empty list. This property is read-only. Inherited from [managedDevice](../resources/intune-devices-manageddevice.md)| ## JSON Representation Here is a JSON representation of the resource. Here is a JSON representation of the resource. "deviceIdentityAttestationStatus": "String" } }-``` +``` |
v1.0 | Intune Devices Windowsmanagementapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmanagementapp.md | Here is a JSON representation of the resource. "managedInstaller": "String", "managedInstallerConfiguredDateTime": "String" }-``` +``` |
v1.0 | Intune Devices Windowsmanagementapphealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmanagementapphealthstate.md | Here is a JSON representation of the resource. "deviceName": "String", "deviceOSVersion": "String" }-``` +``` |
v1.0 | Intune Devices Windowsprotectionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsprotectionstate.md | Here is a JSON representation of the resource. "isVirtualMachine": true, "tamperProtectionEnabled": true }-``` +``` |
v1.0 | Intune Enrollment Activedirectorywindowsautopilotdeploymentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-activedirectorywindowsautopilotdeploymentprofile.md | Inherits from [windowsAutopilotDeploymentProfile](../resources/intune-shared-win |Property|Type|Description| |:|:|:| |id|String|Profile Key Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|displayName|String|Name of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|description|String|Description of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|language|String|Language configured on the device Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|createdDateTime|DateTimeOffset|Profile creation time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|lastModifiedDateTime|DateTimeOffset|Profile last modified time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|Out of box experience setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|displayName|String|The display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|description|String|A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|language|String|The language code to be used when configuring the device. E.g. en-US. The default value is os-default. 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 locale instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|locale|String|The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|createdDateTime|DateTimeOffset|The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|lastModifiedDateTime|DateTimeOffset|The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSetting|[outOfBoxExperienceSetting](../resources/intune-enrollment-outofboxexperiencesetting.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| |enrollmentStatusScreenSettings|[windowsEnrollmentStatusScreenSettings](../resources/intune-enrollment-windowsenrollmentstatusscreensettings.md)|Enrollment status screen setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|extractHardwareHash|Boolean|HardwareHash Extraction for the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceNameTemplate|String|The template used to name the AutoPilot Device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The AutoPilot device type that this profile is applicable to. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| -|enableWhiteGlove|Boolean|Enable Autopilot White Glove for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|roleScopeTagIds|String collection|Scope tags for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|managementServiceAppId|String|AzureAD management app ID used during client device-based enrollment discovery Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|extractHardwareHash|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. 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 hardwareHashExtractionEnabled instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|hardwareHashExtractionEnabled|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceNameTemplate|String|The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The Windows device type that this profile is applicable to. Possible values include windowsPc, holoLens, and virtualMachine. The default is windowsPc. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| +|enableWhiteGlove|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|preprovisioningAllowed|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|roleScopeTagIds|String collection|List of role scope tags for the deployment profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|managementServiceAppId|String|The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| |hybridAzureADJoinSkipConnectivityCheck|Boolean|The Autopilot Hybrid Azure AD join flow will continue even if it does not establish domain controller connectivity during OOBE.| ## Relationships Here is a JSON representation of the resource. "displayName": "String", "description": "String", "language": "String",+ "locale": "String", "createdDateTime": "String (timestamp)", "lastModifiedDateTime": "String (timestamp)", "outOfBoxExperienceSettings": { Here is a JSON representation of the resource. "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "String", + "deviceUsageType": "String", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Here is a JSON representation of the resource. "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "String", "deviceType": "String", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "String" ], "managementServiceAppId": "String", "hybridAzureADJoinSkipConnectivityCheck": true }-``` +``` |
v1.0 | Intune Enrollment Appleenrollmentprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-appleenrollmentprofileassignment.md | Here is a JSON representation of the resource. "entraObjectId": "String" } }-``` +``` |
v1.0 | Intune Enrollment Appleownertypeenrollmenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-appleownertypeenrollmenttype.md | Here is a JSON representation of the resource. "ownerType": "String", "enrollmentType": "String" }-``` +``` |
v1.0 | Intune Enrollment Appleuserinitiatedenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-appleuserinitiatedenrollmentprofile.md | Here is a JSON representation of the resource. "createdDateTime": "String (timestamp)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Enrollment Appleuserinitiatedenrollmenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-appleuserinitiatedenrollmenttype.md | Namespace: microsoft.graph |user|2|Profile-driven user enrollment via the iOS Company Portal. An enrollment type that segregates corportate and personal data. Supported on devices running iOS/iPadOS 13 and higher.| |accountDrivenUserEnrollment|3|Account-driven user enrollment. Users will enroll from the iOS Settings app without using the iOS Company Portal. This enrollment type segregates corporate and personal data. Supported on devices running iOS/iPadOS 15 and higher.| |webDeviceEnrollment|4|Device enrollment via the web. Users will enroll without using the iOS Company Portal. This enrollment type does not segregate corporate and personal data. Supported on all Intune-supported iOS/iPadOS versions.|-|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Enrollment Azureadwindowsautopilotdeploymentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-azureadwindowsautopilotdeploymentprofile.md | Inherits from [windowsAutopilotDeploymentProfile](../resources/intune-shared-win |Property|Type|Description| |:|:|:| |id|String|Profile Key Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|displayName|String|Name of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|description|String|Description of the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|language|String|Language configured on the device Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|createdDateTime|DateTimeOffset|Profile creation time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|lastModifiedDateTime|DateTimeOffset|Profile last modified time Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|Out of box experience setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|displayName|String|The display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|description|String|A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|language|String|The language code to be used when configuring the device. E.g. en-US. The default value is os-default. 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 locale instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|locale|String|The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|createdDateTime|DateTimeOffset|The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|lastModifiedDateTime|DateTimeOffset|The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|outOfBoxExperienceSetting|[outOfBoxExperienceSetting](../resources/intune-enrollment-outofboxexperiencesetting.md)|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. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| |enrollmentStatusScreenSettings|[windowsEnrollmentStatusScreenSettings](../resources/intune-enrollment-windowsenrollmentstatusscreensettings.md)|Enrollment status screen setting Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|-|extractHardwareHash|Boolean|HardwareHash Extraction for the profile Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceNameTemplate|String|The template used to name the AutoPilot Device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The AutoPilot device type that this profile is applicable to. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| -|enableWhiteGlove|Boolean|Enable Autopilot White Glove for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|roleScopeTagIds|String collection|Scope tags for the profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| -|managementServiceAppId|String|AzureAD management app ID used during client device-based enrollment discovery Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|extractHardwareHash|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. 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 hardwareHashExtractionEnabled instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|hardwareHashExtractionEnabled|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceNameTemplate|String|The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The Windows device type that this profile is applicable to. Possible values include windowsPc, holoLens, and virtualMachine. The default is windowsPc. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md). Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| +|enableWhiteGlove|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|preprovisioningAllowed|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|roleScopeTagIds|String collection|List of role scope tags for the deployment profile. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| +|managementServiceAppId|String|The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Inherited from [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)| ## Relationships |Relationship|Type|Description| Here is a JSON representation of the resource. "displayName": "String", "description": "String", "language": "String",+ "locale": "String", "createdDateTime": "String (timestamp)", "lastModifiedDateTime": "String (timestamp)", "outOfBoxExperienceSettings": { Here is a JSON representation of the resource. "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "String", + "deviceUsageType": "String", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Here is a JSON representation of the resource. "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "String", "deviceType": "String", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "String" ], "managementServiceAppId": "String" }-``` +``` |
v1.0 | Intune Enrollment Conceptual | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-conceptual.md | Namespace: microsoft.graph You can enroll organization-owned or corporate-owned devices to manage with Intune in a variety of ways, depending on the type of device, how the device was purchased, and the needs of the organization. You also can install the Company Portal app to enroll and manage corporate-owned devices, like in a "bring your own device" (BYOD) scenario. -Use Graph resources to enroll corporate-owned devices in Intune. See the table of content for a list of resources. +Use Graph resources to enroll corporate-owned devices in Intune. See the table of content for a list of resources. |
v1.0 | Intune Enrollment Deletedwindowsautopilotdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-deletedwindowsautopilotdevicestate.md | Here is a JSON representation of the resource. "deletionState": "String", "errorMessage": "String" }-``` +``` |
v1.0 | Intune Enrollment Depenrollmentbaseprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-depenrollmentbaseprofile.md | Here is a JSON representation of the resource. ], "waitForDeviceConfiguredConfirmation": true }-``` +``` |
v1.0 | Intune Enrollment Depenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-depenrollmentprofile.md | Here is a JSON representation of the resource. "sharedIPadMaximumUserCount": 1024, "enableSharedIPad": true }-``` +``` |
v1.0 | Intune Enrollment Depiosenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-depiosenrollmentprofile.md | Here is a JSON representation of the resource. "carrierActivationUrl": "String", "userlessSharedAadModeEnabled": true }-``` +``` |
v1.0 | Intune Enrollment Depmacosenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-depmacosenrollmentprofile.md | Here is a JSON representation of the resource. "requestRequiresNetworkTether": true, "autoAdvanceSetupEnabled": true }-``` +``` |
v1.0 | Intune Enrollment Deponboardingsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-deponboardingsetting.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Enrollment Deptokentype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-deptokentype.md | Namespace: microsoft.graph |:|:|:| |none|0|Token Type is None| |dep|1|Token Type is Dep.|-|appleSchoolManager|2|Token Type is Apple School Manager| +|appleSchoolManager|2|Token Type is Apple School Manager| |
v1.0 | Intune Enrollment Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-devicemanagement.md | The deviceManagement resource represents a tenant's collection device identities ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-enrollment-devicemanagement-get.md)|[deviceManagement](../resources/intune-enrollment-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-enrollment-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-enrollment-devicemanagement-update.md)|[deviceManagement](../resources/intune-enrollment-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-enrollment-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-enrollment-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-enrollment-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| |[getSuggestedEnrollmentLimit function](../api/intune-enrollment-devicemanagement-getsuggestedenrollmentlimit.md)|[suggestedEnrollmentLimit](../resources/intune-enrollment-suggestedenrollmentlimit.md)|| ## Properties The deviceManagement resource represents a tenant's collection device identities |:|:|:| |windowsAutopilotSettings|[windowsAutopilotSettings](../resources/intune-enrollment-windowsautopilotsettings.md)|The Windows autopilot account settings.| |windowsAutopilotDeviceIdentities|[windowsAutopilotDeviceIdentity](../resources/intune-enrollment-windowsautopilotdeviceidentity.md) collection|The Windows autopilot device identities contained collection.|-|windowsAutopilotDeploymentProfiles|[windowsAutopilotDeploymentProfile](../resources/intune-enrollment-windowsautopilotdeploymentprofile.md) collection|Windows auto pilot deployment profiles| +|windowsAutopilotDeploymentProfiles|[windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md) collection|Windows auto pilot deployment profiles| |importedDeviceIdentities|[importedDeviceIdentity](../resources/intune-enrollment-importeddeviceidentity.md) collection|The imported device identities.| |depOnboardingSettings|[depOnboardingSetting](../resources/intune-enrollment-deponboardingsetting.md) collection|This collections of multiple DEP tokens per-tenant.| |importedWindowsAutopilotDeviceIdentities|[importedWindowsAutopilotDeviceIdentity](../resources/intune-enrollment-importedwindowsautopilotdeviceidentity.md) collection|Collection of imported Windows autopilot devices.| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Enrollment Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-deviceplatformtype.md | Supported platform types. |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.|-|unknownFutureValue|12|Evolvable enumeration sentinel value. Do not use.| +|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 | Namespace: microsoft.graph |:|:|:| |unknown|0|DiscoverySource is Unknown.| |adminImport|2|Device is imported by admin.|-|deviceEnrollmentProgram|4|Device is added by Apple device enrollment program (Dep).| +|deviceEnrollmentProgram|4|Device is added by Apple device enrollment program (Dep).| |
v1.0 | Intune Enrollment Enrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-enrollmentprofile.md | Here is a JSON representation of the resource. "enableAuthenticationViaCompanyPortal": true, "requireCompanyPortalOnSetupAssistantEnrolledDevices": true }-``` +``` |
v1.0 | Intune Enrollment Enrollmentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-enrollmentstate.md | Namespace: microsoft.graph |pendingReset|2|Enrolled but it's enrolled via enrollment profile and the enrolled profile is different from the assigned profile.| |failed|3|Not enrolled and there is enrollment failure record.| |notContacted|4|Device is imported but not enrolled.|-|blocked|5|Device is enrolled as userless, but is blocked from moving to user enrollment because the app failed to install.| +|blocked|5|Device is enrolled as userless, but is blocked from moving to user enrollment because the app failed to install.| |
v1.0 | Intune Enrollment Importedappledeviceidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedappledeviceidentity.md | Here is a JSON representation of the resource. "enrollmentState": "String", "platform": "String" }-``` +``` |
v1.0 | Intune Enrollment Importedappledeviceidentityresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedappledeviceidentityresult.md | Here is a JSON representation of the resource. "platform": "String", "status": true }-``` +``` |
v1.0 | Intune Enrollment Importeddeviceidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importeddeviceidentity.md | Here is a JSON representation of the resource. "enrollmentState": "String", "platform": "String" }-``` +``` |
v1.0 | Intune Enrollment Importeddeviceidentityresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importeddeviceidentityresult.md | Here is a JSON representation of the resource. "platform": "String", "status": true }-``` +``` |
v1.0 | Intune Enrollment Importeddeviceidentitytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importeddeviceidentitytype.md | Namespace: microsoft.graph |unknown|0|Unknown value of importedDeviceIdentityType.| |imei|1|Device Identity is of type imei.| |serialNumber|2|Device Identity is of type serial number.|-|manufacturerModelSerial|3|Device Identity is of type manufacturer + model + serial number semi-colon delimited tuple with enforced order.| +|manufacturerModelSerial|3|Device Identity is of type manufacturer + model + serial number semi-colon delimited tuple with enforced order.| |
v1.0 | Intune Enrollment Importedwindowsautopilotdeviceidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedwindowsautopilotdeviceidentity.md | Here is a JSON representation of the resource. }, "assignedUserPrincipalName": "String" }-``` +``` |
v1.0 | Intune Enrollment Importedwindowsautopilotdeviceidentityimportstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedwindowsautopilotdeviceidentityimportstatus.md | Namespace: microsoft.graph |pending|1|Pending status.| |partial|2|Partial status.| |complete|3|Complete status.|-|error|4|Error status.| +|error|4|Error status.| |
v1.0 | Intune Enrollment Importedwindowsautopilotdeviceidentitystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedwindowsautopilotdeviceidentitystate.md | Here is a JSON representation of the resource. "deviceErrorCode": 1024, "deviceErrorName": "String" }-``` +``` |
v1.0 | Intune Enrollment Importedwindowsautopilotdeviceidentityuploadstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedwindowsautopilotdeviceidentityuploadstatus.md | Namespace: microsoft.graph |noUpload|0|No upload status.| |pending|1|Pending status.| |complete|2|Complete status.|-|error|3|Error status.| +|error|3|Error status.| |
v1.0 | Intune Enrollment Itunespairingmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-itunespairingmode.md | Namespace: microsoft.graph |:|:|:| |disallow|0|Pairing is not allowed| |allow|1|Pairing allowed|-|requiresCertificate|2|Certificate required to pair with iTunes| +|requiresCertificate|2|Certificate required to pair with iTunes| |
v1.0 | Intune Enrollment Managementcertificatewiththumbprint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-managementcertificatewiththumbprint.md | Here is a JSON representation of the resource. "thumbprint": "String", "certificate": "String" }-``` +``` |
v1.0 | Intune Enrollment Outofboxexperiencesetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-outofboxexperiencesetting.md | + + Title: "outOfBoxExperienceSetting resource type" +description: "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." ++localization_priority: Normal ++++# 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 +|Property|Type|Description| +|:|:|:| +|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`.| +|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`.| +|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.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "String", + "deviceUsageType": "String", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true +} +``` |
v1.0 | Intune Enrollment Outofboxexperiencesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-outofboxexperiencesettings.md | Title: "outOfBoxExperienceSettings resource type" -description: "Out of box experience setting" +description: "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." localization_priority: Normal 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. -Out of box experience setting +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 |Property|Type|Description| Here is a JSON representation of the resource. "skipKeyboardSelectionPage": true, "hideEscapeLink": true }-``` +``` |
v1.0 | Intune Enrollment Platform | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-platform.md | Namespace: microsoft.graph |android|2|Android device platform| |windows|3|Windows device platform| |windowsMobile|4|WindowsMobile device platform|-|macOS|5|Mac device platform| +|macOS|5|Mac device platform| |
v1.0 | Intune Enrollment Suggestedenrollmentlimit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-suggestedenrollmentlimit.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.suggestedEnrollmentLimit", "suggestedDailyLimit": 1024 }-``` +``` |
v1.0 | Intune Enrollment Windowsautopilotdeploymentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdeploymentprofile.md | Windows Autopilot Deployment Profile ## Methods |Method|Return Type|Description| |:|:|:|-|[Get windowsAutopilotDeploymentProfile](../api/intune-enrollment-windowsautopilotdeploymentprofile-get.md)|[windowsAutopilotDeploymentProfile](../resources/intune-enrollment-windowsautopilotdeploymentprofile.md)|Read properties and relationships of the [windowsAutopilotDeploymentProfile](../resources/intune-enrollment-windowsautopilotdeploymentprofile.md) object.| +|[Get windowsAutopilotDeploymentProfile](../api/intune-enrollment-windowsautopilotdeploymentprofile-get.md)|[windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md)|Read properties and relationships of the [windowsAutopilotDeploymentProfile](../resources/intune-shared-windowsautopilotdeploymentprofile.md) object.| |[assign action](../api/intune-enrollment-windowsautopilotdeploymentprofile-assign.md)|None|| ## Properties |Property|Type|Description| |:|:|:| |id|String|Profile Key|-|displayName|String|Name of the profile| -|description|String|Description of the profile| -|language|String|Language configured on the device| -|createdDateTime|DateTimeOffset|Profile creation time| -|lastModifiedDateTime|DateTimeOffset|Profile last modified time| -|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|Out of box experience setting| +|displayName|String|The display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported.| +|description|String|A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported.| +|language|String|The language code to be used when configuring the device. E.g. en-US. The default value is os-default. 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 locale instead.| +|locale|String|The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.| +|createdDateTime|DateTimeOffset|The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only.| +|lastModifiedDateTime|DateTimeOffset|The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. 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 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only.| +|outOfBoxExperienceSettings|[outOfBoxExperienceSettings](../resources/intune-enrollment-outofboxexperiencesettings.md)|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.| +|outOfBoxExperienceSetting|[outOfBoxExperienceSetting](../resources/intune-enrollment-outofboxexperiencesetting.md)|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.| |enrollmentStatusScreenSettings|[windowsEnrollmentStatusScreenSettings](../resources/intune-enrollment-windowsenrollmentstatusscreensettings.md)|Enrollment status screen setting|-|extractHardwareHash|Boolean|HardwareHash Extraction for the profile| -|deviceNameTemplate|String|The template used to name the AutoPilot Device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters.| -|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The AutoPilot device type that this profile is applicable to. Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| -|enableWhiteGlove|Boolean|Enable Autopilot White Glove for the profile.| -|roleScopeTagIds|String collection|Scope tags for the profile.| -|managementServiceAppId|String|AzureAD management app ID used during client device-based enrollment discovery| +|extractHardwareHash|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. 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 hardwareHashExtractionEnabled instead.| +|hardwareHashExtractionEnabled|Boolean|Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.| +|deviceNameTemplate|String|The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.| +|deviceType|[windowsAutopilotDeviceType](../resources/intune-enrollment-windowsautopilotdevicetype.md)|The Windows device type that this profile is applicable to. Possible values include windowsPc, holoLens, and virtualMachine. The default is windowsPc. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Possible values are: `windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`.| +|enableWhiteGlove|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead.| +|preprovisioningAllowed|Boolean|Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE.| +|roleScopeTagIds|String collection|List of role scope tags for the deployment profile. | +|managementServiceAppId|String|The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.| ## Relationships |Relationship|Type|Description| Here is a JSON representation of the resource. "displayName": "String", "description": "String", "language": "String",+ "locale": "String", "createdDateTime": "String (timestamp)", "lastModifiedDateTime": "String (timestamp)", "outOfBoxExperienceSettings": { Here is a JSON representation of the resource. "skipKeyboardSelectionPage": true, "hideEscapeLink": true },+ "outOfBoxExperienceSetting": { + "@odata.type": "microsoft.graph.outOfBoxExperienceSetting", + "privacySettingsHidden": true, + "eulaHidden": true, + "userType": "String", + "deviceUsageType": "String", + "keyboardSelectionPageSkipped": true, + "escapeLinkHidden": true + }, "enrollmentStatusScreenSettings": { "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings", "hideInstallationProgress": true, Here is a JSON representation of the resource. "allowDeviceUseOnInstallFailure": true }, "extractHardwareHash": true,+ "hardwareHashExtractionEnabled": true, "deviceNameTemplate": "String", "deviceType": "String", "enableWhiteGlove": true,+ "preprovisioningAllowed": true, "roleScopeTagIds": [ "String" ], "managementServiceAppId": "String" }-``` +``` |
v1.0 | Intune Enrollment Windowsautopilotdeploymentprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdeploymentprofileassignment.md | Here is a JSON representation of the resource. "source": "String", "sourceId": "String" }-``` +``` |
v1.0 | Intune Enrollment Windowsautopilotdevicedeletionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdevicedeletionstate.md | Namespace: microsoft.graph |unknown|0|Unknown status.| |failed|1|Request failed status.| |accepted|2|Request accepted status.|-|error|3|Error status.| +|error|3|Error status.| |
v1.0 | Intune Enrollment Windowsautopilotdeviceidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdeviceidentity.md | Here is a JSON representation of the resource. "remediationStateLastModifiedDateTime": "String (timestamp)", "userlessEnrollmentStatus": "String" }-``` +``` |
v1.0 | Intune Enrollment Windowsautopilotdeviceremediationstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdeviceremediationstate.md | Device remediation status, indicating whether or not hardware has been changed f |noRemediationRequired|1|No hardware change has been detected.| |automaticRemediationRequired|2|Hardware change detected on client. Additional remediation is required.| |manualRemediationRequired|3|Hardware change detected on client that could not resolved automatically. Additional remediation is required.|-|unknownFutureValue|4|Marks the end of known enum values, and allows for additional values in the future.| +|unknownFutureValue|4|Marks the end of known enum values, and allows for additional values in the future.| |
v1.0 | Intune Enrollment Windowsautopilotdevicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdevicetype.md | Namespace: microsoft.graph |holoLens|2|HoloLens| |surfaceHub2S|3|SurfaceHub2S| |virtualMachine|4|VirtualMachine|-|unknownFutureValue|99|Placeholder for evolvable enum, but this enum is never returned to the caller, so it shouldn't be necessary. | +|unknownFutureValue|99|Placeholder for evolvable enum, but this enum is never returned to the caller, so it shouldn't be necessary. | |
v1.0 | Intune Enrollment Windowsautopilotprofileassignmentdetailedstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotprofileassignmentdetailedstatus.md | Namespace: microsoft.graph |holoLensProfileNotSupported|3|Indicates that a HoloLens AutoPilot Profile is assigned to a device that is not HoloLens.| |windowsPcProfileNotSupported|4|Indicates that a Windows PC AutoPilot Profile is assigned to a device that is not Windows PC.| |surfaceHub2SProfileNotSupported|5|Indicates that a surface Hub 2S AutoPilot Profile is assigned to a device that is not surface Hub 2S.|-|unknownFutureValue|99|Placeholder for evolvable enum, but this enum is never returned to the caller, so it shouldn't be necessary.| +|unknownFutureValue|99|Placeholder for evolvable enum, but this enum is never returned to the caller, so it shouldn't be necessary.| |
v1.0 | Intune Enrollment Windowsautopilotprofileassignmentstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotprofileassignmentstatus.md | Namespace: microsoft.graph |assignedUnkownSyncState|3|Assigned successfully in Intune and either in-sync or out of sync with Windows auto pilot program| |notAssigned|4|Not assigned| |pending|5|Pending assignment|-|failed|6| Assignment failed| +|failed|6| Assignment failed| |
v1.0 | Intune Enrollment Windowsautopilotsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotsettings.md | Here is a JSON representation of the resource. "lastManualSyncTriggerDateTime": "String (timestamp)", "syncStatus": "String" }-``` +``` |
v1.0 | Intune Enrollment Windowsautopilotsyncstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotsyncstatus.md | Namespace: microsoft.graph |unknown|0|Unknown sync status| |inProgress|1|Sync is in progress| |completed|2|Sync completed.|-|failed|3|Sync failed.| +|failed|3|Sync failed.| |
v1.0 | Intune Enrollment Windowsautopilotuserlessenrollmentstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotuserlessenrollmentstatus.md | Userless enrollment block status, indicating whether the next device enrollment |unknown|0|Unknown userless enrollment block status. Next userless enrollment may fail. This is the default value.| |allowed|1|Indicates next userless enrollment can proceed.| |blocked|2|Indicates next userless enrollment cannot proceed without resetting the windowsAutopilotUserlessEnrollmentStatus.|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Enrollment Windowsdeviceusagetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsdeviceusagetype.md | Namespace: microsoft.graph |Member|Value|Description| |:|:|:| |singleUser|0|Single User Device Type|-|shared|1|Shared Device Type| +|shared|1|Shared Device Type| |
v1.0 | Intune Enrollment Windowsdomainjoinconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsdomainjoinconfiguration.md | Namespace: microsoft.graph ## Methods |Method|Return Type|Description| |:|:|:|-|[Get windowsDomainJoinConfiguration](../api/intune-enrollment-windowsdomainjoinconfiguration-get.md)|[windowsDomainJoinConfiguration](../resources/intune-enrollment-windowsdomainjoinconfiguration.md)|Read properties and relationships of the [windowsDomainJoinConfiguration](../resources/intune-enrollment-windowsdomainjoinconfiguration.md) object.| -|[Update windowsDomainJoinConfiguration](../api/intune-enrollment-windowsdomainjoinconfiguration-update.md)|[windowsDomainJoinConfiguration](../resources/intune-enrollment-windowsdomainjoinconfiguration.md)|Update the properties of a [windowsDomainJoinConfiguration](../resources/intune-enrollment-windowsdomainjoinconfiguration.md) object.| +|[Get windowsDomainJoinConfiguration](../api/intune-enrollment-windowsdomainjoinconfiguration-get.md)|[windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md)|Read properties and relationships of the [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object.| +|[Update windowsDomainJoinConfiguration](../api/intune-enrollment-windowsdomainjoinconfiguration-update.md)|[windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md)|Update the properties of a [windowsDomainJoinConfiguration](../resources/intune-shared-windowsdomainjoinconfiguration.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.windowsDomainJoinConfiguration" }-``` +``` |
v1.0 | Intune Enrollment Windowsenrollmentstatusscreensettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsenrollmentstatusscreensettings.md | Here is a JSON representation of the resource. "installProgressTimeoutInMinutes": 1024, "allowDeviceUseOnInstallFailure": true }-``` +``` |
v1.0 | Intune Enrollment Windowsusertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsusertype.md | Namespace: microsoft.graph |Member|Value|Description| |:|:|:| |administrator|0||-|standard|1|| +|standard|1|| |
v1.0 | Intune Epmgraphapiservice Applicationdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-epmgraphapiservice-applicationdetail.md | Here is a JSON representation of the resource. "productInternalName": "String", "productVersion": "String" }-``` +``` |
v1.0 | Intune Epmgraphapiservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-epmgraphapiservice-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-epmgraphapiservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-epmgraphapiservice-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-epmgraphapiservice-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-epmgraphapiservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-epmgraphapiservice-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-epmgraphapiservice-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-epmgraphapiservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-epmgraphapiservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Epmgraphapiservice Elevationrequeststate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-epmgraphapiservice-elevationrequeststate.md | Indicates state of elevation request |denied|3|Indicates elevation request has been denied by IT Admin.| |expired|4|Set to expire when Approved for is elapsed or ExpireDate is elapsed, whichever is sooner.| |unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.|-|revoked|6|Set to expire when Approved for is elapsed or ExpireDate is elapsed, whichever is sooner.| +|revoked|6|Set to expire when Approved for is elapsed or ExpireDate is elapsed, whichever is sooner.| |
v1.0 | Intune Epmgraphapiservice Privilegemanagementelevationrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-epmgraphapiservice-privilegemanagementelevationrequest.md | These are elevation approval requests for EPM support arbitrated scenario initia |[getAllElevationRequests action](../api/intune-epmgraphapiservice-privilegemanagementelevationrequest-getallelevationrequests.md)|[privilegeManagementElevationRequest](../resources/intune-epmgraphapiservice-privilegemanagementelevationrequest.md) collection|| |[approve action](../api/intune-epmgraphapiservice-privilegemanagementelevationrequest-approve.md)|[privilegeManagementElevationRequest](../resources/intune-epmgraphapiservice-privilegemanagementelevationrequest.md)|| |[deny action](../api/intune-epmgraphapiservice-privilegemanagementelevationrequest-deny.md)|[privilegeManagementElevationRequest](../resources/intune-epmgraphapiservice-privilegemanagementelevationrequest.md)||+|[revoke action](../api/intune-epmgraphapiservice-privilegemanagementelevationrequest-revoke.md)|[privilegeManagementElevationRequest](../resources/intune-epmgraphapiservice-privilegemanagementelevationrequest.md)|| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "requestExpiryDateTime": "String (timestamp)", "reviewerJustification": "String" }-``` +``` |
v1.0 | Intune Esim Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-esim-devicemanagement-get.md)|[deviceManagement](../resources/intune-esim-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-esim-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-esim-devicemanagement-update.md)|[deviceManagement](../resources/intune-esim-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-esim-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-esim-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-esim-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Esim Embeddedsimactivationcode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-embeddedsimactivationcode.md | Here is a JSON representation of the resource. "matchingIdentifier": "String", "smdpPlusServerAddress": "String" }-``` +``` |
v1.0 | Intune Esim Embeddedsimactivationcodepool | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-embeddedsimactivationcodepool.md | Here is a JSON representation of the resource. ], "activationCodeCount": 1024 }-``` +``` |
v1.0 | Intune Esim Embeddedsimactivationcodepoolassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-embeddedsimactivationcodepoolassignment.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterType": "String" } }-``` +``` |
v1.0 | Intune Esim Embeddedsimdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-embeddedsimdevicestate.md | Here is a JSON representation of the resource. "state": "String", "stateDetails": "String" }-``` +``` |
v1.0 | Intune Esim Embeddedsimdevicestatevalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-embeddedsimdevicestatevalue.md | Describes the various states for an embedded SIM activation code. |deleting|4|Designates that Intune Service is trying to delete the profile from the device.| |error|5|Designates that there is error with this profile.| |deleted|6|Designates that the profile is deleted from the device.|-|removedByUser|7|Designates that the profile is removed from the device by the user| +|removedByUser|7|Designates that the profile is removed from the device by the user| |
v1.0 | Intune Esim Platformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-platformtype.md | Namespace: microsoft.graph |windowsPhone81|5|| |windows81AndLater|6|| |windows10AndLater|7||-|androidWorkProfile|8|| +|androidWorkProfile|8|| |
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 | Here is a JSON representation of the resource. "<Unknown None>" ] }-``` +``` |
v1.0 | Intune Gpanalyticsservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-gpanalyticsservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-gpanalyticsservice-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-gpanalyticsservice-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-gpanalyticsservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-gpanalyticsservice-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-gpanalyticsservice-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-gpanalyticsservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-gpanalyticsservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Gpanalyticsservice Grouppolicymigrationreadiness | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicymigrationreadiness.md | Indicates if the Group Policy Object file is covered and ready for Intune migrat |partial|2|Partial Intune coverage| |complete|3|Complete Intune coverage| |error|4|Error when analyzing coverage|-|notApplicable|5|No Group Policy settings in GPO| +|notApplicable|5|No Group Policy settings in GPO| |
v1.0 | Intune Gpanalyticsservice Grouppolicymigrationreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicymigrationreport.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Gpanalyticsservice Grouppolicyobjectfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicyobjectfile.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Gpanalyticsservice Grouppolicysettingmapping | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicysettingmapping.md | Here is a JSON representation of the resource. "intuneSettingDefinitionId": "String", "admxSettingDefinitionId": "String" }-``` +``` |
v1.0 | Intune Gpanalyticsservice Grouppolicysettingscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicysettingscope.md | Scope of the group policy setting. |:|:|:| |unknown|0|Device scope unknown| |device|1|Device scope|-|user|2|User scope| +|user|2|User scope| |
v1.0 | Intune Gpanalyticsservice Grouppolicysettingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicysettingtype.md | Setting type of the group policy. |registrySettings|24|RegistrySettings setting type| |scheduledTasks|25|ScheduledTasks setting type| |shortcutSettings|26|ShortcutSettings setting type|-|startMenuSettings|27|StartMenuSettings setting type| +|startMenuSettings|27|StartMenuSettings setting type| |
v1.0 | Intune Gpanalyticsservice Mdmsupportedstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-mdmsupportedstate.md | Mdm Support Status of the setting. |unknown|0|Mdm support status of the setting is not known.| |supported|1|Setting is supported.| |unsupported|2|Setting is unsupported.|-|deprecated|3|Setting is depcrecated.| +|deprecated|3|Setting is depcrecated.| |
v1.0 | Intune Gpanalyticsservice Unsupportedgrouppolicyextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-unsupportedgrouppolicyextension.md | Here is a JSON representation of the resource. "extensionType": "String", "nodeName": "String" }-``` +``` |
v1.0 | Intune Graph Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/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.+- 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. |
v1.0 | Intune Grouppolicy Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-grouppolicy-devicemanagement-get.md)|[deviceManagement](../resources/intune-grouppolicy-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-grouppolicy-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-grouppolicy-devicemanagement-update.md)|[deviceManagement](../resources/intune-grouppolicy-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-grouppolicy-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-grouppolicy-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-grouppolicy-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Grouppolicy Devicemanagementreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-devicemanagementreports.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementReports", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicycategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicycategory.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyconfiguration.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyconfigurationassignment.md | Here is a JSON representation of the resource. "entraObjectId": "String" } }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyconfigurationingestiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyconfigurationingestiontype.md | Group Policy Configuration Ingestion Type |custom|1|Indicates policy created have definitions ingested by IT admin with sufficient permissions through custom ingestion process| |builtIn|2|Indicates policy created have definitions ingested through system ingestion process| |mixed|3|Indicated atleast 1 tenant admin & system ingested definitions configured for this policy|-|unknownFutureValue|4|Unknown future enum value| +|unknownFutureValue|4|Unknown future enum value| |
v1.0 | Intune Grouppolicy Grouppolicyconfigurationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyconfigurationtype.md | Group Policy Configuration Type |Member|Value|Description| |:|:|:| |policy|0|The policy type does not tattoo the value, which means the value is removed allowing the original configuration value to be used. The policy type supercedes application configuration setting so the application is always aware of the value. The policy type prevents the user from modifying the value through the application's user interface.|-|preference|1|The preference type does tattoo the value, which means the value is not removed from the registry. The preference type will overwrite the user configured-value and does not retain the previous value. The preference type does not prevent the user from modifying the value through the application's user interface.| +|preference|1|The preference type does tattoo the value, which means the value is not removed from the registry. The preference type will overwrite the user configured-value and does not retain the previous value. The preference type does not prevent the user from modifying the value through the application's user interface.| |
v1.0 | Intune Grouppolicy Grouppolicydefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicydefinition.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicydefinitionclasstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicydefinitionclasstype.md | Group Policy Definition Class Type. |Member|Value|Description| |:|:|:| |user|0|Identifies placement of the policy setting under the user configuration node.|-|machine|1|Identifies placement of the policy setting under the computer configuration node.| +|machine|1|Identifies placement of the policy setting under the computer configuration node.| |
v1.0 | Intune Grouppolicy Grouppolicydefinitionfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicydefinitionfile.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicydefinitionvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicydefinitionvalue.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyoperation.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyoperationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyoperationstatus.md | Type of Group Policy operation status. |unknown|0|Group Policy unknown operation status.| |inProgress|1|Group Policy in progress operation status.| |success|2|Group Policy successful operation status.|-|failed|3|Group Policy failed operation status.| +|failed|3|Group Policy failed operation status.| |
v1.0 | Intune Grouppolicy Grouppolicyoperationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyoperationtype.md | Type of Group Policy operation. |addLanguageFiles|3|Group Policy add new language(ADML) files operation type.| |removeLanguageFiles|4|Group Policy remove language(ADML) files operation type.| |updateLanguageFiles|5|Group Policy update language(ADML) files operation type.|-|remove|6|Group Policy remove uploaded file operation type.| +|remove|6|Group Policy remove uploaded file operation type.| |
v1.0 | Intune Grouppolicy Grouppolicypresentation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentation.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationcheckbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationcheckbox.md | Here is a JSON representation of the resource. "lastModifiedDateTime": "String (timestamp)", "defaultChecked": true }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationcombobox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationcombobox.md | Here is a JSON representation of the resource. "required": true, "maxLength": 1024 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationdecimaltextbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationdecimaltextbox.md | Here is a JSON representation of the resource. "minValue": 1024, "maxValue": 1024 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationdropdownlist | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationdropdownlist.md | Here is a JSON representation of the resource. ], "required": true }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationdropdownlistitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationdropdownlistitem.md | Here is a JSON representation of the resource. "displayName": "String", "value": "String" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationlistbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationlistbox.md | Here is a JSON representation of the resource. "explicitValue": true, "valuePrefix": "String" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationlongdecimaltextbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationlongdecimaltextbox.md | Here is a JSON representation of the resource. "minValue": 1024, "maxValue": 1024 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationmultitextbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationmultitextbox.md | Here is a JSON representation of the resource. "maxLength": 1024, "maxStrings": 1024 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationtext | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationtext.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationtextbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationtextbox.md | Here is a JSON representation of the resource. "required": true, "maxLength": 1024 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvalue.md | Here is a JSON representation of the resource. "createdDateTime": "String (timestamp)", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationvalueboolean | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvalueboolean.md | Here is a JSON representation of the resource. "id": "String (identifier)", "value": true }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationvaluedecimal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvaluedecimal.md | Here is a JSON representation of the resource. "id": "String (identifier)", "value": 1024 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationvaluelist | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvaluelist.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationvaluelongdecimal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvaluelongdecimal.md | Here is a JSON representation of the resource. "id": "String (identifier)", "value": 1024 }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationvaluemultitext | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvaluemultitext.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicypresentationvaluetext | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvaluetext.md | Here is a JSON representation of the resource. "id": "String (identifier)", "value": "String" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicytype.md | Type of Group Policy File or Definition. |Member|Value|Description| |:|:|:| |admxBacked|0|Group Policy administrative templates built-in to the Policy configuration service provider (CSP).|-|admxIngested|1|Group Policy administrative templates installed using the Policy configuration service provider (CSP).| +|admxIngested|1|Group Policy administrative templates installed using the Policy configuration service provider (CSP).| |
v1.0 | Intune Grouppolicy Grouppolicyuploadedcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadedcategory.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyuploadeddefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadeddefinition.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyuploadeddefinitionfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadeddefinitionfile.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyuploadeddefinitionfilestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadeddefinitionfilestatus.md | Type of Group Policy uploaded definition file status. |assigned|3|Group Policy uploaded definition file assigned to policy.| |removalInProgress|4|Group Policy uploaded definition file removal in progress.| |uploadFailed|5|Group Policy uploaded definition file upload failed.|-|removalFailed|6|Group Policy uploaded definition file removal failed.| +|removalFailed|6|Group Policy uploaded definition file removal failed.| |
v1.0 | Intune Grouppolicy Grouppolicyuploadedlanguagefile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadedlanguagefile.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Grouppolicyuploadedpresentation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadedpresentation.md | Here is a JSON representation of the resource. "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Grouppolicy Ingestionsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-ingestionsource.md | Category Ingestion source |unknown|0|Indicates unknown category| |custom|1|Indicates the category is ingested by IT admin with sufficient permissions through custom ingestion process| |builtIn|2|Indicates the category is ingested through system ingestion process|-|unknownFutureValue|3|Unknown future enum value| +|unknownFutureValue|3|Unknown future enum value| |
v1.0 | Intune Grouppolicy Keyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-keyvaluepair.md | Here is a JSON representation of the resource. "name": "String", "value": "String" }-``` +``` |
v1.0 | Intune Mam Androidmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmanagedappprotection.md | Inherits from [targetedManagedAppProtection](../resources/intune-mam-targetedman ## Methods |Method|Return Type|Description| |:|:|:|-|[List androidManagedAppProtections](../api/intune-mam-androidmanagedappprotection-list.md)|[androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) collection|List properties and relationships of the [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) objects.| -|[Get androidManagedAppProtection](../api/intune-mam-androidmanagedappprotection-get.md)|[androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md)|Read properties and relationships of the [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) object.| -|[Create androidManagedAppProtection](../api/intune-mam-androidmanagedappprotection-create.md)|[androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md)|Create a new [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) object.| -|[Delete androidManagedAppProtection](../api/intune-mam-androidmanagedappprotection-delete.md)|None|Deletes a [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md).| -|[Update androidManagedAppProtection](../api/intune-mam-androidmanagedappprotection-update.md)|[androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md)|Update the properties of a [androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) object.| +|[List androidManagedAppProtections](../api/intune-mam-androidmanagedappprotection-list.md)|[androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) collection|List properties and relationships of the [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) objects.| +|[Get androidManagedAppProtection](../api/intune-mam-androidmanagedappprotection-get.md)|[androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md)|Read properties and relationships of the [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) object.| +|[Create androidManagedAppProtection](../api/intune-mam-androidmanagedappprotection-create.md)|[androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md)|Create a new [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) object.| +|[Delete androidManagedAppProtection](../api/intune-mam-androidmanagedappprotection-delete.md)|None|Deletes a [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md).| +|[Update androidManagedAppProtection](../api/intune-mam-androidmanagedappprotection-update.md)|[androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md)|Update the properties of a [androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "messagingRedirectAppPackageId": "String", "messagingRedirectAppDisplayName": "String" }-``` +``` |
v1.0 | Intune Mam Androidmanagedappregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmanagedappregistration.md | Here is a JSON representation of the resource. "version": "String", "patchVersion": "String" }-``` +``` |
v1.0 | Intune Mam Androidmanagedappsafetynetappsverificationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmanagedappsafetynetappsverificationtype.md | An admin enforced Android SafetyNet Device Attestation requirement on a managed |Member|Value|Description| |:|:|:| |none|0|no requirement set|-|enabled|1|require that Android device has SafetyNet Apps Verification enabled| +|enabled|1|require that Android device has SafetyNet Apps Verification enabled| |
v1.0 | Intune Mam Androidmanagedappsafetynetdeviceattestationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmanagedappsafetynetdeviceattestationtype.md | An admin enforced Android SafetyNet Device Attestation requirement on a managed |:|:|:| |none|0|no requirement set| |basicIntegrity|1|require that Android device passes SafetyNet Basic Integrity validation|-|basicIntegrityAndDeviceCertification|2|require that Android device passes SafetyNet Basic Integrity and Device Certification validations| +|basicIntegrityAndDeviceCertification|2|require that Android device passes SafetyNet Basic Integrity and Device Certification validations| |
v1.0 | Intune Mam Androidmanagedappsafetynetevaluationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmanagedappsafetynetevaluationtype.md | An admin enforced Android SafetyNet evaluation type requirement on a managed app |Member|Value|Description| |:|:|:| |basic|0|Require basic evaluation|-|hardwareBacked|1|Require hardware backed evaluation| +|hardwareBacked|1|Require hardware backed evaluation| |
v1.0 | Intune Mam Androidmobileappidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmobileappidentifier.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.androidMobileAppIdentifier", "packageId": "String" }-``` +``` |
v1.0 | Intune Mam Appmanagementlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-appmanagementlevel.md | Management levels for apps |androidEnterpriseDedicatedDevicesWithAzureAdSharedMode|8|Android Enterprise dedicated devices with Azure AD Shared mode| |androidOpenSourceProjectUserAssociated|16|Android Open Source Project (AOSP) devices| |androidOpenSourceProjectUserless|32|Android Open Source Project (AOSP) userless devices|-|unknownFutureValue|64|Place holder for evolvable enum| +|unknownFutureValue|64|Place holder for evolvable enum| |
v1.0 | Intune Mam Conceptual | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-conceptual.md | Microsoft Intune app protection policies help protect your company data and prev You can use Intune app protection policies to help protect your companyΓÇÖs data. Because Intune app protection policies can be used independent of any mobile-device management (MDM) solution, you can use it to protect your companyΓÇÖs data with or without enrolling devices in a device management solution. By implementing app-level policies, you can restrict access to company resources and keep data within the purview of your IT department. -Use Graph resources to manage app protection polices in Intune. See the table of content for a list of resources. +Use Graph resources to manage app protection polices in Intune. See the table of content for a list of resources. |
v1.0 | Intune Mam Defaultmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-defaultmanagedappprotection.md | Here is a JSON representation of the resource. "messagingRedirectAppDisplayName": "String", "messagingRedirectAppPackageId": "String" }-``` +``` |
v1.0 | Intune Mam Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-deviceappmanagement.md | Device app management singleton entity. |Relationship|Type|Description| |:|:|:| |managedAppPolicies|[managedAppPolicy](../resources/intune-mam-managedapppolicy.md) collection|Managed app policies.|-|iosManagedAppProtections|[iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) collection|iOS managed app policies.| -|androidManagedAppProtections|[androidManagedAppProtection](../resources/intune-mam-androidmanagedappprotection.md) collection|Android managed app policies.| +|iosManagedAppProtections|[iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) collection|iOS managed app policies.| +|androidManagedAppProtections|[androidManagedAppProtection](../resources/intune-shared-androidmanagedappprotection.md) collection|Android managed app policies.| |windowsManagedAppProtections|[windowsManagedAppProtection](../resources/intune-mam-windowsmanagedappprotection.md) collection|Windows managed app policies.| |defaultManagedAppProtections|[defaultManagedAppProtection](../resources/intune-mam-defaultmanagedappprotection.md) collection|Default managed app policies.|-|targetedManagedAppConfigurations|[targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) collection|Targeted managed app configurations.| -|mdmWindowsInformationProtectionPolicies|[mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) collection|Windows information protection for apps running on devices which are MDM enrolled.| +|targetedManagedAppConfigurations|[targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) collection|Targeted managed app configurations.| +|mdmWindowsInformationProtectionPolicies|[mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) collection|Windows information protection for apps running on devices which are MDM enrolled.| |windowsInformationProtectionPolicies|[windowsInformationProtectionPolicy](../resources/intune-mam-windowsinformationprotectionpolicy.md) collection|Windows information protection for apps running on devices which are not MDM enrolled.| |managedAppRegistrations|[managedAppRegistration](../resources/intune-mam-managedappregistration.md) collection|The managed app registrations.| |managedAppStatuses|[managedAppStatus](../resources/intune-mam-managedappstatus.md) collection|The managed app statuses.| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceAppManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Mam Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-mam-devicemanagement-get.md)|[deviceManagement](../resources/intune-mam-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-mam-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-mam-devicemanagement-update.md)|[deviceManagement](../resources/intune-mam-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-mam-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-mam-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-mam-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettingcollectiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationchoicesettingcollectiondefinition.md | Here is a JSON representation of the resource. "maximumCount": 1024, "minimumCount": 1024 }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationchoicesettingcollectioninstance.md | Inherits from [deviceManagementConfigurationSettingInstance](../resources/intune |:|:|:| |settingDefinitionId|String|Setting Definition Id Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)| |settingInstanceTemplateReference|[deviceManagementConfigurationSettingInstanceTemplateReference](../resources/intune-shared-devicemanagementconfigurationsettinginstancetemplatereference.md)|Setting Instance Template Reference Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)|-|choiceSettingCollectionValue|[deviceManagementConfigurationChoiceSettingValue](../resources/intune-mam-devicemanagementconfigurationchoicesettingvalue.md) collection|Choice setting collection value| +|choiceSettingCollectionValue|[deviceManagementConfigurationChoiceSettingValue](../resources/intune-shared-devicemanagementconfigurationchoicesettingvalue.md) collection|Choice setting collection value| ## Relationships None Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationchoicesettinginstance.md | Inherits from [deviceManagementConfigurationSettingInstance](../resources/intune |:|:|:| |settingDefinitionId|String|Setting Definition Id Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)| |settingInstanceTemplateReference|[deviceManagementConfigurationSettingInstanceTemplateReference](../resources/intune-shared-devicemanagementconfigurationsettinginstancetemplatereference.md)|Setting Instance Template Reference Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)|-|choiceSettingValue|[deviceManagementConfigurationChoiceSettingValue](../resources/intune-mam-devicemanagementconfigurationchoicesettingvalue.md)|Choice setting value| +|choiceSettingValue|[deviceManagementConfigurationChoiceSettingValue](../resources/intune-shared-devicemanagementconfigurationchoicesettingvalue.md)|Choice setting value| ## Relationships None Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationchoicesettingvalue.md | Namespace: microsoft.graph Setting value -Inherits from [deviceManagementConfigurationSettingValue](../resources/intune-mam-devicemanagementconfigurationsettingvalue.md) +Inherits from [deviceManagementConfigurationSettingValue](../resources/intune-shared-devicemanagementconfigurationsettingvalue.md) ## Properties |Property|Type|Description| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationexchangeonlinesettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationexchangeonlinesettingapplicability.md | Namespace: microsoft.graph Applicability for an Exchange Online Setting -Inherits from [deviceManagementConfigurationSettingApplicability](../resources/intune-mam-devicemanagementconfigurationsettingapplicability.md) +Inherits from [deviceManagementConfigurationSettingApplicability](../resources/intune-shared-devicemanagementconfigurationsettingapplicability.md) ## Properties |Property|Type|Description| |:|:|:|-|description|String|description of the setting Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-mam-devicemanagementconfigurationsettingapplicability.md)| -|platform|[deviceManagementConfigurationPlatforms](../resources/intune-shared-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-mam-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|deviceMode|[deviceManagementConfigurationDeviceMode](../resources/intune-shared-devicemanagementconfigurationdevicemode.md)|Device Mode that setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-mam-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `kiosk`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-mam-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-mam-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `linuxMdm`, `unknownFutureValue`.| +|description|String|description of the setting Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-shared-devicemanagementconfigurationsettingapplicability.md)| +|platform|[deviceManagementConfigurationPlatforms](../resources/intune-shared-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-shared-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| +|deviceMode|[deviceManagementConfigurationDeviceMode](../resources/intune-shared-devicemanagementconfigurationdevicemode.md)|Device Mode that setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-shared-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `kiosk`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-shared-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-shared-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `linuxMdm`, `unknownFutureValue`.| ## Relationships None Here is a JSON representation of the resource. "deviceMode": "String", "technologies": "String" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationgroupsettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationgroupsettingcollectioninstance.md | Inherits from [deviceManagementConfigurationSettingInstance](../resources/intune |:|:|:| |settingDefinitionId|String|Setting Definition Id Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)| |settingInstanceTemplateReference|[deviceManagementConfigurationSettingInstanceTemplateReference](../resources/intune-shared-devicemanagementconfigurationsettinginstancetemplatereference.md)|Setting Instance Template Reference Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)|-|groupSettingCollectionValue|[deviceManagementConfigurationGroupSettingValue](../resources/intune-mam-devicemanagementconfigurationgroupsettingvalue.md) collection|A collection of GroupSetting values| +|groupSettingCollectionValue|[deviceManagementConfigurationGroupSettingValue](../resources/intune-shared-devicemanagementconfigurationgroupsettingvalue.md) collection|A collection of GroupSetting values| ## Relationships None Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationgroupsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationgroupsettinginstance.md | Inherits from [deviceManagementConfigurationSettingInstance](../resources/intune |:|:|:| |settingDefinitionId|String|Setting Definition Id Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)| |settingInstanceTemplateReference|[deviceManagementConfigurationSettingInstanceTemplateReference](../resources/intune-shared-devicemanagementconfigurationsettinginstancetemplatereference.md)|Setting Instance Template Reference Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)|-|groupSettingValue|[deviceManagementConfigurationGroupSettingValue](../resources/intune-mam-devicemanagementconfigurationgroupsettingvalue.md)|GroupSetting value| +|groupSettingValue|[deviceManagementConfigurationGroupSettingValue](../resources/intune-shared-devicemanagementconfigurationgroupsettingvalue.md)|GroupSetting value| ## Relationships None Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationgroupsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationgroupsettingvalue.md | Namespace: microsoft.graph Value of the GroupSetting -Inherits from [deviceManagementConfigurationSettingValue](../resources/intune-mam-devicemanagementconfigurationsettingvalue.md) +Inherits from [deviceManagementConfigurationSettingValue](../resources/intune-shared-devicemanagementconfigurationsettingvalue.md) ## Properties |Property|Type|Description| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsetting.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementConfigurationSetting" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsettingapplicability.md | Not yet documented |description|String|description of the setting| |platform|[deviceManagementConfigurationPlatforms](../resources/intune-shared-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| |deviceMode|[deviceManagementConfigurationDeviceMode](../resources/intune-shared-devicemanagementconfigurationdevicemode.md)|Device Mode that setting can be applied on. Possible values are: `none`, `kiosk`.|-|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-mam-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `linuxMdm`, `unknownFutureValue`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-shared-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `linuxMdm`, `unknownFutureValue`.| ## Relationships None Here is a JSON representation of the resource. "deviceMode": "String", "technologies": "String" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsettinggroupcollectiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsettinggroupcollectiondefinition.md | Here is a JSON representation of the resource. "maximumCount": 1024, "minimumCount": 1024 }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettingcollectiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsimplesettingcollectiondefinition.md | Here is a JSON representation of the resource. "maximumCount": 1024, "minimumCount": 1024 }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsimplesettingcollectioninstance.md | Inherits from [deviceManagementConfigurationSettingInstance](../resources/intune |:|:|:| |settingDefinitionId|String|Setting Definition Id Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)| |settingInstanceTemplateReference|[deviceManagementConfigurationSettingInstanceTemplateReference](../resources/intune-shared-devicemanagementconfigurationsettinginstancetemplatereference.md)|Setting Instance Template Reference Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)|-|simpleSettingCollectionValue|[deviceManagementConfigurationSimpleSettingValue](../resources/intune-mam-devicemanagementconfigurationsimplesettingvalue.md) collection|Simple setting collection instance value| +|simpleSettingCollectionValue|[deviceManagementConfigurationSimpleSettingValue](../resources/intune-shared-devicemanagementconfigurationsimplesettingvalue.md) collection|Simple setting collection instance value| ## Relationships None Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsimplesettinginstance.md | Inherits from [deviceManagementConfigurationSettingInstance](../resources/intune |:|:|:| |settingDefinitionId|String|Setting Definition Id Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)| |settingInstanceTemplateReference|[deviceManagementConfigurationSettingInstanceTemplateReference](../resources/intune-shared-devicemanagementconfigurationsettinginstancetemplatereference.md)|Setting Instance Template Reference Inherited from [deviceManagementConfigurationSettingInstance](../resources/intune-shared-devicemanagementconfigurationsettinginstance.md)|-|simpleSettingValue|[deviceManagementConfigurationSimpleSettingValue](../resources/intune-mam-devicemanagementconfigurationsimplesettingvalue.md)|Simple setting instance value| +|simpleSettingValue|[deviceManagementConfigurationSimpleSettingValue](../resources/intune-shared-devicemanagementconfigurationsimplesettingvalue.md)|Simple setting instance value| ## Relationships None Here is a JSON representation of the resource. "@odata.type": "microsoft.graph.deviceManagementConfigurationSimpleSettingValue" } }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsimplesettingvalue.md | Namespace: microsoft.graph Simple setting value -Inherits from [deviceManagementConfigurationSettingValue](../resources/intune-mam-devicemanagementconfigurationsettingvalue.md) +Inherits from [deviceManagementConfigurationSettingValue](../resources/intune-shared-devicemanagementconfigurationsettingvalue.md) ## Properties |Property|Type|Description| Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementConfigurationSimpleSettingValue" }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationstringformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationstringformat.md | Not yet documented |regEx|11|Not yet documented| |json|12|Not yet documented| |dateTime|13|Not yet documented|-|surfaceHub|14|Not yet documented| +|surfaceHub|14|Not yet documented| |
v1.0 | Intune Mam Devicemanagementconfigurationstringsettingvaluedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationstringsettingvaluedefinition.md | Inherits from [deviceManagementConfigurationSettingValueDefinition](../resources ## Properties |Property|Type|Description| |:|:|:|-|format|[deviceManagementConfigurationStringFormat](../resources/intune-mam-devicemanagementconfigurationstringformat.md)|Pre-defined format of the string. Possible values are: `none`, `email`, `guid`, `ip`, `base64`, `url`, `version`, `xml`, `date`, `time`, `binary`, `regEx`, `json`, `dateTime`, `surfaceHub`.| +|format|[deviceManagementConfigurationStringFormat](../resources/intune-shared-devicemanagementconfigurationstringformat.md)|Pre-defined format of the string. Possible values are: `none`, `email`, `guid`, `ip`, `base64`, `url`, `version`, `xml`, `date`, `time`, `binary`, `regEx`, `json`, `dateTime`, `surfaceHub`.| |inputValidationSchema|String|Regular expression or any xml or json schema that the input string should match| |maximumLength|Int64|Maximum length of string| |minimumLength|Int64|Minimum length of string| Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Mam Devicemanagementconfigurationtechnologies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationtechnologies.md | Describes which technology this setting can be deployed with |microsoftSense|128|Setting can be deployed through the SENSE agent channel| |exchangeOnline|256|Setting can be deployed through the Exchange Online agent channel| |linuxMdm|1024|Setting can be deployed through the Linux Mdm channel|-|unknownFutureValue|1073741824|Sentinel member for cases where the client cannot handle the new enum values.| +|unknownFutureValue|1073741824|Sentinel member for cases where the client cannot handle the new enum values.| |
v1.0 | Intune Mam Devicemanagementconfigurationwindowssettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationwindowssettingapplicability.md | Namespace: microsoft.graph Not yet documented -Inherits from [deviceManagementConfigurationSettingApplicability](../resources/intune-mam-devicemanagementconfigurationsettingapplicability.md) +Inherits from [deviceManagementConfigurationSettingApplicability](../resources/intune-shared-devicemanagementconfigurationsettingapplicability.md) ## Properties |Property|Type|Description| |:|:|:|-|description|String|description of the setting Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-mam-devicemanagementconfigurationsettingapplicability.md)| -|platform|[deviceManagementConfigurationPlatforms](../resources/intune-shared-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-mam-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|deviceMode|[deviceManagementConfigurationDeviceMode](../resources/intune-shared-devicemanagementconfigurationdevicemode.md)|Device Mode that setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-mam-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `kiosk`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-mam-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-mam-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `linuxMdm`, `unknownFutureValue`.| +|description|String|description of the setting Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-shared-devicemanagementconfigurationsettingapplicability.md)| +|platform|[deviceManagementConfigurationPlatforms](../resources/intune-shared-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-shared-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| +|deviceMode|[deviceManagementConfigurationDeviceMode](../resources/intune-shared-devicemanagementconfigurationdevicemode.md)|Device Mode that setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-shared-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `kiosk`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-shared-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-shared-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `linuxMdm`, `unknownFutureValue`.| |configurationServiceProviderVersion|String|Version of CSP setting is a part of| |maximumSupportedVersion|String|Maximum supported version of Windows| |minimumSupportedVersion|String|Minimum supported version of Windows| Here is a JSON representation of the resource. "requiresAzureAd": true, "requiredAzureAdTrustType": "String" }-``` +``` |
v1.0 | Intune Mam Devicemanagementreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementreports.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementReports", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Mam Iosmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-iosmanagedappprotection.md | Inherits from [targetedManagedAppProtection](../resources/intune-mam-targetedman ## Methods |Method|Return Type|Description| |:|:|:|-|[List iosManagedAppProtections](../api/intune-mam-iosmanagedappprotection-list.md)|[iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) collection|List properties and relationships of the [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) objects.| -|[Get iosManagedAppProtection](../api/intune-mam-iosmanagedappprotection-get.md)|[iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md)|Read properties and relationships of the [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) object.| -|[Create iosManagedAppProtection](../api/intune-mam-iosmanagedappprotection-create.md)|[iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md)|Create a new [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) object.| -|[Delete iosManagedAppProtection](../api/intune-mam-iosmanagedappprotection-delete.md)|None|Deletes a [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md).| -|[Update iosManagedAppProtection](../api/intune-mam-iosmanagedappprotection-update.md)|[iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md)|Update the properties of a [iosManagedAppProtection](../resources/intune-mam-iosmanagedappprotection.md) object.| +|[List iosManagedAppProtections](../api/intune-mam-iosmanagedappprotection-list.md)|[iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) collection|List properties and relationships of the [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) objects.| +|[Get iosManagedAppProtection](../api/intune-mam-iosmanagedappprotection-get.md)|[iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md)|Read properties and relationships of the [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) object.| +|[Create iosManagedAppProtection](../api/intune-mam-iosmanagedappprotection-create.md)|[iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md)|Create a new [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) object.| +|[Delete iosManagedAppProtection](../api/intune-mam-iosmanagedappprotection-delete.md)|None|Deletes a [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md).| +|[Update iosManagedAppProtection](../api/intune-mam-iosmanagedappprotection-update.md)|[iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md)|Update the properties of a [iosManagedAppProtection](../resources/intune-shared-iosmanagedappprotection.md) object.| ## Properties |Property|Type|Description| Inherits from [targetedManagedAppProtection](../resources/intune-mam-targetedman |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`.| |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.| Here is a JSON representation of the resource. "minimumWipeSdkVersion": "String", "allowedIosDeviceModels": "String", "appActionIfIosDeviceModelNotAllowed": "String",+ "appActionIfAccountIsClockedOut": "String", "thirdPartyKeyboardsBlocked": true, "filterOpenInToOnlyManagedApps": true, "disableProtectionOfManagedOutboundOpenInData": true, Here is a JSON representation of the resource. "minimumWarningSdkVersion": "String", "messagingRedirectAppUrlScheme": "String" }-``` +``` |
v1.0 | Intune Mam Iosmanagedappregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-iosmanagedappregistration.md | Here is a JSON representation of the resource. "id": "String (identifier)", "version": "String" }-``` +``` |
v1.0 | Intune Mam Iosmobileappidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-iosmobileappidentifier.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.iosMobileAppIdentifier", "bundleId": "String" }-``` +``` |
v1.0 | Intune Mam Json | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-json.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.Json" }-``` +``` |
v1.0 | Intune Mam Keyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-keyvaluepair.md | Here is a JSON representation of the resource. "name": "String", "value": "String" }-``` +``` |
v1.0 | Intune Mam Macappidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-macappidentifier.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.macAppIdentifier", "bundleId": "String" }-``` +``` |
v1.0 | Intune Mam Managedappclipboardsharinglevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappclipboardsharinglevel.md | Represents the level to which the device's clipboard may be shared between apps |allApps|0|Sharing is allowed between all apps, managed or not| |managedAppsWithPasteIn|1|Sharing is allowed between all managed apps with paste in enabled| |managedApps|2|Sharing is allowed between all managed apps|-|blocked|3|Sharing between apps is disabled| +|blocked|3|Sharing between apps is disabled| |
v1.0 | Intune Mam Managedappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappconfiguration.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Mam Managedappdataencryptiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdataencryptiontype.md | Represents the level to which app data is encrypted for managed apps |useDeviceSettings|0|App data is encrypted based on the default settings on the device.| |afterDeviceRestart|1|App data is encrypted when the device is restarted.| |whenDeviceLockedExceptOpenFiles|2|App data associated with this policy is encrypted when the device is locked, except data in files that are open|-|whenDeviceLocked|3|App data associated with this policy is encrypted when the device is locked| +|whenDeviceLocked|3|App data associated with this policy is encrypted when the device is locked| |
v1.0 | Intune Mam Managedappdataingestionlocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdataingestionlocation.md | Locations which can be used to bring data into organization documents |oneDriveForBusiness|1|OneDrive for business| |sharePoint|2|SharePoint Online| |camera|3|The device's camera|-|photoLibrary|4|The device's photo library| +|photoLibrary|4|The device's photo library| |
v1.0 | Intune Mam Managedappdatastoragelocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdatastoragelocation.md | Storage locations where managed apps can potentially store their data |sharePoint|2|SharePoint| |box|3|Box| |localStorage|6|Local storage on the device|-|photoLibrary|7|The device's photo library| +|photoLibrary|7|The device's photo library| |
v1.0 | Intune Mam Managedappdatatransferlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdatatransferlevel.md | Data can be transferred from/to these classes of apps |:|:|:| |allApps|0|All apps.| |managedApps|1|Managed apps.|-|none|2|No apps.| +|none|2|No apps.| |
v1.0 | Intune Mam Managedappdevicethreatlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdevicethreatlevel.md | The maxium threat level allowed for an app to be compliant. |secured|1|Device needs to have no threat| |low|2|Device needs to have a low threat.| |medium|3|Device needs to have not more than medium threat.|-|high|4|Device needs to have not more than high threat| +|high|4|Device needs to have not more than high threat| |
v1.0 | Intune Mam Managedappdiagnosticstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdiagnosticstatus.md | Here is a JSON representation of the resource. "state": "String", "mitigationInstruction": "String" }-``` +``` |
v1.0 | Intune Mam Managedappflaggedreason | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappflaggedreason.md | The reason for which a user has been flagged |none|0|No issue.| |rootedDevice|1|The app registration is running on a rooted/unlocked device.| |androidBootloaderUnlocked|2|The app registration is running on an Android device on which the bootloader is unlocked.|-|androidFactoryRomModified|3|The app registration is running on an Android device on which the factory ROM has been modified.| +|androidFactoryRomModified|3|The app registration is running on an Android device on which the factory ROM has been modified.| |
v1.0 | Intune Mam Managedapplogcollectionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapplogcollectionrequest.md | The Managed App log collection response |Property|Type|Description| |:|:|:| |id|String|The unique identifier of the managed app log collection request. This id is assigned during request creation time. Read-only.|-|managedAppRegistrationId|String|The unique identifier of the app instance for which diagnostic was collected.| +|managedAppRegistrationId|String|The unique identifier of the app instance for which diagnostic logs were collected. Read-only.| |status|String|Indicates the status for the app log collection request - pending, completed or failed. Default is pending.|-|requestedBy|String|The user principal name associated with the request for the managed application log collection.| +|requestedBy|String|The user principal name associated with the request for the managed application log collection. Read-only.| +|requestedByUserPrincipalName|String|The user principal name associated with the request for the managed application log collection. Read-only.| |requestedDateTime|DateTimeOffset|DateTime of when the log upload request was received. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.| |completedDateTime|DateTimeOffset|DateTime of when the log upload request was completed. 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 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.|-|userLogUploadConsent|[managedAppLogUploadConsent](../resources/intune-mam-managedapploguploadconsent.md)|Indicates whether the user associated with the device provided consent for the log collection. Possible values are: `default`, `declined`, `accepted`, `unknownFutureValue`.| -|uploadedLogs|[managedAppLogUpload](../resources/intune-mam-managedapplogupload.md) collection|The collection of log upload results as reported by each component on the device. Such components can be the application itself, the Mobile Application Management (MAM) SDK, and other on-device components that are requested to upload diagnostic logs.| +|userLogUploadConsent|[managedAppLogUploadConsent](../resources/intune-mam-managedapploguploadconsent.md)|Indicates whether the user associated with the device provided consent for the log collection. The user must consent before the diagnostic logs can be collected. accepted means the user consented. declined means the user declined. unknown is the default value. The Log Collection Request must be completed within 24 hours or it will be abandoned and deleted. Read-only. Possible values are: `unknown`, `declined`, `accepted`, `unknownFutureValue`.| +|uploadedLogs|[managedAppLogUpload](../resources/intune-mam-managedapplogupload.md) collection|The collection of log upload results as reported by each component on the device. Such components can be the application itself, the Mobile Application Management (MAM) SDK, and other on-device components that are requested to upload diagnostic logs. Read-only.| |version|String|Version of the entity.| ## Relationships Here is a JSON representation of the resource. "managedAppRegistrationId": "String", "status": "String", "requestedBy": "String",+ "requestedByUserPrincipalName": "String", "requestedDateTime": "String (timestamp)", "completedDateTime": "String (timestamp)", "userLogUploadConsent": "String", Here is a JSON representation of the resource. { "@odata.type": "microsoft.graph.managedAppLogUpload", "managedAppComponent": "String",+ "managedAppComponentDescription": "String", "status": "String", "referenceId": "String" } ], "version": "String" }-``` +``` |
v1.0 | Intune Mam Managedapplogupload | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapplogupload.md | A `managedAppLogUpload` represents the log upload result for a given Mobile Appl ## Properties |Property|Type|Description| |:|:|:|-|managedAppComponent|String|The Mobile Application Management (MAM) Logs Uploading Component.| -|status|[managedAppLogUploadState](../resources/intune-mam-managedapploguploadstate.md)|The status of the log upload. Possible values are: `pending`, `partiallyCompleted`, `completed`, `cancelled`, `cancelledByUser`, `timedOut`, `failed`, `unknownFutureValue`.| -|referenceId|String|A provider-specific reference id for the uploaded logs.| +|managedAppComponent|String|The 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. Read-only.| +|managedAppComponentDescription|String|The 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. Read-only.| +|status|[managedAppLogUploadState](../resources/intune-mam-managedapploguploadstate.md)|The status of the log upload. If a result is present, the log collection is complete and the upload status for the component is final. completed is the default value. Read-only. Possible values are: `pending`, `inProgress`, `completed`, `declinedByUser`, `timedOut`, `failed`, `unknownFutureValue`.| +|referenceId|String|A provider-specific reference id for the uploaded logs. Read-only.| ## Relationships None Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.managedAppLogUpload", "managedAppComponent": "String",+ "managedAppComponentDescription": "String", "status": "String", "referenceId": "String" }-``` +``` |
v1.0 | Intune Mam Managedapploguploadconsent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapploguploadconsent.md | Represents the current consent status of the associated `managedAppLogCollection ## Members |Member|Value|Description| |:|:|:|-|default|0|The Default state. This state is automatically assigned at request creation time, and is updated when the User Accepts or Declines the log collection request.| -|declined|1|The User has Declined the Log Collection Request. Log uploads will not occur and the request will be abandoned.| -|accepted|2|The User has Accepted the Log Collection Request. Log uploads will occur.| -|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknown|0|Default. Indicates app log consent state is 'Unknown'. This state is automatically assigned at request creation time and is updated when the log collection completes.| +|declined|1|The User has Declined the Log Collection Request. The Log collection and uploads will not be initiated/triggered, and the log collection request will be abandoned.| +|accepted|2|The User has Accepted the Log Collection Request. The log collection and upload will be initiated.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Mam Managedapploguploadstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapploguploadstate.md | Represents the current status of the associated `managedAppLogCollectionRequest` ## Members |Member|Value|Description| |:|:|:|-|pending|0|The log upload request has been successfully created, and is pending delivery to the Mobile Application Management (MAM) application.| -|partiallyCompleted|1|One or more log upload components have uploaded their logs.| -|completed|2|All log upload successfully components have uploaded their logs| -|cancelled|3|The log upload request was cancelled by the requestor| -|cancelledByUser|4|The log upload request was cancelled by the user on the device| -|timedOut|5|The log upload request was not acknowledged by the user within the allowed time window| -|failed|6|The log upload request encountered an error| -|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use| +|pending|0|Default. The log upload request has been successfully created, and is pending delivery to the Mobile Application Management (MAM) application.| +|inProgress|1|One or more log upload components have uploaded their logs.| +|completed|2|All log upload successfully components have uploaded their logs.| +|declinedByUser|4|The log upload request was declined by the user on the device.| +|timedOut|5|The log upload request was not acknowledged by the user within the allowed time window.| +|failed|6|The log upload request encountered an error.| +|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Mam Managedappnotificationrestriction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappnotificationrestriction.md | Restrict managed app notification |:|:|:| |allow|0|Share all notifications.| |blockOrganizationalData|1|Do not share Orgnizational data in notifications.|-|block|2|Do not share notifications.| +|block|2|Do not share notifications.| |
v1.0 | Intune Mam Managedappoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappoperation.md | Here is a JSON representation of the resource. "id": "String (identifier)", "version": "String" }-``` +``` |
v1.0 | Intune Mam Managedappphonenumberredirectlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappphonenumberredirectlevel.md | The classes of apps that are allowed to click-to-open a phone number, for making |allApps|0|Sharing is allowed to all apps.| |managedApps|1|Sharing is allowed to all managed apps.| |customApp|2|Sharing is allowed to a custom app.|-|blocked|3|Sharing between apps is blocked.| +|blocked|3|Sharing between apps is blocked.| |
v1.0 | Intune Mam Managedapppincharacterset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapppincharacterset.md | Character set which is to be used for a user's app PIN |Member|Value|Description| |:|:|:| |numeric|0|Numeric characters|-|alphanumericAndSymbol|1|Alphanumeric and symbolic characters| +|alphanumericAndSymbol|1|Alphanumeric and symbolic characters| |
v1.0 | Intune Mam Managedapppolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapppolicy.md | Here is a JSON representation of the resource. "id": "String (identifier)", "version": "String" }-``` +``` |
v1.0 | Intune Mam Managedapppolicydeploymentsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapppolicydeploymentsummary.md | Here is a JSON representation of the resource. "id": "String (identifier)", "version": "String" }-``` +``` |
v1.0 | Intune Mam Managedapppolicydeploymentsummaryperapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapppolicydeploymentsummaryperapp.md | Here is a JSON representation of the resource. }, "configurationAppliedUserCount": 1024 }-``` +``` |
v1.0 | Intune Mam Managedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappprotection.md | Here is a JSON representation of the resource. "gracePeriodToBlockAppsDuringOffClockHours": "String (duration)", "protectedMessagingRedirectAppType": "String" }-``` +``` |
v1.0 | Intune Mam Managedappregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappregistration.md | Here is a JSON representation of the resource. "id": "String (identifier)", "version": "String" }-``` +``` |
v1.0 | Intune Mam Managedappremediationaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappremediationaction.md | An admin initiated action to be applied on a managed app. |:|:|:| |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| +|warn|2|app and the corresponding user to be warned| |
v1.0 | Intune Mam Managedappstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappstatus.md | Here is a JSON representation of the resource. "id": "String (identifier)", "version": "String" }-``` +``` |
v1.0 | Intune Mam Managedappstatusraw | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappstatusraw.md | Here is a JSON representation of the resource. "@odata.type": "microsoft.graph.Json" } }-``` +``` |
v1.0 | Intune Mam Managedbrowsertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedbrowsertype.md | Type of managed browser |Member|Value|Description| |:|:|:| |notConfigured|0|Not configured|-|microsoftEdge|1|Microsoft Edge| +|microsoftEdge|1|Microsoft Edge| |
v1.0 | Intune Mam Managedmobileapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedmobileapp.md | Here is a JSON representation of the resource. "id": "String (identifier)", "version": "String" }-``` +``` |
v1.0 | Intune Mam Mdmwindowsinformationprotectionpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-mdmwindowsinformationprotectionpolicy.md | Inherits from [windowsInformationProtection](../resources/intune-mam-windowsinfo ## Methods |Method|Return Type|Description| |:|:|:|-|[List mdmWindowsInformationProtectionPolicies](../api/intune-mam-mdmwindowsinformationprotectionpolicy-list.md)|[mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) collection|List properties and relationships of the [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) objects.| -|[Get mdmWindowsInformationProtectionPolicy](../api/intune-mam-mdmwindowsinformationprotectionpolicy-get.md)|[mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md)|Read properties and relationships of the [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) object.| -|[Create mdmWindowsInformationProtectionPolicy](../api/intune-mam-mdmwindowsinformationprotectionpolicy-create.md)|[mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md)|Create a new [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) object.| -|[Delete mdmWindowsInformationProtectionPolicy](../api/intune-mam-mdmwindowsinformationprotectionpolicy-delete.md)|None|Deletes a [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md).| -|[Update mdmWindowsInformationProtectionPolicy](../api/intune-mam-mdmwindowsinformationprotectionpolicy-update.md)|[mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md)|Update the properties of a [mdmWindowsInformationProtectionPolicy](../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md) object.| +|[List mdmWindowsInformationProtectionPolicies](../api/intune-mam-mdmwindowsinformationprotectionpolicy-list.md)|[mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) collection|List properties and relationships of the [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) objects.| +|[Get mdmWindowsInformationProtectionPolicy](../api/intune-mam-mdmwindowsinformationprotectionpolicy-get.md)|[mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md)|Read properties and relationships of the [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) object.| +|[Create mdmWindowsInformationProtectionPolicy](../api/intune-mam-mdmwindowsinformationprotectionpolicy-create.md)|[mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md)|Create a new [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) object.| +|[Delete mdmWindowsInformationProtectionPolicy](../api/intune-mam-mdmwindowsinformationprotectionpolicy-delete.md)|None|Deletes a [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md).| +|[Update mdmWindowsInformationProtectionPolicy](../api/intune-mam-mdmwindowsinformationprotectionpolicy-update.md)|[mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md)|Update the properties of a [mdmWindowsInformationProtectionPolicy](../resources/intune-shared-mdmwindowsinformationprotectionpolicy.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. ], "isAssigned": true }-``` +``` |
v1.0 | Intune Mam Messagingredirectapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-messagingredirectapptype.md | Defines how app messaging redirection is protected by an App Protection Policy. |anyApp|0|App protection policy will allow messaging redirection to any app.| |anyManagedApp|1|App protection policy will allow messaging redirection to any managed application.| |specificApps|2|App protection policy will allow messaging redirection only to specified applications in related App protection policy settings. See related settings `messagingRedirectAppDisplayName`, `messagingRedirectAppPackageId` and `messagingRedirectAppUrlScheme`.|-|blocked|3|App protection policy will block messaging redirection to any app.| +|blocked|3|App protection policy will block messaging redirection to any app.| |
v1.0 | Intune Mam Mobileappidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-mobileappidentifier.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.mobileAppIdentifier" }-``` +``` |
v1.0 | Intune Mam Mobilethreatdefensepartnerpriority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-mobilethreatdefensepartnerpriority.md | Determines the conflict resolution strategy, when more than one Mobile Threat De |:|:|:| |defenderOverThirdPartyPartner|0|Indicates use of Microsoft Defender Endpoint over 3rd party MTD connectors| |thirdPartyPartnerOverDefender|1|Indicates use of a 3rd party MTD connector over Microsoft Defender Endpoint|-|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Mam Targetedmanagedappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-targetedmanagedappconfiguration.md | Inherits from [managedAppConfiguration](../resources/intune-mam-managedappconfig ## Methods |Method|Return Type|Description| |:|:|:|-|[List targetedManagedAppConfigurations](../api/intune-mam-targetedmanagedappconfiguration-list.md)|[targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) collection|List properties and relationships of the [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) objects.| -|[Get targetedManagedAppConfiguration](../api/intune-mam-targetedmanagedappconfiguration-get.md)|[targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md)|Read properties and relationships of the [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) object.| -|[Create targetedManagedAppConfiguration](../api/intune-mam-targetedmanagedappconfiguration-create.md)|[targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md)|Create a new [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) object.| -|[Delete targetedManagedAppConfiguration](../api/intune-mam-targetedmanagedappconfiguration-delete.md)|None|Deletes a [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md).| -|[Update targetedManagedAppConfiguration](../api/intune-mam-targetedmanagedappconfiguration-update.md)|[targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md)|Update the properties of a [targetedManagedAppConfiguration](../resources/intune-mam-targetedmanagedappconfiguration.md) object.| +|[List targetedManagedAppConfigurations](../api/intune-mam-targetedmanagedappconfiguration-list.md)|[targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) collection|List properties and relationships of the [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) objects.| +|[Get targetedManagedAppConfiguration](../api/intune-mam-targetedmanagedappconfiguration-get.md)|[targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md)|Read properties and relationships of the [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) object.| +|[Create targetedManagedAppConfiguration](../api/intune-mam-targetedmanagedappconfiguration-create.md)|[targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md)|Create a new [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) object.| +|[Delete targetedManagedAppConfiguration](../api/intune-mam-targetedmanagedappconfiguration-delete.md)|None|Deletes a [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md).| +|[Update targetedManagedAppConfiguration](../api/intune-mam-targetedmanagedappconfiguration-update.md)|[targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md)|Update the properties of a [targetedManagedAppConfiguration](../resources/intune-shared-targetedmanagedappconfiguration.md) object.| |[assign action](../api/intune-mam-targetedmanagedappconfiguration-assign.md)|None|| |[changeSettings action](../api/intune-mam-targetedmanagedappconfiguration-changesettings.md)|None|| |[targetApps action](../api/intune-mam-targetedmanagedappconfiguration-targetapps.md)|None|| Here is a JSON representation of the resource. "targetedAppManagementLevels": "String", "appGroupType": "String" }-``` +``` |
v1.0 | Intune Mam Targetedmanagedappgrouptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-targetedmanagedappgrouptype.md | Indicates a collection of apps to target which can be one of several pre-defined |selectedPublicApps|0|Target the collection of apps manually selected by the admin.| |allCoreMicrosoftApps|1|Target the core set of Microsoft apps (Office, Edge, etc).| |allMicrosoftApps|2|Target all apps with Microsoft as publisher.|-|allApps|4|Target all apps with an available assignment.| +|allApps|4|Target all apps with an available assignment.| |
v1.0 | Intune Mam Targetedmanagedapppolicyassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-targetedmanagedapppolicyassignment.md | Here is a JSON representation of the resource. "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 | Here is a JSON representation of the resource. "targetedAppManagementLevels": "String", "appGroupType": "String" }-``` +``` |
v1.0 | Intune Mam User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-user.md | Represents an Azure Active Directory user object. ## Methods |Method|Return Type|Description| |:|:|:|-|[List users](../api/intune-mam-user-list.md)|[user](../resources/intune-mam-user.md) collection|List properties and relationships of the [user](../resources/intune-mam-user.md) objects.| -|[Get user](../api/intune-mam-user-get.md)|[user](../resources/intune-mam-user.md)|Read properties and relationships of the [user](../resources/intune-mam-user.md) object.| -|[Create user](../api/intune-mam-user-create.md)|[user](../resources/intune-mam-user.md)|Create a new [user](../resources/intune-mam-user.md) object.| -|[Delete user](../api/intune-mam-user-delete.md)|None|Deletes a [user](../resources/intune-mam-user.md).| -|[Update user](../api/intune-mam-user-update.md)|[user](../resources/intune-mam-user.md)|Update the properties of a [user](../resources/intune-mam-user.md) object.| +|[List users](../api/intune-mam-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-mam-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-mam-user-create.md)|[user](../resources/intune-shared-user.md)|Create a new [user](../resources/intune-shared-user.md) object.| +|[Delete user](../api/intune-mam-user-delete.md)|None|Deletes a [user](../resources/intune-shared-user.md).| +|[Update user](../api/intune-mam-user-update.md)|[user](../resources/intune-shared-user.md)|Update the properties of a [user](../resources/intune-shared-user.md) object.| |[getManagedAppDiagnosticStatuses function](../api/intune-mam-user-getmanagedappdiagnosticstatuses.md)|[managedAppDiagnosticStatus](../resources/intune-mam-managedappdiagnosticstatus.md) collection|Gets diagnostics validation status for a given user.| |[getManagedAppPolicies function](../api/intune-mam-user-getmanagedapppolicies.md)|[managedAppPolicy](../resources/intune-mam-managedapppolicy.md) collection|Gets app restrictions for a given user.| |[wipeManagedAppRegistrationByDeviceTag action](../api/intune-mam-user-wipemanagedappregistrationbydevicetag.md)|None|Issues a wipe operation on an app registration with specified device tag.| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.user", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Mam Windowsappidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsappidentifier.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsAppIdentifier", "windowsAppId": "String" }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotection.md | Here is a JSON representation of the resource. ], "isAssigned": true }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectionapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionapp.md | Here is a JSON representation of the resource. "productName": "String", "denied": true }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectionapplockerfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionapplockerfile.md | Here is a JSON representation of the resource. "id": "String (identifier)", "version": "String" }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectiondatarecoverycertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectiondatarecoverycertificate.md | Here is a JSON representation of the resource. "expirationDateTime": "String (timestamp)", "certificate": "binary" }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectiondesktopapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectiondesktopapp.md | Here is a JSON representation of the resource. "binaryVersionLow": "String", "binaryVersionHigh": "String" }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectiondeviceregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectiondeviceregistration.md | Here is a JSON representation of the resource. "deviceMacAddress": "String", "lastCheckInDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectionenforcementlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionenforcementlevel.md | Possible values for WIP Protection enforcement levels |noProtection|0|No protection enforcement| |encryptAndAuditOnly|1|Encrypt and Audit only| |encryptAuditAndPrompt|2|Encrypt, Audit and Prompt|-|encryptAuditAndBlock|3|Encrypt, Audit and Block| +|encryptAuditAndBlock|3|Encrypt, Audit and Block| |
v1.0 | Intune Mam Windowsinformationprotectioniprangecollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectioniprangecollection.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectionpincharacterrequirements | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionpincharacterrequirements.md | Pin Character Requirements |:|:|:| |notAllow|0|Not allow| |requireAtLeastOne|1|Require atleast one|-|allow|2|Allow any number| +|allow|2|Allow any number| |
v1.0 | Intune Mam Windowsinformationprotectionpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionpolicy.md | Here is a JSON representation of the resource. "minutesOfInactivityBeforeDeviceLock": 1024, "daysWithoutContactBeforeUnenroll": 1024 }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectionproxieddomaincollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionproxieddomaincollection.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectionresourcecollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionresourcecollection.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectionstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionstoreapp.md | Here is a JSON representation of the resource. "productName": "String", "denied": true }-``` +``` |
v1.0 | Intune Mam Windowsinformationprotectionwipeaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionwipeaction.md | Here is a JSON representation of the resource. "targetedDeviceMacAddress": "String", "lastCheckInDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Mam Windowsmanagedappclipboardsharinglevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsmanagedappclipboardsharinglevel.md | Represents the level to which the device's clipboard may be shared between apps |Member|Value|Description| |:|:|:| |anyDestinationAnySource|0|Org users can paste data from and cut/copy data to any account, document, location or application.|-|none|1|Org users cannot cut, copy or paste data to or from external accounts, documents, locations or applications from or into the org context.| +|none|1|Org users cannot cut, copy or paste data to or from external accounts, documents, locations or applications from or into the org context.| |
v1.0 | Intune Mam Windowsmanagedappdatatransferlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsmanagedappdatatransferlevel.md | Data can be transferred from/to these classes of apps |Member|Value|Description| |:|:|:| |allApps|0|All apps.|-|none|1|No apps.| +|none|1|No apps.| |
v1.0 | Intune Mam Windowsmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsmanagedappprotection.md | Inherits from [managedAppPolicy](../resources/intune-mam-managedapppolicy.md) |:|:|:| |assignments|[targetedManagedAppPolicyAssignment](../resources/intune-mam-targetedmanagedapppolicyassignment.md) collection|Navigation property to list of inclusion and exclusion groups to which the policy is deployed.| |apps|[managedMobileApp](../resources/intune-mam-managedmobileapp.md) collection|List of apps to which the policy is deployed.|+|deploymentSummary|[managedAppPolicyDeploymentSummary](../resources/intune-mam-managedapppolicydeploymentsummary.md)|Navigation property to deployment summary of the configuration.| ## JSON Representation Here is a JSON representation of the resource. Here is a JSON representation of the resource. "periodOfflineBeforeWipeIsEnforced": "String (duration)", "periodOfflineBeforeAccessCheck": "String (duration)" }-``` +``` |
v1.0 | Intune Mam Windowsmanagedappregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsmanagedappregistration.md | Here is a JSON representation of the resource. "id": "String (identifier)", "version": "String" }-``` +``` |
v1.0 | Intune Mstunnel Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-devicemanagement.md | Singleton that acts as container for a collection of Resource Access entities. ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-mstunnel-devicemanagement-get.md)|[deviceManagement](../resources/intune-mstunnel-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-mstunnel-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-mstunnel-devicemanagement-update.md)|[deviceManagement](../resources/intune-mstunnel-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-mstunnel-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-mstunnel-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-mstunnel-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Mstunnel Keyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-keyvaluepair.md | Here is a JSON representation of the resource. "name": "String", "value": "String" }-``` +``` |
v1.0 | Intune Mstunnel Metrictimeseriesdatapoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-metrictimeseriesdatapoint.md | Here is a JSON representation of the resource. "dateTime": "String (timestamp)", "value": 1024 }-``` +``` |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelconfiguration.md | Here is a JSON representation of the resource. ], "disableUdpConnections": true }-``` +``` |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelhealththreshold.md | Here is a JSON representation of the resource. "defaultHealthyThreshold": 1024, "defaultUnhealthyThreshold": 1024 }-``` +``` |
v1.0 | Intune Mstunnel Microsofttunnellogcollectionstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnellogcollectionstatus.md | Enum type that represent the status of log collection |pending|0|Indicates that the log collection is in progress| |completed|1|Indicates that the log collection is completed| |failed|2|Indicates that the log collection has failed|-|unknownFutureValue|3|Placeholder value for future expansion enums| +|unknownFutureValue|3|Placeholder value for future expansion enums| |
v1.0 | Intune Mstunnel Microsofttunnelserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelserver.md | Here is a JSON representation of the resource. "agentImageDigest": "String", "serverImageDigest": "String" }-``` +``` |
v1.0 | Intune Mstunnel Microsofttunnelserverhealthstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelserverhealthstatus.md | Enum of possible MicrosoftTunnelServer health status types |offline|4|Indicates the server state is offline| |upgradeInProgress|5|Indicates the upgrade in progress during the upgrade cycle of when Intune begins upgrading servers, one server at a time| |upgradeFailed|6|Indicates the failure of the upgrade during the upgrade cycle of when Intune begins upgrading servers, one server at a time|-|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use enums.| +|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use enums.| |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md | Here is a JSON representation of the resource. "requestDateTime": "String (timestamp)", "expiryDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Mstunnel Microsofttunnelsite | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelsite.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Notification Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-notification-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-notification-devicemanagement-get.md)|[deviceManagement](../resources/intune-notification-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-notification-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-notification-devicemanagement-update.md)|[deviceManagement](../resources/intune-notification-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-notification-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-notification-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-notification-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Notification Localizednotificationmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-notification-localizednotificationmessage.md | Here is a JSON representation of the resource. "messageTemplate": "String", "isDefault": true }-``` +``` |
v1.0 | Intune Notification Notificationmessagetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-notification-notificationmessagetemplate.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Notification Notificationtemplatebrandingoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-notification-notificationtemplatebrandingoptions.md | Branding Options for the Message Template. Branding is defined in the Intune Adm |includeContactInformation|4|Indicates to include contact information in the message template.| |includeCompanyPortalLink|8|Indicates to include company portal website link in the message template.| |includeDeviceDetails|16|Indicates to include device details in the message template.|-|unknownFutureValue|32|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|32|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Odj Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-odj-devicemanagement.md | Singleton entity that acts as a container for all domain join connector entities ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-odj-devicemanagement-get.md)|[deviceManagement](../resources/intune-odj-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-odj-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-odj-devicemanagement-update.md)|[deviceManagement](../resources/intune-odj-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-odj-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-odj-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-odj-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Odj Devicemanagementdomainjoinconnector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-odj-devicemanagementdomainjoinconnector.md | Here is a JSON representation of the resource. "state": "String", "version": "String" }-``` +``` |
v1.0 | Intune Odj Devicemanagementdomainjoinconnectorstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-odj-devicemanagementdomainjoinconnectorstate.md | The ODJ request states. |:|:|:| |active|0|Connector is actively pinging Intune.| |error|1|There is no heart-beat from connector from last one hour.|-|inactive|2|There is no heart-beat from connector from last 5 days.| +|inactive|2|There is no heart-beat from connector from last 5 days.| |
v1.0 | Intune Onboarding Certificateconnectorsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-certificateconnectorsetting.md | Here is a JSON representation of the resource. "connectorVersion": "String", "lastUploadVersion": 1024 }-``` +``` |
v1.0 | Intune Onboarding Compliancemanagementpartner | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-compliancemanagementpartner.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Onboarding Compliancemanagementpartnerassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-compliancemanagementpartnerassignment.md | Here is a JSON representation of the resource. "entraObjectId": "String" } }-``` +``` |
v1.0 | Intune Onboarding Conceptual | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-conceptual.md | Namespace: microsoft.graph You can enroll devices, including Windows PCs, to enable mobile device management (MDM) with Microsoft Intune. This topic describes different ways to enroll mobile devices in Intune management. The way you enroll your devices depends on the device type, ownership, and the level of management that's needed. "Bring your own device" (BYOD) enrollment lets users enroll their personal phones, tablets, or PCs. Corporate-owned device (COD) enrollment enables management scenarios like remote wipe, shared devices, or user affinity for a device. -Use Graph resources to manage enrollment in Intune. See the table of content for a list of resources. +Use Graph resources to manage enrollment in Intune. See the table of content for a list of resources. |
v1.0 | Intune Onboarding Deviceandappmanagementdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceandappmanagementdata.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceAndAppManagementData", "content": "Stream" }-``` +``` |
v1.0 | Intune Onboarding Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceappmanagement.md | Singleton entity that acts as a container for all device app management function ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceAppManagement](../api/intune-onboarding-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-onboarding-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-onboarding-deviceappmanagement.md) object.| -|[Update deviceAppManagement](../api/intune-onboarding-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-onboarding-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-onboarding-deviceappmanagement.md) object.| +|[Get deviceAppManagement](../api/intune-onboarding-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| +|[Update deviceAppManagement](../api/intune-onboarding-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| |[syncMicrosoftStoreForBusinessApps action](../api/intune-onboarding-deviceappmanagement-syncmicrosoftstoreforbusinessapps.md)|None|Syncs Intune account with Microsoft Store For Business| ## Properties Here is a JSON representation of the resource. "microsoftStoreForBusinessLastCompletedApplicationSyncTime": "String (timestamp)", "microsoftStoreForBusinessPortalSelection": "String" }-``` +``` |
v1.0 | Intune Onboarding Devicecategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicecategory.md | Device categories provides a way to organize your devices. Using device categori ## Methods |Method|Return Type|Description| |:|:|:|-|[List deviceCategories](../api/intune-onboarding-devicecategory-list.md)|[deviceCategory](../resources/intune-onboarding-devicecategory.md) collection|List properties and relationships of the [deviceCategory](../resources/intune-onboarding-devicecategory.md) objects.| -|[Get deviceCategory](../api/intune-onboarding-devicecategory-get.md)|[deviceCategory](../resources/intune-onboarding-devicecategory.md)|Read properties and relationships of the [deviceCategory](../resources/intune-onboarding-devicecategory.md) object.| -|[Create deviceCategory](../api/intune-onboarding-devicecategory-create.md)|[deviceCategory](../resources/intune-onboarding-devicecategory.md)|Create a new [deviceCategory](../resources/intune-onboarding-devicecategory.md) object.| -|[Delete deviceCategory](../api/intune-onboarding-devicecategory-delete.md)|None|Deletes a [deviceCategory](../resources/intune-onboarding-devicecategory.md).| -|[Update deviceCategory](../api/intune-onboarding-devicecategory-update.md)|[deviceCategory](../resources/intune-onboarding-devicecategory.md)|Update the properties of a [deviceCategory](../resources/intune-onboarding-devicecategory.md) object.| +|[List deviceCategories](../api/intune-onboarding-devicecategory-list.md)|[deviceCategory](../resources/intune-shared-devicecategory.md) collection|List properties and relationships of the [deviceCategory](../resources/intune-shared-devicecategory.md) objects.| +|[Get deviceCategory](../api/intune-onboarding-devicecategory-get.md)|[deviceCategory](../resources/intune-shared-devicecategory.md)|Read properties and relationships of the [deviceCategory](../resources/intune-shared-devicecategory.md) object.| +|[Create deviceCategory](../api/intune-onboarding-devicecategory-create.md)|[deviceCategory](../resources/intune-shared-devicecategory.md)|Create a new [deviceCategory](../resources/intune-shared-devicecategory.md) object.| +|[Delete deviceCategory](../api/intune-onboarding-devicecategory-delete.md)|None|Deletes a [deviceCategory](../resources/intune-shared-devicecategory.md).| +|[Update deviceCategory](../api/intune-onboarding-devicecategory-update.md)|[deviceCategory](../resources/intune-shared-devicecategory.md)|Update the properties of a [deviceCategory](../resources/intune-shared-devicecategory.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Onboarding Devicecomanagementauthorityconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicecomanagementauthorityconfiguration.md | Here is a JSON representation of the resource. "installConfigurationManagerAgent": true, "configurationManagerAgentCommandLineArgument": "String" }-``` +``` |
v1.0 | Intune Onboarding Deviceenrollmentconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentconfiguration.md | The Base Class of Device Enrollment Configuration ## Methods |Method|Return Type|Description| |:|:|:|-|[List deviceEnrollmentConfigurations](../api/intune-onboarding-deviceenrollmentconfiguration-list.md)|[deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) collection|List properties and relationships of the [deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) objects.| -|[Get deviceEnrollmentConfiguration](../api/intune-onboarding-deviceenrollmentconfiguration-get.md)|[deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md)|Read properties and relationships of the [deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) object.| +|[List deviceEnrollmentConfigurations](../api/intune-onboarding-deviceenrollmentconfiguration-list.md)|[deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) collection|List properties and relationships of the [deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) objects.| +|[Get deviceEnrollmentConfiguration](../api/intune-onboarding-deviceenrollmentconfiguration-get.md)|[deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md)|Read properties and relationships of the [deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) object.| |[setPriority action](../api/intune-onboarding-deviceenrollmentconfiguration-setpriority.md)|None|| |[assign action](../api/intune-onboarding-deviceenrollmentconfiguration-assign.md)|None|| |[createEnrollmentNotificationConfiguration action](../api/intune-onboarding-deviceenrollmentconfiguration-createenrollmentnotificationconfiguration.md)|None|| Here is a JSON representation of the resource. ], "deviceEnrollmentConfigurationType": "String" }-``` +``` |
v1.0 | Intune Onboarding Deviceenrollmentconfigurationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentconfigurationtype.md | Describes the TemplateFamily for the Template entity |deviceComanagementAuthorityConfiguration|9|Indicates that configuration is of type Comanagement Authority which refers to policies applied to Co-Managed devices.| |singlePlatformRestriction|10|Indicates that configuration is of type single platform restriction which refers to types of devices a user is allowed to enroll.| |unknownFutureValue|11|Unknown future value|-|enrollmentNotificationsConfiguration|12|Indicates that configuration is of type Enrollment Notification which refers to types of notification a user receives during enrollment.| +|enrollmentNotificationsConfiguration|12|Indicates that configuration is of type Enrollment Notification which refers to types of notification a user receives during enrollment.| |
v1.0 | Intune Onboarding Deviceenrollmentlimitconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentlimitconfiguration.md | Here is a JSON representation of the resource. "deviceEnrollmentConfigurationType": "String", "limit": 1024 }-``` +``` |
v1.0 | Intune Onboarding Deviceenrollmentnotificationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentnotificationconfiguration.md | Here is a JSON representation of the resource. "brandingOptions": "String", "defaultLocale": "String" }-``` +``` |
v1.0 | Intune Onboarding Deviceenrollmentplatformrestriction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentplatformrestriction.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Onboarding Deviceenrollmentplatformrestrictionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentplatformrestrictionconfiguration.md | Here is a JSON representation of the resource. }, "platformType": "String" }-``` +``` |
v1.0 | Intune Onboarding Deviceenrollmentplatformrestrictionsconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentplatformrestrictionsconfiguration.md | Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Onboarding Deviceenrollmentwindowshelloforbusinessconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentwindowshelloforbusinessconfiguration.md | Here is a JSON representation of the resource. "securityKeyForSignIn": "String", "enhancedSignInSecurity": 1024 }-``` +``` |
v1.0 | Intune Onboarding Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-onboarding-devicemanagement-get.md)|[deviceManagement](../resources/intune-onboarding-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-onboarding-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-onboarding-devicemanagement-update.md)|[deviceManagement](../resources/intune-onboarding-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-onboarding-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-onboarding-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-onboarding-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| |[verifyWindowsEnrollmentAutoDiscovery function](../api/intune-onboarding-devicemanagement-verifywindowsenrollmentautodiscovery.md)|Boolean|| ## Properties Singleton entity that acts as a container for all device management functionalit ## Relationships |Relationship|Type|Description| |:|:|:|-|deviceCategories|[deviceCategory](../resources/intune-onboarding-devicecategory.md) collection|The list of device categories with the tenant.| +|deviceCategories|[deviceCategory](../resources/intune-shared-devicecategory.md) collection|The list of device categories with the tenant.| |exchangeConnectors|[deviceManagementExchangeConnector](../resources/intune-onboarding-devicemanagementexchangeconnector.md) collection|The list of Exchange Connectors configured by the tenant.|-|deviceEnrollmentConfigurations|[deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) collection|The list of device enrollment configurations| +|deviceEnrollmentConfigurations|[deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) collection|The list of device enrollment configurations| |exchangeOnPremisesPolicy|[deviceManagementExchangeOnPremisesPolicy](../resources/intune-onboarding-devicemanagementexchangeonpremisespolicy.md)|The policy which controls mobile device access to Exchange On Premises| |exchangeOnPremisesPolicies|[deviceManagementExchangeOnPremisesPolicy](../resources/intune-onboarding-devicemanagementexchangeonpremisespolicy.md) collection|The list of Exchange On Premisis policies configured by the tenant.| |conditionalAccessSettings|[onPremisesConditionalAccessSettings](../resources/intune-onboarding-onpremisesconditionalaccesssettings.md)|The Exchange on premises conditional access settings. On premises conditional access will require devices to be both enrolled and compliant for mail access| Here is a JSON representation of the resource. "disableClientTelemetry": true } }-``` +``` |
v1.0 | Intune Onboarding Devicemanagementexchangeaccesslevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeaccesslevel.md | Access Level in Exchange. |none|0|No device access rule has been configured in Exchange.| |allow|1|Allow the device access to Exchange.| |block|2|Block the device from accessing Exchange.|-|quarantine|3|Quarantine the device in Exchange.| +|quarantine|3|Quarantine the device in Exchange.| |
v1.0 | Intune Onboarding Devicemanagementexchangeaccessrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeaccessrule.md | Here is a JSON representation of the resource. }, "accessLevel": "String" }-``` +``` |
v1.0 | Intune Onboarding Devicemanagementexchangeaccessruletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeaccessruletype.md | Criteria which defines the type of device this access rule will apply to |Member|Value|Description| |:|:|:| |family|0|Family of devices|-|model|1|Specific model of device| +|model|1|Specific model of device| |
v1.0 | Intune Onboarding Devicemanagementexchangeconnector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeconnector.md | Here is a JSON representation of the resource. "exchangeAlias": "String", "exchangeOrganization": "String" }-``` +``` |
v1.0 | Intune Onboarding Devicemanagementexchangeconnectorstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeconnectorstatus.md | The current status of the Exchange Connector. |connectionPending|1|Pending Connection to the Exchange Environment.| |connected|2|Connected to the Exchange Environment| |disconnected|3|Disconnected from the Exchange Environment|-|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Onboarding Devicemanagementexchangeconnectorsynctype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeconnectorsynctype.md | The type of Exchange Connector sync requested. |Member|Value|Description| |:|:|:| |fullSync|0|Discover all the device in Exchange.|-|deltaSync|1|Discover only the device in Exchange which have updated during the delta sync window.| +|deltaSync|1|Discover only the device in Exchange which have updated during the delta sync window.| |
v1.0 | Intune Onboarding Devicemanagementexchangeconnectortype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeconnectortype.md | The type of Exchange Connector. |hosted|1|Connects to O365 multi-tenant Exchange environment| |serviceToService|2|Intune Service connects directly to O365 multi-tenant Exchange environment| |dedicated|3|Connects to O365 Dedicated Exchange environment.|-|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Onboarding Devicemanagementexchangedeviceclass | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangedeviceclass.md | Here is a JSON representation of the resource. "name": "String", "type": "String" }-``` +``` |
v1.0 | Intune Onboarding Devicemanagementexchangeonpremisespolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeonpremisespolicy.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Onboarding Devicemanagementpartner | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementpartner.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Onboarding Devicemanagementpartnerapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementpartnerapptype.md | Partner App Type. |:|:|:| |unknown|0|Partner App type is unknown.| |singleTenantApp|1|Partner App is Single tenant in AAD.|-|multiTenantApp|2|Partner App is Multi tenant in AAD.| +|multiTenantApp|2|Partner App is Multi tenant in AAD.| |
v1.0 | Intune Onboarding Devicemanagementpartnerassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementpartnerassignment.md | Here is a JSON representation of the resource. "entraObjectId": "String" } }-``` +``` |
v1.0 | Intune Onboarding Devicemanagementpartnertenantstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementpartnertenantstate.md | Partner state of this tenant. |enabled|2|Partner is enabled.| |terminated|3|Partner connection is terminated.| |rejected|4|Partner messages are rejected.|-|unresponsive|5|Partner is unresponsive.| +|unresponsive|5|Partner is unresponsive.| |
v1.0 | Intune Onboarding Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceplatformtype.md | Supported platform types. |windows81AndLater|5|Windows 8.1 and later| |windows10AndLater|6|Windows 10 and later.| |androidWorkProfile|7|Android Work Profile.|-|unknown|8|Unknown.| +|unknown|8|Unknown.| |
v1.0 | Intune Onboarding Enablement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-enablement.md | Namespace: microsoft.graph |:|:|:| |notConfigured|0|Device default value, no intent.| |enabled|1|Enables the setting on the device.|-|disabled|2|Disables the setting on the device.| +|disabled|2|Disables the setting on the device.| |
v1.0 | Intune Onboarding Enrollmentconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-enrollmentconfigurationassignment.md | Here is a JSON representation of the resource. "source": "String", "sourceId": "String" }-``` +``` |
v1.0 | Intune Onboarding Enrollmentnotificationbrandingoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-enrollmentnotificationbrandingoptions.md | Branding Options for the Message Template. Branding is defined in the Intune Adm |includeContactInformation|4|Indicates that the Contact Information is included in the notification.| |includeCompanyPortalLink|8|Indicates that the Company Portal Link is included in the notification.| |includeDeviceDetails|16|Indicates that the DeviceDetails is included in the notification.|-|unknownFutureValue|32|unknownFutureValue for evolvable enums pattern.| +|unknownFutureValue|32|unknownFutureValue for evolvable enums pattern.| |
v1.0 | Intune Onboarding Enrollmentnotificationtemplatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-enrollmentnotificationtemplatetype.md | This enum indicates the Template type for which the enrollment notification appl |:|:|:| |email|1|Email Notification| |push|2|Push Notification|-|unknownFutureValue|99|Unknown Type| +|unknownFutureValue|99|Unknown Type| |
v1.0 | Intune Onboarding Enrollmentrestrictionplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-enrollmentrestrictionplatformtype.md | This enum indicates the platform type for which the enrollment restriction appli |androidForWork|5|Indicates that the enrollment configuration applies only to Android for Work devices| |mac|7|Indicates that the enrollment configuration applies only to macOS devices| |linux|8|Indicates that the enrollment configuration applies only to Linux devices|-|unknownFutureValue|9|Evolvable enumeration sentinel value. Do not use| +|unknownFutureValue|9|Evolvable enumeration sentinel value. Do not use| |
v1.0 | Intune Onboarding Intunebrand | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-intunebrand.md | Here is a JSON representation of the resource. "enrollmentAvailability": "String", "disableClientTelemetry": true }-``` +``` |
v1.0 | Intune Onboarding Mdmauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-mdmauthority.md | Mobile device management authority. |unknown|0|Unknown| |intune|1|Intune| |sccm|2|SCCM|-|office365|3|Office365| +|office365|3|Office365| |
v1.0 | Intune Onboarding Microsoftstoreforbusinessportalselectionoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-microsoftstoreforbusinessportalselectionoptions.md | Portal to which admin syncs available Microsoft Store for Business apps. This is |:|:|:| |none|0|This option is not available for the account| |companyPortal|1|Intune Company Portal only.|-|privateStore|2|MSFB Private store only.| +|privateStore|2|MSFB Private store only.| |
v1.0 | Intune Onboarding Mobilethreatdefenseconnector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-mobilethreatdefenseconnector.md | Here is a JSON representation of the resource. "allowPartnerToCollectIOSPersonalApplicationMetadata": true, "microsoftDefenderForEndpointAttachEnabled": true }-``` +``` |
v1.0 | Intune Onboarding Mobilethreatpartnertenantstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-mobilethreatpartnertenantstate.md | Partner state of this tenant. |unresponsive|3|Partner is unresponsive.| |notSetUp|4|Indicates that the partner connector is not set up. This can occur when the connector is not provisioned and Intune has not received a heartbeat for the connector. Please see https://go.microsoft.com/fwlink/?linkid=2239039 for more information on connector states.| |error|5|Indicates that the partner connector is in an error state. This can occur when the connector has a non-zero error code set due to an internal error in processing. Please see https://go.microsoft.com/fwlink/?linkid=2239039 for more information on connector states.|-|unknownFutureValue|6|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|6|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Onboarding Onpremisesconditionalaccesssettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-onpremisesconditionalaccesssettings.md | Here is a JSON representation of the resource. ], "overrideDefaultRule": true }-``` +``` |
v1.0 | Intune Onboarding Organization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-organization.md | Here is a JSON representation of the resource. "lastUploadVersion": 1024 } }-``` +``` |
v1.0 | Intune Onboarding Sideloadingkey | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-sideloadingkey.md | Here is a JSON representation of the resource. "totalActivation": 1024, "lastUpdatedDateTime": "String" }-``` +``` |
v1.0 | Intune Onboarding User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-user.md | Namespace: microsoft.graph ## Methods |Method|Return Type|Description| |:|:|:|-|[List users](../api/intune-onboarding-user-list.md)|[user](../resources/intune-onboarding-user.md) collection|List properties and relationships of the [user](../resources/intune-onboarding-user.md) objects.| -|[Get user](../api/intune-onboarding-user-get.md)|[user](../resources/intune-onboarding-user.md)|Read properties and relationships of the [user](../resources/intune-onboarding-user.md) object.| -|[Create user](../api/intune-onboarding-user-create.md)|[user](../resources/intune-onboarding-user.md)|Create a new [user](../resources/intune-onboarding-user.md) object.| -|[Delete user](../api/intune-onboarding-user-delete.md)|None|Deletes a [user](../resources/intune-onboarding-user.md).| -|[Update user](../api/intune-onboarding-user-update.md)|[user](../resources/intune-onboarding-user.md)|Update the properties of a [user](../resources/intune-onboarding-user.md) object.| +|[List users](../api/intune-onboarding-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-onboarding-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-onboarding-user-create.md)|[user](../resources/intune-shared-user.md)|Create a new [user](../resources/intune-shared-user.md) object.| +|[Delete user](../api/intune-onboarding-user-delete.md)|None|Deletes a [user](../resources/intune-shared-user.md).| +|[Update user](../api/intune-onboarding-user-update.md)|[user](../resources/intune-shared-user.md)|Update the properties of a [user](../resources/intune-shared-user.md) object.| |[exportDeviceAndAppManagementData function](../api/intune-onboarding-user-exportdeviceandappmanagementdata.md)|[deviceAndAppManagementData](../resources/intune-onboarding-deviceandappmanagementdata.md)|| |[exportDeviceAndAppManagementData function](../api/intune-onboarding-user-exportdeviceandappmanagementdata.md)|[deviceAndAppManagementData](../resources/intune-onboarding-deviceandappmanagementdata.md)||-|[getEffectiveDeviceEnrollmentConfigurations function](../api/intune-onboarding-user-geteffectivedeviceenrollmentconfigurations.md)|[deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) collection|| +|[getEffectiveDeviceEnrollmentConfigurations function](../api/intune-onboarding-user-geteffectivedeviceenrollmentconfigurations.md)|[deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) collection|| ## Properties |Property|Type|Description| Namespace: microsoft.graph ## Relationships |Relationship|Type|Description| |:|:|:|-|deviceEnrollmentConfigurations|[deviceEnrollmentConfiguration](../resources/intune-onboarding-deviceenrollmentconfiguration.md) collection|Get enrollment configurations targeted to the user| +|deviceEnrollmentConfigurations|[deviceEnrollmentConfiguration](../resources/intune-shared-deviceenrollmentconfiguration.md) collection|Get enrollment configurations targeted to the user| ## JSON Representation Here is a JSON representation of the resource. Here is a JSON representation of the resource. "id": "String (identifier)", "deviceEnrollmentLimit": 1024 }-``` +``` |
v1.0 | Intune Onboarding Vpptokenlicensesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vppTokenLicenseSummary.md | Here is a JSON representation of the resource. "availableLicenseCount": 1024, "usedLicenseCount": 1024 }-``` +``` |
v1.0 | Intune Onboarding Vpptoken | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vpptoken.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Onboarding Vpptokenactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vpptokenactionresult.md | Here is a JSON representation of the resource. "startDateTime": "String (timestamp)", "lastUpdatedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Onboarding Vpptokenrevokelicensesactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vpptokenrevokelicensesactionresult.md | Here is a JSON representation of the resource. "failedLicensesCount": 1024, "actionFailureReason": "String" }-``` +``` |
v1.0 | Intune Onboarding Vpptokenstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vpptokenstate.md | Possible states associated with an Apple Volume Purchase Program token. |expired|2|Token is expired.| |invalid|3|Token is invalid.| |assignedToExternalMDM|4|Token is managed by another MDM Service.|-|duplicateLocationId|5|Token is associated with the same location as another token on the account.| +|duplicateLocationId|5|Token is associated with the same location as another token on the account.| |
v1.0 | Intune Onboarding Vpptokensyncstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vpptokensyncstatus.md | Possible sync statuses associated with an Apple Volume Purchase Program token. |none|0|Default status.| |inProgress|1|Last Sync in progress.| |completed|2|Last Sync completed successfully.|-|failed|3|Last Sync failed.| +|failed|3|Last Sync failed.| |
v1.0 | Intune Onboarding Windows10enrollmentcompletionpageconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-windows10enrollmentcompletionpageconfiguration.md | Here is a JSON representation of the resource. "trackInstallProgressForAutopilotOnly": true, "disableUserStatusTrackingAfterFirstUser": true }-``` +``` |
v1.0 | Intune Onboarding Windowshelloforbusinesspinusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-windowshelloforbusinesspinusage.md | Windows Hello for Business pin usage options |:|:|:| |allowed|0|Allowed the usage of certain pin rule| |required|1|Enforce the usage of certain pin rule|-|disallowed|2|Forbit the usage of certain pin rule| +|disallowed|2|Forbit the usage of certain pin rule| |
v1.0 | Intune Osprovisioninggraphservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-osprovisioninggraphservice-devicemanagement.md | Singleton that acts as container for a collection of Resource Access entities. ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-osprovisioninggraphservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-osprovisioninggraphservice-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-osprovisioninggraphservice-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-osprovisioninggraphservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-osprovisioninggraphservice-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-osprovisioninggraphservice-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-osprovisioninggraphservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-osprovisioninggraphservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemedition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemedition.md | Here is a JSON representation of the resource. "editionType": "String", "supportEndDate": "String (Date)" }-``` +``` |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemeditiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemeditiontype.md | Windows Operating System is available in different editions, which have a specif |proEducationN|7|Indicates Pro Education N Operating System edition used for the managed device.| |proWorkstation|8|Indicates Pro Workstation Operating System edition used for the managed device.| |proWorkstationN|9|Indicates Pro Workstation N Operating System edition used for the managed device.|-|unknownFutureValue|10|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|10|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemimage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemupdate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemupdate.md | Here is a JSON representation of the resource. "releaseMonth": 1024, "releaseYear": 1024 }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymanageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-appvulnerabilitymanageddevice.md | Here is a JSON representation of the resource. "displayName": "String", "lastSyncDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymobileapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-appvulnerabilitymobileapp.md | Here is a JSON representation of the resource. "mobileAppType": "String", "version": "String" }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitytask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-appvulnerabilitytask.md | Here is a JSON representation of the resource. "mobileAppCount": 1024, "remediation": "String" }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitytaskmitigationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-appvulnerabilitytaskmitigationtype.md | Device app management task mitigation type. |unknown|0|Mitigation steps are unknown.| |update|1|The app needs to be updated.| |uninstall|2|The app needs to be uninstalled.|-|securityConfiguration|3|The security configuration needs to be changed.| +|securityConfiguration|3|The security configuration needs to be changed.| |
v1.0 | Intune Partnerintegration Configmanagercollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-configmanagercollection.md | Here is a JSON representation of the resource. "createdDateTime": "String (timestamp)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Partnerintegration Configmanagerpolicysummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-configmanagerpolicysummary.md | Here is a JSON representation of the resource. "pendingDeviceCount": 1024, "enforcedDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Partnerintegration Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-deviceappmanagement.md | Device app management singleton entity. ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceAppManagement](../api/intune-partnerintegration-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-partnerintegration-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-partnerintegration-deviceappmanagement.md) object.| -|[Update deviceAppManagement](../api/intune-partnerintegration-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-partnerintegration-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-partnerintegration-deviceappmanagement.md) object.| +|[Get deviceAppManagement](../api/intune-partnerintegration-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| +|[Update deviceAppManagement](../api/intune-partnerintegration-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceAppManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Partnerintegration Deviceappmanagementtask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-deviceappmanagementtask.md | Here is a JSON representation of the resource. "assignedTo": "String", "status": "String" }-``` +``` |
v1.0 | Intune Partnerintegration Deviceappmanagementtaskcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-deviceappmanagementtaskcategory.md | Device app management task category. |Member|Value|Description| |:|:|:| |unknown|0|Unknown source.|-|advancedThreatProtection|1|Windows Defender ATP Threat & Vulnerability Management.| +|advancedThreatProtection|1|Windows Defender ATP Threat & Vulnerability Management.| |
v1.0 | Intune Partnerintegration Deviceappmanagementtaskpriority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-deviceappmanagementtaskpriority.md | Device app management task priority. |:|:|:| |none|0|No priority set.| |high|1|High priority.|-|low|2|Low priority.| +|low|2|Low priority.| |
v1.0 | Intune Partnerintegration Deviceappmanagementtaskstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-deviceappmanagementtaskstatus.md | Device app management task status. |pending|1|The task is ready for review.| |active|2|The task has been accepted and is being worked on.| |completed|3|The work is complete.|-|rejected|4|The task was rejected.| +|rejected|4|The task was rejected.| |
v1.0 | Intune Partnerintegration Endpointsecurityconfigurationapplicableplatform | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-endpointsecurityconfigurationapplicableplatform.md | The endpoint security configuration applicable platform. |unknown|0|Unknown.| |macOS|1|MacOS.| |windows10AndLater|2|Windows 10 and later.|-|windows10AndWindowsServer|3|Windows 10 and Windows Server.| +|windows10AndWindowsServer|3|Windows 10 and Windows Server.| |
v1.0 | Intune Partnerintegration Endpointsecurityconfigurationprofiletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-endpointsecurityconfigurationprofiletype.md | The endpoint security policy profile type. |webProtection|11|Web protection.| |applicationControl|12|Application control.| |attackSurfaceReductionRules|13|Attack surface reduction rules.|-|accountProtection|14|Account protection.| +|accountProtection|14|Account protection.| |
v1.0 | Intune Partnerintegration Endpointsecurityconfigurationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-endpointsecurityconfigurationtype.md | The endpoint security policy type. |firewall|3|Firewall.| |endpointDetectionAndResponse|4|Endpoint detection and response.| |attackSurfaceReduction|5|Attack surface reduction.|-|accountProtection|6|Account protection.| +|accountProtection|6|Account protection.| |
v1.0 | Intune Partnerintegration Keyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-keyvaluepair.md | Here is a JSON representation of the resource. "name": "String", "value": "String" }-``` +``` |
v1.0 | Intune Partnerintegration Securityconfigurationtask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-securityconfigurationtask.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Partnerintegration Unmanageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-unmanageddevice.md | Here is a JSON representation of the resource. "lastLoggedOnUser": "String", "lastSeenDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Partnerintegration Unmanageddevicediscoverytask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-unmanageddevicediscoverytask.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Partnerintegration Vulnerablemanageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-vulnerablemanageddevice.md | Here is a JSON representation of the resource. "displayName": "String", "lastSyncDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Policylistingservice Deviceconfigurationprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policylistingservice-deviceconfigurationprofile.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policylistingservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policylistingservice-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## 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.| +|[Get deviceManagement](../api/intune-policylistingservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-policylistingservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. { "@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 | Platform Type |iOS|4|iOS Platform Type| |macOS|8|MacOS Platform Type| |windows10X|16|Windows 10X Platform Type|-|windows10|32|Windows 10 Platform Type| +|windows10|32|Windows 10 Platform Type| |
v1.0 | Intune Policylistingservice Profiletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policylistingservice-profiletype.md | 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| +|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 | Here is a JSON representation of the resource. ], "search": "String" }-``` +``` |
v1.0 | Intune Policyset Assignmentfilterevaluationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterevaluationresult.md | Supported evaluation results for filter. |notMatch|2|NotMatch.| |inconclusive|3|Inconclusive.| |failure|4|Failure.|-|notEvaluated|5|NotEvaluated.| +|notEvaluated|5|NotEvaluated.| |
v1.0 | Intune Policyset Assignmentfilterevaluationsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterevaluationsummary.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Policyset Assignmentfiltermanagementtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfiltermanagementtype.md | Supported filter management types whether its devices or apps. |:|:|:| |devices|0|Indicates when filter is supported based on device properties. This is the default value when management type resolution fails.| |apps|1|Indicates when filter is supported based on app properties.|-|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Policyset Assignmentfilteroperator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilteroperator.md | Represents the different type of operators which can be used to craft the Assign |in|7|In.| |notIn|8|NotIn.| |endsWith|9|EndsWith.|-|notEndsWith|10|NotEndsWith.| +|notEndsWith|10|NotEndsWith.| |
v1.0 | Intune Policyset Assignmentfilterpayloadtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterpayloadtype.md | Represents the payload type AssignmentFilter is being assigned to. |Member|Value|Description| |:|:|:| |notSet|0|NotSet|-|enrollmentRestrictions|1|EnrollmentRestrictions| +|enrollmentRestrictions|1|EnrollmentRestrictions| |
v1.0 | Intune Policyset Assignmentfilterstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterstate.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.assignmentFilterState", "enabled": true }-``` +``` |
v1.0 | Intune Policyset Assignmentfilterstatusdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterstatusdetails.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Policyset Assignmentfiltersupportedproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfiltersupportedproperty.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Assignmentfiltertypeandevaluationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfiltertypeandevaluationresult.md | Here is a JSON representation of the resource. "assignmentFilterType": "String", "evaluationResult": "String" }-``` +``` |
v1.0 | Intune Policyset Assignmentfiltervalidationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfiltervalidationresult.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.assignmentFilterValidationResult", "isValidRule": true }-``` +``` |
v1.0 | Intune Policyset Associatedassignmentpayloadtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-associatedassignmentpayloadtype.md | This enum represents associated assignment payload type |deviceFirmwareConfigurationInterfacePolicy|20|Indicates that this assignment filter is associated with Device Firmware Configuration Interface(DCFI) payload type| |resourceAccessPolicy|23|Indicates that this filter is associated with a resource access policy (Wifi, VPN, Certificate) payload type| |win32app|24|Indicates that this filter is associated with a Win32 app payload type|-|deviceManagmentConfigurationAndCompliancePolicy|29|Indicates that this filter is associated with a configuration or compliance policy on Device Configuration v2 Infrastructure payload type| +|deviceManagmentConfigurationAndCompliancePolicy|29|Indicates that this filter is associated with a configuration or compliance policy on Device Configuration v2 Infrastructure payload type| |
v1.0 | Intune Policyset Deviceandappmanagementassignmentfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-deviceandappmanagementassignmentfilter.md | Here is a JSON representation of the resource. ], "assignmentFilterManagementType": "String" }-``` +``` |
v1.0 | Intune Policyset Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-deviceappmanagement.md | Singleton entity that acts as a container for all device and app management func ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceAppManagement](../api/intune-policyset-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-policyset-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-policyset-deviceappmanagement.md) object.| -|[Update deviceAppManagement](../api/intune-policyset-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-policyset-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-policyset-deviceappmanagement.md) object.| +|[Get deviceAppManagement](../api/intune-policyset-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| +|[Update deviceAppManagement](../api/intune-policyset-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceAppManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Policyset Devicecompliancepolicypolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-devicecompliancepolicypolicysetitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Deviceconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-deviceconfigurationpolicysetitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-devicemanagement.md | Singleton entity that acts as a container for all device and app management func ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-policyset-devicemanagement-get.md)|[deviceManagement](../resources/intune-policyset-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-policyset-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-policyset-devicemanagement-update.md)|[deviceManagement](../resources/intune-policyset-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-policyset-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-policyset-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-policyset-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| |[getAssignmentFiltersStatusDetails action](../api/intune-policyset-devicemanagement-getassignmentfiltersstatusdetails.md)|[assignmentFilterStatusDetails](../resources/intune-policyset-assignmentfilterstatusdetails.md)|| |[evaluateAssignmentFilter action](../api/intune-policyset-devicemanagement-evaluateassignmentfilter.md)|Stream|| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Policyset Devicemanagementconfigurationpolicypolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-devicemanagementconfigurationpolicypolicysetitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Devicemanagementscriptpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-devicemanagementscriptpolicysetitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-deviceplatformtype.md | Supported platform types. |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.|-|windowsMobileApplicationManagement|13|Indicates device platform type associated with Mobile Application Management (MAM) for Windows devices.| +|windowsMobileApplicationManagement|13|Indicates device platform type associated with Mobile Application Management (MAM) for Windows devices.| |
v1.0 | Intune Policyset Enrollmentrestrictionsconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-enrollmentrestrictionsconfigurationpolicysetitem.md | Here is a JSON representation of the resource. "priority": 1024, "limit": 1024 }-``` +``` |
v1.0 | Intune Policyset Errorcode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-errorcode.md | Namespace: microsoft.graph |noError|0|Default Value to indicate no error.| |unauthorized|1|The current user does not have access due to lack of RBAC permissions on the resource.| |notFound|2|The current user does not have access due to lack of RBAC Scope Tags on the resource.|-|deleted|3|The resource has been deleted.| +|deleted|3|The resource has been deleted.| |
v1.0 | Intune Policyset Haspayloadlinkresultitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-haspayloadlinkresultitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Ioslobappprovisioningconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-ioslobappprovisioningconfigurationpolicysetitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Keyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-keyvaluepair.md | Here is a JSON representation of the resource. "name": "String", "value": "String" }-``` +``` |
v1.0 | Intune Policyset Macoslobappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-macoslobappassignmentsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.macOsLobAppAssignmentSettings", "uninstallOnDeviceRemoval": true }-``` +``` |
v1.0 | Intune Policyset Macosvppappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-macosvppappassignmentsettings.md | Here is a JSON representation of the resource. "useDeviceLicensing": true, "uninstallOnDeviceRemoval": true }-``` +``` |
v1.0 | Intune Policyset Managedappprotectionpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-managedappprotectionpolicysetitem.md | Here is a JSON representation of the resource. ], "targetedAppManagementLevels": "String" }-``` +``` |
v1.0 | Intune Policyset Manageddevicemobileappconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-manageddevicemobileappconfigurationpolicysetitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Mdmwindowsinformationprotectionpolicypolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-mdmwindowsinformationprotectionpolicypolicysetitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Mobileapppolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-mobileapppolicysetitem.md | Here is a JSON representation of the resource. } } }-``` +``` |
v1.0 | Intune Policyset Payloadbyfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-payloadbyfilter.md | Here is a JSON representation of the resource. "groupId": "String", "assignmentFilterType": "String" }-``` +``` |
v1.0 | Intune Policyset Payloadcompatibleassignmentfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-payloadcompatibleassignmentfilter.md | Here is a JSON representation of the resource. "assignmentFilterManagementType": "String", "payloadType": "String" }-``` +``` |
v1.0 | Intune Policyset Policyset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-policyset.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Policysetassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-policysetassignment.md | Here is a JSON representation of the resource. "entraObjectId": "String" } }-``` +``` |
v1.0 | Intune Policyset Policysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-policysetitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Policysetstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-policysetstatus.md | The enum to specify the status of PolicySet. |partialSuccess|2|Post process complete for all PolicySet items but there are failures.| |success|3|All PolicySet items are deployed. DoesnΓÇÖt mean that all deployment succeeded. | |error|4|PolicySet processing completely failed.|-|notAssigned|5|PolicySet/PolicySetItem is not assigned to any group.| +|notAssigned|5|PolicySet/PolicySetItem is not assigned to any group.| |
v1.0 | Intune Policyset Targetedmanagedappconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-targetedmanagedappconfigurationpolicysetitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Win32lobappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-win32lobappassignmentsettings.md | Inherits from [mobileAppAssignmentSettings](../resources/intune-shared-mobileapp |restartSettings|[win32LobAppRestartSettings](../resources/intune-shared-win32lobapprestartsettings.md)|The reboot settings to apply for this app assignment.| |installTimeSettings|[mobileAppInstallTimeSettings](../resources/intune-shared-mobileappinstalltimesettings.md)|The install time settings to apply for this app assignment.| |deliveryOptimizationPriority|[win32LobAppDeliveryOptimizationPriority](../resources/intune-shared-win32lobappdeliveryoptimizationpriority.md)|The delivery optimization priority for this app assignment. This setting is not supported in National Cloud environments. Possible values are: `notConfigured`, `foreground`.|+|autoUpdateSettings|[win32LobAppAutoUpdateSettings](../resources/intune-shared-win32lobappautoupdatesettings.md)|The auto-update settings to apply for this app assignment.| ## Relationships None Here is a JSON representation of the resource. "startDateTime": "String (timestamp)", "deadlineDateTime": "String (timestamp)" },- "deliveryOptimizationPriority": "String" + "deliveryOptimizationPriority": "String", + "autoUpdateSettings": { + "@odata.type": "microsoft.graph.win32LobAppAutoUpdateSettings", + "autoUpdateSupersededApps": "String" + } }-``` +``` |
v1.0 | Intune Policyset Win32lobappautoupdatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-win32lobappautoupdatesettings.md | + + Title: "win32LobAppAutoUpdateSettings resource type" +description: "Contains properties used to perform the auto-update of an application." ++localization_priority: Normal ++++# 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 +|Property|Type|Description| +|:|:|:| +|autoUpdateSupersededApps|[win32LobAppAutoUpdateSupersededApps](../resources/intune-shared-win32lobappautoupdatesupersededapps.md)|The auto-update superseded apps setting for the app assignment. Possible values are notConfigured and enabled. Default value is notConfigured. Possible values are: `notConfigured`, `enabled`, `unknownFutureValue`.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.win32LobAppAutoUpdateSettings" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.win32LobAppAutoUpdateSettings", + "autoUpdateSupersededApps": "String" +} +``` |
v1.0 | Intune Policyset Windows10enrollmentcompletionpageconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-windows10enrollmentcompletionpageconfigurationpolicysetitem.md | Here is a JSON representation of the resource. ], "priority": 1024 }-``` +``` |
v1.0 | Intune Policyset Windowsappxappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-windowsappxappassignmentsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsAppXAppAssignmentSettings", "useDeviceContext": true }-``` +``` |
v1.0 | Intune Policyset Windowsautopilotdeploymentprofilepolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-windowsautopilotdeploymentprofilepolicysetitem.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Policyset Windowsuniversalappxappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-windowsuniversalappxappassignmentsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsUniversalAppXAppAssignmentSettings", "useDeviceContext": true }-``` +``` |
v1.0 | Intune Raimportcerts Certificateconnectordetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-certificateconnectordetails.md | Here is a JSON representation of the resource. "lastCheckinDateTime": "String (timestamp)", "connectorVersion": "String" }-``` +``` |
v1.0 | Intune Raimportcerts Certificateconnectorhealthmetricvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-certificateconnectorhealthmetricvalue.md | Here is a JSON representation of the resource. "successCount": 1024, "failureCount": 1024 }-``` +``` |
v1.0 | Intune Raimportcerts Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-devicemanagement.md | Singleton that acts as container for a collection of UserPFXCertificate entities ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-raimportcerts-devicemanagement-get.md)|[deviceManagement](../resources/intune-raimportcerts-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-raimportcerts-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-raimportcerts-devicemanagement-update.md)|[deviceManagement](../resources/intune-raimportcerts-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-raimportcerts-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-raimportcerts-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-raimportcerts-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Raimportcerts Onpremencryptedpayload | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-onpremencryptedpayload.md | Here is a JSON representation of the resource. "eTag": "String", "isDeleted": true }-``` +``` |
v1.0 | Intune Raimportcerts Pfxrecryptionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-pfxrecryptionrequest.md | Here is a JSON representation of the resource. "isDeleted": true, "eTag": "String" }-``` +``` |
v1.0 | Intune Raimportcerts Pfxusercertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-pfxusercertificate.md | Here is a JSON representation of the resource. "lastModifiedTime": "String (timestamp)", "eTag": "String" }-``` +``` |
v1.0 | Intune Raimportcerts Timeseriesparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-timeseriesparameter.md | Here is a JSON representation of the resource. "startDateTime": "String (timestamp)", "endDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Raimportcerts Userpfxcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-userpfxcertificate.md | Here is a JSON representation of the resource. "createdDateTime": "String (timestamp)", "lastModifiedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Raimportcerts Userpfxintendedpurpose | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-userpfxintendedpurpose.md | Supported values for the intended purpose of a user PFX certificate. |smimeEncryption|1|Valid for S/MIME encryption.| |smimeSigning|2|Valid for S/MIME signing.| |vpn|4|Valid for use in VPN.|-|wifi|8|Valid for use in WiFi.| +|wifi|8|Valid for use in WiFi.| |
v1.0 | Intune Raimportcerts Userpfxpaddingscheme | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-userpfxpaddingscheme.md | Supported values for the padding scheme used by encryption provider. |oaepSha1|2|OaepSha1 is no longer supported| |oaepSha256|3|Use OAEP SHA-256 padding.| |oaepSha384|4|Use OAEP SHA-384 padding.|-|oaepSha512|5|Use OAEP SHA-512 padding.| +|oaepSha512|5|Use OAEP SHA-512 padding.| |
v1.0 | Intune Rapolicy Applicabilityrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-applicabilityrule.md | + + Title: "applicabilityRule resource type" +description: "Intune Rapolicy Applicabilityrule Resources ." ++localization_priority: Normal ++++# 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| +|:|:|:| +|filterType|[filterAssociationType](../resources/intune-rapolicy-filterassociationtype.md)|. Possible values are: `unknown`, `include`, `exclude`.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.applicabilityRule" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.applicabilityRule", + "filterType": "String" +} +``` |
v1.0 | Intune Rapolicy Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagement.md | Singleton that acts as container for a collection of Resource Access entities. ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-rapolicy-devicemanagement-get.md)|[deviceManagement](../resources/intune-rapolicy-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-rapolicy-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-rapolicy-devicemanagement-update.md)|[deviceManagement](../resources/intune-rapolicy-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-rapolicy-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-rapolicy-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-rapolicy-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Singleton that acts as container for a collection of Resource Access entities. ## Relationships |Relationship|Type|Description| |:|:|:|-|derivedCredentials|[deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) collection|Collection of Derived credential settings associated with account.| +|derivedCredentials|[deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) collection|Collection of Derived credential settings associated with account.| |resourceAccessProfiles|[deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md) collection|Collection of resource access settings associated with account.| ## JSON Representation Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialissuer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementderivedcredentialissuer.md | Supported values for the derived credential issuer. |intercede|0|Intercede| |entrustDatacard|1|Entrust| |purebred|2|Purebred|-|xTec|3|XTec| +|xTec|3|XTec| |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialnotificationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementderivedcredentialnotificationtype.md | Supported values for the notification type to use. |:|:|:| |none|0|None| |companyPortal|1|Company Portal|-|email|2|Email| +|email|2|Email| |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md | Entity that describes tenant level settings for derived credentials ## Methods |Method|Return Type|Description| |:|:|:|-|[List deviceManagementDerivedCredentialSettingses](../api/intune-rapolicy-devicemanagementderivedcredentialsettings-list.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) collection|List properties and relationships of the [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) objects.| -|[Get deviceManagementDerivedCredentialSettings](../api/intune-rapolicy-devicemanagementderivedcredentialsettings-get.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md)|Read properties and relationships of the [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) object.| -|[Create deviceManagementDerivedCredentialSettings](../api/intune-rapolicy-devicemanagementderivedcredentialsettings-create.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md)|Create a new [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) object.| -|[Delete deviceManagementDerivedCredentialSettings](../api/intune-rapolicy-devicemanagementderivedcredentialsettings-delete.md)|None|Deletes a [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md).| -|[Update deviceManagementDerivedCredentialSettings](../api/intune-rapolicy-devicemanagementderivedcredentialsettings-update.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md)|Update the properties of a [deviceManagementDerivedCredentialSettings](../resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md) object.| +|[List deviceManagementDerivedCredentialSettingses](../api/intune-rapolicy-devicemanagementderivedcredentialsettings-list.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) collection|List properties and relationships of the [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) objects.| +|[Get deviceManagementDerivedCredentialSettings](../api/intune-rapolicy-devicemanagementderivedcredentialsettings-get.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md)|Read properties and relationships of the [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object.| +|[Create deviceManagementDerivedCredentialSettings](../api/intune-rapolicy-devicemanagementderivedcredentialsettings-create.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md)|Create a new [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object.| +|[Delete deviceManagementDerivedCredentialSettings](../api/intune-rapolicy-devicemanagementderivedcredentialsettings-delete.md)|None|Deletes a [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md).| +|[Update deviceManagementDerivedCredentialSettings](../api/intune-rapolicy-devicemanagementderivedcredentialsettings-update.md)|[deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md)|Update the properties of a [deviceManagementDerivedCredentialSettings](../resources/intune-shared-devicemanagementderivedcredentialsettings.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "notificationType": "String", "renewalThresholdPercentage": 1024 }-``` +``` |
v1.0 | Intune Rapolicy Devicemanagementresourceaccessprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementresourceaccessprofileassignment.md | Here is a JSON representation of the resource. }, "sourceId": "String" }-``` +``` |
v1.0 | Intune Rapolicy Devicemanagementresourceaccessprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md | Base Profile Type for Resource Access |creationDateTime|DateTimeOffset|DateTime profile was created| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified| |roleScopeTagIds|String collection|Scope Tags|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile| ## Relationships |Relationship|Type|Description| Here is a JSON representation of the resource. "lastModifiedDateTime": "String (timestamp)", "roleScopeTagIds": [ "String"+ ], + "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.osVersionApplicabilityRule", + "filterType": "String", + "minOSVersion": "String", + "maxOSVersion": "String" + } ] }-``` +``` |
v1.0 | Intune Rapolicy Devicemanagementresourceaccessprofileintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementresourceaccessprofileintent.md | The administrator intent for the assignment of the profile. |Member|Value|Description| |:|:|:| |apply|0|Apply the profile.|-|remove|1|Remove the profile from devices that have installed the profile.| +|remove|1|Remove the profile from devices that have installed the profile.| |
v1.0 | Intune Rapolicy Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-deviceplatformtype.md | Supported platform types. |windows10AndLater|6|Indicates device platform type is Windows 10 and later.| |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.| +|androidAOSP|9|Indicates device platform type is Android AOSP.| |
v1.0 | Intune Rapolicy Extendedkeyusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-extendedkeyusage.md | Here is a JSON representation of the resource. "name": "String", "objectIdentifier": "String" }-``` +``` |
v1.0 | Intune Rapolicy Filterassociationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-filterassociationtype.md | + + Title: "filterAssociationType enum type" +description: "Intune Rapolicy Filterassociationtype Resources ." ++localization_priority: Normal ++++# 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| +|:|:|:| +|unknown|0|| +|include|1|| +|exclude|2|| |
v1.0 | Intune Rapolicy Oseditionapplicabilityrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-oseditionapplicabilityrule.md | + + Title: "osEditionApplicabilityRule resource type" +description: "Intune Rapolicy Oseditionapplicabilityrule Resources ." ++localization_priority: Normal ++++# 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. +++++Inherits from [applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) ++## Properties +|Property|Type|Description| +|:|:|:| +|filterType|[filterAssociationType](../resources/intune-rapolicy-filterassociationtype.md)| Inherited from [applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md). Possible values are: `unknown`, `include`, `exclude`.| +|osEditions|Int32 collection|| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.osEditionApplicabilityRule" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.osEditionApplicabilityRule", + "filterType": "String", + "osEditions": [ + 1024 + ] +} +``` |
v1.0 | Intune Rapolicy Osversionapplicabilityrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-osversionapplicabilityrule.md | + + Title: "osVersionApplicabilityRule resource type" +description: "Intune Rapolicy Osversionapplicabilityrule Resources ." ++localization_priority: Normal ++++# 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. +++++Inherits from [applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) ++## Properties +|Property|Type|Description| +|:|:|:| +|filterType|[filterAssociationType](../resources/intune-rapolicy-filterassociationtype.md)| Inherited from [applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md). Possible values are: `unknown`, `include`, `exclude`.| +|minOSVersion|String|| +|maxOSVersion|String|| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.osVersionApplicabilityRule" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.osVersionApplicabilityRule", + "filterType": "String", + "minOSVersion": "String", + "maxOSVersion": "String" +} +``` |
v1.0 | Intune Rapolicy Policyplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-policyplatformtype.md | Supported platform types for policies. |androidWorkProfile|7|AndroidWorkProfile.| |windows10XProfile|8|Windows10XProfile.| |androidAOSP|9|AndroidAOSPProfile.|-|all|100|All platforms.| +|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 | Inherits from [deviceManagementResourceAccessProfileBase](../resources/intune-ra |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| ## Relationships |Relationship|Type|Description| Here is a JSON representation of the resource. "lastModifiedDateTime": "String (timestamp)", "roleScopeTagIds": [ "String"+ ], + "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "String" + } ] }-``` +``` |
v1.0 | Intune Rapolicy Windows10xcustomsubjectalternativename | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xcustomsubjectalternativename.md | Here is a JSON representation of the resource. "sanType": "String", "name": "String" }-``` +``` |
v1.0 | Intune Rapolicy Windows10xscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xscepcertificateprofile.md | Inherits from [windows10XCertificateProfile](../resources/intune-rapolicy-window |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| |certificateValidityPeriodScale|[certificateValidityPeriodScale](../resources/intune-shared-certificatevalidityperiodscale.md)|Scale for the Certificate Validity Period. Possible values are: `days`, `months`, `years`.| |certificateValidityPeriodValue|Int32|Value for the Certificate Validity Period|-|extendedKeyUsages|[extendedKeyUsage](../resources/intune-rapolicy-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-shared-extendedkeyusage.md) collection|Extended Key Usage (EKU) settings.| |hashAlgorithm|[hashAlgorithms](../resources/intune-shared-hashalgorithms.md) collection|SCEP Hash Algorithm.| |keySize|[keySize](../resources/intune-shared-keysize.md)|SCEP Key Size. Possible values are: `size1024`, `size2048`, `size4096`.| |keyStorageProvider|[keyStorageProviderOption](../resources/intune-shared-keystorageprovideroption.md)|Key Storage Provider (KSP). Possible values are: `useTpmKspOtherwiseUseSoftwareKsp`, `useTpmKspOtherwiseFail`, `usePassportForWorkKspOtherwiseFail`, `useSoftwareKsp`.| Here is a JSON representation of the resource. "roleScopeTagIds": [ "String" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "String" + } + ], "certificateStore": "String", "certificateValidityPeriodScale": "String", "certificateValidityPeriodValue": 1024, Here is a JSON representation of the resource. ], "subjectNameFormatString": "String" }-``` +``` |
v1.0 | Intune Rapolicy Windows10xtrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xtrustedrootcertificate.md | Inherits from [deviceManagementResourceAccessProfileBase](../resources/intune-ra |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |trustedRootCertificate|Binary|Trusted Root Certificate| |certFileName|String|File name to display in UI.| |destinationStore|[certificateDestinationStore](../resources/intune-shared-certificatedestinationstore.md)|Destination store location for the Trusted Root Certificate. Possible values are: `computerCertStoreRoot`, `computerCertStoreIntermediate`, `userCertStoreIntermediate`.| Here is a JSON representation of the resource. "roleScopeTagIds": [ "String" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "String" + } + ], "trustedRootCertificate": "binary", "certFileName": "String", "destinationStore": "String" }-``` +``` |
v1.0 | Intune Rapolicy Windows10xvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xvpnconfiguration.md | Inherits from [deviceManagementResourceAccessProfileBase](../resources/intune-ra |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |authenticationCertificateId|Guid|ID to the Authentication Certificate| |customXmlFileName|String|Custom Xml file name.| |customXml|Binary|Custom XML commands that configures the VPN connection. (UTF8 byte encoding)| Here is a JSON representation of the resource. "roleScopeTagIds": [ "String" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "String" + } + ], "authenticationCertificateId": "Guid", "customXmlFileName": "String", "customXml": "binary" }-``` +``` |
v1.0 | Intune Rapolicy Windows10xwificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xwificonfiguration.md | Inherits from [deviceManagementResourceAccessProfileBase](../resources/intune-ra |creationDateTime|DateTimeOffset|DateTime profile was created Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |lastModifiedDateTime|DateTimeOffset|DateTime profile was last modified Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |roleScopeTagIds|String collection|Scope Tags Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)|+|serverApplicabilityRules|[applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) collection|The list of Applicability Rules for a Device Configuration Profile Inherited from [deviceManagementResourceAccessProfileBase](../resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md)| |authenticationCertificateId|Guid|ID to the Authentication Certificate| |customXmlFileName|String|Custom Xml file name.| |customXml|Binary|Custom XML commands that configures the VPN connection. (UTF8 byte encoding)| Here is a JSON representation of the resource. "roleScopeTagIds": [ "String" ],+ "serverApplicabilityRules": [ + { + "@odata.type": "microsoft.graph.applicabilityRule", + "filterType": "String" + } + ], "authenticationCertificateId": "Guid", "customXmlFileName": "String", "customXml": "binary" }-``` +``` |
v1.0 | Intune Rbac Conceptual | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-conceptual.md | Namespace: microsoft.graph Intune's role-based access control determines who can perform actions on Intune objects and make changes for managed applications, users and devices. -Graph resources are available to manage role-based access control in Intune. See the table of content for a list of resources. +Graph resources are available to manage role-based access control in Intune. See the table of content for a list of resources. |
v1.0 | Intune Rbac Deviceandappmanagementassignedroledetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-deviceandappmanagementassignedroledetails.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Rbac Deviceandappmanagementroleassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-deviceandappmanagementroleassignment.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Rbac Deviceandappmanagementroledefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-deviceandappmanagementroledefinition.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Rbac Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-rbac-devicemanagement-get.md)|[deviceManagement](../resources/intune-rbac-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-rbac-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-rbac-devicemanagement-update.md)|[deviceManagement](../resources/intune-rbac-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-rbac-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-rbac-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-rbac-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| |[getEffectivePermissions function](../api/intune-rbac-devicemanagement-geteffectivepermissions.md)|String collection|| |[getEffectivePermissions function](../api/intune-rbac-devicemanagement-geteffectivepermissions.md)|[rolePermission](../resources/intune-rbac-rolepermission.md) collection|| |[getRoleScopeTagsByResource function](../api/intune-rbac-devicemanagement-getrolescopetagsbyresource.md)|[roleScopeTag](../resources/intune-rbac-rolescopetag.md) collection|| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Rbac Identity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-identity.md | Here is a JSON representation of the resource. "id": "String (identifier)", "displayName": "String" }-``` +``` |
v1.0 | Intune Rbac Identityset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-identityset.md | Here is a JSON representation of the resource. "displayName": "String" } }-``` +``` |
v1.0 | Intune Rbac Operationapprovalpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalpolicy.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Rbac Operationapprovalpolicyplatform | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalpolicyplatform.md | The set of available platforms for the OperationApprovalPolicy. Allows configura |windows10AndLater|16|Indicates that the configured policy platform is for Windows 10 and later.| |windows81AndLater|32|Indicates that the configured policy platform is for Windows 8.1 and later.| |windows10X|64|Indicates that the configured policy platform is for Windows 10X.|-|unknownFutureValue|128|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|128|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Rbac Operationapprovalpolicyset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalpolicyset.md | Here is a JSON representation of the resource. "policyType": "String", "policyPlatform": "String" }-``` +``` |
v1.0 | Intune Rbac Operationapprovalpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalpolicytype.md | The set of available policy types that can be configured for approval. There is |role|18|Indicates that the configured policy type is for a Role.| |deviceResetPasscode|19|Indicates that the configured policy type is for a Device Reset Passcode Action.| |customOrganizationalMessage|20|Indicates that the configured policy type is for a Custom Organizational Message.|-|unknownFutureValue|21|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|21|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Rbac Operationapprovalrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalrequest.md | The OperationApprovalRequest entity encompasses the operation an admin wishes to |status|[operationApprovalRequestStatus](../resources/intune-rbac-operationapprovalrequeststatus.md)|The current approval status of the request. Possible values are: `unknown`, `needsApproval`, `approved`, `rejected`, `cancelled`, `completed`, `expired`. Default value is `unknown`. Read-only. This property is read-only. Possible values are: `unknown`, `needsApproval`, `approved`, `rejected`, `cancelled`, `completed`, `expired`, `unknownFutureValue`.| |requestJustification|String|Indicates the justification for creating the request. Maximum length of justification is 1024 characters. For example: 'Needed for Feb 2023 application baseline updates.' Read-only. This property is read-only.| |approvalJustification|String|Indicates the justification for approving or rejecting the request. Maximum length of justification is 1024 characters. For example: 'Approved per Change 23423 - needed for Feb 2023 application baseline updates.' Read-only. This property is read-only.|-|operationApprovalPolicies|String|The operational approval policies used in the request. Indicates the policy and platform combinations that are required for this request to be approved or rejected. Read-only. This property is read-only.| |requiredOperationApprovalPolicyTypes|[operationApprovalPolicyType](../resources/intune-rbac-operationapprovalpolicytype.md) collection|Indicates the approval policy types required by the request in order for the request to be approved or rejected. Read-only. This property is read-only.| ## Relationships Here is a JSON representation of the resource. "status": "String", "requestJustification": "String", "approvalJustification": "String",- "operationApprovalPolicies": "String", "requiredOperationApprovalPolicyTypes": [ "String" ] }-``` +``` |
v1.0 | Intune Rbac Operationapprovalrequestentitystatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalrequestentitystatus.md | Here is a JSON representation of the resource. "requestStatus": "String", "entityLocked": true }-``` +``` |
v1.0 | Intune Rbac Operationapprovalrequeststatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalrequeststatus.md | Indicates the status of the Approval Request. The status of a request will chang |cancelled|4|Indicates that the approval request has been cancelled by the request's requestor. No further action can be taken to complete the operation or to modify the request.| |completed|5|Indicates that the approval request has been completed. This status is feature agnostic and does not indicate success or failure of the operation. No further action is necessary for the operation or to modify the request.| |expired|6|Indicates that the approval request has expired. No further action can be taken to complete the operation or to modify the request. A new approval request must be made and approved in order to complete the operation.|-|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Rbac Operationapprovalsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalsource.md | Source of the action on the approval request. |unknown|0|Default. Indicates the source of the action on the approval request is unknown.| |adminConsole|1|Indicates the source of the action on the approval request is from an interactive session using the Intune Admin Console.| |email|2|Indicates the source of the action on the approval request is from an email based form.|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Rbac Rbacapplicationmultiple | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-rbacapplicationmultiple.md | Namespace: microsoft.graph ## Properties |Property|Type|Description| |:|:|:|-|id|String|| ## Relationships None Here is a JSON representation of the resource. --> ``` json {- "@odata.type": "#microsoft.graph.rbacApplicationMultiple", - "id": "String (identifier)" + "@odata.type": "#microsoft.graph.rbacApplicationMultiple" }-``` +``` |
v1.0 | Intune Rbac Resourceaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-resourceaction.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Rbac Resourceoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-resourceoperation.md | Here is a JSON representation of the resource. "description": "String", "enabledForScopeValidation": true }-``` +``` |
v1.0 | Intune Rbac Roleassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-roleassignment.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Rbac Roleassignmentscopetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-roleassignmentscopetype.md | Specifies the type of scope for a Role Assignment. |resourceScope|0|Allow assignments to the specified ResourceScopes.| |allDevices|1|Allow assignments to all Intune devices.| |allLicensedUsers|2|Allow assignments to all Intune licensed users.|-|allDevicesAndLicensedUsers|3|Allow assignments to all Intune devices and licensed users.| +|allDevicesAndLicensedUsers|3|Allow assignments to all Intune devices and licensed users.| |
v1.0 | Intune Rbac Roledefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-roledefinition.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Rbac Rolemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-rolemanagement.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.roleManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Rbac Rolepermission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-rolepermission.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Rbac Rolescopetag | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-rolescopetag.md | Here is a JSON representation of the resource. "description": "String", "isBuiltIn": true }-``` +``` |
v1.0 | Intune Rbac Rolescopetagautoassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-rolescopetagautoassignment.md | Here is a JSON representation of the resource. "entraObjectId": "String" } }-``` +``` |
v1.0 | Intune Remoteassistance Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-remoteassistance-devicemanagement-get.md)|[deviceManagement](../resources/intune-remoteassistance-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-remoteassistance-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-remoteassistance-devicemanagement-update.md)|[deviceManagement](../resources/intune-remoteassistance-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-remoteassistance-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-remoteassistance-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-remoteassistance-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| |[getAllowedRemoteAssistanceActions function](../api/intune-remoteassistance-devicemanagement-getallowedremoteassistanceactions.md)|[allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md)|| |[reportRemoteAssistance action](../api/intune-remoteassistance-devicemanagement-reportremoteassistance.md)|None|A post call to submit the reporting payload| |[reportRemoteHelpSessionStartTime action](../api/intune-remoteassistance-devicemanagement-reportremotehelpsessionstarttime.md)|None|| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Remoteassistance Devicemanagementreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-devicemanagementreports.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementReports", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Remoteassistance Enrollmentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-enrollmentstate.md | This status denotes the current enrollent state of the device |pendingReset|2|Enrolled but it's enrolled via enrollment profile and the enrolled profile is different from the assigned profile.| |failed|3|Not enrolled and there is enrollment failure record.| |notContacted|4|Device is imported but not enrolled.|-|blocked|5|Device is enrolled as userless, but is blocked from moving to user enrollment because the app failed to install.| +|blocked|5|Device is enrolled as userless, but is blocked from moving to user enrollment because the app failed to install.| |
v1.0 | Intune Remoteassistance Remoteassistanceonboardingstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-remoteassistanceonboardingstatus.md | The current TeamViewer connector status |:|:|:| |notOnboarded|0|The status reported when there is no active TeamViewer connector configured or active| |onboarding|1|The status reported when the system has initiated a TeamViewer connection, but the service has not yet completed the confirmation of a connector|-|onboarded|2|The status reported when the system has successfully exchanged account information with TeamViewer and can now initiate remote assistance sessions with clients| +|onboarded|2|The status reported when the system has successfully exchanged account information with TeamViewer and can now initiate remote assistance sessions with clients| |
v1.0 | Intune Remoteassistance Remoteassistancepartner | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-remoteassistancepartner.md | Here is a JSON representation of the resource. "lastConnectionDateTime": "String (timestamp)", "onboardingRequestExpiryDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Remoteassistance Remoteassistancesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-remoteassistancesettings.md | Here is a JSON representation of the resource. "allowSessionsToUnenrolledDevices": true, "blockChat": true }-``` +``` |
v1.0 | Intune Remoteassistance Remoteassistancestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-remoteassistancestate.md | State of remote assistance for the account |Member|Value|Description| |:|:|:| |disabled|1|Remote assistance is disabled for the account. With this value, Quick Assist remote assistance sessions are not allowed for the account.|-|enabled|2|Remote assistance is enabled for the account. With this value, enterprise Quick Assist remote assistance features are provided.| +|enabled|2|Remote assistance is enabled for the account. With this value, enterprise Quick Assist remote assistance features are provided.| |
v1.0 | Intune Reporting Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-reporting-devicemanagement-get.md)|[deviceManagement](../resources/intune-reporting-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-reporting-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-reporting-devicemanagement-update.md)|[deviceManagement](../resources/intune-reporting-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-reporting-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-reporting-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-reporting-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Reporting Devicemanagementcachedreportconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementcachedreportconfiguration.md | Here is a JSON representation of the resource. "lastRefreshDateTime": "String (timestamp)", "expirationDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Reporting Devicemanagementexportjob | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementexportjob.md | Here is a JSON representation of the resource. "requestDateTime": "String (timestamp)", "expirationDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Reporting Devicemanagementexportjoblocalizationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementexportjoblocalizationtype.md | Configures how the requested export job is localized. |Member|Value|Description| |:|:|:| |localizedValuesAsAdditionalColumn|0|Configures the export job to expose localized values as an additional column.|-|replaceLocalizableValues|1|Configures the export job to replace enumerable values with their localized values.| +|replaceLocalizableValues|1|Configures the export job to replace enumerable values with their localized values.| |
v1.0 | Intune Reporting Devicemanagementreportfileformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementreportfileformat.md | Possible values for the file format of a report. |csv|0|CSV Format.| |pdf|1|PDF Format (Deprecate later).| |json|2|JSON Format.|-|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Reporting Devicemanagementreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementreports.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementReports", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Reporting Devicemanagementreportschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementreportschedule.md | Here is a JSON representation of the resource. ], "format": "String" }-``` +``` |
v1.0 | Intune Reporting Devicemanagementreportstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementreportstatus.md | Possible statuses associated with a generated report. |notStarted|1|Report generation has not started.| |inProgress|2|Report generation is in progress.| |completed|3|Report generation is completed.|-|failed|4|Report generation has failed.| +|failed|4|Report generation has failed.| |
v1.0 | Intune Reporting Devicemanagementscheduledreportrecurrence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementscheduledreportrecurrence.md | Possible values for the recurrence of a scheduled report |none|0|Default value, specifies a single occurence| |daily|1|Daily| |weekly|2|Weekly|-|monthly|3|Monthly| +|monthly|3|Monthly| |
v1.0 | Intune Resaccess Conceptual | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-resaccess-conceptual.md | Namespace: microsoft.graph You can import PFX certificates using Microsoft Graph API for Intune. -Use Graph resources to manage certificates in Intune. See the table of content for a list of resources. +Use Graph resources to manage certificates in Intune. See the table of content for a list of resources. |
v1.0 | Intune Servicenowconnectorservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-servicenowconnectorservice-devicemanagement.md | Singleton that acts as container for a collection of Resource Access entities. ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-servicenowconnectorservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-servicenowconnectorservice-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-servicenowconnectorservice-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-servicenowconnectorservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-servicenowconnectorservice-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-servicenowconnectorservice-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-servicenowconnectorservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-servicenowconnectorservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Servicenowconnectorservice Servicenowauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-servicenowconnectorservice-servicenowauthenticationmethod.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.serviceNowAuthenticationMethod" }-``` +``` |
v1.0 | Intune Servicenowconnectorservice Servicenowconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-servicenowconnectorservice-servicenowconnection.md | Here is a JSON representation of the resource. "lastModifiedDateTime": "String (timestamp)", "lastQueriedDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Servicenowconnectorservice Servicenowconnectionstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-servicenowconnectorservice-servicenowconnectionstatus.md | Status of ServiceNow Connection |:|:|:| |disabled|0|Tenant has disabled the connection| |enabled|1|Tenant has enabled the connection|-|unknownFutureValue|2|Future authentication method to be added here.| +|unknownFutureValue|2|Future authentication method to be added here.| |
v1.0 | Intune Servicenowconnectorservice Servicenowoauthsecretauthentication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-servicenowconnectorservice-servicenowoauthsecretauthentication.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.serviceNowOauthSecretAuthentication", "appId": "String" }-``` +``` |
v1.0 | Intune Shared Actionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-actionstate.md | State of the action on the device |active|3|Action is active.| |done|4|Action completed without errors.| |failed|5|Action failed|-|notSupported|6|Action is not supported.| +|notSupported|6|Action is not supported.| |
v1.0 | Intune Shared Alldevicesassignmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-alldevicesassignmenttarget.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterId": "String", "deviceAndAppManagementAssignmentFilterType": "String" }-``` +``` |
v1.0 | Intune Shared Alllicensedusersassignmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-alllicensedusersassignmenttarget.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterId": "String", "deviceAndAppManagementAssignmentFilterType": "String" }-``` +``` |
v1.0 | Intune Shared Androidenterprisealwaysonvpnpackagetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-androidenterprisealwaysonvpnpackagetype.md | Namespace: microsoft.graph |ciscoAnyConnect|2|Cisco AnyConnect.| |f5Access|3|F5 Access.| |paloAltoNetworksGlobalProtect|4|Palo Alto Networks GlobalProtect.|-|pulseSecure|5|Pulse Secure.| +|pulseSecure|5|Pulse Secure.| |
v1.0 | Intune Shared Androidmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-androidmanagedappprotection.md | Here is a JSON representation of the resource. "minimumWarningCompanyPortalVersion": "String", "minimumWipeCompanyPortalVersion": "String" }-``` +``` |
v1.0 | Intune Shared Androidmanagedstoreappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-androidmanagedstoreappassignmentsettings.md | Here is a JSON representation of the resource. ], "autoUpdateMode": "String" }-``` +``` |
v1.0 | Intune Shared Androidmanagedstoreautoupdatemode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-androidmanagedstoreautoupdatemode.md | Prioritization for automatic updates of Android Managed Store apps set on assign |default|0|Default update behavior (device must be connected to Wifi, charging and not actively used).| |postponed|1|Updates are postponed for a maximum of 90 days after the app becomes out of date.| |priority|2|The app is updated as soon as possible by the developer. If device is online, it will be updated within minutes.|-|unknownFutureValue|3|Unknown future mode (reserved, not used right now).| +|unknownFutureValue|3|Unknown future mode (reserved, not used right now).| |
v1.0 | Intune Shared Certificatedestinationstore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-certificatedestinationstore.md | Possible values for the Certificate Destination Store. |:|:|:| |computerCertStoreRoot|0|Computer Certificate Store - Root.| |computerCertStoreIntermediate|1|Computer Certificate Store - Intermediate.|-|userCertStoreIntermediate|2|User Certificate Store - Intermediate.| +|userCertStoreIntermediate|2|User Certificate Store - Intermediate.| |
v1.0 | Intune Shared Certificateissuancestates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-certificateissuancestates.md | Certificate Issuance State Options. |deleteFailed|19|| |deleted|20|| |renewalRequested|21||-|requested|22|| +|requested|22|| |
v1.0 | Intune Shared Certificaterevocationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-certificaterevocationstatus.md | Certificate Revocation Status. |pending|1|Revocation pending.| |issued|2|Revocation command issued.| |failed|3|Revocation failed.|-|revoked|4|Revoked.| +|revoked|4|Revoked.| |
v1.0 | Intune Shared Certificatestore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-certificatestore.md | CertificateStore types |Member|Value|Description| |:|:|:| |user|1||-|machine|2|| +|machine|2|| |
v1.0 | Intune Shared Certificatevalidityperiodscale | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-certificatevalidityperiodscale.md | Certificate Validity Period Options. |:|:|:| |days|0|Days.| |months|1|Months.|-|years|2|Years.| +|years|2|Years.| |
v1.0 | Intune Shared Companyportalaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-companyportalaction.md | Action on a device that can be executed in the Company Portal |:|:|:| |unknown|0|Unknown device action| |remove|1|Remove device from Company Portal|-|reset|2|Reset device enrolled in Company Portal| +|reset|2|Reset device enrolled in Company Portal| |
v1.0 | Intune Shared Companyportalblockedaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-companyportalblockedaction.md | Here is a JSON representation of the resource. "ownerType": "String", "action": "String" }-``` +``` |
v1.0 | Intune Shared Compliancestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-compliancestatus.md | Namespace: microsoft.graph |nonCompliant|4|| |error|5|| |conflict|6||-|notAssigned|7|| +|notAssigned|7|| |
v1.0 | Intune Shared Conceptual | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-conceptual.md | Namespace: microsoft.graph These endpoints are used in multiple Microsoft Graph API for Intune workflows. The intent, purpose, and permissions required to use a given resource varies according to the specific workflow and context of the underlying call. In addition, certain methods, properties, and actions are supported only for specific workflows. -Graph resources are shared between Intune workflows. See the table of content for a list of resources. +Graph resources are shared between Intune workflows. See the table of content for a list of resources. |
v1.0 | Intune Shared Configurationmanagercollectionassignmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-configurationmanagercollectionassignmenttarget.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterType": "String", "collectionId": "String" }-``` +``` |
v1.0 | Intune Shared Deviceandappmanagementassignmentfiltertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-deviceandappmanagementassignmentfiltertype.md | Represents type of the assignment filter. |:|:|:| |none|0|Default value. Do not use.| |include|1|Indicates in-filter, rule matching will offer the payload to devices.|-|exclude|2|Indicates out-filter, rule matching will not offer the payload to devices.| +|exclude|2|Indicates out-filter, rule matching will not offer the payload to devices.| |
v1.0 | Intune Shared Deviceandappmanagementassignmentsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-deviceandappmanagementassignmentsource.md | Represents source of assignment. |Member|Value|Description| |:|:|:| |direct|0|Direct indicates a direct assignment.|-|policySets|1|PolicySets indicates assignment was made via PolicySet assignment.| +|policySets|1|PolicySets indicates assignment was made via PolicySet assignment.| |
v1.0 | Intune Shared Deviceandappmanagementassignmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-deviceandappmanagementassignmenttarget.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterId": "String", "deviceAndAppManagementAssignmentFilterType": "String" }-``` +``` |
v1.0 | Intune Shared Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-deviceappmanagement.md | Here is a JSON representation of the resource. Note that this is only an exampl "microsoftStoreForBusinessLanguage": "String", "microsoftStoreForBusinessLastCompletedApplicationSyncTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Shared Devicecategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicecategory.md | Here is a JSON representation of the resource. "displayName": "String", "description": "String" }-``` +``` |
v1.0 | Intune Shared Devicecompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicecompliancepolicy.md | Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Shared Deviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-deviceconfiguration.md | Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Shared Deviceenrollmentconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-deviceenrollmentconfiguration.md | Here is a JSON representation of the resource. "lastModifiedDateTime": "String (timestamp)", "version": 1024 }-``` +``` |
v1.0 | Intune Shared Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagement.md | Here is a JSON representation of the resource. "id": "String (identifier)", "subscriptionState": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationazureadtrusttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationazureadtrusttype.md | Required AAD Trust Type |none|0|No AAD Trust Type specified| |azureAdJoined|1|AAD Joined Trust Type| |addWorkAccount|2|AddWorkAccount|-|mdmOnly|4|MDM only| +|mdmOnly|4|MDM only| |
v1.0 | Intune Shared Devicemanagementconfigurationchoicesettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationchoicesettingcollectioninstance.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationchoicesettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationchoicesettingdefinition.md | Here is a JSON representation of the resource. ], "defaultOptionId": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationchoicesettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationchoicesettinginstance.md | Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationchoicesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationchoicesettingvalue.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationcontroltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationcontroltype.md | Setting control type representation in the UX |largeTextBox|3|Display text input in large text input| |toggle|4|Allow for toggle control type| |multiheaderGrid|5|Allow for multiheader grid control type|-|contextPane|6|Allow for context pane control type| +|contextPane|6|Allow for context pane control type| |
v1.0 | Intune Shared Devicemanagementconfigurationdependenton | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationdependenton.md | Here is a JSON representation of the resource. "dependentOn": "String", "parentSettingId": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationdevicemode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationdevicemode.md | Describes applicability for the mode the device is in |Member|Value|Description| |:|:|:| |none|0|No Device Mode specified|-|kiosk|1|Device must be in kiosk mode for this setting to apply| +|kiosk|1|Device must be in kiosk mode for this setting to apply| |
v1.0 | Intune Shared Devicemanagementconfigurationexchangeonlinesettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationexchangeonlinesettingapplicability.md | Here is a JSON representation of the resource. "deviceMode": "String", "technologies": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationgroupsettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationgroupsettingcollectioninstance.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationgroupsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationgroupsettinginstance.md | Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationgroupsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationgroupsettingvalue.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationintegersettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationintegersettingvalue.md | Here is a JSON representation of the resource. }, "value": 1024 }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationintegersettingvaluedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationintegersettingvaluedefinition.md | Here is a JSON representation of the resource. "maximumValue": 1024, "minimumValue": 1024 }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationoptiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationoptiondefinition.md | Here is a JSON representation of the resource. "name": "String", "displayName": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationplatforms | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationplatforms.md | Supported platform types. |windows10X|16|Windows 10 X.| |windows10|32|Windows 10.| |linux|128|Linux.|-|unknownFutureValue|1073741824|Sentinel member for cases where the client cannot handle the new enum values.| +|unknownFutureValue|1073741824|Sentinel member for cases where the client cannot handle the new enum values.| |
v1.0 | Intune Shared Devicemanagementconfigurationredirectsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationredirectsettingdefinition.md | Here is a JSON representation of the resource. "redirectMessage": "String", "redirectReason": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationreferencesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationreferencesettingvalue.md | Here is a JSON representation of the resource. "value": "String", "note": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationreferredsettinginformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationreferredsettinginformation.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementConfigurationReferredSettingInformation", "settingDefinitionId": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsecretsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsecretsettingvalue.md | Here is a JSON representation of the resource. "value": "String", "valueState": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsecretsettingvaluestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsecretsettingvaluestate.md | type tracking the encryption state of a secret setting value |:|:|:| |invalid|0|default invalid value| |notEncrypted|1|secret value is not encrypted|-|encryptedValueToken|2|a token for the encrypted value is returned by the service| +|encryptedValueToken|2|a token for the encrypted value is returned by the service| |
v1.0 | Intune Shared Devicemanagementconfigurationsettingaccesstypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettingaccesstypes.md | Not yet documented |delete|4|Not yet documented| |get|8|Not yet documented| |replace|16|Not yet documented|-|execute|32|Not yet documented| +|execute|32|Not yet documented| |
v1.0 | Intune Shared Devicemanagementconfigurationsettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettingapplicability.md | Here is a JSON representation of the resource. "deviceMode": "String", "technologies": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettingdefinition.md | Here is a JSON representation of the resource. "displayName": "String", "version": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettingdependedonby | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettingdependedonby.md | Here is a JSON representation of the resource. "dependedOnBy": "String", "required": true }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettinggroupcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettinggroupcollectioninstance.md | Here is a JSON representation of the resource. "settingInstanceTemplateId": "String" } }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettinggroupdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettinggroupdefinition.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettinggroupinstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettinggroupinstance.md | Here is a JSON representation of the resource. "settingInstanceTemplateId": "String" } }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettinginstance.md | Here is a JSON representation of the resource. "settingInstanceTemplateId": "String" } }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettinginstancetemplatereference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettinginstancetemplatereference.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementConfigurationSettingInstanceTemplateReference", "settingInstanceTemplateId": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettingoccurrence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettingoccurrence.md | Here is a JSON representation of the resource. "minDeviceOccurrence": 1024, "maxDeviceOccurrence": 1024 }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettingusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettingusage.md | Supported setting types |:|:|:| |none|0|No setting type specified| |configuration|1|Configuration setting|-|compliance|2|Compliance setting| +|compliance|2|Compliance setting| |
v1.0 | Intune Shared Devicemanagementconfigurationsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettingvalue.md | Here is a JSON representation of the resource. "useTemplateDefault": true } }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettingvaluedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettingvaluedefinition.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.deviceManagementConfigurationSettingValueDefinition" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettingvaluetemplatereference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettingvaluetemplatereference.md | Here is a JSON representation of the resource. "settingValueTemplateId": "String", "useTemplateDefault": true }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsettingvisibility | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsettingvisibility.md | Supported setting types |:|:|:| |none|0|Not visible| |settingsCatalog|1|Visible to setting catalog UX|-|template|2|Visible to template| +|template|2|Visible to template| |
v1.0 | Intune Shared Devicemanagementconfigurationsimplesettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsimplesettingcollectioninstance.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsimplesettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsimplesettingdefinition.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsimplesettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsimplesettinginstance.md | Here is a JSON representation of the resource. "value": "String" } }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationsimplesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationsimplesettingvalue.md | Here is a JSON representation of the resource. "useTemplateDefault": true } }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationstringformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationstringformat.md | Not yet documented |regEx|11|Not yet documented| |json|12|Not yet documented| |dateTime|13|Not yet documented|-|surfaceHub|14|Not yet documented| +|surfaceHub|14|Not yet documented| |
v1.0 | Intune Shared Devicemanagementconfigurationstringsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationstringsettingvalue.md | Here is a JSON representation of the resource. }, "value": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationtechnologies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationtechnologies.md | Describes which technology this setting can be deployed with |linuxMdm|1024|Setting can be deployed through the Linux Mdm channel| |enrollment|4096|Setting can be deployed through device enrollment.| |endpointPrivilegeManagement|8192|Setting can be deployed using the Endpoint privilege management channel|-|unknownFutureValue|16384|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|16384|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Shared Devicemanagementconfigurationwindowssettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationwindowssettingapplicability.md | Here is a JSON representation of the resource. "requiresAzureAd": true, "requiredAzureAdTrustType": "String" }-``` +``` |
v1.0 | Intune Shared Devicemanagementconfigurationwindowsskus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementconfigurationwindowsskus.md | Not yet documented |holoLensEnterprise|11|Not yet documented| |holographicForBusiness|12|Not yet documented| |windowsMultiSession|13|Not yet documented|-|surfaceHub|14|Not yet documented| +|surfaceHub|14|Not yet documented| |
v1.0 | Intune Shared Devicemanagementderivedcredentialsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementderivedcredentialsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementDerivedCredentialSettings", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Shared Devicemanagementscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicemanagementscript.md | Here is a JSON representation of the resource. ], "runAs32Bit": true }-``` +``` |
v1.0 | Intune Shared Devicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-devicetype.md | Device type. |blackberry|100|Blackberry.| |palm|101|Palm.| |unknown|255|Represents that the device type is unknown.|-|cloudPC|257|Cloud PC device.| +|cloudPC|257|Cloud PC device.| |
v1.0 | Intune Shared Enablement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-enablement.md | Possible values of a property |:|:|:| |notConfigured|0|Device default value, no intent.| |enabled|1|Enables the setting on the device.|-|disabled|2|Disables the setting on the device.| +|disabled|2|Disables the setting on the device.| |
v1.0 | Intune Shared Enrollmentavailabilityoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-enrollmentavailabilityoptions.md | Options available for enrollment flow customization |:|:|:| |availableWithPrompts|0|Device enrollment flow is shown to the end user with guided enrollment prompts| |availableWithoutPrompts|1|Device enrollment flow is available to the end user without guided enrollment prompts|-|unavailable|2|Device enrollment flow is unavailable to the enduser| +|unavailable|2|Device enrollment flow is unavailable to the enduser| |
v1.0 | Intune Shared Enrollmentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-enrollmentstate.md | Namespace: microsoft.graph |pendingReset|2|Enrolled but it's enrolled via enrollment profile and the enrolled profile is different from the assigned profile.| |failed|3|Not enrolled and there is enrollment failure record.| |notContacted|4|Device is imported but not enrolled.|-|blocked|5|Device is enrolled as userless, but is blocked from moving to user enrollment because the app failed to install.| +|blocked|5|Device is enrolled as userless, but is blocked from moving to user enrollment because the app failed to install.| |
v1.0 | Intune Shared Exclusiongroupassignmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-exclusiongroupassignmenttarget.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterType": "String", "groupId": "String" }-``` +``` |
v1.0 | Intune Shared Extendedkeyusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-extendedkeyusage.md | Here is a JSON representation of the resource. "name": "String", "objectIdentifier": "String" }-``` +``` |
v1.0 | Intune Shared Groupassignmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-groupassignmenttarget.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterType": "String", "groupId": "String" }-``` +``` |
v1.0 | Intune Shared Hashalgorithms | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-hashalgorithms.md | Hash Algorithm Options. |Member|Value|Description| |:|:|:| |sha1|1|SHA-1 Hash Algorithm.|-|sha2|2|SHA-2 Hash Algorithm.| +|sha2|2|SHA-2 Hash Algorithm.| |
v1.0 | Intune Shared Installintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-installintent.md | Possible values for the install intent chosen by the admin. |available|0|Available install intent.| |required|1|Required install intent.| |uninstall|2|Uninstall install intent.|-|availableWithoutEnrollment|3|Available without enrollment install intent.| +|availableWithoutEnrollment|3|Available without enrollment install intent.| |
v1.0 | Intune Shared Ioslobappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-ioslobappassignmentsettings.md | Here is a JSON representation of the resource. "isRemovable": true, "preventManagedAppBackup": true }-``` +``` |
v1.0 | Intune Shared Ioslobappprovisioningconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-ioslobappprovisioningconfiguration.md | Here is a JSON representation of the resource. "displayName": "String", "version": 1024 }-``` +``` |
v1.0 | Intune Shared Iosmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-iosmanagedappprotection.md | Here is a JSON representation of the resource. "protectInboundDataFromUnknownSources": true, "customBrowserProtocol": "String" }-``` +``` |
v1.0 | Intune Shared Iosstoreappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-iosstoreappassignmentsettings.md | Here is a JSON representation of the resource. "isRemovable": true, "preventManagedAppBackup": true }-``` +``` |
v1.0 | Intune Shared Iosvppappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-iosvppappassignmentsettings.md | Here is a JSON representation of the resource. "preventManagedAppBackup": true, "preventAutoAppUpdate": true }-``` +``` |
v1.0 | Intune Shared Iprange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-iprange.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.ipRange" }-``` +``` |
v1.0 | Intune Shared Ipv4range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-ipv4range.md | Here is a JSON representation of the resource. "lowerAddress": "String", "upperAddress": "String" }-``` +``` |
v1.0 | Intune Shared Ipv6range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-ipv6range.md | Here is a JSON representation of the resource. "lowerAddress": "String", "upperAddress": "String" }-``` +``` |
v1.0 | Intune Shared Keylongvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-keylongvaluepair.md | Here is a JSON representation of the resource. "name": "String", "value": 1024 }-``` +``` |
v1.0 | Intune Shared Keysize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-keysize.md | Key Size Options. |:|:|:| |size1024|0|1024 Bits.| |size2048|1|2048 Bits.|-|size4096|2|4096 Bits.| +|size4096|2|4096 Bits.| |
v1.0 | Intune Shared Keystorageprovideroption | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-keystorageprovideroption.md | Key Storage Provider (KSP) Import Options. |useTpmKspOtherwiseUseSoftwareKsp|0|Import to Trusted Platform Module (TPM) KSP if present, otherwise import to Software KSP.| |useTpmKspOtherwiseFail|1|Import to Trusted Platform Module (TPM) KSP if present, otherwise fail.| |usePassportForWorkKspOtherwiseFail|2|Import to Passport for work KSP if available, otherwise fail.|-|useSoftwareKsp|3|Import to Software KSP.| +|useSoftwareKsp|3|Import to Software KSP.| |
v1.0 | Intune Shared Keyusages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-keyusages.md | Key Usage Options. |Member|Value|Description| |:|:|:| |keyEncipherment|1|Key Encipherment Usage.|-|digitalSignature|2|Digital Signature Usage.| +|digitalSignature|2|Digital Signature Usage.| |
v1.0 | Intune Shared Keyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-keyvaluepair.md | Here is a JSON representation of the resource. "name": "String", "value": "String" }-``` +``` |
v1.0 | Intune Shared Macoslobappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-macoslobappassignmentsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.macOsLobAppAssignmentSettings", "uninstallOnDeviceRemoval": true }-``` +``` |
v1.0 | Intune Shared Macosvppappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-macosvppappassignmentsettings.md | Here is a JSON representation of the resource. "preventManagedAppBackup": true, "preventAutoAppUpdate": true }-``` +``` |
v1.0 | Intune Shared Manageddevicearchitecture | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-manageddevicearchitecture.md | Processor architecture |x86|1|X86| |x64|2|X64| |arm|3|ARM|-|arM64|4|ARM64| +|arM64|4|ARM64| |
v1.0 | Intune Shared Manageddeviceownertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-manageddeviceownertype.md | Owner type of device. |:|:|:| |unknown|0|Unknown.| |company|1|Owned by company.|-|personal|2|Owned by person.| +|personal|2|Owned by person.| |
v1.0 | Intune Shared Managementagenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-managementagenttype.md | Management agent type. |msSense|1024|| |intuneAosp|2048|This device is managed by Intune's MDM for AOSP (Android Open Source Project) devices| |google|8192|Indicates the management agent to manage the device is Google.|-|unknownFutureValue|8193|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|8193|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Shared Mdmwindowsinformationprotectionpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-mdmwindowsinformationprotectionpolicy.md | Here is a JSON representation of the resource. ], "isAssigned": true }-``` +``` |
v1.0 | Intune Shared Microsoftstoreforbusinessappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-microsoftstoreforbusinessappassignmentsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.microsoftStoreForBusinessAppAssignmentSettings", "useDeviceContext": true }-``` +``` |
v1.0 | Intune Shared Mimecontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-mimecontent.md | Here is a JSON representation of the resource. "type": "String", "value": "binary" }-``` +``` |
v1.0 | Intune Shared Mobileapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-mobileapp.md | Here is a JSON representation of the resource. ], "dependentAppCount": 1024 }-``` +``` |
v1.0 | Intune Shared Mobileappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-mobileappassignmentsettings.md | Here is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.mobileAppAssignmentSettings" }-``` +``` |
v1.0 | Intune Shared Mobileappinstalltimesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-mobileappinstalltimesettings.md | Here is a JSON representation of the resource. "startDateTime": "String (timestamp)", "deadlineDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Shared Mobileapptroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-mobileapptroubleshootingevent.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Shared Ownertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-ownertype.md | Owner type of device. |:|:|:| |unknown|0|Unknown.| |company|1|Owned by company.|-|personal|2|Owned by person.| +|personal|2|Owned by person.| |
v1.0 | Intune Shared Proxieddomain | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-proxieddomain.md | Here is a JSON representation of the resource. "ipAddressOrFQDN": "String", "proxy": "String" }-``` +``` |
v1.0 | Intune Shared Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-report.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.report", "content": "<Unknown Primitive Type Edm.Stream>" }-``` +``` |
v1.0 | Intune Shared Reportroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-reportroot.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.reportRoot", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Shared Resultantappstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-resultantappstate.md | A list of possible states for application status on an individual device. When d |uninstallFailed|4|The application failed to uninstall.| |pendingInstall|5|The installation of the application is in progress.| |unknown|99|The status of the application is unknown.|-|notApplicable|-1|The application is not applicable.| +|notApplicable|-1|The application is not applicable.| |
v1.0 | Intune Shared Rgbcolor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-rgbcolor.md | Here is a JSON representation of the resource. "g": 1024, "b": 1024 }-``` +``` |
v1.0 | Intune Shared Runasaccounttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-runasaccounttype.md | Indicates the type of execution context the app runs in. |Member|Value|Description| |:|:|:| |system|0|System context|-|user|1|User context| +|user|1|User context| |
v1.0 | Intune Shared Runstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-runstate.md | Indicates the type of execution status of the device management script. |fail|2|Script failed to run.| |scriptError|3|Discovery script hits error.| |pending|4|Script is pending to execute.|-|notApplicable|5|Script is not applicable for this device.| +|notApplicable|5|Script is not applicable for this device.| |
v1.0 | Intune Shared Saveduistategenerationoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-saveduistategenerationoptions.md | Namespace: microsoft.graph |Member|Value|Description| |:|:|:| |none|0||-|omitSilverlightPolicyReferences|1|| +|omitSilverlightPolicyReferences|1|| |
v1.0 | Intune Shared Scopetaggroupassignmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-scopetaggroupassignmenttarget.md | Here is a JSON representation of the resource. "targetType": "String", "entraObjectId": "String" }-``` +``` |
v1.0 | Intune Shared Scopetagtargettype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-scopetagtargettype.md | Specifies which type of Entra object to target in the Group for a given ScopeTag |none|0|Unused value. Do not use.| |user|1|Indicates the ScopeTag assignment will Target Users in the Group Ids provided.| |device|2|Indicates the ScopeTag assignment will Target Devices in the Group Ids provided.|-|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Shared Settingsourcetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-settingsourcetype.md | Namespace: microsoft.graph |Member|Value|Description| |:|:|:| |deviceConfiguration|0||-|deviceIntent|1|| +|deviceIntent|1|| |
v1.0 | Intune Shared Subjectalternativenametype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-subjectalternativenametype.md | Subject Alternative Name Options. |userPrincipalName|2|User Principal Name (UPN).| |customAzureADAttribute|4|Custom Azure AD Attribute.| |domainNameService|8|Domain Name Service (DNS).|-|universalResourceIdentifier|16|Universal Resource Identifier (URI).| +|universalResourceIdentifier|16|Universal Resource Identifier (URI).| |
v1.0 | Intune Shared Subjectnameformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-subjectnameformat.md | Subject Name Format Options. |commonNameAsSerialNumber|6|Common Name As Serial Number.| |commonNameAsAadDeviceId|7|Common Name As Serial Number.| |commonNameAsIntuneDeviceId|8|Common Name As Serial Number.|-|commonNameAsDurableDeviceId|9|Common Name As Serial Number.| +|commonNameAsDurableDeviceId|9|Common Name As Serial Number.| |
v1.0 | Intune Shared Targetedmanagedappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-targetedmanagedappconfiguration.md | Here is a JSON representation of the resource. "deployedAppCount": 1024, "isAssigned": true }-``` +``` |
v1.0 | Intune Shared Uri | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-uri.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Shared User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-user.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.user", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Shared Vpptokenaccounttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-vpptokenaccounttype.md | Possible types of an Apple Volume Purchase Program token. |Member|Value|Description| |:|:|:| |business|0|Apple Volume Purchase Program token associated with an business program.|-|education|1|Apple Volume Purchase Program token associated with an education program.| +|education|1|Apple Volume Purchase Program token associated with an education program.| |
v1.0 | Intune Shared Vpptokenactionfailurereason | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-vpptokenactionfailurereason.md | Possible types of reasons for an Apple Volume Purchase Program token action fail |appleFailure|1|There was an error on Apple's service.| |internalError|2|There was an internal error.| |expiredVppToken|3|There was an error because the Apple Volume Purchase Program token was expired.|-|expiredApplePushNotificationCertificate|4|There was an error because the Apple Volume Purchase Program Push Notification certificate expired.| +|expiredApplePushNotificationCertificate|4|There was an error because the Apple Volume Purchase Program Push Notification certificate expired.| |
v1.0 | Intune Shared Win32lobappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-win32lobappassignmentsettings.md | Here is a JSON representation of the resource. "autoUpdateSupersededApps": "String" } }-``` +``` |
v1.0 | Intune Shared Win32lobappautoupdatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-win32lobappautoupdatesettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.win32LobAppAutoUpdateSettings", "autoUpdateSupersededApps": "String" }-``` +``` |
v1.0 | Intune Shared Win32lobappautoupdatesupersededapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-win32lobappautoupdatesupersededapps.md | Contains value for auto-update superseded apps. |:|:|:| |notConfigured|0|Indicates that the auto-update superseded apps is not configured and the app will not auto-update the superseded apps.| |enabled|1|Indicates that the auto-update superseded apps is enabled and the app will auto-update the superseded apps if the superseded apps are installed on the device.|-|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Shared Win32lobappdeliveryoptimizationpriority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-win32lobappdeliveryoptimizationpriority.md | Contains value for delivery optimization priority. |Member|Value|Description| |:|:|:| |notConfigured|0|Not configured or background normal delivery optimization priority.|-|foreground|1|Foreground delivery optimization priority.| +|foreground|1|Foreground delivery optimization priority.| |
v1.0 | Intune Shared Win32lobappnotification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-win32lobappnotification.md | Contains value for notification status. |:|:|:| |showAll|0|Show all notifications.| |showReboot|1|Only show restart notification and suppress other notifications.|-|hideAll|2|Hide all notifications.| +|hideAll|2|Hide all notifications.| |
v1.0 | Intune Shared Win32lobapprestartsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-win32lobapprestartsettings.md | Here is a JSON representation of the resource. "countdownDisplayBeforeRestartInMinutes": 1024, "restartNotificationSnoozeDurationInMinutes": 1024 }-``` +``` |
v1.0 | Intune Shared Windowsappxappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-windowsappxappassignmentsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsAppXAppAssignmentSettings", "useDeviceContext": true }-``` +``` |
v1.0 | Intune Shared Windowsautopilotdeploymentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-windowsautopilotdeploymentprofile.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Shared Windowsdomainjoinconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-windowsdomainjoinconfiguration.md | Here is a JSON representation of the resource. Note: The response object shown "computerNameSuffixRandomCharCount": 1024, "activeDirectoryDomainName": "String" }-``` +``` |
v1.0 | Intune Shared Windowsuniversalappxappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-windowsuniversalappxappassignmentsettings.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.windowsUniversalAppXAppAssignmentSettings", "useDeviceContext": true }-``` +``` |
v1.0 | Intune Shared Windowsupdatestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-windowsupdatestate.md | Here is a JSON representation of the resource. "lastScanDateTime": "String (timestamp)", "lastSyncDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Shared Wingetappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-wingetappassignmentsettings.md | Here is a JSON representation of the resource. "deadlineDateTime": "String (timestamp)" } }-``` +``` |
v1.0 | Intune Shared Wingetappinstalltimesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-wingetappinstalltimesettings.md | Here is a JSON representation of the resource. "useLocalTime": true, "deadlineDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Shared Wingetappnotification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-wingetappnotification.md | Contains value for notification status. |showAll|0|Show all notifications.| |showReboot|1|Only show restart notification and suppress other notifications.| |hideAll|2|Hide all notifications.|-|unknownFutureValue|3|Unknown future value, reserved for future usage as expandable enum.| +|unknownFutureValue|3|Unknown future value, reserved for future usage as expandable enum.| |
v1.0 | Intune Shared Wingetapprestartsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-wingetapprestartsettings.md | Here is a JSON representation of the resource. "countdownDisplayBeforeRestartInMinutes": 1024, "restartNotificationSnoozeDurationInMinutes": 1024 }-``` +``` |
v1.0 | Intune Softwareupdate Bulkdriveractionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-bulkdriveractionresult.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Softwareupdate Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-softwareupdate-devicemanagement-get.md)|[deviceManagement](../resources/intune-softwareupdate-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-softwareupdate-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-softwareupdate-devicemanagement-update.md)|[deviceManagement](../resources/intune-softwareupdate-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-softwareupdate-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-softwareupdate-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-softwareupdate-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Softwareupdate Driverapprovalaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-driverapprovalaction.md | An enum type to represent approval actions of single or list of drivers. |:|:|:| |approve|0|This indicates the action to approve single or list of drivers.| |decline|1|This indicates the action to approve single or list of drivers.|-|suspend|2|This indicates the action to suspend single or list of drivers.| +|suspend|2|This indicates the action to suspend single or list of drivers.| |
v1.0 | Intune Softwareupdate Driverapprovalstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-driverapprovalstatus.md | An enum type to represent approval status of a driver. |needsReview|0|This indicates a driver needs IT admin's review.| |declined|1|This indicates IT admin has declined a driver.| |approved|2|This indicates IT admin has approved a driver.|-|suspended|3|This indicates IT admin has suspended a driver.| +|suspended|3|This indicates IT admin has suspended a driver.| |
v1.0 | Intune Softwareupdate Drivercategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-drivercategory.md | An enum type to represent which category a driver belongs to. |:|:|:| |recommended|0|This indicates a driver is recommended by Microsoft.| |previouslyApproved|1|This indicates a driver was recommended by Microsoft and IT admin has taken some approval action on it.|-|other|2|This indicates a driver is never recommended by Microsoft.| +|other|2|This indicates a driver is never recommended by Microsoft.| |
v1.0 | Intune Softwareupdate Driverupdateprofileapprovaltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-driverupdateprofileapprovaltype.md | An enum type to represent approval type of a driver update profile. |Member|Value|Description| |:|:|:| |manual|0|This indicates a driver and firmware profile needs to be approved manually.|-|automatic|1|This indicates a driver and firmware profile is approved automatically.| +|automatic|1|This indicates a driver and firmware profile is approved automatically.| |
v1.0 | Intune Softwareupdate Expeditedwindowsqualityupdatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-expeditedwindowsqualityupdatesettings.md | Here is a JSON representation of the resource. "qualityUpdateRelease": "String", "daysUntilForcedReboot": 1024 }-``` +``` |
v1.0 | Intune Softwareupdate Iosavailableupdateversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-iosavailableupdateversion.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Softwareupdate Windowsdriverupdateinventory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsdriverupdateinventory.md | Here is a JSON representation of the resource. "category": "String", "deployDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Softwareupdate Windowsdriverupdateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsdriverupdateprofile.md | Here is a JSON representation of the resource. "driverInventorySyncState": "String" } }-``` +``` |
v1.0 | Intune Softwareupdate Windowsdriverupdateprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsdriverupdateprofileassignment.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterType": "String" } }-``` +``` |
v1.0 | Intune Softwareupdate Windowsdriverupdateprofileinventorysyncstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsdriverupdateprofileinventorysyncstate.md | Windows DnF update inventory sync state. |:|:|:| |pending|0|Pending sync.| |success|1|Successful sync.|-|failure|2|Failed sync.| +|failure|2|Failed sync.| |
v1.0 | Intune Softwareupdate Windowsdriverupdateprofileinventorysyncstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsdriverupdateprofileinventorysyncstatus.md | Here is a JSON representation of the resource. "lastSuccessfulSyncDateTime": "String (timestamp)", "driverInventorySyncState": "String" }-``` +``` |
v1.0 | Intune Softwareupdate Windowsfeatureupdatecatalogitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsfeatureupdatecatalogitem.md | Here is a JSON representation of the resource. "endOfSupportDate": "String (timestamp)", "version": "String" }-``` +``` |
v1.0 | Intune Softwareupdate Windowsfeatureupdateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsfeatureupdateprofile.md | Here is a JSON representation of the resource. "endOfSupportDate": "String (timestamp)", "installLatestWindows10OnWindows11IneligibleDevice": true }-``` +``` |
v1.0 | Intune Softwareupdate Windowsfeatureupdateprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsfeatureupdateprofileassignment.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterType": "String" } }-``` +``` |
v1.0 | Intune Softwareupdate Windowsqualityupdatecatalogitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsqualityupdatecatalogitem.md | Here is a JSON representation of the resource. "classification": "String", "isExpeditable": true }-``` +``` |
v1.0 | Intune Softwareupdate Windowsqualityupdateclassification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsqualityupdateclassification.md | Windows quality update classification |:|:|:| |all|0|All update type| |security|1|Security only update type|-|nonSecurity|2|Non security only update type| +|nonSecurity|2|Non security only update type| |
v1.0 | Intune Softwareupdate Windowsqualityupdateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsqualityupdateprofile.md | Here is a JSON representation of the resource. "releaseDateDisplayName": "String", "deployableContentDisplayName": "String" }-``` +``` |
v1.0 | Intune Softwareupdate Windowsqualityupdateprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsqualityupdateprofileassignment.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterType": "String" } }-``` +``` |
v1.0 | Intune Softwareupdate Windowsupdatecatalogitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsupdatecatalogitem.md | Here is a JSON representation of the resource. "releaseDateTime": "String (timestamp)", "endOfSupportDate": "String (timestamp)" }-``` +``` |
v1.0 | Intune Softwareupdate Windowsupdaterolloutsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsupdaterolloutsettings.md | Here is a JSON representation of the resource. "offerEndDateTimeInUTC": "String (timestamp)", "offerIntervalInDays": 1024 }-``` +``` |
v1.0 | Intune Troubleshooting Applevpptokentroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-applevpptokentroubleshootingevent.md | Here is a JSON representation of the resource. ], "tokenId": "String" }-``` +``` |
v1.0 | Intune Troubleshooting Connectorhealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-connectorhealthstate.md | Connector health state for connector status |healthy|0|Indicates a healthy connector status and no action required.| |warning|1|Indicates that a connector needs attention.| |unhealthy|2|Indicates that a connector needs immediate attention to retain functionality.|-|unknown|3|unknown| +|unknown|3|unknown| |
v1.0 | Intune Troubleshooting Connectorname | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-connectorname.md | Connectors name for connector status |windowsDefenderATPConnectorLastHeartbeatDateTime|12|Indicates the last heartbeat date/time that the Windows Defender ATP connector was contacted.| |mobileThreatDefenceConnectorLastHeartbeatDateTime|13|Indicates the last heartbeat date/time that the Mobile Threat Defence connector was contacted.| |chromebookLastDirectorySyncDateTime|14|Indicates the last sync date/time that the Chrombook Last Directory performed a sync.|-|futureValue|15|Future use| +|futureValue|15|Future use| |
v1.0 | Intune Troubleshooting Connectorstatusdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-connectorstatusdetails.md | Here is a JSON representation of the resource. "status": "String", "eventDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Intune Troubleshooting Deviceenrollmentfailurereason | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-deviceenrollmentfailurereason.md | Top level failure categories for enrollment. |featureNotSupported|8|Feature(s) used by this enrollment are not supported for this account.| |enrollmentRestrictionsEnforced|9|Enrollment restrictions configured by admin blocked this enrollment.| |clientDisconnected|10|Client timed out or enrollment was aborted by enduser.|-|userAbandonment|11|Enrollment was abandoned by enduser. (Enduser started onboarding but failed to complete it in timely manner)| +|userAbandonment|11|Enrollment was abandoned by enduser. (Enduser started onboarding but failed to complete it in timely manner)| |
v1.0 | Intune Troubleshooting Deviceenrollmenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-deviceenrollmenttype.md | Possible ways of adding a mobile device to management. |azureAdJoinUsingAzureVmExtension|14|Azure AD Join enrollment when an Azure VM is provisioned| |androidEnterpriseDedicatedDevice|15|Android Enterprise Dedicated Device| |androidEnterpriseFullyManaged|16|Android Enterprise Fully Managed|-|androidEnterpriseCorporateWorkProfile|17|Android Enterprise Corporate Work Profile| +|androidEnterpriseCorporateWorkProfile|17|Android Enterprise Corporate Work Profile| |
v1.0 | Intune Troubleshooting Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-troubleshooting-devicemanagement-get.md)|[deviceManagement](../resources/intune-troubleshooting-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-troubleshooting-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-troubleshooting-devicemanagement-update.md)|[deviceManagement](../resources/intune-troubleshooting-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-troubleshooting-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-troubleshooting-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-troubleshooting-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Troubleshooting Devicemanagementautopilotevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementautopilotevent.md | Here is a JSON representation of the resource. "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 | Namespace: microsoft.graph |installed|2|| |notCompliant|3|| |notInstalled|4||-|error|5|| +|error|5|| |
v1.0 | Intune Troubleshooting Devicemanagementautopilotpolicystatusdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementautopilotpolicystatusdetail.md | Here is a JSON representation of the resource. "lastReportedDateTime": "String (timestamp)", "errorCode": 1024 }-``` +``` |
v1.0 | Intune Troubleshooting Devicemanagementautopilotpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementautopilotpolicytype.md | Namespace: microsoft.graph |unknown|0|| |application|3|| |appModel|7||-|configurationPolicy|12|| +|configurationPolicy|12|| |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingerrordetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementtroubleshootingerrordetails.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingerrorresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementtroubleshootingerrorresource.md | Here is a JSON representation of the resource. "text": "String", "link": "String" }-``` +``` |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementtroubleshootingevent.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Troubleshooting Devicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicetype.md | Device type. |blackberry|100|Blackberry.| |palm|101|Palm.| |unknown|255|Represents that the device type is unknown.|-|cloudPC|257|Cloud PC device.| +|cloudPC|257|Cloud PC device.| |
v1.0 | Intune Troubleshooting Enrollmentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-enrollmentstate.md | Namespace: microsoft.graph |pendingReset|2|| |failed|3|| |notContacted|4||-|blocked|5|| +|blocked|5|| |
v1.0 | Intune Troubleshooting Enrollmenttroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-enrollmenttroubleshootingevent.md | Here is a JSON representation of the resource. "failureCategory": "String", "failureReason": "String" }-``` +``` |
v1.0 | Intune Troubleshooting Keyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-keyvaluepair.md | Here is a JSON representation of the resource. "name": "String", "value": "String" }-``` +``` |
v1.0 | Intune Troubleshooting Manageddevicesummarizedappstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-manageddevicesummarizedappstate.md | Here is a JSON representation of the resource. "summarizedAppState": "String", "deviceId": "String" }-``` +``` |
v1.0 | Intune Troubleshooting Mobileappactiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileappactiontype.md | Defines the Action Types for an Intune Application. |installCommandSent|1|Application install command was sent.| |installed|3|Application installed.| |uninstalled|4|Application uninstalled.|-|userRequestedInstall|5|User requested installation| +|userRequestedInstall|5|User requested installation| |
v1.0 | Intune Troubleshooting Mobileappintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileappintent.md | Indicates the status of the mobile app on the device. |requiredUninstall|3|Required Uninstall| |requiredAndAvailableInstall|4|RequiredAndAvailableInstall| |availableInstallWithoutEnrollment|5|AvailableInstallWithoutEnrollment|-|exclude|6|Exclude| +|exclude|6|Exclude| |
v1.0 | Intune Troubleshooting Mobileappintentandstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileappintentandstate.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Troubleshooting Mobileappintentandstatedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileappintentandstatedetail.md | Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Troubleshooting Mobileappsupporteddevicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileappsupporteddevicetype.md | Here is a JSON representation of the resource. "minimumOperatingSystemVersion": "String", "maximumOperatingSystemVersion": "String" }-``` +``` |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingapppolicycreationhistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingapppolicycreationhistory.md | Here is a JSON representation of the resource. "runState": "String", "errorCode": "String" }-``` +``` |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingappstatehistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingappstatehistory.md | Here is a JSON representation of the resource. "runState": "String", "errorCode": "String" }-``` +``` |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingapptargethistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingapptargethistory.md | Here is a JSON representation of the resource. "runState": "String", "errorCode": "String" }-``` +``` |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingappupdatehistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingappupdatehistory.md | Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingdevicecheckinhistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingdevicecheckinhistory.md | Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingevent.md | Inherits from [deviceManagementTroubleshootingEvent](../resources/intune-trouble ## Methods |Method|Return Type|Description| |:|:|:|-|[List mobileAppTroubleshootingEvents](../api/intune-troubleshooting-mobileapptroubleshootingevent-list.md)|[mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) collection|List properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) objects.| -|[Get mobileAppTroubleshootingEvent](../api/intune-troubleshooting-mobileapptroubleshootingevent-get.md)|[mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md)|Read properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object.| -|[Create mobileAppTroubleshootingEvent](../api/intune-troubleshooting-mobileapptroubleshootingevent-create.md)|[mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md)|Create a new [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object.| -|[Delete mobileAppTroubleshootingEvent](../api/intune-troubleshooting-mobileapptroubleshootingevent-delete.md)|None|Deletes a [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md).| -|[Update mobileAppTroubleshootingEvent](../api/intune-troubleshooting-mobileapptroubleshootingevent-update.md)|[mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md)|Update the properties of a [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object.| +|[List mobileAppTroubleshootingEvents](../api/intune-troubleshooting-mobileapptroubleshootingevent-list.md)|[mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) collection|List properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) objects.| +|[Get mobileAppTroubleshootingEvent](../api/intune-troubleshooting-mobileapptroubleshootingevent-get.md)|[mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md)|Read properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object.| +|[Create mobileAppTroubleshootingEvent](../api/intune-troubleshooting-mobileapptroubleshootingevent-create.md)|[mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md)|Create a new [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object.| +|[Delete mobileAppTroubleshootingEvent](../api/intune-troubleshooting-mobileapptroubleshootingevent-delete.md)|None|Deletes a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md).| +|[Update mobileAppTroubleshootingEvent](../api/intune-troubleshooting-mobileapptroubleshootingevent-update.md)|[mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md)|Update the properties of a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. } ] }-``` +``` |
v1.0 | Intune Troubleshooting Mobileapptroubleshootinghistoryitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootinghistoryitem.md | Here is a JSON representation of the resource. ] } }-``` +``` |
v1.0 | Intune Troubleshooting Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-report.md | Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.report", "content": "Stream" }-``` +``` |
v1.0 | Intune Troubleshooting Reportroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-reportroot.md | The resource that represents an instance of Enrollment Failure Reports. ## Methods |Method|Return Type|Description| |:|:|:|-|[Get reportRoot](../api/intune-troubleshooting-reportroot-get.md)|[reportRoot](../resources/intune-troubleshooting-reportroot.md)|Read properties and relationships of the [reportRoot](../resources/intune-troubleshooting-reportroot.md) object.| -|[Update reportRoot](../api/intune-troubleshooting-reportroot-update.md)|[reportRoot](../resources/intune-troubleshooting-reportroot.md)|Update the properties of a [reportRoot](../resources/intune-troubleshooting-reportroot.md) object.| -|[managedDeviceEnrollmentFailureDetails function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmentfailuredetails.md)|[report](../resources/intune-troubleshooting-report.md)|| -|[managedDeviceEnrollmentFailureDetails function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmentfailuredetails.md)|[report](../resources/intune-troubleshooting-report.md)|| -|[managedDeviceEnrollmentFailureTrends function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmentfailuretrends.md)|[report](../resources/intune-troubleshooting-report.md)|Metadata for the enrollment failure trends report| -|[managedDeviceEnrollmentTopFailures function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmenttopfailures.md)|[report](../resources/intune-troubleshooting-report.md)|| -|[managedDeviceEnrollmentTopFailures function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmenttopfailures.md)|[report](../resources/intune-troubleshooting-report.md)|| -|[managedDeviceEnrollmentAbandonmentSummary function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmentabandonmentsummary.md)|[report](../resources/intune-troubleshooting-report.md)|Metadata for Enrollment abandonment summary report| -|[managedDeviceEnrollmentAbandonmentDetails function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmentabandonmentdetails.md)|[report](../resources/intune-troubleshooting-report.md)|Metadata for Enrollment abandonment details report| +|[Get reportRoot](../api/intune-troubleshooting-reportroot-get.md)|[reportRoot](../resources/intune-shared-reportroot.md)|Read properties and relationships of the [reportRoot](../resources/intune-shared-reportroot.md) object.| +|[Update reportRoot](../api/intune-troubleshooting-reportroot-update.md)|[reportRoot](../resources/intune-shared-reportroot.md)|Update the properties of a [reportRoot](../resources/intune-shared-reportroot.md) object.| +|[managedDeviceEnrollmentFailureDetails function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmentfailuredetails.md)|[report](../resources/intune-shared-report.md)|| +|[managedDeviceEnrollmentFailureDetails function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmentfailuredetails.md)|[report](../resources/intune-shared-report.md)|| +|[managedDeviceEnrollmentFailureTrends function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmentfailuretrends.md)|[report](../resources/intune-shared-report.md)|Metadata for the enrollment failure trends report| +|[managedDeviceEnrollmentTopFailures function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmenttopfailures.md)|[report](../resources/intune-shared-report.md)|| +|[managedDeviceEnrollmentTopFailures function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmenttopfailures.md)|[report](../resources/intune-shared-report.md)|| +|[managedDeviceEnrollmentAbandonmentSummary function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmentabandonmentsummary.md)|[report](../resources/intune-shared-report.md)|Metadata for Enrollment abandonment summary report| +|[managedDeviceEnrollmentAbandonmentDetails function](../api/intune-troubleshooting-reportroot-manageddeviceenrollmentabandonmentdetails.md)|[report](../resources/intune-shared-report.md)|Metadata for Enrollment abandonment details report| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.reportRoot", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Troubleshooting Resultantappstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-resultantappstate.md | Not yet documented |uninstallFailed|4|The application failed to uninstall.| |pendingInstall|5|The installation of the application is in progress.| |unknown|99|The status of the application is unknown.|-|notApplicable|-1|The application is not applicable.| +|notApplicable|-1|The application is not applicable.| |
v1.0 | Intune Troubleshooting Runstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-runstate.md | Indicates the type of execution status of the device management script. |fail|2|Script failed to run.| |scriptError|3|Discovery script hits error.| |pending|4|Script is pending to execute.|-|notApplicable|5|Script is not applicable for this device.| +|notApplicable|5|Script is not applicable for this device.| |
v1.0 | Intune Troubleshooting User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-user.md | Namespace: microsoft.graph ## Methods |Method|Return Type|Description| |:|:|:|-|[List users](../api/intune-troubleshooting-user-list.md)|[user](../resources/intune-troubleshooting-user.md) collection|List properties and relationships of the [user](../resources/intune-troubleshooting-user.md) objects.| -|[Get user](../api/intune-troubleshooting-user-get.md)|[user](../resources/intune-troubleshooting-user.md)|Read properties and relationships of the [user](../resources/intune-troubleshooting-user.md) object.| -|[Create user](../api/intune-troubleshooting-user-create.md)|[user](../resources/intune-troubleshooting-user.md)|Create a new [user](../resources/intune-troubleshooting-user.md) object.| -|[Delete user](../api/intune-troubleshooting-user-delete.md)|None|Deletes a [user](../resources/intune-troubleshooting-user.md).| -|[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.| +|[List users](../api/intune-troubleshooting-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-troubleshooting-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-troubleshooting-user-create.md)|[user](../resources/intune-shared-user.md)|Create a new [user](../resources/intune-shared-user.md) object.| +|[Delete user](../api/intune-troubleshooting-user-delete.md)|None|Deletes a [user](../resources/intune-shared-user.md).| +|[Update user](../api/intune-troubleshooting-user-update.md)|[user](../resources/intune-shared-user.md)|Update the properties of a [user](../resources/intune-shared-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| Namespace: microsoft.graph |:|:|:| |deviceManagementTroubleshootingEvents|[deviceManagementTroubleshootingEvent](../resources/intune-troubleshooting-devicemanagementtroubleshootingevent.md) collection|The list of troubleshooting events for this user.| |mobileAppIntentAndStates|[mobileAppIntentAndState](../resources/intune-troubleshooting-mobileappintentandstate.md) collection|The list of troubleshooting events for this user.|-|mobileAppTroubleshootingEvents|[mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) collection|The list of mobile app troubleshooting events for this user.| +|mobileAppTroubleshootingEvents|[mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) collection|The list of mobile app troubleshooting events for this user.| ## JSON Representation Here is a JSON representation of the resource. Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.user", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Troubleshooting Windowsautopilotdeploymentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-windowsautopilotdeploymentstate.md | Deployment states for Autopilot devices |successWithTimeout|4|The deployment timed out but user clicked past failure.| |notAttempted|5|The deployment was not run.| |disabled|6|The deployment is disabled.|-|successOnRetry|7|The deployment succeeded after hitting an initial timeout failure.| +|successOnRetry|7|The deployment succeeded after hitting an initial timeout failure.| |
v1.0 | Intune Troubleshooting Windowsautopilotenrollmenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-windowsautopilotenrollmenttype.md | Namespace: microsoft.graph |azureADJoinedWithOfflineAutopilotProfile|5|| |azureADJoinedWithWhiteGlove|6|| |offlineDomainJoinedWithWhiteGlove|7||-|offlineDomainJoinedWithOfflineAutopilotProfile|8|| +|offlineDomainJoinedWithOfflineAutopilotProfile|8|| |
v1.0 | Intune Unlock Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-deviceappmanagement.md | Singleton entity that acts as a container for all device and app management func ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceAppManagement](../api/intune-unlock-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-unlock-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-unlock-deviceappmanagement.md) object.| -|[Update deviceAppManagement](../api/intune-unlock-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-unlock-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-unlock-deviceappmanagement.md) object.| +|[Get deviceAppManagement](../api/intune-unlock-deviceappmanagement-get.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Read properties and relationships of the [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| +|[Update deviceAppManagement](../api/intune-unlock-deviceappmanagement-update.md)|[deviceAppManagement](../resources/intune-shared-deviceappmanagement.md)|Update the properties of a [deviceAppManagement](../resources/intune-shared-deviceappmanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceAppManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicyassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment.md | Here is a JSON representation of the resource. "deviceAndAppManagementAssignmentFilterType": "String" } }-``` +``` |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus.md | Here is a JSON representation of the resource. "userPrincipalName": "String", "policyVersion": "String" }-``` +``` |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentsummary.md | Here is a JSON representation of the resource. "deployedDeviceCount": 1024, "failedDeviceCount": 1024 }-``` +``` |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicystatuses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicystatuses.md | Enum values for the various WindowsDefenderApplicationControl supplemental polic |success|1|The WindowsDefenderApplicationControl supplemental policy is in effect.| |tokenError|2|The WindowsDefenderApplicationControl supplemental policy is structurally okay but there is an error with authorizing the token.| |notAuthorizedByToken|3|The token does not authorize this WindowsDefenderApplicationControl supplemental policy.|-|policyNotFound|4|The WindowsDefenderApplicationControl supplemental policy is not found.| +|policyNotFound|4|The WindowsDefenderApplicationControl supplemental policy is not found.| |
v1.0 | Intune Wip Applicationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-applicationtype.md | Possible types of Application |Member|Value|Description| |:|:|:| |universal|1|The windows universal application|-|desktop|2|The windows desktop application| +|desktop|2|The windows desktop application| |
v1.0 | Intune Wip Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-devicemanagement.md | Singleton entity that acts as a container for all device management functionalit ## Methods |Method|Return Type|Description| |:|:|:|-|[Get deviceManagement](../api/intune-wip-devicemanagement-get.md)|[deviceManagement](../resources/intune-wip-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-wip-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-wip-devicemanagement-update.md)|[deviceManagement](../resources/intune-wip-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-wip-devicemanagement.md) object.| +|[Get deviceManagement](../api/intune-wip-devicemanagement-get.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-wip-devicemanagement-update.md)|[deviceManagement](../resources/intune-shared-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object.| ## Properties |Property|Type|Description| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagement", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Wip Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-deviceplatformtype.md | Supported platform types. |windows81AndLater|5|Windows 8.1 and later| |windows10AndLater|6|Windows 10 and later.| |androidWorkProfile|7|Android Work Profile.|-|unknown|8|Unknown.| +|unknown|8|Unknown.| |
v1.0 | Intune Wip Intunebrandingprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-intunebrandingprofile.md | Here is a JSON representation of the resource. "String" ] }-``` +``` |
v1.0 | Intune Wip Intunebrandingprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-intunebrandingprofileassignment.md | Here is a JSON representation of the resource. "entraObjectId": "String" } }-``` +``` |
v1.0 | Intune Wip Windowsinformationprotectionapplearningsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-windowsinformationprotectionapplearningsummary.md | Here is a JSON representation of the resource. "applicationType": "String", "deviceCount": 1024 }-``` +``` |
v1.0 | Intune Wip Windowsinformationprotectionnetworklearningsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-windowsinformationprotectionnetworklearningsummary.md | Here is a JSON representation of the resource. "url": "String", "deviceCount": 1024 }-``` +``` |
v1.0 | Invalidlicensealertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/invalidlicensealertincident.md | Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanag None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Invitation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/invitation.md | Creating an invitation returns a redemption URL in the response (*inviteRedeemUr |invitedUserSponsors|[directoryObject](../resources/directoryobject.md) collection|The users or groups who are sponsors of the invited user. Sponsors are users and groups that are responsible for guest users' privileges in the tenant and for keeping the guest users' information and access up to date. | ## JSON representation-Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { |
v1.0 | Invitedusermessageinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/invitedusermessageinfo.md | The invitedUserMessageInfo object allows you to configure the [invitation](invit |messageLanguage|String|The language you want to send the default message in. If the customizedMessageBody is specified, this property is ignored, and the message is sent using the customizedMessageBody. The language format should be in ISO 639. The default is en-US.| ## JSON representation-Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- {"blockType": "resource", "@odata.type": "microsoft.graph.invitedUserMessageInfo"} --> ```json |
v1.0 | Invitenewbotresponse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/invitenewbotresponse.md | Contains a response to a request to have a participant joining notification sent ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Inviteparticipantsoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/inviteparticipantsoperation.md | Represents the status of a long-running participant invitation operation, trigge ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Invokeuserflowlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/invokeuserflowlistener.md | Inherits from the abstract base type [authenticationListener](../resources/authe ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Ipnamedlocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ipnamedlocation.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Iprange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/iprange.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Ipv4cidrrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ipv4cidrrange.md | Inherits from [ipRange](../resources/iprange.md) ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Ipv6cidrrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ipv6cidrrange.md | Inherits from [ipRange](../resources/iprange.md) ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Itemattachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/itemattachment.md | Derived from [attachment](attachment.md). ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Itembody | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/itembody.md | Represents properties of the body of an item, such as a message, event or group ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Itemfacet | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/itemfacet.md | Title: "itemFacet resource type" -description: "itemFacet resource type" +description: "Represents the abstract base type for the all resource types in the profile entity set." ms.localizationpriority: medium ++ doc_type: "resourcePageType" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the abstract base type that all resource types in the [profile](profile.md) entityset inherit from. +Represents the abstract base type for all resource types in the [profile](profile.md) entity set. ## Properties |Property|Type|Description| Represents the abstract base type that all resource types in the [profile](profi |lastModifiedBy|[identitySet](../resources/identityset.md)|Provides the identifier of the user and/or application that last modified the entity.| |lastModifiedDateTime|DateTimeOffset|Provides the dateTimeOffset for when the entity was created.| |source|[personDataSource](../resources/persondatasource.md)|Where the values within an entity originated if synced from another service.|+|sources|[profileSourceAnnotation](../resources/profileSourceAnnotation.md) collection|Where the values within an entity originated if synced from another source.| ## Relationships None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", Here's a JSON representation of the resource. }, "source": { "@odata.type": "microsoft.graph.personDataSource"- } + }, + "sources": [ + { + "@odata.type": "microsoft.graph.profileSourceAnnotation" + } + ] } ``` |
v1.0 | Jointransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/jointransformation.md | + + Title: "joinTransformation resource type" +description: "Creates a new value by joining two attributes." ++ms.localizationpriority: medium ++++# joinTransformation resource type ++Namespace: microsoft.graph +++Creates a new value by joining two attributes. Optionally, you can use a separator between the two attributes. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|input2|[transformationAttribute](../resources/transformationattribute.md)|The second input used in the join operation.| +|separator|String|The separator value to be used.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.joinTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.joinTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "input2": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "separator": "String" +} +``` |
v1.0 | Json | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/json.md | 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.Json" |
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|String collection|Collection of GUIDs that point to the [certificateBasedApplicationConfiguration](../resources/certificatebasedapplicationconfiguration.md) that contains the collection of allowed root and intermediate certificate authorities.| -| 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`. | +| certificateBasedApplicationConfigurationIds|String collection|Collection of GUIDs that point to the [certificateBasedApplicationConfiguration](../resources/certificatebasedapplicationconfiguration.md) that contains the collection of allowed root and intermediate certificate authorities.| +| 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. | | restrictionType | appKeyCredentialRestrictionType | The type of restriction being applied. Possible values are `asymmetricKeyLifetime`, `unknownFutureValue`. Each value of restrictionType can be used only once per policy. | |
v1.0 | Keyvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/keyvalue.md | The configuration of this resource is shared by the following objects: ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Learningcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/learningcontent.md | Inherits from [entity](../resources/entity.md). |duration|Duration|The duration of the learning content in seconds. The value is represented in ISO 8601 format for durations. Optional.| |externalId|String|Unique external content ID for the learning content. Required.| |format|String|The format of the learning content. For example, `Course`, `Video`, `Book`, `Book Summary`, `Audiobook Summary`. Optional.|+|level|Level|The difficulty level of the learning content. Possible values are: `Beginner`, `Intermediate`, `Advanced`, `unknownFutureValue`. Optional.| |id|String|The unique identifier for the learning content. Not nullable. Read-only. Inherited from [entity](../resources/entity.md).| |isActive|Boolean|Indicates whether the content is active or not. Inactive content doesn't show up in the UI. The default value is `true`. Optional.| |isPremium|Boolean|Indicates whether the learning content requires the user to sign-in on the learning provider platform or not. The default value is `false`. Optional.| Inherits from [entity](../resources/entity.md). |thumbnailWebUrl|String|The URL of learning content thumbnail image. Optional.| |title|String|The title of the learning content. Required.| +## Level values +|Member|Description| +|:|:| +|Beginner|For learning content at a beginner level.| +|Intermediate|For learning content at an intermediate level.| +|Advanced|For learning content at an advanced level.| +|UnknownFutureValue|Evolvable enumeration sentinel value. Do not use.| + ## Relationships None. The following is a JSON representation of the resource. "duration": "String (duration)", "externalId": "String", "format": "String",+ "level": "String", "id": "String (identifier)", "isActive": "Boolean", "isPremium": "Boolean", |
v1.0 | Learningcourseactivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/learningcourseactivity.md | Inherits from [entity](../resources/entity.md). |completedDateTime|DateTimeOffset|Date and time when the assignment was completed. Optional.| |completionPercentage|Int32|The percentage completion value of the course activity. Optional.| |dueDateTime|DateTimeTimeZone|Due date for the course activity. Optional.|-|externalcourseActivityId|String|A course activity ID generated by the provider. Optional.| +|externalCourseActivityId|String|A course activity ID generated by the provider. Optional.| |id|String|A generated ID that can be used with other course activity APIs.| |learnerUserId|String|The user ID of the learner to whom the activity is assigned. Required.| |learningContentId|String|The ID of the learning content created in Viva Learning. Required.| |
v1.0 | Licenseassignmentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/licenseAssignmentState.md | Title: "licenseAssignmentState resource type" description: "The **licenseAssignmentStates** property of the user entity is a collection of **licenseAssignmentState**. It provides details about license assignments to a user. The details include information like: " ms.localizationpriority: medium doc_type: resourcePageType+ The **licenseAssignmentStates** property of the [user](user.md) entity is a coll ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Licensedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/licensedetails.md | Title: "licenseDetails resource type" description: "Contains information about a license assigned to a user." ms.localizationpriority: medium doc_type: resourcePageType+ |
v1.0 | Licenseunitsdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/licenseunitsdetail.md | The **prepaidUnits** property of the [subscribedSku](subscribedsku.md) entity is ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Linkedresource_V2 | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/linkedresource_v2.md | Some **linkedResource** objects aren't associated with any web URLs, in which ca None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Linkroleabilities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/linkroleabilities.md | + + Title: "linkRoleAbilities resource type" +description: "Represents the sharing link operations for a link of a specified role." ++ms.localizationpriority: medium ++++# linkRoleAbilities resource type ++Namespace: microsoft.graph +++Represents the sharing link operations for a link of a specified role. ++## Properties ++|Property|Type|Description| +|:|:|:| +|addExistingExternalUsers|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates if the current user can add existing external user recipients to this sharing link.| +|addNewExternalUsers|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates if the current user can add new external user recipients to this sharing link.| +|applyVariants|[sharingLinkVariants](../resources/sharinglinkvariants.md)|Indicates the status of the potential sharing link variants. If selected, it generates a separate sharing link from the sharing link that would otherwise be generated without the variant, yet with an identical role and scope.| +|createLink|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates if links of this role can be created.| +|deleteLink|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates if links of this role can be deleted.| +|linkAllowsExternalUsers|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates if this link can include external users.| +|linkExpiration|[sharingLinkExpirationStatus](../resources/sharinglinkexpirationstatus.md)|Indicates if links must expire, meaning the link is no longer usable after a specified time. If link expiration is enabled, a default link expiration time is provided.| +|retrieveLink|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates if links of this role can be retrieved.| +|updateLink|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates if links of this role can be updated.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.linkRoleAbilities" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.linkRoleAbilities", + "createLink": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "retrieveLink": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "updateLink": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "deleteLink": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "applyVariants": { + "@odata.type": "microsoft.graph.sharingLinkVariants" + }, + "linkExpiration": { + "@odata.type": "microsoft.graph.sharingLinkExpirationStatus" + }, + "addNewExternalUsers": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "addExistingExternalUsers": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "linkAllowsExternalUsers": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + } +} +``` |
v1.0 | Linkscopeabilities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/linkscopeabilities.md | + + Title: "linkScopeAbilities resource type" +description: "Represents the sharing abilities for each possible sharingRole within a particular sharing link scope." ++ms.localizationpriority: medium ++++# linkScopeAbilities resource type ++Namespace: microsoft.graph +++Represents the sharing abilities for each possible sharingRole within a particular sharing link scope. ++## Properties ++|Property|Type|Description| +|:|:|:| +|blockDownloadLinkAbilities|[linkRoleAbilities](../resources/linkroleabilities.md)|The blockDownload link abilities.| +|editLinkAbilities|[linkRoleAbilities](../resources/linkroleabilities.md)|The edit link abilities.| +|manageListLinkAbilities|[linkRoleAbilities](../resources/linkroleabilities.md)|The manageList link abilities.| +|readLinkAbilities|[linkRoleAbilities](../resources/linkroleabilities.md)|The read link abilities.| +|reviewLinkAbilities|[linkRoleAbilities](../resources/linkroleabilities.md)|The review link abilities.| +|submitOnlyLinkAbilities|[linkRoleAbilities](../resources/linkroleabilities.md)|The submitOnly link abilities.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.linkScopeAbilities" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.linkScopeAbilities", + "readLinkAbilities": { + "@odata.type": "microsoft.graph.linkRoleAbilities" + }, + "editLinkAbilities": { + "@odata.type": "microsoft.graph.linkRoleAbilities" + }, + "reviewLinkAbilities": { + "@odata.type": "microsoft.graph.linkRoleAbilities" + }, + "manageListLinkAbilities": { + "@odata.type": "microsoft.graph.linkRoleAbilities" + }, + "blockDownloadLinkAbilities": { + "@odata.type": "microsoft.graph.linkRoleAbilities" + }, + "submitOnlyLinkAbilities": { + "@odata.type": "microsoft.graph.linkRoleAbilities" + } +} +``` |
v1.0 | List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/list.md | description: "Represents a list in a site." Title: "List resource" + Title: list resource type ms.localizationpriority: medium doc_type: resourcePageType -# List resource +# list resource type Namespace: microsoft.graph |
v1.0 | Listinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/listinfo.md | description: The listInfo complex type provides additional information about a list. Last updated 09/11/2017 Title: ListInfo + Title: listInfo resource type ms.localizationpriority: medium doc_type: resourcePageType -# ListInfo resource +# listInfo resource type Namespace: microsoft.graph The **listInfo** complex type provides additional information about a [list][]. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Listitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/listitem.md | description: "Represents an item in a SharePoint list." Title: "listItem resource" + Title: listItem resource type ms.localizationpriority: medium doc_type: resourcePageType -# listItem resource +# listItem resource type Namespace: microsoft.graph |
v1.0 | Listitemversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/listitemversion.md | The following tasks are available for listItemVersion resources. ## JSON representation -<!-- { "blockType": "resource","keyProperty":"id", "@odata.type": "microsoft.graph.listItemVersion", "@type.aka": "oneDrive.baseItemVersion" } --> +<!-- { + "blockType": "resource", + "keyProperty":"id", + "baseType": "microsoft.graph.baseItemVersion", + "@odata.type": "microsoft.graph.listItemVersion", + "@type.aka": "oneDrive.baseItemVersion" +} --> ```json {- "content": { "@odata.type": "Edm.Stream" }, "fields": { "@odata.type": "microsoft.graph.fieldValueSet" }, "id": "string", "lastModifiedBy": { "@odata.type": "microsoft.graph.identitySet" }, |
v1.0 | Localeinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/localeinfo.md | Information about the locale, including the preferred language and country/regio ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Localidentitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/localidentitysource.md | description: "Represents local source of identity." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Locationconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/locationconstraint.md | The conditions stated by a client for the location of a meeting. ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Locationconstraintitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/locationconstraintitem.md | Derived from [location](location.md). ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Loginpagelayoutconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/loginPageLayoutConfiguration.md | Contains details of the layout of the sign-in page for a tenant. 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.loginPageLayoutConfiguration" |
v1.0 | M365appsinstallationoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/m365appsinstallationoptions.md | ms.localizationpriority: medium doc_type: resourcePageType +toc. Title: Installation options # m365AppsInstallationOptions resource type |
v1.0 | Mailassessmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mailassessmentrequest.md | When you create a mail threat assessment request, the mail should be received by ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mailbox Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mailbox-usage-reports.md | - Title: "Mailbox usage reports" -description: "You can get information about users with a mailbox and their level of activity which is primarily based on emails sent and received. You can also see how much storage each mailbox consumes and how many mailboxes are approaching storage quotas." ---doc_type: conceptualPageType ---# Mailbox usage reports --Namespace: microsoft.graph ---You can get information about users with a mailbox and their level of activity which is primarily based on emails sent and received. You can also see how much storage each mailbox consumes and how many mailboxes are approaching storage quotas. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Mailbox usage](https://support.office.com/client/Mailbox-usage-beffbe01-ce2d-4614-9ae5-7898868e2729). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get mailbox detail](../api/reportroot-getmailboxusagedetail.md) | Stream | Stream | Get details about mailbox usage. | -| [Get mailbox counts](../api/reportroot-getmailboxusagemailboxcounts.md) | Stream | 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 | Stream | Get the count of user mailboxes in each quota category. | -| [Get storage](../api/reportroot-getmailboxusagestorage.md) | Stream | Stream | Get the amount of storage used in your organization. | -- |
v1.0 | Mailboxsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mailboxsettings.md | You can [get](../api/user-get-mailboxsettings.md) or [update](../api/user-update ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mailfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mailfolder.md | By default, [listing mailFolders](../api/user-list-mailfolders.md) returns only ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mailtips | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mailtips.md | as an automatic reply for a message recipient. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mailtipserror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mailtipserror.md | An error that occurs during an action. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Malwarestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/malwarestate.md | Contains stateful information about the malware entity. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Managedtenants Aggregatedpolicycompliance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/managedtenants-aggregatedpolicycompliance.md | Represents an aggregate view of device compliance for a managed tenant. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Managedtenants Auditevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/managedtenants-auditevent.md | Represents an audit event for managed tenants in Microsoft 365 Lighthouse. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Managedtenants Cloudpcconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/managedtenants-cloudpcconnection.md | Represents a cloud PC connection for a given managed tenant. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Managedtenants Cloudpcdevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/managedtenants-cloudpcdevice.md | Represents a cloud PC device that belongs to a given managed tenant. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Managedtenants Cloudpcoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/managedtenants-cloudpcoverview.md | Represents an overview of cloud PCs for a given managed tenant. ## Properties |Property|Type|Description| |:|:|:|+|frontlineLicensesCount|Int32|The total number of cloud PC devices that have the `Frontline` SKU. Optional. Read-only.| |id|String|The unique identifier for the cloud PC overview. Required. Read-only.| |lastRefreshedDateTime|DateTimeOffset|Date and time the entity was last updated in the multi-tenant management platform. Optional. Read-only.| |numberOfCloudPcConnectionStatusFailed|Int32|The number of cloud PC connections that have a status of `failed`. Optional. Read-only.| The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.managedTenants.cloudPcOverview",+ "frontlineLicensesCount": "Integer", "id": "String (identifier)", "lastRefreshedDateTime": "String (timestamp)", "numberOfCloudPcConnectionStatusFailed": "Integer", |
v1.0 | Managedtenants Manageddevicecompliancetrend | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/managedtenants-manageddevicecompliancetrend.md | Represents a trend of compliant and non-compliant devices for a given managed te None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Managedtenants Tenantcustomizedinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/managedtenants-tenantcustomizedinformation.md | Namespace: microsoft.graph.managedTenants Represents customizable information for a managed tenant. ## Methods-|Method|Return type|Description| -|:|:|:| -|[List tenantCustomizedInformations](../api/managedtenants-managedtenant-list-tenantscustomizedinformation.md)|[microsoft.graph.managedTenants.tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md) collection|Get a list of the [tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md) objects and their properties.| -|[Get tenantCustomizedInformation](../api/managedtenants-tenantcustomizedinformation-get.md)|[microsoft.graph.managedTenants.tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md)|Read the properties and relationships of a [tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md) object.| -|[Update tenantCustomizedInformation](../api/managedtenants-tenantcustomizedinformation-update.md)|[microsoft.graph.managedTenants.tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md)|Update the properties of a [tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md) object.| +| Method | Return type | Description | +| : | :- | :- | +| [List tenantCustomizedInformations](../api/managedtenants-managedtenant-list-tenantscustomizedinformation.md) | [microsoft.graph.managedTenants.tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md) collection | Get a list of the [tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md) objects and their properties. | +| [Get tenantCustomizedInformation](../api/managedtenants-tenantcustomizedinformation-get.md) | [microsoft.graph.managedTenants.tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md) | Read the properties and relationships of a [tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md) object. | +| [Update tenantCustomizedInformation](../api/managedtenants-tenantcustomizedinformation-update.md) | [microsoft.graph.managedTenants.tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md) | Update the properties of a [tenantCustomizedInformation](../resources/managedtenants-tenantcustomizedinformation.md) object. | ## Properties-|Property|Type|Description| -|:|:|:| -|contacts|[microsoft.graph.managedTenants.tenantContactInformation](../resources/managedtenants-tenantcontactinformation.md) collection|The collection of contacts for the managed tenant. Optional.| -|displayName|String|The display name for the managed tenant. Required. Read-only.| -|id|String|The Microsoft Entra tenant identifier for the managed tenant. Required. Read-only.| -|tenantId|String|The Microsoft Entra tenant identifier for the [managed tenant](../resources/managedtenants-tenant.md). Optional. Read-only.| -|website|String|The website for the managed tenant. Required.| +| Property | Type | Description | +| :-- | :- | :-- | +| contacts | [microsoft.graph.managedTenants.tenantContactInformation](../resources/managedtenants-tenantcontactinformation.md) collection | The collection of contacts for the managed tenant. Optional. | +| displayName | String | The display name for the managed tenant. Required. Read-only. | +| id | String | The Microsoft Entra tenant identifier for the managed tenant. Required. Read-only. | +| tenantId | String | The Microsoft Entra tenant identifier for the [managed tenant](../resources/managedtenants-tenant.md). Optional. Read-only. | +| website | String | The website for the managed tenant. Required. | +| businessRelationship | String | Describes the relationship between the Managed Services Provider and the managed tenant; for example, Managed, Co-managed, Licensing. The maximum length is 250 characters. Optional. | +| complianceRequirements | String collection | Contains the compliance requirements for the customer tenant; for example, HIPPA, NIST, CMMC. The maximum length is 250 characters per compliance requirement. Optional. | +| managedServicesPlans | String collection | This is the Managed Services Plans for the customer tenant that the Managed Services Provider manages. The maximum length is 250 characters per managed service plan. Optional. | +| note | String | A field for the Managed Services Provider technician to input custom text to share notes between technicians within the Managed Service Providers. The maximum length is 5000 characters. Optional. | +| noteLastModifiedDateTime | DateTimeOffset | The date on which the note field of this entity was last modified. Optional. | +| partnerRelationshipManagerUserIds | String collection | The list of Entra user IDs for users in the Managed Services Provider that manage the relationship with the managed tenant. Optional. | ## Relationships None. ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", The following is a JSON representation of the resource. } --> ``` json-{ - "@odata.type": "#microsoft.graph.managedTenants.tenantCustomizedInformation", - "id": "String (identifier)", - "displayName": "String", - "tenantId": "String", - "contacts": [ {- "@odata.type": "microsoft.graph.managedTenants.tenantContactInformation" + "id": "34298981-4fc8-4974-9486-c8909ed1521b", + "tenantId": "34298981-4fc8-4974-9486-c8909ed1521b", + "website": "https://www.fourthcoffee.com", + "contacts": [ + { + "name": "Sally", + "email": "sally@fourthcoffee.com", + "phone": "5558009731" + }, + { + "name": "Hector", + "email": "hector@fourthcoffee.com", + "phone": "5558009732" + } + ], + "businessRelationship": "Managed", + "complianceRequirements": [ + "NIST", + "HIPPA" + ], + "managedServicesPlans": [ + "Microsoft Entra ID P1" + ], + "note": "This is a test note.", + "noteLastModifiedDateTime": "2024-04-03 00:10:21.1989208", + "partnerRelationshipManagerUserIds": [ + "3c23994c-711b-46f6-ab1e-0aeef19413f3" + ] }- ], - "website": "String" -} ``` |
v1.0 | Managedtenants Tenantstatusinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/managedtenants-tenantstatusinformation.md | Represents onboarding status information for a managed tenant. 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.managedTenants.tenantStatusInformation" |
v1.0 | Mediaconfig | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mediaconfig.md | An abstract base class that contains the media configuration used to connect to | Property | Type | Description| |:|:--|:-|-| removeFromDefaultAudioGroup | Boolean | | +| removeFromDefaultAudioGroup | Boolean |Remove media from the default audio group.| ## JSON representation |
v1.0 | Mediainfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mediainfo.md | The media information used in actions for prompts. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mediastream | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mediastream.md | Contains information about the media channel. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Meetingattendancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/meetingattendancereport.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Contains information associated with a meeting attendance report. +Contains information associated with a meeting attendance report for an [onlineMeeting](../resources/onlinemeeting.md) or a [virtualEvent](../resources/virtualevent.md). Meeting attendance reports are online meeting artifacts. For details, see [Online meeting artifacts and permissions](/graph/cloud-communications-online-meeting-artifacts). |
v1.0 | Meetingregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/meetingregistration.md | -# meetingRegistration resource type +# meetingRegistration resource type (deprecated) Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!CAUTION] +> The meeting registration API is deprecated and will stop returning data on **July 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/). + Contains registration details of an online meeting, such as a [Microsoft Teams Webinar](https://support.microsoft.com/office/get-started-with-teams-webinars-42f3f874-22dc-4289-b53f-bbc1a69013e3). Inherits from [meetingRegistrationBase](meetingregistrationbase.md). |
v1.0 | Meetingtimesuggestion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/meetingtimesuggestion.md | availability, and available meeting locations. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Meetingtimesuggestionsresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/meetingtimesuggestionsresult.md | The following are the possible reasons that [findMeetingTimes](../api/user-findm ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mentionspreview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mentionspreview.md | Represents information about [mention](../resources/mention.md) objects in a res ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Messagerule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/messagerule.md | Title: "messageRule resource type" -description: "A rule that applies to messages in the Inbox of a user." +description: "Represents a rule that applies to messages in the Inbox of a user." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A rule that applies to messages in the Inbox of a user. +Represents a rule that applies to messages in the Inbox of a user. In Outlook, you can set up rules for incoming messages in the Inbox to carry out specific actions upon certain conditions. and available rule conditions and exceptions are represented by the [messageRule | Property | Type |Description| |:|:--|:-| | actions | [messageRuleActions](messageruleactions.md) | Actions to be taken on a message when the corresponding conditions are fulfilled. |-| conditions | [messageRulePredicates](messagerulepredicates.md) | Conditions that when fulfilled, will trigger the corresponding actions for that rule. | +| conditions | [messageRulePredicates](messagerulepredicates.md) | Conditions that when fulfilled trigger the corresponding actions for that rule. | | displayName | String | The display name of the rule. | | exceptions | [messageRulePredicates](messagerulepredicates.md) | Exception conditions for the rule. | | hasError | Boolean | Indicates whether the rule is in an error condition. Read-only. | and available rule conditions and exceptions are represented by the [messageRule ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Messageruleactions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/messageruleactions.md | Represents the set of actions that are available to a rule. ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Messagerulepredicates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/messagerulepredicates.md | Represents the set of conditions and exceptions that are available for a rule. | withinSizeRange | [sizeRange](sizerange.md) | Represents the minimum and maximum sizes (in kilobytes) that an incoming message must fall in between in order for the condition or exception to apply. | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mfadetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mfadetail.md | Title: "mfaDetail resource type" -description: "Indicates MFA details for a specific sign-in. It includes the authentication method used for signing in and auth details (for example: Phone, SMS or voicemail) " +description: "Indicates MFA details for a specific sign-in. It includes the authentication method used for signing in and auth details (for example, Phone, SMS, or voicemail) " ms.localizationpriority: medium doc_type: resourcePageType -Indicates MFA details for a specific sign-in. It includes the authentication method used for signing in and auth details (for example: Phone, SMS or voicemail) ++Indicates MFA details for a specific sign-in. It includes the authentication method used for signing in and auth details (for example: Phone, SMS, or voicemail) ## Properties | Property | Type |Description| |:|:--|:-|-|authDetail|String|Indicates the MFA auth detail for the corresponding Sign-in activity when the MFA Required is "Yes".| -|authMethod|String|Indicates the MFA Auth methods (SMS, Phone, Authenticator App are some of the value) for the corresponding sign-in activity when the MFA Required field is "Yes".| +|authDetail|String|Indicates the MFA auth detail for the corresponding sign-in activity when the MFA Required is "Yes".| +|authMethod|String|Indicates the MFA Auth methods (SMS, Phone, Authenticator App are some of the values) for the corresponding sign-in activity when the MFA Required field is "Yes".| ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Microsoft 365 Apps Usage Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoft-365-apps-usage-report.md | - Title: "Microsoft 365 Apps usage reports" -description: "Use the Microsoft 365 Apps usage reports to get insights into the usage of Microsoft 365 Apps in your organization." ---doc_type: conceptualPageType ---# Microsoft 365 Apps usage reports --Namespace: microsoft.graph ---Use the Microsoft 365 Apps usage reports to get insights into the usage of Microsoft 365 Apps in your organization. --> **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). --## Methods --| Method | Return Type | Description | -| :- | : | : | -| [Get user detail](../api/reportroot-getm365appuserdetail.md) | [report](../resources/intune-shared-report.md) | Get details about the usage of Microsoft 365 Apps by user. | -| [Get user counts](../api/reportroot-getm365appusercounts.md) | [report](../resources/intune-shared-report.md) | Get the number of daily unique users by app. | -| [Get platform user counts](../api/reportroot-getm365appplatformusercounts.md) | [report](../resources/intune-shared-report.md) | Get the number of daily unique users by platform. | |
v1.0 | Microsoft 365 Browser Usage Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoft-365-browser-usage-report.md | - Title: "Microsoft 365 browser usage reports" -description: "Use the Microsoft 365 browser usage reports to get insights into the usage of browser (Microsoft Edge) in your organization." ---doc_type: conceptualPageType ---# Microsoft 365 browser usage reports --Namespace: microsoft.graph ---Use the Microsoft 365 browser usage reports to get insights into the usage of browser (Microsoft Edge) in your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 Reports in the admin center - Microsoft browser usage](/microsoft-365/admin/activity-reports/browser-usage-report). --## Reports --| Function | CSV return type | JSON return type | Description | -| : | | - | - | -| [Get user detail](../api/reportroot-getbrowseruserdetail.md ) | Stream | Stream | Get the detailed browser usage per user. | -| [Get user counts](../api/reportroot-getbrowserusercounts.md ) | Stream | Stream |Get the trend in the number of active users for each browser. | -| [Get distribution user counts](../api/reportroot-getbrowserdistributionusercounts.md) | Stream | Stream | Get the number of users by browser over a selected period. | |
v1.0 | Microsoft Forms Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoft-forms-usage-reports.md | - Title: "Microsoft forms usage reports" -description: "Use the Microsoft forms usage reports to get insights into the usage of Microsoft Forms in your organization." ---doc_type: conceptualPageType ---# Microsoft Forms usage reports --Namespace: microsoft.graph ---Use the Microsoft forms usage reports to get insights into the usage of Microsoft Forms in your organization. --## Reports --| Function | CSV return type | JSON return type | Description | -| : | | - | - | -| [Get user detail](../api/reportroot-getformsuseractivityuserdetail.md ) | Stream | Stream | Get the detailed forms usage per user. | -| [Get user counts](../api/reportroot-getformsuseractivityusercounts.md ) | Stream | Stream |Get the trend in the number of active users for each user type. | -| [Get activity counts](../api/reportroot-getformsuseractivitycounts.md) | Stream | Stream | Get the number of activities count by activity type over a selected period. | |
v1.0 | Microsoft Teams Device Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoft-teams-device-usage-reports.md | - Title: "Microsoft Teams device usage reports" -description: "Use the Microsoft Teams device usage reports to get insights into the Microsoft Teams device usage in your organization. " ---doc_type: conceptualPageType ---# Microsoft Teams device usage reports --Namespace: microsoft.graph ---Use the Microsoft Teams device usage reports to get insights into the Microsoft Teams device usage in your organization. --## Methods --| 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 Microsoft Teams licensed 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 Microsoft Teams licensed 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. | -- |
v1.0 | Microsoft Teams Team Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoft-teams-team-usage-reports.md | - Title: "Microsoft Teams team activity reports" -description: "Use the Microsoft Teams team activity reports to get insights into the usage of teams in your organization." ---doc_type: conceptualPageType ---# Microsoft Teams team activity reports --Namespace: microsoft.graph ---Use the Microsoft Teams team activity reports to get insights into the usage of teams in your organization. --## Reports --| Function | CSV return type | JSON return type | Description | -| : | | - | - | -| [Get team detail](../api/reportroot-getteamsteamactivitydetail.md) | Stream | Stream | Get details about Teams activity by team. The numbers include activities for both licensed and non-licensed users. | -| [Get team activity counts](../api/reportroot-getteamsteamactivitycounts.md) | Stream | Stream | Get the number of team activities across Microsoft Teams. The activity types are related to meetings and messages. | -| [Get team counts](../api/reportroot-getteamsteamcounts.md) | Stream | Stream | Get the number of teams by type across Microsoft Teams. | -| [Get distribution team counts](../api/reportroot-getteamsteamactivitydistributioncounts.md) | Stream | Stream | Get the number of team activities across Microsoft Teams over a selected period. | -- |
v1.0 | Microsoft Teams User Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoft-teams-user-activity-reports.md | - Title: "Microsoft Teams user activity reports" -description: "Use the Microsoft Teams user activity reports to get insights into the Microsoft Teams user activity in your organization." ---doc_type: conceptualPageType ---# Microsoft Teams user activity reports --Namespace: microsoft.graph ---Use the Microsoft Teams user activity reports to get insights into the Microsoft Teams user activity in your organization. --## Methods --| 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 nonlicensed users. | -| [Get user counts](../api/reportroot-getteamsuseractivityusercounts.md) | Stream | Get the number of Microsoft Teams licensed 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 nonlicensed 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 nonlicensed users by activity type over 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. | - |
v1.0 | Microsoftauthenticatorauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoftauthenticatorauthenticationmethod.md | This is a derived type that inherits from the [authenticationMethod](authenticat |device|[device](../resources/device.md)|The registered device on which Microsoft Authenticator resides. This property is null if the device is not registered for passwordless Phone Sign-In.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Microsoftauthenticatorauthenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoftauthenticatorauthenticationmethodtarget.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A collection of groups enabled to use [Microsoft Authenticator authentication methods policy](../resources/microsoftAuthenticatorAuthenticationMethodConfiguration.md) in Microsoft Entra ID. Inherits from [authenticationMethodTarget](authenticationMethodTarget.md). +A collection of groups enabled to use [Microsoft Authenticator authentication methods policy](../resources/microsoftAuthenticatorAuthenticationMethodConfiguration.md) in Microsoft Entra ID. Inherits from [authenticationMethodTarget](authenticationMethodTarget.md). ## Properties |Property|Type|Description| |
v1.0 | Microsoftauthenticatorfeaturesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoftauthenticatorfeaturesettings.md | Represents Microsoft Authenticator settings such as number matching and location 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.microsoftAuthenticatorFeatureSettings" |
v1.0 | Mobilitymanagementpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mobilitymanagementpolicy.md | In Microsoft Entra ID, a mobility management policy represents an autoenrollment ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Monthlyuserinsightmetricsroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/monthlyuserinsightmetricsroot.md | None. |Property|Type|Description| |:|:|:| |activeUsers|[activeUsersMetric](../resources/activeusersmetric.md) collection|Insights for active users on apps registered in the tenant for a specified period.|-|activeUsersBreakdown (deprecated)|[activeUsersBreakdownMetric](../resources/activeusersbreakdownmetric.md) collection|Insights for the breakdown of users who were active on apps registered in the tenant for a specified period.| |authentications|[authenticationsMetric](../resources/authenticationsmetric.md) collection|Insights for authentications on apps registered in the tenant for a specified period.| |mfaCompletions|[mfaCompletionMetric](../resources/mfacompletionmetric.md) collection|Insights for MFA usage on apps registered in the tenant for a specified period.| |requests|[userRequestsMetric](../resources/userrequestsmetric.md) collection| Insights for all user requests on apps registered in the tenant for a specified period.| |
v1.0 | Multitenantorganization Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/multitenantorganization-overview.md | Last updated 07/30/2023 # Multitenant organization API overview -Namespace: microsoft.graph - [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] The multitenant organization feature allows you to define an organization with more than one instance of Microsoft Entra ID. A multitenant organization enables multiple tenants to collaborate like a single entity. Also, at the time of joining, multitenant organization tenants can have a defaul If you need to increase these limits, you can submit a support request using the Azure portal or Microsoft Entra admin center. In your request, include the tenant ID of one owner tenant and a list of all tenant IDs that are intended to be part of the finalized multitenant organization. -## Next steps +## Related content + [What is a multitenant organization in Microsoft Entra ID?](/azure/active-directory/multi-tenant-organizations/overview) + [multiTenantOrganization resource type](../resources/multitenantorganization.md) |
v1.0 | Multitenantorganization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/multitenantorganization.md | There can only be one multitenant organization per active tenant. It is not poss |tenants|[multiTenantOrganizationMember](../resources/multitenantorganizationmember.md) collection|Defines tenants added to a multitenant organization.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Multitenantorganizationidentitysyncpolicytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/multitenantorganizationidentitysyncpolicytemplate.md | +toc. Title: Identity sync policy template # multiTenantOrganizationIdentitySyncPolicyTemplate resource type In its default and unconfigured state, where all template properties (other than None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Multitenantorganizationjoinrequestrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/multitenantorganizationjoinrequestrecord.md | +toc. Title: Join request # multiTenantOrganizationJoinRequestRecord resource type Defines the status of a tenant joining a multi-tenant organization. Before a ten None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Multitenantorganizationjoinrequesttransitiondetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/multitenantorganizationjoinrequesttransitiondetails.md | Details of the processing status for a tenant joining a multitenant organization 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.multiTenantOrganizationJoinRequestTransitionDetails" |
v1.0 | Multitenantorganizationmember | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/multitenantorganizationmember.md | +toc. Title: Member # multiTenantOrganizationMember resource type |
v1.0 | Multitenantorganizationmembertransitiondetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/multitenantorganizationmembertransitiondetails.md | Details of the processing status for a tenant in a multitenant organization. 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.multiTenantOrganizationMemberTransitionDetails" |
v1.0 | Multitenantorganizationpartnerconfigurationtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/multitenantorganizationpartnerconfigurationtemplate.md | +toc. Title: Partner configuration template # multiTenantOrganizationPartnerConfigurationTemplate resource type In its default and unconfigured state, where all template properties (other than None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Multivaluelegacyextendedproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/multivaluelegacyextendedproperty.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Networkaccess Bgpconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-bgpconfiguration.md | The border gateway protocol (BGP) specifies the IP address and ASN to route traf ## Properties |Property|Type|Description| |:|:|:|+|ipAddress|String|Specifies the BGP IP address.| |localIpAddress|String| Specifies the BGP IP address of peer (Microsoft, in this case).| |peerIpAddress |String| Specifies the BGP IP address of customer's on-premise VPN router configuration.| |asn |Int32| Specifies the ASN of the BGP.| |
v1.0 | Networkaccess Branchconnectivityconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-branchconnectivityconfiguration.md | Title: "branchConnectivityConfiguration resource type" + Title: "branchConnectivityConfiguration resource type (deprecated)" description: "Specifies the connectivity details of all device links associated with a branch." ms.localizationpriority: medium-# branchConnectivityConfiguration resource type +# branchConnectivityConfiguration resource type (deprecated) Namespace: microsoft.graph.networkaccess Namespace: microsoft.graph.networkaccess Specifies the connectivity details of all device links associated with a branch. +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetworkConnectivityConfiguration resource type](../resources/networkaccess-remotenetworkconnectivityconfiguration.md) and its associated methods instead. + ## Methods |Method|Return type|Description| |:|:|:| |
v1.0 | Networkaccess Branchsite | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-branchsite.md | Title: "branch resource type" + Title: "branchSite resource type (deprecated)" description: "A branch connects the Customer Premises Equipment (CPE) to the Global Secure Access services edge network." ms.localizationpriority: medium-# branchSite resource type +# branchSite resource type (deprecated) Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!IMPORTANT] +> Deprecated and to be retired soon. Use the [remoteNetwork resource type](../resources/networkaccess-remotenetwork.md) and its associated methods instead. + A branch connects the Customer Premises Equipment (CPE) to the Global Secure Access services edge network. Inherits from [microsoft.graph.entity](../resources/entity.md). Inherits from [microsoft.graph.entity](../resources/entity.md). |[Get branchSite](../api/networkaccess-branchsite-get.md)|[microsoft.graph.networkaccess.branchSite](../resources/networkaccess-branchsite.md)|Read the properties and relationships of a [microsoft.graph.networkaccess.branchSite](../resources/networkaccess-branchsite.md) object.| |[Update branchSite](../api/networkaccess-branchsite-update.md)|[microsoft.graph.networkaccess.branchSite](../resources/networkaccess-branchsite.md)|Update the properties of a [microsoft.graph.networkaccess.branchSite](../resources/networkaccess-branchsite.md) object.| |[Delete branchSite](../api/networkaccess-branchsite-delete.md)|None|Delete a [microsoft.graph.networkaccess.branchSite](../resources/networkaccess-branchsite.md) object.|-|[List deviceLinks](../api/networkaccess-branchsite-list-devicelinks.md)|[microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) collection|Get the deviceLink resources from the deviceLinks navigation property.| -|[Create deviceLink](../api/networkaccess-branchsite-post-devicelinks.md)|[microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md)|Create a new deviceLink object.| -|[List forwardingProfiles](../api/networkaccess-branchsite-list-forwardingprofiles.md)|[microsoft.graph.networkaccess.forwardingProfile](../resources/networkaccess-forwardingprofile.md) collection|Get the forwardingProfile resources linked to this branchSite.| -[Create forwardingProfile](../api/networkaccess-branchsite-post-forwardingprofiles.md)|[microsoft.graph.networkaccess.forwardingProfile](../resources/networkaccess-forwardingprofile.md)|Create a new forwardingProfile object.| ## Properties |Property|Type|Description| Inherits from [microsoft.graph.entity](../resources/entity.md). |id|String|Identifier for the branch. Inherited from [microsoft.graph.entity](../resources/entity.md).| |lastModifiedDateTime|DateTimeOffset|last modified time.| |name|String|Name.|-|region|String|The branch site is created in the specified location. The possible value are: `eastUS`, `eastUS2`, `westUS`, `westUS2`, `westUS3`, `centralUS`, `northCentralUS`, `southCentralUS`, `northEurope`, `westEurope`, `franceCentral`, `germanyWestCentral`, `switzerlandNorth`, `ukSouth`, `canadaEast`, `canadaCentral`, `southAfricaWest`, `southAfricaNorth`, `uaeNorth`, `australiaEast`, `westCentralUS`, `centralIndia`, `southEastAsia`, `swedenCentral`, `southIndia`, `australiaSouthEast`, `koreaCentral`, `polandCentral`, `brazilSouth`, `japanEast`, `japanWest`, `unknownFutureValue`.| +|region|microsoft.graph.networkaccess.region|Specify the region closest to your remote network. The possible value are: `eastUS`, `eastUS2`, `westUS`, `westUS2`, `westUS3`, `centralUS`, `northCentralUS`, `southCentralUS`, `northEurope`, `westEurope`, `franceCentral`, `germanyWestCentral`, `switzerlandNorth`, `ukSouth`, `canadaEast`, `canadaCentral`, `southAfricaWest`, `southAfricaNorth`, `uaeNorth`, `australiaEast`, `westCentralUS`, `centralIndia`, `southEastAsia`, `swedenCentral`, `southIndia`, `australiaSouthEast`, `koreaCentral`, `koreaSouth`, `polandCentral`, `brazilSouth`, `japanEast`, `japanWest`, `koreaSouth`, `italyNorth`, `franceSouth`, `israelCentral`, `unknownFutureValue`.| |version|String|The branch version.| |country (deprecated)|String|The branch site is created in the specified country. **DO NOT USE.**| |
v1.0 | Networkaccess Conditionalaccesssettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-conditionalaccesssettings.md | Inherits from [microsoft.graph.entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Networkaccess Connectivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-connectivity.md | None. ## Relationships |Relationship|Type|Description| |:|:|:|-|branches|[microsoft.graph.networkaccess.branchSite](../resources/networkaccess-branchsite.md) collection|Branches represent locations for connectivity.| +|branches|[microsoft.graph.networkaccess.branchSite](../resources/networkaccess-branchsite.md) collection|Branches represent locations for connectivity. **DEPRECATED AND TO BE RETIRED SOON. Use the remoteNetwork relationship and its associated APIs instead.**| +|remoteNetworks|[microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) collection|Represent locations, such as branches, that are connected to Global Secure Access services through an IPsec tunnel.| ## JSON representation Here's is a JSON representation of the resource. |
v1.0 | Networkaccess Crosstenantsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-crosstenantsummary.md | A summary for cross-tenant access counts for Microsoft 365 traffic. |authTransactionCount|Int32|The total number of authentication sessions between startDateTime and endDateTime. | |deviceCount|Int32|The number of unique devices that performed cross-tenant access. | |newTenantCount|Int32|The number of unique tenants that were accessed between endDateTime and discoveryPivotDateTime, but weren't accessed between discoveryPivotDateTime and startDateTime.|+|rarelyUsedTenantCount|Int32|The number of tenants that are rarely used.| |tenantCount|Int32|The number of unique tenants that were accessed, not including the device's tenant.| |userCount|Int32|The number of unique users that performed cross-tenant access.| |
v1.0 | Networkaccess Devicelink | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-devicelink.md | Title: "deviceLink resource type" -description: "A device link represents a single customer-premises equipment (CPE) at a physical branch site location that's connected to the Global Secure Access services." +description: "A device link represents a single customer-premises equipment (CPE) at a remote network that's connected to the Global Secure Access services." ms.localizationpriority: medium Namespace: microsoft.graph.networkaccess [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A device link represents a single customer-premises equipment (CPE) at a physical branch site location that's connected to the Global Secure Access services. +A device link represents a single customer-premises equipment (CPE) at a remote network that's connected to the Global Secure Access services. Inherits from [microsoft.graph.entity](../resources/entity.md). ## Methods |Method|Return type|Description| |:|:|:|-|[List deviceLinks](../api/networkaccess-branchsite-list-devicelinks.md)|[microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) collection|Get a list of the [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) objects and their properties.| -|[Create deviceLink](../api/networkaccess-branchsite-post-devicelinks.md)|None|Create a new [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) object.| +|[List deviceLinks](../api/networkaccess-remotenetwork-list-devicelinks.md)|[microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) collection|Get a list of the [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) objects and their properties.| +|[Create deviceLink](../api/networkaccess-remotenetwork-post-devicelinks.md)|None|Create a new [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) object.| |[Get deviceLink](../api/networkaccess-devicelink-get.md)|[microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md)|Read the properties and relationships of a [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) object.|-|[Update deviceLink](../api/networkaccess-devicelink-update.md)|[microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md)|Update the properties of a [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) object.| -|[Delete deviceLink](../api/networkaccess-branchsite-delete-devicelinks.md)|None|Delete a [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) object.| +|[Delete deviceLink](../api/networkaccess-devicelink-delete.md)|None|Delete a [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) object.| +|[List deviceLinks for a branchSite (deprecated)](../api/networkaccess-branchsite-list-devicelinks.md)|[microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) collection|Get a list of the [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) objects and their properties.| +|[Create deviceLink for a branchSite (deprecated)](../api/networkaccess-branchsite-post-devicelinks.md)|None|Create a new [microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) object.| ## Properties |Property|Type|Description| |:|:|:|-|bgpConfiguration|[microsoft.graph.networkaccess.bgpConfiguration](../resources/networkaccess-bgpconfiguration.md)|The border gateway protocol specifies the IP address and ASN for directing traffic from a link to the edge.| -|bandwidthCapacityInMbps|Int64|Determines the maximum allowed Mbps (megabits per second) bandwidth from a branch site. The possible values are:`250`,`500`,`750`,`1000`.| -|deviceVendor|microsoft.graph.networkaccess.deviceVendor|Specifies the manufacturer of the deviceLink. The possible values are: `barracudaNetworks`, `checkPoint`, `ciscoMeraki`, `citrix`, `fortinet`, `hpeAruba`, `netFoundry`, `nuage`, `openSystems`, `paloAltoNetworks`, `riverbedTechnology`, `silverPeak`, `vmWareSdWan`, `versa`, `other`, `unknownFutureValue`.| +|bgpConfiguration|[microsoft.graph.networkaccess.bgpConfiguration](../resources/networkaccess-bgpconfiguration.md)|The border gateway protocol specifies the Border Gateway Protocol (BGP) IP address and ASN for directing traffic from a link to the edge.| +|bandwidthCapacityInMbps|Int64|Determines the maximum allowed Mbps (megabits per second) bandwidth from a device link. The possible values are:`250`,`500`,`750`,`1000`.| +|deviceVendor|microsoft.graph.networkaccess.deviceVendor|Specifies the manufacturer of the deviceLink. The possible values are: `barracudaNetworks`, `checkPoint`, `ciscoMeraki`, `citrix`, `fortinet`, `hpeAruba`, `netFoundry`, `nuage`, `openSystems`, `paloAltoNetworks`, `riverbedTechnology`, `silverPeak`, `vmWareSdWan`, `versa`, `other`.| |id|String|Identifier. Inherited from [microsoft.graph.entity](../resources/entity.md).|-|ipAddress|String|Specifies the client IPv4 of the link | +|ipAddress|String|The public IP address of your CPE (customer premise equipment) device. | |lastModifiedDateTime|DateTimeOffset|last modified time.| |name|String|Name.| |tunnelConfiguration|[microsoft.graph.networkaccess.tunnelConfiguration](../resources/networkaccess-tunnelconfiguration.md)|The connectivity settings, including the protocol, IPSec policy, and preshared key, are specified for establishing connectivity.| |
v1.0 | Networkaccess Enrichedauditlogssettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-enrichedauditlogssettings.md | Represents a configuration object that centralizes enriched audit logs settings 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.networkaccess.enrichedAuditLogsSettings" |
v1.0 | Networkaccess Filteringpolicylink | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-filteringpolicylink.md | Inherits from [microsoft.graph.networkaccess.policyLink](../resources/networkacc |createdDateTime|DateTimeOffset|The date and time when the filtering Policy link was created.| |id|String|Unique identifier. Inherited from [microsoft.graph.entity](../resources/entity.md).| |lastModifiedDateTime|DateTimeOffset|The date and time when the policy was most recently modified.|-|state|microsoft.graph.networkaccess.status|A value that tells whether the link is enabled or disabled. Inherited from [microsoft.graph.networkaccess.policyLink](../resources/networkaccess-policylink.md). The allowed values are `enabled` and `disabled`.| -+|loggingState|microsoft.graph.networkaccess.status|A value that tells whether the link is enabled or disabled. Inherited from [microsoft.graph.networkaccess.policyLink](../resources/networkaccess-policylink.md). The allowed values are `enabled` and `disabled`.| +|priority|Int64|Provides an integer priority level for each instance of a URL filtering policy linked to a profile. Required.| ## Relationships |Relationship|Type|Description| The following JSON representation shows the resource type. { "@odata.type": "#microsoft.graph.networkaccess.filteringPolicyLink", "id": "String (identifier)",- "state": "String", "version": "String", "lastModifiedDateTime": "String (timestamp)", "createdDateTime": "String (timestamp)", |
v1.0 | Networkaccess Forwardingpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-forwardingpolicy.md | Inherits from [microsoft.graph.networkaccess.policy](../resources/networkaccess- |policyRules|[microsoft.graph.networkaccess.policyRule](../resources/networkaccess-policyrule.md) collection| Represents the definition of the policy ruleset that makes up the core definition of a policy. Inherited from [microsoft.graph.networkaccess.policy](../resources/networkaccess-policy.md). Supports `$expand`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Networkaccess Forwardingprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-forwardingprofile.md | Inherits from [microsoft.graph.networkaccess.profile](../resources/networkaccess ## Properties |Property|Type|Description| |:|:|:|-|associations|[microsoft.graph.networkaccess.association](../resources/networkaccess-association.md) collection|Specifies the users, groups, devices, and branch locations whose traffic is associated with the given traffic forwarding profile.| +|associations|[microsoft.graph.networkaccess.association](../resources/networkaccess-association.md) collection|Specifies the users, groups, devices, and remote networks whose traffic is associated with the given traffic forwarding profile.| |description|String|Profile description. Inherited from [microsoft.graph.networkaccess.profile](../resources/networkaccess-profile.md).| |id|String|Identifier for the profile. Inherited from [microsoft.graph.entity](../resources/entity.md).| |lastModifiedDateTime|DateTimeOffset|Profile last modified time. Inherited from [microsoft.graph.networkaccess.profile](../resources/networkaccess-profile.md).| The following is a JSON representation of the resource. "trafficForwardingType": "String", "associations": [ {- "@odata.type": "microsoft.graph.networkaccess.associatedBranch" + "@odata.type": "microsoft.graph.networkaccess.association" } ], "priority": "Integer" |
v1.0 | Networkaccess Global Secure Access Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-global-secure-access-api-overview.md | description: "Learn how to use Microsoft Graph network access APIs to secure acc ms.localizationpriority: medium -doc_type: resourcePageType # Secure access to cloud, public, and private apps using Microsoft Graph network access APIs (preview) The network access APIs provide a framework to configure how you want to forward | [forwardingPolicy](../resources/networkaccess-forwardingpolicy.md) | Defines the rules for routing or bypassing specific traffic type through the Global Secure Access services. Each policy is tried to one traffic type that can be Microsoft 365, Internet, or Private traffic. A forwarding policy can have only forwarding policy rules. | | [forwardingPolicyLink](../resources/networkaccess-forwardingpolicylink.md) | Represents the relationship between a forwarding profile and a forwarding policy, and maintains the current state of the connection.| | [policyRule](../resources/networkaccess-policyrule.md) | Maintains the core definition of a policy ruleset. |-| [branchSite](../resources/networkaccess-branchsite.md) | Represents the physical branch office locations from where users and devices connect to access the cloud, public, or private apps. Each branch comprises devices and the connection of devices in a branch is maintained via customer-premises equipment (CPE).| --<!-- -| Filtering profiles | Groups filtering policies, which are then associated with Conditional Access policies in Azure AD to leverage a rich set of user-context conditions.| -| Filtering policies | Encapsulates various policies configured by administrators, such as network filtering policies, data loss prevention, and threat protection.| -| [Filtering policy links](../resources/networkaccess-filteringpolicylink.md) | Represents the relationship between a filtering profile and a filtering policy, and maintains the current state of the connection.| >+| [remoteNetwork](../resources/networkaccess-remotenetwork.md) | Represents the physical location from where users and devices connect to access the cloud, public, or private apps. Each remote network comprises devices and the connection of devices in a remote network is maintained via customer-premises equipment (CPE).| +| [filteringProfile](../resources/networkaccess-filteringprofile.md) | Groups filtering policies, which are then associated with Conditional Access policies in Microsoft Entra to leverage a rich set of user-context conditions.| +| [filteringPolicy](../resources/networkaccess-filteringpolicy.md) | Encapsulates various policies configured by administrators, such as network filtering policies, data loss prevention, and threat protection.| +| [filteringPolicLink](../resources/networkaccess-filteringpolicylink.md) | Represents the relationship between a filtering profile and a filtering policy, and maintains the current state of the connection.| ## Onboard to the service process The following APIs allow an admin to manage and configure forwarding profiles. T | Sample operations | Description | |--|--| | [List forwarding profiles](../api/networkaccess-networkaccessroot-list-forwardingprofiles.md) | List the forwarding profiles configured for the tenant. You can also retrieve the associated policies using the `$expand` query parameter.|-| [Update forwardingProfile](../api/networkaccess-forwardingprofile-update.md) | Enable or disable a forwarding profile or configure associations such as the branch. | +| [Update forwardingProfile](../api/networkaccess-forwardingprofile-update.md) | Enable or disable a forwarding profile or configure associations such as the remote network. | | [List forwarding policies](../api/networkaccess-networkaccessroot-list-forwardingpolicies.md) | List the forwarding policies configured for the tenant. You can also retrieve the associated forwarding policy rules using the `$expand` query parameter.| | [List forwarding policy links](../api/networkaccess-forwardingprofile-list-policies.md) | List the policy links associated with a forwarding profile. You can also retrieve the associated forwarding policy rules using the `$expand` query parameter.| -## Branches +## Remote networks -A branch or remote network scenario involves user devices or user-less devices like printers establishing connectivity via customer-premises equipment (CPE), also known as device links, at the physical branch office location. +A remote network scenario involves user devices or user-less devices like printers establishing connectivity via customer-premises equipment (CPE), also known as device links, at a physical office location. -Use the following APIs to manage the branch details once a branch is onboarded to the service. +Use the following APIs to manage the details of a remote network that you've onboarded to the service. | Sample operations | Description | |--|--|-| [Create a branch](../api/networkaccess-connectivity-post-branches.md) <br/>[Create device links for a branch](../api/networkaccess-branchsite-post-devicelinks.md) <br/>[Create forwarding profiles for a branch](../api/networkaccess-branchsite-post-forwardingprofiles.md)| Create branches and their associated device links and forwarding profiles.| -| [List branches](../api/networkaccess-connectivity-list-branches.md) <br/>[List device links for a branch](../api/networkaccess-branchsite-list-devicelinks.md) <br/>[List forwarding profiles for a branch](../api/networkaccess-branchsite-list-forwardingprofiles.md)| List branches and their associated device links and forwarding profiles.| +| [Create a remote network](../api/networkaccess-connectivity-post-remotenetworks.md) <br/>[Create device links for a remote network](../api/networkaccess-remotenetwork-post-devicelinks.md) <br/>[Create forwarding profiles for a remote network](../api/networkaccess-remotenetwork-post-forwardingprofiles.md)| Create remote networks and their associated device links and forwarding profiles.| +| [List remote networks](../api/networkaccess-connectivity-list-remotenetworks.md) <br/>[List device links for a remote network](../api/networkaccess-remotenetwork-list-devicelinks.md) <br/>[List forwarding profiles for a remote network](../api/networkaccess-remotenetwork-list-forwardingprofiles.md)| List remote networks and their associated device links and forwarding profiles.| ## Access controls Forwarding options allows administrators to enable or disable the ability to ski ## Audit logs -Monitoring and auditing of events within your environment is crucial for maintaining security, compliance, and operational efficiency. The Global Secure Access events are logged in the [directory logs](../resources/directoryaudit.md) and can be retrieved using associated APIs. --<!-- -```msgraph-interactive -GET https://graph.microsoft.com/beta/auditLogs/directoryAudits?$filter= -``` >+Monitoring and auditing of events within your environment is crucial for maintaining security, compliance, and operational efficiency. The Global Secure Access events are logged in the [directory logs](../resources/directoryaudit.md) and [sign-in logs](../resources/signin.md) can be retrieved using associated APIs. ## Traffic logs and reports |
v1.0 | Networkaccess Iprange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-iprange.md | Title: "Global Secure Access ipRange resource type" + Title: ipRange resource type description: "An IP address range represents either a specific IP address or a range of IP addresses. It is used to define a set of network addresses or a single network endpoint within a specified range." ms.localizationpriority: medium-# Global Secure Access ipRange resource type +# ipRange resource type Namespace: microsoft.graph.networkaccess |
v1.0 | Networkaccess Localconnectivityconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-localconnectivityconfiguration.md | Specifies the Microsoft end of the tunnel configuration for a device link. |asn|Int32|Specifies ASN of one end of IPSec tunnel (local or peer).| |bgpAddress|String|Specifies BGP IPv4 address of one end of IPSec tunnel (local or peer).| |endpoint|String|Specifies public IPv4 address of one end of IPSec tunnel (local or peer).|-|region|microsoft.graph.networkaccess.region| Specifies the region in which the Microsoft end of the tunnel exists. Not applicable for peer configuration. The possible values are: `eastUS`, `eastUS2`, `westUS`, `westUS2`, `westUS3`, `centralUS`, `northCentralUS`, `southCentralUS`, `northEurope`, `westEurope`, `franceCentral`, `germanyWestCentral`, `switzerlandNorth`, `ukSouth`, `canadaEast`, `canadaCentral`, `southAfricaWest`, `southAfricaNorth`, `uaeNorth`,`unknownFutureValue`.| +|region|microsoft.graph.networkaccess.region|Specify the region closest to your remote network. Not applicable for peer configuration. The possible value are: `eastUS`, `eastUS2`, `westUS`, `westUS2`, `westUS3`, `centralUS`, `northCentralUS`, `southCentralUS`, `northEurope`, `westEurope`, `franceCentral`, `germanyWestCentral`, `switzerlandNorth`, `ukSouth`, `canadaEast`, `canadaCentral`, `southAfricaWest`, `southAfricaNorth`, `uaeNorth`, `australiaEast`, `westCentralUS`, `centralIndia`, `southEastAsia`, `swedenCentral`, `southIndia`, `australiaSouthEast`, `koreaCentral`, `koreaSouth`, `polandCentral`, `brazilSouth`, `japanEast`, `japanWest`, `koreaSouth`, `italyNorth`, `franceSouth`, `israelCentral`, `unknownFutureValue`.| ## Relationships None. |
v1.0 | Networkaccess M365forwardingrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-m365forwardingrule.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Networkaccess Networkaccessroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-networkaccessroot.md | None. |tenantStatus|[microsoft.graph.networkaccess.tenantStatus](../resources/networkaccess-tenantstatus.md)|Represents the status of the Global Secure Access services for the tenant.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Networkaccess Networkaccesstraffic | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-networkaccesstraffic.md | Represents a network access traffic log entry. It contains comprehensive informa ## Properties |Property|Type|Description| |:|:|:|+|action|microsoft.graph.networkaccess.filteringPolicyAction|Indicates what action to take based on filtering policies. The possible values are: `block`, `allow`.| |agentVersion|String|Represents the version of the Global Secure Access client agent software. Supports $filter (`eq`) and `$orderby`.| |connectionId|String|Represents a unique identifier assigned to a connection. Supports $filter (`eq`) and `$orderby`.| |createdDateTime|DateTimeOffset|Represents the date and time when a network access traffic log entry was created. Supports $filter (`eq`) and `$orderby`.| Represents a network access traffic log entry. It contains comprehensive informa None. ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "transactionId", |
v1.0 | Networkaccess Policylink | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-policylink.md | None. |policy|[microsoft.graph.networkaccess.policy](../resources/networkaccess-policy.md)|Policy. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Networkaccess Privateaccessforwardingrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-privateaccessforwardingrule.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Networkaccess Profile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-profile.md | Title: "network access profile resource type" + Title: profile resource type description: "A profile serves as a container for forwarding policies." ms.localizationpriority: medium-# network access profile resource type +# profile resource type Namespace: microsoft.graph.networkaccess Inherits from [microsoft.graph.entity](../resources/entity.md). |policies|[microsoft.graph.networkaccess.policyLink](../resources/networkaccess-policylink.md) collection|Traffic forwarding policies associated with this profile.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", "@odata.type": "microsoft.graph.networkaccess.profile", "baseType": "microsoft.graph.entity", "abstract": true,- "openType": false + "openType": false } --> ``` json |
v1.0 | Networkaccess Remotenetwork | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-remotenetwork.md | + + Title: "remoteNetwork resource type" +description: "A remote network represents a location such as a branch office where customer premises equipment (CPE) is connected to the nearest deployment of Global Secure Access service though IPsec tunnels." ++ms.localizationpriority: medium ++++# remoteNetwork resource type ++Namespace: microsoft.graph.networkaccess +++A remote network represents a location such as a branch office where customer premises equipment (CPE) is connected to the nearest deployment of Global Secure Access service though IPsec tunnels. ++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List remoteNetworks](../api/networkaccess-connectivity-list-remotenetworks.md)|[microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) collection|Get a list of the [microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) objects and their properties.| +|[Create remoteNetwork](../api/networkaccess-connectivity-post-remotenetworks.md)|[microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md)|Create a new [microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) object.| +|[Get remoteNetwork](../api/networkaccess-remotenetwork-get.md)|[microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md)|Read the properties and relationships of a [microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) object.| +|[Update remoteNetwork](../api/networkaccess-remotenetwork-update.md)|[microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md)|Update the properties of a [microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) object.| +|[Delete remoteNetwork](../api/networkaccess-connectivity-delete-remotenetworks.md)|None|Delete a [microsoft.graph.networkaccess.remoteNetwork](../resources/networkaccess-remotenetwork.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|Identifier for the remote network. Inherited from [microsoft.graph.entity](../resources/entity.md).| +|lastModifiedDateTime|DateTimeOffset|last modified time.| +|name|String|Name.| +|region|microsoft.graph.networkaccess.region|Specify the region closest to your remote network. The possible value are: `eastUS`, `eastUS2`, `westUS`, `westUS2`, `westUS3`, `centralUS`, `northCentralUS`, `southCentralUS`, `northEurope`, `westEurope`, `franceCentral`, `germanyWestCentral`, `switzerlandNorth`, `ukSouth`, `canadaEast`, `canadaCentral`, `southAfricaWest`, `southAfricaNorth`, `uaeNorth`, `australiaEast`, `westCentralUS`, `centralIndia`, `southEastAsia`, `swedenCentral`, `southIndia`, `australiaSouthEast`, `koreaCentral`, `koreaSouth`, `polandCentral`, `brazilSouth`, `japanEast`, `japanWest`, `koreaSouth`, `italyNorth`, `franceSouth`, `israelCentral`, `unknownFutureValue`.| +|version|String|Remote network version.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|connectivityConfiguration|[microsoft.graph.networkaccess.remoteNetworkConnectivityConfiguration](../resources/networkaccess-remotenetworkconnectivityconfiguration.md) collection|Specifies the connectivity details of all device links associated with a remote network.| +|deviceLinks|[microsoft.graph.networkaccess.deviceLink](../resources/networkaccess-devicelink.md) collection|Each unique CPE device associated with a remote network is specified. Supports `$expand`.| +|forwardingProfiles|[microsoft.graph.networkaccess.forwardingProfile](../resources/networkaccess-forwardingprofile.md) collection|Each forwarding profile associated with a remote network is specified. Supports `$expand` and `$select`.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.networkaccess.remoteNetwork", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.networkaccess.remoteNetwork", + "id": "String (identifier)", + "lastModifiedDateTime": "String (timestamp)", + "name": "String", + "region": "microsoft.graph.networkaccess.region", + "version": "String", +} +``` + |
v1.0 | Networkaccess Remotenetworkconnectivityconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-remotenetworkconnectivityconfiguration.md | + + Title: "remoteNetworkConnectivityConfiguration resource type" +description: "Specifies the connectivity details of all device links associated with a remote network." ++ms.localizationpriority: medium ++++# remoteNetworkConnectivityConfiguration resource type ++Namespace: microsoft.graph.networkaccess +++Specifies the connectivity details of all device links associated with a remote network. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get remoteNetworkConnectivityConfiguration](../api/networkaccess-remotenetworkconnectivityconfiguration-get.md)|[microsoft.graph.networkaccess.remoteNetworkConnectivityConfiguration](../resources/networkaccess-remotenetworkconnectivityconfiguration.md)|Read the properties and relationships of a [microsoft.graph.networkaccess.remoteNetworkConnectivityConfiguration](../resources/networkaccess-remotenetworkconnectivityconfiguration.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|remoteNetworkId|String|Unique identifier or a specific reference assigned to a branchSite. Key.| +|remoteNetworkName|String|Display name assigned to a branchSite.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|links|[microsoft.graph.networkaccess.connectivityConfigurationLink](../resources/networkaccess-connectivityconfigurationlink.md) collection|List of connectivity configurations for [deviceLink](../resources/networkaccess-devicelink.md) objects.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "remoteNetworkId", + "@odata.type": "microsoft.graph.networkaccess.remoteNetworkConnectivityConfiguration", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.networkaccess.remoteNetworkConnectivityConfiguration", + "remoteNetworkId": "String (identifier)", + "remoteNetworkName": "String" +} +``` + |
v1.0 | Networkaccess Settings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-settings.md | Title: "Global Secure Access settings resource type" + Title: settings resource type description: "The tenant configuration settings that are associated with Microsoft Entra Internet Access and Microsoft Entra Private Access capabilities under the umbrella of Global Secure Access." ms.localizationpriority: medium-# Global Secure Access settings resource type +# settings resource type Namespace: microsoft.graph.networkaccess |
v1.0 | Networkaccess Tenantstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-tenantstatus.md | Inherits from [microsoft.graph.entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Networkaccess Tunnelconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-tunnelconfiguration.md | This is an abstract type from which the [microsoft.graph.networkaccess.tunnelCon |Property|Type|Description| |:|:|:| |preSharedKey|String|A key to establish secure connection between the link and VPN tunnel on the edge.|+|zoneRedundancyPreSharedKey|String|Another key for zone redundant tunnel. Required only when you select `zoneRedundancy` redindancyTier when creating a deviceLink.| ## Relationships None. The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.networkaccess.tunnelConfiguration",- "preSharedKey": "String" + "preSharedKey": "String", + "zoneRedundancyPreSharedKey": "String" } ``` |
v1.0 | Networkaccess Tunnelconfigurationikev2default | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-tunnelconfigurationikev2default.md | Inherits from [microsoft.graph.networkaccess.tunnelConfiguration](../resources/n 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.networkaccess.tunnelConfigurationIKEv2Default" |
v1.0 | Networkinterface | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkinterface.md | Represents a Network Interface Card (NIC) associated with this host. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Noentitlementsdatacollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/noentitlementsdatacollection.md | description: "Represents the details and status of data collection about permiss ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Nomediaconfig | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/nomediaconfig.md | Media configuration for indicating no media. | Property | Type | Description| |:|:--|:-|-| removeFromDefaultAudioGroup | Boolean | | +| removeFromDefaultAudioGroup | Boolean |Remove media from the default audio group.| ## JSON representation |
v1.0 | Nomfaonroleactivationalertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/nomfaonroleactivationalertconfiguration.md | Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrole |alertDefinition|[unifiedRoleManagementAlertDefinition](../resources/unifiedrolemanagementalertdefinition.md)| The definition of the alert that contains its description, impact, and measures to mitigate or prevent it. Supports `$expand`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Nomfaonroleactivationalertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/nomfaonroleactivationalertincident.md | Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanag None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Notebook | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/notebook.md | A OneNote notebook. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Notebooklinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/notebooklinks.md | Links for opening a OneNote notebook. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Objectidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/objectidentity.md | Title: "objectIdentity resource type" description: "Represents an identity used to sign in to a user account." ms.localizationpriority: medium doc_type: resourcePageType+ |
v1.0 | Office 365 Activations Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/office-365-activations-reports.md | - Title: "Microsoft 365 activations reports" -description: "The Microsoft 365 activation report gives you a view of which users have activated their Microsoft 365 subscriptions on at least one device. It provides a breakdown of the Microsoft 365 ProPlus, Project, and Visio Pro for Microsoft 365 subscription activations, as well as the breakdown of activations across desktop and devices. This report could help you identify users who might need additional support to activate their Office subscription." ---doc_type: conceptualPageType ---# Microsoft 365 activations reports --Namespace: microsoft.graph ---The Microsoft 365 activation report gives you a view of which users have activated their Microsoft 365 subscriptions on at least one device. It provides a breakdown of the Microsoft 365 ProPlus, Project, and Visio Pro for Microsoft 365 subscription activations, as well as the breakdown of activations across desktop and devices. This report could help you identify users who might need additional support to activate their Office subscription. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Microsoft Office activations](https://support.office.com/client/Office-activations-87c24ae2-82e0-4d1e-be01-c3bcc3f18c60). --## Reports -| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get user detail](../api/reportroot-getoffice365activationsuserdetail.md) | Stream | Stream | Get details about users who have activated Microsoft 365. | -| [Get activation counts](../api/reportroot-getoffice365activationcounts.md) | Stream | Stream | Get the count of Microsoft 365 activations on desktops and devices. | -| [Get user counts](../api/reportroot-getoffice365activationsusercounts.md) | Stream | Stream | Get the count of users that are enabled and those that have activated the Office subscription on desktop or devices. | -- |
v1.0 | Office 365 Active Users Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/office-365-active-users-reports.md | - Title: "Microsoft 365 active users reports" -description: "You can use the Microsoft 365 active users report to find out how many product licenses are being used by individuals in your organization, and drill down for information about which users are using what products. This report can help administrators identify underutilized products or users that might need additional training or information." ---doc_type: conceptualPageType ---# Microsoft 365 active users reports --Namespace: microsoft.graph ---You can use the Microsoft 365 active users report to find out how many product licenses are being used by individuals in your organization, and drill down for information about which users are using what products. This report can help administrators identify underutilized products or users that might need additional training or information. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Active Users](https://support.office.com/client/Active-Users-fc1cf1d0-cd84-43fd-adb7-a4c4dfa8112d). --## Reports -| Function | CSV return type | JSON return type | Description | -| : | :-- | : | - | -| [Get user detail](../api/reportroot-getoffice365activeuserdetail.md) | Stream | [office365ActiveUserDetail](../resources/office365activeuserdetail.md) | Get details about Microsoft 365 active users. | -| [Get user counts](../api/reportroot-getoffice365activeusercounts.md) | Stream | [office365ActiveUserCounts](../resources/office365activeusercounts.md) | Get the count of daily active users in the reporting period by product. | -| [Get services user counts](../api/reportroot-getoffice365servicesusercounts.md) | Stream | [office365ServicesUserCounts](../resources/office365servicesusercounts.md) | Get the count of users by activity type and service. | -- |
v1.0 | Office 365 Groups Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/office-365-groups-activity-reports.md | - Title: "Microsoft 365 groups activity reports" -description: "You can gain insights into the activity of Microsoft 365 groups in your organization and see how many Microsoft 365 groups are being created and used." ---doc_type: conceptualPageType ---# Microsoft 365 groups activity reports --Namespace: microsoft.graph ---You can gain insights into the activity of Microsoft 365 groups in your organization and see how many Microsoft 365 groups are being created and used. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Microsoft 365 groups](https://support.office.com/client/Office-365-groups-a27f1a99-3557-4f85-9560-a28e3d822a40). --## Reports --| Function | CSV return type | JSON return type | Description | -| : | :-- | : | - | -| [Get group detail](../api/reportroot-getoffice365groupsactivitydetail.md) | Stream | [office365GroupsActivityDetail](../resources/office365groupsactivitydetail.md) | Get details about Microsoft 365 groups activity by group. | -| [Get activity counts](../api/reportroot-getoffice365groupsactivitycounts.md) | Stream | [office365GroupsActivityCounts](../resources/office365groupsactivitycounts.md) | Get the number of group activities across group workloads. | -| [Get group counts](../api/reportroot-getoffice365groupsactivitygroupcounts.md) | Stream | [office365GroupsActivityGroupCounts](../resources/office365groupsactivitygroupcounts.md) | Get the daily total number of groups and how many of them were active based on email conversations, Yammer posts, and SharePoint file activities. | -| [Get storage](../api/reportroot-getoffice365groupsactivitystorage.md) | Stream | [office365GroupsActivityStorage](../resources/office365groupsactivitystorage.md) | Get the total storage used across all group mailboxes and group sites. | -| [Get file counts](../api/reportroot-getoffice365groupsactivityfilecounts.md) | Stream | [office365GroupsActivityFileCounts](../resources/office365groupsactivityfilecounts.md) | Get the total number of files and how many of them were active across all group sites associated with a Microsoft 365 group. | -- |
v1.0 | Office365activeuserdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/office365activeuserdetail.md | Title: "office365ActiveUserDetail resource type" -description: "Here's a JSON representation of the resource." +description: "The following JSON representation shows the resource type." ms.localizationpriority: medium Namespace: microsoft.graph ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Office365groupsactivitydetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/office365groupsactivitydetail.md | Title: "office365GroupsActivityDetail resource type" -description: "Here's a JSON representation of the resource." +description: "The following JSON representation shows the resource type." ms.localizationpriority: medium Namespace: microsoft.graph ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Office365groupsactivityfilecounts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/office365groupsactivityfilecounts.md | Title: "office365GroupsActivityFileCounts resource type" -description: "Here's a JSON representation of the resource." +description: "The following JSON representation shows the resource type." ms.localizationpriority: medium Namespace: microsoft.graph ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { |
v1.0 | Office365groupsactivitygroupcounts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/office365groupsactivitygroupcounts.md | Title: "office365GroupsActivityGroupCounts resource type" -description: "Here's a JSON representation of the resource." +description: "The following JSON representation shows the resource type." ms.localizationpriority: medium Namespace: microsoft.graph ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Officegraphinsights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/officegraphinsights.md | Each insight is returned with a **resourceVisualization** and **resourceReferenc ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty":"id", |
v1.0 | Onattributecollectionlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onattributecollectionlistener.md | Used for configuring the collection of attributes during user sign-up as defined Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ## Methods-|Method|Return type|Description| -|:|:|:| -|[List authenticationEventListeners](../api/identitycontainer-list-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md) collection|Retrieve a list of the following object types derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Create authenticationEventListener](../api/identitycontainer-post-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Create a new [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Get authenticationEventListener](../api/authenticationeventlistener-get.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Read the properties and relationships of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Update authenticationEventListener](../api/authenticationeventlistener-update.md)|None|Update the properties of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Delete authenticationEventListener](../api/authenticationeventlistener-delete.md)|None|Delete an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| +None. ++For the list of API operations for managing this resource type, see the [authenticationEventListener](../resources/authenticationeventlistener.md) resource type. ## Properties |
v1.0 | Onattributecollectionstartcustomextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onattributecollectionstartcustomextension.md | Title: "onAttributeCollectionStartCustomExtension resource type" description: "Used for creating a new custom extension based on the onAttributeCollectionStart event."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Onattributecollectionstartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onattributecollectionstartlistener.md | Title: "onAttributeCollectionStartListener resource type" description: "A listener for the start of the user attribute collection stage of a sign up flow represented by an externalUsersSelfServiceSignUpEventsFlow object."-+ ms.localizationpriority: medium doc_type: resourcePageType A listener for the start of the user attribute collection stage of a sign up flo Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ## Methods-|Method|Return type|Description| -|:|:|:| -|[List authenticationEventListeners](../api/identitycontainer-list-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md) collection|Retrieve a list of the following object types derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Create authenticationEventListener](../api/identitycontainer-post-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Create a new [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Get authenticationEventListener](../api/authenticationeventlistener-get.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Read the properties and relationships of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Update authenticationEventListener](../api/authenticationeventlistener-update.md)|None|Update the properties of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Delete authenticationEventListener](../api/authenticationeventlistener-delete.md)|None|Delete an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| +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 | Onattributecollectionsubmitlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onattributecollectionsubmitlistener.md | A listener for the end of the user attribution collection stage of a sign up flo Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ## Methods-|Method|Return type|Description| -|:|:|:| -|[List authenticationEventListeners](../api/identitycontainer-list-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md) collection|Retrieve a list of the following object types derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Create authenticationEventListener](../api/identitycontainer-post-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Create a new [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Get authenticationEventListener](../api/authenticationeventlistener-get.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Read the properties and relationships of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Update authenticationEventListener](../api/authenticationeventlistener-update.md)|None|Update the properties of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Delete authenticationEventListener](../api/authenticationeventlistener-delete.md)|None|Delete an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| +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/beta/resources/onauthenticationmethodloadstartlistener.md | Used for configuring what authentication methods are enabled for the authenticat Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ## Methods-|Method|Return type|Description| -|:|:|:| -|[List authenticationEventListeners](../api/identitycontainer-list-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md) collection|Retrieve a list of the following object types derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Create authenticationEventListener](../api/identitycontainer-post-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Create a new [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Get authenticationEventListener](../api/authenticationeventlistener-get.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Read the properties and relationships of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Update authenticationEventListener](../api/authenticationeventlistener-update.md)|None|Update the properties of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Delete authenticationEventListener](../api/authenticationeventlistener-delete.md)|None|Delete an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| +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 | Onedrive Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onedrive-activity-reports.md | - Title: "OneDrive activity reports" -description: "You can get the activity of every user licensed to use OneDrive by looking at their interaction with files on OneDrive. It also helps you to understand the level of collaboration going on by showing the number of files shared." ---doc_type: conceptualPageType ---# OneDrive activity reports --Namespace: microsoft.graph ---You can get the activity of every user licensed to use OneDrive by looking at their interaction with files on OneDrive. It also helps you to understand the level of collaboration going on by showing the number of files shared. --> **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). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get user detail](../api/reportroot-getonedriveactivityuserdetail.md) | Stream | Stream | Get details about OneDrive activity by user. | -| [Get user counts](../api/reportroot-getonedriveactivityusercounts.md) | Stream | Stream | Get the trend in the number of active OneDrive users. | -| [Get file counts](../api/reportroot-getonedriveactivityfilecounts.md) | Stream | Stream | Get the number of unique, licensed users that performed file interactions against any OneDrive account. | -- |
v1.0 | Onedrive Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onedrive-usage-reports.md | - Title: "OneDrive usage reports" -description: "You can get a high-level view of the value you are getting from OneDrive in terms of the total number of files and storage used across all the OneDrive accounts in your organization. You can then drill down to understand the trends of active OneDrive accounts, how many files users have interacted with, and how much storage is used. It also gives you the per OneDrive account details." ---doc_type: conceptualPageType ---# OneDrive usage reports --Namespace: microsoft.graph ---You can get a high-level view of the value you are getting from OneDrive in terms of the total number of files and storage used across all the OneDrive accounts in your organization. You can then drill down to understand the trends of active OneDrive accounts, how many files users have interacted with, and how much storage is used. It also gives you the per OneDrive account details. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - OneDrive for Business usage](https://support.office.com/client/OneDrive-for-Business-usage-0de3b312-c4e8-4e4b-a02d-32b2f726a680). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | - | | -| [Get account detail](../api/reportroot-getonedriveusageaccountdetail.md) | Stream | Stream | Get details about OneDrive usage by account. | -| [Get account counts](../api/reportroot-getonedriveusageaccountcounts.md) | Stream | 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 | 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 | Stream | Get the trend on the amount of storage you are using in OneDrive for Business. | -- |
v1.0 | Onenoteidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onenoteidentity.md | In future, this type is merged with [identity](identity.md) ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onenoteidentityset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onenoteidentityset.md | In future, this type will be merged with [IdentitySet](identityset.md) ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onenoteoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onenoteoperation.md | The status of certain long-running OneNote operations. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onenoteoperationerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onenoteoperationerror.md | An error from a failed OneNote operation. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onenotepage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onenotepage.md | A page in a OneNote notebook. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onenoteresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onenoteresource.md | An `object` tag (which represents files such as PDF, DOCX, and PNG) includes the ## Properties | Property | Type |Description| |:|:--|:-|-| content | Edm.Stream|| -| contentUrl | String || +| content | Edm.Stream|The content of the resource.| +| contentUrl | String |The URL for the content stream.| ## Relationships None. |
v1.0 | Onenotesection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onenotesection.md | A section in a OneNote notebook. Sections can contain pages. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Oninteractiveauthflowstartexternalusersselfservicesignup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/oninteractiveauthflowstartexternalusersselfservicesignup.md | Inherits from [onInteractiveAuthFlowStartHandler](../resources/oninteractiveauth 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.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp" |
v1.0 | Oninteractiveauthflowstartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/oninteractiveauthflowstartlistener.md | Used for configuring whether the authentication flow allows for sign up as defin Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ## Methods-|Method|Return type|Description| -|:|:|:| -|[List authenticationEventListeners](../api/identitycontainer-list-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md) collection|Retrieve a list of the following object types derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Create authenticationEventListener](../api/identitycontainer-post-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Create a new [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Get authenticationEventListener](../api/authenticationeventlistener-get.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Read the properties and relationships of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Update authenticationEventListener](../api/authenticationeventlistener-update.md)|None|Update the properties of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Delete authenticationEventListener](../api/authenticationeventlistener-delete.md)|None|Delete an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| +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 | Onlinemeeting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onlinemeeting.md | Inherits 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. |-| registration | [meetingRegistration](meetingregistration.md) | The registration that is enabled for an online meeting. One online meeting can only have one registration enabled.| | 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. |+| registration (deprecated) | [meetingRegistration](meetingregistration.md) | The registration that is enabled for an online meeting. One online meeting can only have one registration enabled.| > [!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 type of **registration** can be [meetingRegistration](meetingregistration.md) or [externalMeetingRegistration](externalmeetingregistration.md), both of which inherit from [meetingRegistrationBase](meetingregistrationbase.md). +>- The type of **registration** can only be [externalMeetingRegistration](externalmeetingregistration.md), which inherits from [meetingRegistrationBase](meetingregistrationbase.md). The type [meetingRegistration](meetingregistration.md) is deprecated and will stop returning data on July 31, 2024. ## JSON representation The following JSON representation shows the resource type. "watermarkProtection": {"@odata.type": "microsoft.graph.watermarkProtectionValues"} } ```++<!-- +{ + "type": "#page.annotation", + "description": "Update checklistItem", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: microsoft.graph.microsoft.graph/me: + /me/onlineMeetings/{var}/registration/microsoft.graph.meetingRegistration/customQuestions + Uri path requires navigating into unknown object hierarchy: missing property 'registration' on 'onlineMeeting'. Possible issues: + 1) Doc bug where 'registration' isn't defined on the resource. + 2) Doc bug where 'registration' 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 'onlineMeeting' 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 | Onlinemeetingbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onlinemeetingbase.md | Inherits from [entity](../resources/entity.md). | joinWebUrl | String | The join URL of the online meeting. Read-only. | | 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`.| | 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. | The following JSON representation shows the resource type. "lobbyBypassSettings": {"@odata.type": "microsoft.graph.lobbyBypassSettings"}, "recordAutomatically": "Boolean", "shareMeetingChatHistoryDefault": "microsoft.graph.meetingChatHistoryDefaultMode",- "startDateTime": "String (timestamp)", "subject": "String", "videoTeleconferenceId": "String", "watermarkProtection": {"@odata.type": "microsoft.graph.watermarkProtectionValues"} |
v1.0 | Onlinemeetinginfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onlinemeetinginfo.md | Details for an attendee to join the meeting online. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onpremisesagent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisesagent.md | Represents on-premises agent. On-premises agents installed by a tenant administr |id|String| The object id of the onPremisesAgent. Read-only.| |machineName|String|The name of the machine that the agent is running on. Read-only| |status|agentStatus| Possible values are: `active`, `inactive`.|-|publishingType|String| Possible values are: `applicationProxy`, `exchangeOnline`, `authentication`, `provisioning`, `adAdministration`.| +|supportedPublishingTypes|String collection| Possible values are: `applicationProxy`, `exchangeOnline`, `authentication`, `provisioning`, `adAdministration`.| ## Relationships Represents on-premises agent. On-premises agents installed by a tenant administr ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onpremisescurrentexportdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisescurrentexportdata.md | 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.onPremisesCurrentExportData" |
v1.0 | Onpremisesdirectorysynchronization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisesdirectorysynchronization.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Onpremisesextensionattributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisesextensionattributes.md | Title: "onPremisesExtensionAttributes resource type" description: "The **onPremisesExtensionAttributes** property of the user entity contains fifteen custom extension attribute properties." ms.localizationpriority: medium doc_type: resourcePageType+ |
v1.0 | Onpremisesprovisioningerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisesprovisioningerror.md | Represents directory synchronization errors for the [user](user.md), [group](gro |value|String| Value of the property causing the error. | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onpremisespublishing | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisespublishing.md | For a tutorial about configuring Application Proxy, see [Automate the configurat ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. "externalAuthenticationType": "String", "externalUrl": "String", "internalUrl": "String",- "isBackendCertificationValidationEnabled": true, + "isBackendCertificateValidationEnabled": true, "isHttpOnlyCookieEnabled": true, "isOnPremPublishingEnabled": true, "isPersistentCookieEnabled": true, |
v1.0 | Onpremisespublishingprofile Root | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisespublishingprofile-root.md | Title: "On-premises publishing profiles" description: "Various Azure services (for example, Microsoft Entra Connect Passthrough Authentication, Workday to Microsoft Entra users provisioning) allow a conditional access to various on-premises resources from outside the corporate network." ms.localizationpriority: medium -doc_type: "resourcePageType" Last updated 01/20/2022 # On-premises publishing profiles -Namespace: microsoft.graph - [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Various Azure services (for example, Microsoft Entra Connect [Passthrough Authentication](/azure/active-directory/hybrid/how-to-connect-pta), [Workday to Microsoft Entra users provisioning](/azure/active-directory/saas-apps/workday-inbound-tutorial), and [Application Proxy](/azure/active-directory/app-proxy/what-is-application-proxy) allow access to various on-premises resources from outside the corporate network. [On-premises agents](onpremisesagent.md) (or [connectors](connector.md) for Application Proxy) installed by a tenant administrator can be configured to route requests to a particular [published resource](publishedresource.md). +Various Azure services (for example, Microsoft Entra Connect [Passthrough Authentication](/azure/active-directory/hybrid/how-to-connect-pta), [Workday to Microsoft Entra users provisioning](/azure/active-directory/saas-apps/workday-inbound-tutorial), and [Application Proxy](/azure/active-directory/app-proxy/what-is-application-proxy)) allow access to various on-premises resources from outside the corporate network. [On-premises agents](onpremisesagent.md) (or [connectors](connector.md) for Application Proxy) installed by a tenant administrator can be configured to route requests to a particular [published resource](publishedresource.md). [Agent groups](onpremisesagentgroup.md) (or [connector groups](connectorgroup.md) for Application Proxy) enable a tenant admin to assign specific agents to serve specific published on-premises resources. Tenant admins can group a number of agents together, and then assign each published resource to a group. The entire set of entities of the same on-premises publishing type is represented by [onPremisesPublishingProfile](onpremisespublishingprofile.md). A tenant admin can configure for each **onPremisesPublishingProfile** the [time window](updatewindow.md) during which agents can receive updates or defer updates to the agents. The [updater configuration](hybridagentupdaterconfiguration.md) specified for an **onPremisesPublishingProfile** is applicable to all the agents within that **onPremisesPublishingProfile**. |
v1.0 | Onpremisespublishingprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisespublishingprofile.md | Various Azure services (for example, Microsoft Entra Connect [Passthrough Authen |:-|:|:| |hybridAgentUpdaterConfiguration|[hybridAgentUpdaterConfiguration](hybridagentupdaterconfiguration.md)| Represents a **hybridAgentUpdaterConfiguration** object.| |id|String| Represents a publishing type. Possible values are: `applicationProxy`, `exchangeOnline`, `authentication`, `provisioning`, `adAdministration`. Read-only.|-|isEnabled|Boolean| Represents if [Microsoft Entra application proxy](/azure/active-directory/app-proxy/what-is-application-proxy) is enabled for the tenant. | +|isEnabled|Boolean| Represents if [Microsoft Entra application proxy](/entra/identity/app-proxy/) is enabled for the tenant. | ## Relationships |
v1.0 | Onpremisessipinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisessipinfo.md | Title: "onPremisesSipInfo resource type" description: "onPremisesSipInfo resource type" ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Ontokenissuancestartcustomextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ontokenissuancestartcustomextension.md | Custom extension to invoke when handling the event when a token is about to be i Inherits from [customAuthenticationExtension](../resources/customauthenticationextension.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [customAuthenticationExtension](../resources/customauthenticationextension.md) resource type. ## Properties |Property|Type|Description| |
v1.0 | Ontokenissuancestartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ontokenissuancestartlistener.md | A listener for when a token is about to be issued to your application. Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ## Methods-|Method|Return type|Description| -|:|:|:| -|[List authenticationEventListeners](../api/identitycontainer-list-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md) collection|Retrieve a list of the following object types derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Create authenticationEventListener](../api/identitycontainer-post-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Create a new [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Get authenticationEventListener](../api/authenticationeventlistener-get.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Read the properties and relationships of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Update authenticationEventListener](../api/authenticationeventlistener-update.md)|None|Update the properties of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Delete authenticationEventListener](../api/authenticationeventlistener-delete.md)|None|Delete an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| +None. ++For the list of API operations for managing this resource type, see the [authenticationEventListener](../resources/authenticationeventlistener.md) resource type. ## Properties |Property|Type|Description| The following JSON representation shows the resource type. "conditions": { "@odata.type": "microsoft.graph.authenticationConditions" },- "tags": [ - { - "@odata.type": "microsoft.graph.keyValuePair" - } - ], "authenticationEventsFlowId": "String", "handler": { "@odata.type": "microsoft.graph.onTokenIssuanceStartHandler" |
v1.0 | Onusercreatestartexternalusersselfservicesignup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onusercreatestartexternalusersselfservicesignup.md | Inherits from [onUserCreateStartHandler](../resources/onusercreatestarthandler.m 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.onUserCreateStartExternalUsersSelfServiceSignUp" |
v1.0 | Onusercreatestartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onusercreatestartlistener.md | Used for configuring actions done during user creation as defined in the **onUse Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ## Methods-|Method|Return type|Description| -|:|:|:| -|[List authenticationEventListeners](../api/identitycontainer-list-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md) collection|Retrieve a list of the following object types derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Create authenticationEventListener](../api/identitycontainer-post-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Create a new [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Get authenticationEventListener](../api/authenticationeventlistener-get.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Read the properties and relationships of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Update authenticationEventListener](../api/authenticationeventlistener-update.md)|None|Update the properties of an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| -|[Delete authenticationEventListener](../api/authenticationeventlistener-delete.md)|None|Delete an [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) object type. The type can be one of the following subtypes derived from authenticationEventListener: <br/> <li>[onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.md) <li>[onInteractiveAuthFlowStartListener](../resources/oninteractiveauthflowstartlistener.md) <li>[onAuthenticationMethodLoadStartListener](../resources/onauthenticationmethodloadstartlistener.md) <li>[onAttributeCollectionListener](../resources/onattributecollectionlistener.md)<li>[onUserCreateStartListener](../resources/onusercreatestartlistener.md)<li>[onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)<li>[onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)| +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 | Openawssecuritygroupfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/openawssecuritygroupfinding.md | description: "View AWS open security groups." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Openidconnectidentityprovider | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/openidconnectidentityprovider.md | Inherits from [identityProviderBase](../resources/identityproviderbase.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Openidconnectprovider | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/openidconnectprovider.md | Inherits from [identityProvider](../resources/identityprovider.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Openidconnectsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/openidconnectsetting.md | + + Title: "openIdConnectSetting resource type" +description: "Specifies the OpenID connection properties used for an external authentication method." ++ms.localizationpriority: medium ++++# openIdConnectSetting resource type ++Namespace: microsoft.graph +++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. ++## Properties +|Property|Type|Description| +|:|:|:| +|clientId|String|The Microsoft Entra ID's client ID as generated by the provider or admin to identify Microsoft Entra ID. In OIDC parlance, this is the client_id that external identity provider assigns to Microsoft Entra ID, which is also a recipient of a token from the external identity provider.| +|discoveryUrl|String|The host URL of the external identity provider's OIDC discovery endpoint. This endpoint must support the OIDC discovery process.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.openIdConnectSetting" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.openIdConnectSetting", + "clientId": "String", + "discoveryUrl": "String" +} +``` + |
v1.0 | Opennetworkazuresecuritygroupfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/opennetworkazuresecuritygroupfinding.md | description: "View Azure open security groups." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Opentypeextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/opentypeextension.md | description: "Open extensions (formerly known as Office 365 data extensions) pro ms.localizationpriority: medium doc_type: resourcePageType+ # openTypeExtension resource type (open extensions) Namespace: microsoft.graph Represents open extensions (also known as open type extensions, and formerly known as Office 365 data extensions), an [extensibility option](/graph/extensibility-overview) that provides an easy way to directly add untyped properties to a resource in Microsoft Graph. -Any open extension added to a resource shows up in the **extensions** navigation property. Each extension has an **extensionName** property which is the only pre-defined, writable property for all extensions, along with your custom data. One way to help make sure extension names are unique is to use a reverse domain name system (DNS) format that is dependent on _your own domain_, for example, `com.contoso.ContactInfo`. **Do not use** the Microsoft domain (`com.microsoft` or `com.onmicrosoft`) in an extension name. +Any open extension added to a resource shows up in the **extensions** navigation property. Each extension has an **extensionName** property, which is the only predefined, writable property for all extensions, along with your custom data. One way to help make sure extension names are unique is to use a reverse domain name system (DNS) format that is dependent on _your own domain_, for example, `com.contoso.ContactInfo`. **Do not use** the Microsoft domain (`com.microsoft` or `com.onmicrosoft`) in an extension name. Derives from the [extension](extension.md) abstract type. -Open extensions are supported by the following resources. +The following resource support open extensions: + [user](/graph/api/resources/user) + [group](/graph/api/resources/group) For more information about Microsoft Graph extensibility including limits for op ### Outlook-specific considerations -Each open extension present on an Outlook resource (event, message, or personal contact) is stored in a [MAPI named property](/office/client-developer/outlook/mapi/mapi-named-properties). When you create open extensions for Outlook, consider that MAPI named properties are a finite resource in a user's mailbox. When a user's named property quota is exhausted, you can't create any more named properties for that user. This can result in unexpected behavior from clients that rely on named properties to function. +Each open extension on an Outlook resource (event, message, or personal contact) is stored in a [MAPI named property](/office/client-developer/outlook/mapi/mapi-named-properties). When you create open extensions for Outlook, consider that MAPI named properties are a finite resource in a user's mailbox. When a user's named property quota is exhausted, you can't create anymore named properties for that user. This can result in unexpected behavior from clients that rely on named properties to function. Apply the following guidelines when you create open extensions on Outlook resources: -- Create the minimum number of extensions required. Most applications should require no more than one extension. Extensions have no set defined properties or structure, so you can store multiple values in a single extension.-- Avoid naming extensions in a variable manner (such as based on user input, etc.). Each time an open extension is created with a new name that has not been used in a user's mailbox before, a new MAPI named property is created. Removing the extension does not remove the named property.+- Create the minimum number of extensions required. Most applications should require no more than one extension. Extensions have no defined properties or structure, so you can store multiple values in a single extension. +- Avoid naming extensions in a variable manner (such as based on user input, etc.). Each time an open extension is created with a new name that hasn't been used in a user's mailbox before, a new MAPI named property is created. Removing the extension doesn't remove the named property. ### Use open extensions (for Outlook resources) or extended properties -Open extensions are the recommended solution for most scenarios involving storing and accessing custom data. If, however, you need to access custom data for Outlook MAPI properties that are not already exposed through the [Microsoft Graph API metadata](/graph/traverse-the-graph#microsoft-graph-api-metadata), you can use [extended properties and its REST API](extended-properties-overview.md). You can verify which properties the metadata +Open extensions are the recommended solution for most scenarios involving storing and accessing custom data. If, however, you need to access custom data for Outlook MAPI properties that aren't already exposed through the [Microsoft Graph API metadata](/graph/traverse-the-graph#microsoft-graph-api-metadata), you can use [extended properties and its REST API](extended-properties-overview.md). You can verify which properties the metadata exposes at https://graph.microsoft.com/v1.0/$metadata. ## Methods exposes at https://graph.microsoft.com/v1.0/$metadata. | Property | Type | Description | |:|:--|:-| |extensionName|String|A unique text identifier for an open type data extension. Required.|-|id|String| A fully qualified identifier that concatenates the extension type with the **extensionName**. Read-only. <br/><br/> The **id** must be defined during the Create operation via one of the following ways: <ul><li> Explicitly define the **id** property in the request body. <li> Define an **extensionName** property in the request body, and Microsoft Graph automatically assigns the same value to the **id** property. <ul><li> In subsequent updates, you can change the **extensionName** property value to one that's different from the **id** value. <li>In subsequent updates, specifying only the **id** property in the request body automatically deletes the **extensionName** property from the open extension.</ul></ul>| +|id|String| A fully qualified identifier that concatenates the extension type with the **extensionName**. Read-only. <br/><br/> The **id** must be defined during the *Create* operation via one of the following ways: <ul><li> Explicitly define the **id** property in the request body. <li> Define an **extensionName** property in the request body, and Microsoft Graph automatically assigns the same value to the **id** property. <ul><li> In subsequent updates, you can change the **extensionName** property value to one that's different from the **id** value. <li>In subsequent updates, specifying only the **id** property in the request body automatically deletes the **extensionName** property from the open extension.</ul></ul>| ## Relationships None ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Optionalclaims | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/optionalclaims.md | Application developers can configure optional claims in their Microsoft Entra ap |saml2Token|[optionalClaim](optionalclaim.md) collection| The optional claims returned in the SAML token.| ## JSON Representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", "@odata.type": "microsoft.graph.optionalClaims" |
v1.0 | Organization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/organization.md | The following JSON representation shows the resource type. "assignedPlans": [{"@odata.type": "microsoft.graph.assignedPlan"}], "businessPhones": ["String"], "city": "String",- "companyLastDirSyncTime": "2019-02-07T20:33:52.942Z", "country": "String", "countryLetterCode": "String", "createdDateTime": "String (timestamp)", "defaultUsageLocation": "String", "deletedDateTime": "String (timestamp)", "directorySizeQuota": {"@odata.type": "microsoft.graph.directorySizeQuota"},- "dirSyncEnabled": true, "displayName": "String", "id": "String (identifier)", "isMultipleDataLocationsForServicesEnabled": "Boolean", |
v1.0 | Organizationsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/organizationsettings.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Contains settings that are applicable to the [organization](organization.md) or that should be applied to [user](user.md) objects within an organization. Inherits from [entity](entity.md). Inherits from [entity](entity.md). | Method | Return Type | Description | |:-|:|:| | [List contactInsights](../api/organizationsettings-list-contactinsights.md) | [insightsSettings](insightssettings.md) | Get the properties of an [insightsSettings](insightssettings.md) object for displaying or returning insights for the contacts of users in an organization. |-| [List itemInsights](../api/organizationsettings-list-iteminsights.md) | [insightsSettings](insightssettings.md) | Get the properties of an [insightsSettings](insightssettings.md) object for displaying or returning item insights in an organization. | | [List microsoftApplicationDataAccessSettings](../api/organizationsettings-list-microsoftapplicationdataaccess.md) | [microsoftApplicationDataAccessSettings](microsoftapplicationdataaccesssettings.md) | Get the properties of a [microsoftApplicationDataAccessSettings](microsoftapplicationdataaccesssettings.md) object that specify access from Microsoft applications to Microsoft 365 user data in an organization. | | [List peopleInsights](../api/organizationsettings-list-peopleinsights.md) | [insightsSettings](insightssettings.md) | Get the properties of an [insightsSettings](insightssettings.md) object for displaying or returning people insights in an organization. |+| [List itemInsights](../api/organizationsettings-list-iteminsights.md) (deprecated) | [insightsSettings](insightssettings.md) | Get the properties of an [insightsSettings](insightssettings.md) object for displaying or returning item insights in an organization. | ## Properties Inherits from [entity](entity.md). |:-|:|:| |id |String| Id of the settings object for the organization. | |contactInsights|[insightsSettings](insightssettings.md)|Contains the properties that are configured by an administrator as a tenant-level privacy control whether to identify duplicate contacts among a user's contacts list and suggest the user to merge those contacts to have a cleaner contacts list. [List contactInsights](../api/organizationsettings-list-contactinsights.md) returns the _settings_ to display or return contact insights in an organization.|-|itemInsights|[insightsSettings](insightssettings.md)| Contains the properties that are configured by an administrator for the visibility of Microsoft Graph-derived insights, between a user and other items in Microsoft 365, such as documents or sites. [List itemInsights](../api/organizationsettings-list-iteminsights.md) returns the _settings_ to display or return item insights in an organization.| |microsoftApplicationDataAccessSettings|[microsoftApplicationDataAccessSettings](../resources/microsoftapplicationdataaccesssettings.md)| Contains the properties that are configured by an administrator to specify access from Microsoft applications to Microsoft 365 data belonging to users in an organization. [List microsoftApplicationDataAccessSettings](../api/organizationsettings-list-microsoftapplicationdataaccess.md) returns the _settings_ that specify the access. | |peopleInsights|[insightsSettings](insightssettings.md)| Contains the properties that are configured by an administrator for the visibility of a list of people [relevant and working with](/graph/people-insights-overview#including-a-person-as-relevant-or-working-with) a user in Microsoft 365. [List peopleInsights](../api/organizationsettings-list-peopleinsights.md) returns the _settings_ to display or return people insights in an organization.|+|itemInsights|[insightsSettings](insightssettings.md) (deprecated)| Contains the properties that are configured by an administrator for the visibility of Microsoft Graph-derived insights, between a user and other items in Microsoft 365, such as documents or sites. [List itemInsights](../api/organizationsettings-list-iteminsights.md) returns the _settings_ to display or return item insights in an organization.| ## JSON representation |
v1.0 | Orgcontact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/orgcontact.md | Title: "orgContact resource type" -description: "Here is a JSON representation of the resource" +description: "The following JSON representation shows the resource type." ms.localizationpriority: medium This resource supports using [delta query](/graph/delta-query-overview) to track ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Outboundshareduserprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outboundshareduserprofile.md | Title: "outboundSharedUserProfile resource type" -description: "Represents a Microsoft Entra user that has shared their profile data with an external Microsoft Entra tenant using B2B direct connect." -+description: "Represents a Microsoft Entra user that shared their profile data with an external Microsoft Entra tenant using B2B direct connect." ++ ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a Microsoft Entra user that has shared their profile data with an external Microsoft Entra tenant using B2B direct connect. +Represents a Microsoft Entra user that shared their profile data with an external Microsoft Entra tenant using B2B direct connect. ## Methods Represents a Microsoft Entra user that has shared their profile data with an ext |:|:|:| |[List outboundSharedUserProfiles](../api/directory-list-outboundshareduserprofiles.md)|[outboundSharedUserProfile](../resources/outboundshareduserprofile.md) collection|Retrieve all outboundSharedUserProfiles in the directory.| |[Get outboundSharedUserProfile](../api/outboundshareduserprofile-get.md)|[outboundSharedUserProfile](../resources/outboundshareduserprofile.md) collection|Retrieve a specific outboundSharedUserProfile from the directory.|-|[List tenantReferences](../api/outboundshareduserprofile-list-tenants.md)|[tenantReferences](../resources/tenantreference.md) collection| Get all Microsoft Entra tenants that a user has shared their data with as a Microsoft Entra B2B direct connect user.| +|[List tenantReferences](../api/outboundshareduserprofile-list-tenants.md)|[tenantReferences](../resources/tenantreference.md) collection| Get all Microsoft Entra tenants that a user shared their data with as a Microsoft Entra B2B direct connect user.| |[Remove personal data](../api/tenantreference-removepersonaldata.md)|None| Create a request to remove all personal data associated with a remote user in an external Microsoft Entra tenant.| ## Properties Represents a Microsoft Entra user that has shared their profile data with an ext |Property|Type|Description| |:|:|:|-| tenants | [tenantReference](../resources/tenantreference.md) collection | The collection of external Microsoft Entra tenants that the user has shared profile data with. Read-only. | +| tenants | [tenantReference](../resources/tenantreference.md) collection | The collection of external Microsoft Entra tenants that the user shared profile data with. Read-only. | None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "userId", |
v1.0 | Outlookgeocoordinates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outlookgeocoordinates.md | The geographic coordinates, elevation, and their degree of accuracy for a physic ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Outlookitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outlookitem.md | Title: "outlookItem resource type" -description: "Here's a JSON representation of the resource" +description: "The following JSON representation shows the resource type." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +## Properties +| Property | Type |Description| +|:|:--|:-| +|categories|String collection|The categories associated with the item.| +|changeKey|String|Identifies the version of the item. Every time the item is changed, **changeKey** changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.| +|createdDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| +|id|String| Read-only.| +|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`| ++## Relationships +None. ++ ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource } ```-## Properties -| Property | Type |Description| -|:|:--|:-| -|categories|String collection|| -|changeKey|String|| -|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`| -|id|String| Read-only.| -|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`| --## Relationships -None -- <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!-- |
v1.0 | Outlooktask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outlooktask.md | Prefer: outlook.timezone="Eastern Standard Time" |singleValueExtendedProperties|[singleValueLegacyExtendedProperty](singlevaluelegacyextendedproperty.md) collection|The collection of single-value extended properties defined for the task. Read-only. Nullable.| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Outlooktaskfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outlooktaskfolder.md | You cannot rename or delete these default task group and folder, but you can cre |tasks|[outlookTask](outlooktask.md) collection|The tasks in this task folder. Read-only. Nullable.| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Outlooktaskgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outlooktaskgroup.md | In Outlook, there's a default task group `My Tasks` which you can't rename or de |taskFolders|[outlookTaskFolder](outlooktaskfolder.md) collection| The collection of task folders in the task group. Read-only. Nullable.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Outlookuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outlookuser.md | None ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Overprovisionedawsresourcefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/overprovisionedawsresourcefinding.md | description: "Represents over-provisioned AWS resources." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Overprovisionedawsrolefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/overprovisionedawsrolefinding.md | description: "Represents over-provisioned AWS roles." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Overprovisionedazureserviceprincipalfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/overprovisionedazureserviceprincipalfinding.md | description: "Represents over-provisioned Azure service prinicipals." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Overprovisionedgcpserviceaccountfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/overprovisionedgcpserviceaccountfinding.md | description: "Represents over-provisioned GCP service accounts." ms.localizationpriority: medium-doc_type: apiPageType + # overprovisionedGcpServiceAccountFinding resource type |
v1.0 | Overprovisionedserverlessfunctionfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/overprovisionedserverlessfunctionfinding.md | description: "Represents over-provisioned serverless functions in AWS, Azure, or ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Overprovisioneduserfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/overprovisioneduserfinding.md | description: "Represents over-provisioned users in AWS, Azure, or GCP." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Package | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/package.md | DriveItems with the **package** facet do not include a **folder** or **file** fa } ``` +## Properties + | Property Name | Type | Description | |:--|:-|:| | **type** | string | An string indicating the type of package. While `oneNote` is the only currently defined value, you should expect other package types to be returned and handle them accordingly. | |
v1.0 | Pagelinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/pagelinks.md | Links for opening a OneNote page. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Parentalcontrolsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/parentalcontrolsettings.md | Specifies parental control settings for an application. These settings control t |legalAgeGroupRule| String | Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: <table><tr><th>Value</th><th>Description</th></tr><tr><td>Allow</td><td>Default. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.</td></tr><tr><td>RequireConsentForPrivacyServices</td><td>Enforces the user to specify date of birth to comply with COPPA rules. </td></tr><tr><td>RequireConsentForMinors</td><td>Requires parental consent for ages below 18, regardless of country minor rules.</td></tr><tr><td>RequireConsentForKids</td><td>Requires parental consent for ages below 14, regardless of country minor rules.</td></tr><tr><td>BlockMinors</td><td>Blocks minors from using the app.</td></tr></table> | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Participantinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/participantinfo.md | Contains additional properties about the participant identity ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Partner Security Activitylog | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-activitylog.md | + + Title: "activityLog resource type" +description: "Represents the activity undertaken by a partner and includes details of state transitions, who performed them, and when they occurred." ++ms.localizationpriority: medium ++++# activityLog resource type ++Namespace: microsoft.graph.partner.security +++Represents the activity undertaken by a partner and includes details of state transitions, who performed them, and when they occurred. ++## Properties +|Property|Type|Description| +|:|:|:| +|statusFrom|microsoft.graph.partner.security.securityAlertStatus|The status of the alert before the status update activity by the partner. The possible values are: `active`, `resolved`, `investigating`, `unknownFutureValue`.| +|statusTo|microsoft.graph.partner.security.securityAlertStatus|The status of the alert after the status update activity by the partner. The possible values are: `active`, `resolved`, `investigating`, `unknownFutureValue`.| +|updatedBy|String|The UPN of the partner user who did the status update activity. This attribute is set by the system.| +|updatedDateTime|DateTimeOffset|The date and time for the status update activity. This attribute is set by the system. 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 +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.partner.security.activityLog" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.activityLog", + "statusFrom": "String", + "statusTo": "String", + "updatedBy": "String", + "updatedDateTime": "String (timestamp)" +} +``` + |
v1.0 | Partner Security Additionaldatadictionary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-additionaldatadictionary.md | + + Title: "additionalDataDictionary resource type" +description: "Represents a bag of name-value pairs that contain additional details about an alert." ++ms.localizationpriority: medium ++++# additionalDataDictionary resource type ++Namespace: microsoft.graph.partner.security +++Represents a bag of name-value pairs that contain additional details about an alert. ++## Properties +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.partner.security.additionalDataDictionary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.additionalDataDictionary" +} +``` |
v1.0 | Partner Security Affectedresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-affectedresource.md | + + Title: "affectedResource resource type" +description: "Contains details of the resources that are affected by a security alert." ++ms.localizationpriority: medium ++++# affectedResource resource type ++Namespace: microsoft.graph.partner.security +++Contains details of the resources that are affected by a security alert. ++## Properties +|Property|Type|Description| +|:|:|:| +|resourceId|String|The resource path of the resource affected by the security alert.| +|resourceType|String|The type of resource.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.partner.security.affectedResource" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.affectedResource", + "resourceId": "String", + "resourceType": "String" +} +``` + |
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." ++ms.localizationpriority: medium ++++# partnerSecurity resource type ++Namespace: microsoft.graph.partner.security +++Represents the root for various types of partner security entities. ++Inherits from [entity](../resources/entity.md). ++## Methods ++None. ++## Properties ++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.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.partner.security.partnerSecurity", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.partnerSecurity" +} +``` + |
v1.0 | Partner Security Partnersecurityalert Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-partnersecurityalert-api-overview.md | + + Title: "Use the partner security alert API in Microsoft Graph (preview)" +description: "The partner security alert API can help CSP partners detect patterns of fraudulent activities and misuse in Azure resources of their customers." ++ms.localizationpriority: medium ++++# Use the partner security alert API in Microsoft Graph (preview) ++Namespace: microsoft.graph.partner.security +++As a partner in the Cloud Solution Provider (CSP) program, you're responsible for your customer's Azure consumption; therefore, it's important that you're aware of any anomalous usage in your customer's Azure subscriptions. Use Microsoft Graph [partner security alert](../resources/partner-security-partnersecurityalert.md) API to detect patterns of fraudulent activities and misuse in Azure resources to help reduce your exposure to online transaction risks. Mitigating and responding to the alerts within 24 hours can significantly minimize the financial loss that your customers might incur during the compromise. ++For information about how to contain a compromise on your customer's tenant or Azure subscriptions, see [What additional steps can you take to lower the risk of compromise](/partner-center/azure-fraud-notification#what-additional-steps-can-you-take-to-lower-the-risk-of-compromise). ++The partner security alert API is defined in the OData subnamespace `microsoft.graph.partners.security`. ++## Common use cases ++The following are requests for working with the partner security alert API in Microsoft Graph. ++| Use cases | REST operations | Try it in Graph Explorer | +|:|:--|:-| +|List partner security alerts| [List](../api/partner-security-partnersecurityalert-list-securityalerts.md) | [https://graph.microsoft.com/beta/security/partner/securityAlerts](https://developer.microsoft.com/graph/graph-explorer?request=security/partner/securityAlerts&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) | +|Get a partner security alert |[Get](../api/partner-security-partnersecurityalert-get.md)| [https://graph.microsoft.com/beta/security/partner/securityAlerts/{id}](https://developer.microsoft.com/graph/graph-explorer?request=security/partner/securityAlerts/{id}&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) | +|Update a partner security alert |[Update](../api/partner-security-partnersecurityalert-update.md)| [https://graph.microsoft.com/beta/security/partner/securityAlerts/{id}](https://developer.microsoft.com/graph/graph-explorer?request=security/partner/securityAlerts/{id}&method=PATCH&version=beta&GraphUrl=https://graph.microsoft.com) | ++## Next steps ++The partner security alert API in Microsoft Graph enables detection of fraudulent activities and misuse in Azure resources, which helps reduce your exposure to online transaction risks. Follow these steps to get started: ++- Drill down on the methods and properties of the [partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md) resource. +- Try the API in the [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). |
v1.0 | Partner Security Partnersecurityalert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-partnersecurityalert.md | + + Title: "partnerSecurityAlert resource type" +description: "Represents a security alert or a vulnerability of a CSP partner's customer that the partner must be made aware of for further action." ++ms.localizationpriority: medium ++++# partnerSecurityAlert resource type ++Namespace: microsoft.graph.partner.security +++Represents a security alert or a vulnerability of a CSP partner's customer that the partner must be made aware of for further action. ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/partner-security-partnersecurityalert-list-securityalerts.md)|[microsoft.graph.partner.security.partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md) collection|Get a list of the [partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md) objects and their properties.| +|[Get](../api/partner-security-partnersecurityalert-get.md)|[microsoft.graph.partner.security.partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md)|Read the properties and relationships of a [partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md) object.| +|[Update](../api/partner-security-partnersecurityalert-update.md)|[microsoft.graph.partner.security.partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md)|Update the properties of a [partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md) object.| +++## Properties +|Property|Type|Description| +|:|:|:| +|activityLogs|[microsoft.graph.partner.security.activityLog](../resources/partner-security-activitylog.md) collection|Represents the activity by a partner and includes details of state transitions, who performed them, and when they occurred.| +|additionalDetails|[microsoft.graph.partner.security.additionalDataDictionary](../resources/partner-security-additionaldatadictionary.md)|A bag of name-value pairs that contain more details about an alert.| +|affectedResources|[microsoft.graph.partner.security.affectedResource](../resources/partner-security-affectedresource.md) collection|Contains details of the resources affected by the security alert.| +|alertType|String|The type of vulnerability that impacts the customer due to this alert. For more information, see [Security alerts reference guide](/partner-center/security/security-alerts-reference-guide).| +|catalogOfferId|String|The modern offer category ID of the subscription.| +|confidenceLevel|microsoft.graph.partner.security.securityAlertConfidence|Specifies the confidence in the alert. The possible values are: `low`, `medium`, `high`, `unknownFutureValue`.| +|customerTenantId|String|The impacted customer tenant associated with the alert.| +|description|String|The description for each alert.| +|detectedDateTime|DateTimeOffset|Time when the alert was detected or 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`.| +|displayName|String|The display name of the alert.| +|firstObservedDateTime|DateTimeOffset|Time of the first activity associated with the alert. 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 to represent the alert. Inherited from [microsoft.graph.entity](../resources/entity.md).| +|isTest|Boolean|Indicates whether an alert is a test alert.| +|lastObservedDateTime|DateTimeOffset|Time of the latest activity associated with the alert. 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`.| +|resolvedBy|String|The UPN of the partner user who resolved the alert.| +|resolvedOnDateTime|DateTimeOffset|Time when the alert was resolved. 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`.| +|resolvedReason|microsoft.graph.partner.security.securityAlertResolvedReason|The reason provided by the partner for addressing the alert. The possible values are: `legitimate`, `ignore`, `fraud`, `unknownFutureValue`.| +|severity|microsoft.graph.partner.security.securityAlertSeverity|Indicates the possible impact on assets. The higher the severity the bigger the impact. Typically higher severity items require the most immediate attention. The possible values are: `informational`, `high`, `medium`, `low`, `unknownFutureValue`.| +|status|microsoft.graph.partner.security.securityAlertStatus|The status of the alert. The possible values are: `active`, `resolved`, `investigating`, `unknownFutureValue`.| +|subscriptionId|String|The subscription associated with the alert for the customer.| +|valueAddedResellerTenantId|String|The value-added reseller tenant associated with the partner tenant and customer tenant.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.partner.security.partnerSecurityAlert", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.partnerSecurityAlert", + "activityLogs": [{"@odata.type": "microsoft.graph.partner.security.activityLog"}], + "additionalDetails": {"@odata.type": "microsoft.graph.partner.security.additionalDataDictionary"}, + "affectedResources": [{"@odata.type": "microsoft.graph.partner.security.affectedResource"}], + "alertType": "String", + "catalogOfferId": "String", + "confidenceLevel": "String", + "customerTenantId": "String", + "description": "String", + "detectedDateTime": "String (timestamp)", + "displayName": "String", + "firstObservedDateTime": "String (timestamp)", + "id": "String (identifier)", + "isTest": "Boolean", + "lastObservedDateTime": "String (timestamp)", + "resolvedBy": "String", + "resolvedOnDateTime": "String (timestamp)", + "resolvedReason": "String", + "severity": "String", + "status": "String", + "subscriptionId": "String", + "valueAddedResellerTenantId": "String" +} +``` + |
v1.0 | Partners Billing Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partners-billing-api-overview.md | Title: "Use the Microsoft Graph API to export partner billing data" description: "The partner billing API in Microsoft Graph offers Microsoft direct partners a faster, more efficient way to export their high-volume billed and unbilled Azure usage data." ms.localizationpriority: medium -doc_type: resourcePageType # Use the Microsoft Graph API to export partner billing data |
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 | 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`. | +| 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 backdated. To apply to all applications, this date would be `null`. | ## Relationships |
v1.0 | Passwordprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/passwordprofile.md | Title: "passwordProfile resource type" description: "Contains the password profile associated with a user. The **passwordProfile** property of the user entity is a **passwordProfile** object." ms.localizationpriority: medium doc_type: resourcePageType+ |
v1.0 | Passwordsinglesignonfield | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/passwordsinglesignonfield.md | Contains the fields to capture to fill the use credentials for Password-based si ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Passwordsinglesignonsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/passwordsinglesignonsettings.md | Title: "passwordSingleSignOnSettings resource type" -description: "Settings related to Password-based single sign-on" +description: "Settings related to password-based single sign-on" ms.localizationpriority: medium doc_type: "resourcePageType" [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Contains the collection of Password-based single sign-on settings. +Contains the collection of password-based single sign-on settings. ## Properties | Property | Type | Description | |:-|:|:|-|fields|[passwordSingleSignOnField](passwordsinglesignonfield.md) collection|| +|fields|[passwordSingleSignOnField](passwordsinglesignonfield.md) collection|The fields to capture to fill the user credentials for password-based single sign-on.| ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Passwordvalidationinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/passwordvalidationinformation.md | description: "Exposes the properties that specify whether a user's password is v ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Patchcontentcommand | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/patchcontentcommand.md | The changes to make to a OneNote page in a PATCH request. ## JSON representation -Here is a JSON representation of the resource, which is sent in the body of the [PATCH pages/{id}`](../api/page-update.md) request. +The following JSON representation shows the resource type., which is sent in the body of the [PATCH pages/{id}`](../api/page-update.md) request. <!-- { "blockType": "resource", |
v1.0 | Patternedrecurrence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/patternedrecurrence.md | The recurrence pattern and range. This shared object is used to define the recur ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Payloadcoachmark | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/payloadcoachmark.md | 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.payloadCoachmark" |
v1.0 | Payloaddetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/payloaddetail.md | Base type of [emailPayloadDetail](../resources/emailpayloaddetail.md). |Property|Type|Description| |:|:|:|-|coachmarks|[payloadCoachmark](../resources/payloadcoachmark.md) collection|Payload coachmark details.| +|coachMarks|[payloadCoachmark](../resources/payloadcoachmark.md) collection|Payload coachmark details.| |content|String|Payload content details.| |phishingUrl|String|The phishing URL used to target a user.| 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.payloadDetail" |
v1.0 | Pendingexternaluserprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/pendingexternaluserprofile.md | Title: "pendingExternalUserProfile resource type" description: "Represents an external user profile in the Microsoft Entra tenant that hasn't consented to share data with the tenant." ms.localizationpriority: high + doc_type: resourcePageType |
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). |Method|Return type|Description| |:|:|:| |[Get peopleAdminSettings](../api/peopleadminsettings-get.md) | [peopleAdminSettings](../resources/peopleadminsettings.md) | Retrieve the properties and relationships of a [peopleAdminSettings](../resources/peopleadminsettings.md) object. |+|[List itemInsights](../api/peopleadminsettings-list-iteminsights.md) | [insightsSettings](insightssettings.md) | Get the properties of an [insightsSettings](insightssettings.md) object. | |[List pronounsSettings](../api/peopleadminsettings-list-pronouns.md)|[pronounsSettings](../resources/pronounssettings.md) collection|Get the properties of the [pronounsSettings](../resources/pronounssettings.md) resource for an organization.| |[List profileCardProperties](../api/peopleadminsettings-list-profilecardproperties.md) | [profileCardProperty](profilecardproperty.md) collection | Get a collection of [profileCardProperty](../resources/profilecardproperty.md) resources for an organization. | |[Create profileCardProperty](../api/peopleadminsettings-post-profilecardproperties.md) | [profileCardProperty](profilecardproperty.md) | Create a new [profileCardProperty](../resources/profilecardproperty.md) for an organization. | Inherits from [entity](../resources/entity.md). |Relationship|Type|Description| |:|:|:|-|profileCardProperties|[profileCardProperty](profilecardproperty.md) collection| Contains a collection of the properties an administrator has defined as visible on the Microsoft 365 profile card.| +|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.| |pronouns|[pronounsSettings](../resources/pronounssettings.md)|Represents administrator settings that manage the support of pronouns in an organization.| ## JSON representation |
v1.0 | Permission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permission.md | OneDrive for Business and SharePoint document libraries don't return the **inher ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Permissiongrantpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissiongrantpolicy.md | A permission grant policy is used to specify the conditions under which consent A permission grant policy consists of a list of **includes** condition sets, and a list of **excludes** condition sets. For an event to match a permission grant policy, it must match *at least one* of the **includes** conditions sets, and *none* of the **excludes** condition sets. +For more information, see [Manage app consent policies](/entra/identity/enterprise-apps/manage-app-consent-policies). + ## Methods | Method | Return Type | Description | A permission grant policy consists of a list of **includes** condition sets, and | includes | [permissionGrantConditionSet](permissiongrantconditionset.md) collection| Condition sets that are *included* in this permission grant policy. Automatically expanded on `GET`.| | excludes |[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Condition sets that are *excluded* in this permission grant policy. Automatically expanded on `GET`.| | includeAllPreApprovedApplications | Boolean | Set to `true` to create all pre-approval policies in the tenant. Set to `false` to disable all pre-approval policies in the tenant. The default is `false`.|-| resourceScopeType |String| The resource type the pre-approval policy applies to. Possible values: `group` for [groups](../resources/group.md) and [teams](../resources/team.md), `chat` for [chats](../resources/chat.md), `tenant` for all supported resources in the tenant. Required.| +| resourceScopeType |String| The resource type the pre-approval policy applies to. Possible values: `team` for [groups](../resources/group.md) and [teams](../resources/team.md), `chat` for [chats](../resources/chat.md), `tenant` for all supported resources in the tenant. Required.| ## Relationships |
v1.0 | Permissions Management Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissions-management-api-overview.md | description: "Use Microsoft Entra Permissions Management to discover, remediate, ms.localizationpriority: medium-doc_type: resourcePageType + # Discover, remediate, and monitor permissions in multicloud infrastructures using permissions management APIs (preview) |
v1.0 | Permissionsanalytics | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsanalytics.md | description: "Container for permissions analytics findings in Microsoft Entra Pe ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsanalyticsaggregatediamkeysummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsanalyticsaggregatediamkeysummary.md | description: "Represents the total number of IAM keys and the number of a specif ms.localizationpriority: medium+ doc_type: resourcePageType Represents the total number of IAM keys and the number of a specific finding for ## Properties |Property|Type|Description| |:|:|:|-|findingsCount|Int32|The total number of identities of a specific kind that has a specific finding type.| +|findingsCountOverLimit|Int32|The total number of identities of a specific kind that has a specific finding type.| |totalCount|Int32|The total number of identities in an authorization system that Permissions Management checked for a specific finding.| ## Relationships |
v1.0 | Permissionsanalyticsaggregatedidentitysummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsanalyticsaggregatedidentitysummary.md | description: "Represents the total number of identities of a specific kind and t ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsanalyticsaggregation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsanalyticsaggregation.md | description: "Represents permissions analytics findings for authorization system ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionscope.md | Delegated permissions can be requested by client applications needing an access ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Permissionscreepindex | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionscreepindex.md | description: "Assigns a score based on an identities excessive permissions that ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionscreepindexdistribution | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionscreepindexdistribution.md | description: "Represents the Permissions Creep Index Distribution for the author ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsdefinition.md | description: "An abstract type that represents information about the permissions ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsdefinitionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsdefinitionaction.md | description: "An abstract complex type that represents the action to take in a p ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsdefinitionauthorizationsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsdefinitionauthorizationsystem.md | description: "Represents the authorization system that the permissions will be r ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsdefinitionauthorizationsystemidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsdefinitionauthorizationsystemidentity.md | description: "Represents an identity that's requesting permissions in an authori ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsdefinitionawspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsdefinitionawspolicy.md | description: "Represents an AWS policy." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsdefinitionazurerole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsdefinitionazurerole.md | description: "Represents permissions defined for an Azure role." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsdefinitiongcprole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsdefinitiongcprole.md | description: "Represents permissions in a GCP role." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsdefinitionidentitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsdefinitionidentitysource.md | description: "An abstract type that defines the source of an identity that's req ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsmanagement.md | description: "The base container for the relationships that define the requests ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Permissionsrequestchange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/permissionsrequestchange.md | description: "Represents a change event relating to requests for permissions by ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Persondatasource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/persondatasource.md | Represents the sources the user data comes from, such as Directory and Outlook C ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Phone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/phone.md | Represents a phone number. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Phoneauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/phoneauthenticationmethod.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Physicaladdress | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/physicaladdress.md | Represents the street address of a resource such as a contact or event. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Physicalofficeaddress | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/physicalofficeaddress.md | Represents the business address of a resource such as an organizational contact. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Pkcs12certificateinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/pkcs12CertificateInformation.md | Represents the public information of a Pkcs12 certificate. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.pkcs12CertificateInformation" |
v1.0 | Pkcs12certificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/pkcs12certificate.md | Inherits from [apiAuthenticationConfigurationBase](../resources/apiauthenticatio ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.pkcs12Certificate" |
v1.0 | Planner | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/planner.md | The **planner** resource is the entry point for the Planner object model. It ret |tasks|[plannerTask](plannertask.md) collection| Read-only. Nullable. Returns a collection of the specified tasks| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerappliedcategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerappliedcategories.md | Properties of an open type can be defined by the client. In this case, the clien ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerapprovalrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerapprovalrequirement.md | + + Title: "plannerApprovalRequirement resource type" +description: "Represents whether a plannerTask must have an approval completion requirement created for it." ++ms.localizationpriority: medium ++++# plannerApprovalRequirement resource type ++Namespace: microsoft.graph +++Represents whether a [plannerTask](plannertask.md) must have an approval completion requirement created for it. ++## Properties +|Property|Type|Description| +|:|:|:| +|isApprovalRequired|Boolean|Specifies whether [approval](plannerbaseapprovalattachment.md) is required to complete the [plannerTask](plannertask.md). When this property is set to true, the task can only be marked complete if an approval is created for the task and approved.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerApprovalRequirement" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerApprovalRequirement", + "isApprovalRequired": "Boolean" +} +``` + |
v1.0 | Plannerassignedtotaskboardtaskformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerassignedtotaskboardtaskformat.md | Represents the information used to render a task correctly in the **AssignedTo** None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerassignment.md | The **plannerAssignment** resource represents the assignment of a task to a user |orderHint|String|Hint used to order assignees in a task. The format is defined as outlined [here](planner-order-hint-format.md).| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerassignments.md | Example: "optionalProperties": [ ],- "@odata.type": "microsoft.graph.plannerAssignments" + "@odata.type": "microsoft.graph.plannerAssignments", + "openType": true }--> ```json |
v1.0 | Plannerbaseapprovalattachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerbaseapprovalattachment.md | + + Title: "plannerBaseApprovalAttachment resource type" +description: "Represents the base approval attachment that is added to a plannerTask, which contains the common properties that are required for an approval." ++ms.localizationpriority: medium ++++# plannerBaseApprovalAttachment resource type ++Namespace: microsoft.graph +++Represents the base approval attachment, which contains the common properties that are required for an approval, that is added to a [plannerTask](plannertask.md). The derived types, such as [plannerBasicApprovalAttachment](plannerbasicapprovalattachment.md), have details corresponding to the type of approval. ++This type is abstract. ++## Properties +|Property|Type|Description| +|:|:|:| +|status|[plannerApprovalStatus](../resources/plannerbaseapprovalattachment.md#plannerapprovalstatus-values)|Status of the approval. The possible values are: `requested`, `approved`, `rejected`, `cancelled`, `unknownFutureValue`. Read-only. ++### plannerApprovalStatus values ++| Member | +|:-| +| requested | +| approved | +| rejected | +| cancelled | +| unknownFutureValue | ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerBaseApprovalAttachment" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerBaseApprovalAttachment", + "status": "String" +} +``` + |
v1.0 | Plannerbasicapprovalattachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerbasicapprovalattachment.md | + + Title: "plannerBasicApprovalAttachment resource type" +description: "Represents the approval attachment that is added to a plannerTask." ++ms.localizationpriority: medium ++++# plannerBasicApprovalAttachment resource type ++Namespace: microsoft.graph +++Represents the approval attachment, of type basic, that is created by the approval extensibility service and is added to a [plannerTask](plannertask.md). ++Inherits from [plannerBaseApprovalAttachment](../resources/plannerbaseapprovalattachment.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|approvalId|String|Read-only. The identifier of the approval in the approval service.| +|status|[plannerApprovalStatus](../resources/plannerbaseapprovalattachment.md#plannerapprovalstatus-values)|The status of the approval. Inherited from [plannerBaseApprovalAttachment](../resources/plannerbaseapprovalattachment.md). The possible values are: `requested`, `approved`, `rejected`, `cancelled`, `unknownFutureValue`. Read-only.| ++### plannerApprovalStatus values ++|Member|Description| +|:--|:-| +|requested|Default. Approval is requested.| +|approved|The plannerTask is approved.| +|rejected|The plannerTask is rejected.| +|cancelled|The requestor canceled the approval.| +|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.plannerBasicApprovalAttachment" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerBasicApprovalAttachment", + "status": "String", + "approvalId": "String" +} +``` + |
v1.0 | Plannerbuckettaskboardtaskformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerbuckettaskboardtaskformat.md | None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 |title|String|Title of the checklist item| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerchecklistitems | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerchecklistitems.md | Properties of an Open Type can be defined by the client. In this case, the clien ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ ],- "@odata.type": "microsoft.graph.plannerChecklistItems" + "@odata.type": "microsoft.graph.plannerChecklistItems", + "openType": true }--> ```json |
v1.0 | Plannerexternalbucketsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerexternalbucketsource.md | This type is derived from [plannerBucketCreation](plannerBucketCreation.md). 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.plannerExternalBucketSource" |
v1.0 | Plannerexternalplansource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerexternalplansource.md | This type is derived from [plannerPlanCreation](plannerPlanCreation.md). 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.plannerExternalPlanSource" |
v1.0 | Plannerexternalreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerexternalreference.md | The **plannerExternalReference** resource represents the metadata of a reference |type|String|Used to describe the type of the reference. Types include: `PowerPoint`, `Word`, `Excel`, `Other`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerexternalreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerexternalreferences.md | Properties of an Open Type can be defined by the client. In this case, the clien ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ ],- "@odata.type": "microsoft.graph.plannerExternalReferences" + "@odata.type": "microsoft.graph.plannerExternalReferences", + "openType": true }--> |
v1.0 | Plannerexternaltasksource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerexternaltasksource.md | This type is derived from [plannerTaskCreation](plannerTaskCreation.md). 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.plannerExternalTaskSource" |
v1.0 | Plannerfavoriteplanreferencecollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerfavoriteplanreferencecollection.md | The following is a JSON representation of the resource. "optionalProperties": [ ],- "@odata.type": "microsoft.graph.plannerFavoritePlanReferenceCollection" + "@odata.type": "microsoft.graph.plannerFavoritePlanReferenceCollection", + "openType": true }--> ```json |
v1.0 | Plannerformreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerformreference.md | + + Title: "plannerFormReference resource type" +description: "Represents complete information about a form, including the form's display name, URL, and the response data." +ms.localizationpriority: medium ++++# plannerFormReference resource type ++Namespace: microsoft.graph +++Represents complete details about a form, including the form's display name, URL, and the response data. This object is typically used as a value in the [plannerFormsDictionary](plannerFormsDictionary.md) object. ++## Properties +| Property | Type |Description| +|:|:--|:-| +|displayName|String|The display name of the form.| +|formWebUrl|String|The URL of the form associated with the **plannerFormReference** object.| +|formResponse|String|The unique identifier of the response.| ++## JSON representation +The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerFormReference" +}--> ++```json +{ + "displayName": "String-value", + "formWebUrl": "String-value", + "formResponse": "String-value" +} ++``` |
v1.0 | Plannerformsdictionary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerformsdictionary.md | + + Title: "plannerFormsDictionary resource type" +description: "Represents a dictionary of planner form reference objects for a task." +ms.localizationpriority: medium ++++# plannerFormsDictionary resource type ++Namespace: microsoft.graph +++An open type that represents a dictionary of data about the forms associated with a task. This resource is a part of the [plannerTaskDetails](plannertaskdetails.md) object. Each entry in the dictionary is a key-value pair, where the value is a [plannerFormReference](plannerformreference.md) object. +++## Properties +You can add and remove values from open type properties. Provide GUID values as keys, and [plannerFormReference](plannerformreference.md) objects as values. To remove an item in the forms, set its value to `null`. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerFormsDictionary" +}--> ++```json +{ + "String-value": + { + "displayName": "String-value", + "formWebUrl": "String-value", + "formResponse": "String-value" + } +} ++``` |
v1.0 | Plannerformsrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerformsrequirement.md | + + Title: "plannerFormsRequirement resource type" +description: "Represents the criteria of form requirements that must be met to complete a Planner task." ++ms.localizationpriority: medium +++# plannerFormsRequirement resource type ++Namespace: microsoft.graph +++Represents a form completion requirement on a [plannerTask](plannertask.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|requiredForms|String collection|Read-only. A collection of keys from the [plannerFormsDictionary](plannerformsdictionary.md) that identify the [plannerFormReference](plannerformreference.md) objects that specify the requirements to complete the [plannerTask](plannertask.md).| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerFormsRequirement" +}--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerFormsRequirement", + "requiredForms": ["String"] +} +``` |
v1.0 | Plannergroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannergroup.md | The **plannerGroup** resource provides access to Planner resources for a [group] |plans|[plannerPlan](plannerplan.md) collection| Read-only. Nullable. Returns the [plannerPlans](plannerplan.md) owned by the group.| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerorderhintsbyassignee | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerorderhintsbyassignee.md | Example: "optionalProperties": [ ],- "@odata.type": "microsoft.graph.plannerOrderHintsByAssignee" + "@odata.type": "microsoft.graph.plannerOrderHintsByAssignee", + "openType": true }--> ```json |
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. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerplancontextcollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerplancontextcollection.md | The following is a JSON representation of the resource. "optionalProperties": [ ],- "@odata.type": "microsoft.graph.plannerPlanContextCollection" + "@odata.type": "microsoft.graph.plannerPlanContextCollection", + "openType": true }--> ```json |
v1.0 | Plannerplandetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerplandetails.md | Represents the additional information about a plan. Each [plan](plannerplan.md) None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerprogresstaskboardtaskformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerprogresstaskboardtaskformat.md | None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerrecentplanreferencecollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerrecentplanreferencecollection.md | The following is a JSON representation of the resource. "optionalProperties": [ ],- "@odata.type": "microsoft.graph.plannerRecentPlanReferenceCollection" + "@odata.type": "microsoft.graph.plannerRecentPlanReferenceCollection", + "openType": true }--> ```json |
v1.0 | Plannersharedwithcontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannersharedwithcontainer.md | 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.plannerSharedWithContainer" |
v1.0 | Plannertask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannertask.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a Planner task in Microsoft 365. A Planner task is contained in a [plan](plannerplan.md) and can be assigned to a [bucket](plannerbucket.md) in a plan. Each task object has a [details](plannertaskdetails.md) object that can contain more information about the task. For more information about relationships between group, plan, and task, see [Use the Planner REST API](planner-overview.md) +Represents a Planner task in Microsoft 365. A Planner task is contained in a [plan](plannerplan.md) and can be assigned to a [bucket](plannerbucket.md) in a plan. Each task object has a [details](plannertaskdetails.md) object that can contain more information about the task. For more information about relationships between group, plan, and task, see [Use the Planner REST API](planner-overview.md). ## Methods | Method | Return Type |Description| |:|:--|:-|-|[Get plannerTask](../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. | +|[Get plannerTask](../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 | Property | Type |Description| |:|:--|:-|-|activeChecklistItemCount|Int32|Number of checklist items with value set to `false`, representing incomplete items.| -|appliedCategories|[plannerAppliedCategories](plannerappliedcategories.md)|The categories to which the task has been applied. See [applied Categories](plannerappliedcategories.md) for possible values.| -|assigneePriority|String|Hint used to order items of this type in a list view. The format is defined as outlined [here](planner-order-hint-format.md).| +|activeChecklistItemCount|Int32|The number of checklist items with value set to `false`, representing incomplete items.| +|appliedCategories|[plannerAppliedCategories](plannerappliedcategories.md)|The categories to which the task is applied. See [plannerAppliedCategories resource type](plannerappliedcategories.md) for possible values.| +|assigneePriority|String|A hint that is used to order items of this type in a list view. For more information, see [Using order hints in Planner](planner-order-hint-format.md).| |assignments|[plannerAssignments](plannerassignments.md)|The set of assignees the task is assigned to.|-|bucketId|String|Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. [Format validation](tasks-identifiers-disclaimer.md) is done on the service. | -|checklistItemCount|Int32|Number of checklist items that are present on the task.| -|completedBy|[identitySet](identityset.md)|Identity of the user that completed the task.| -|completedDateTime|DateTimeOffset|Read-only. Date and time at which the `'percentComplete'` of the task is set to `'100'`. 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`| -|conversationThreadId|String|Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.| -|createdBy|[identitySet](identityset.md)|Identity of the user that created the task.| -|createdDateTime|DateTimeOffset|Read-only. Date and time at which the task is 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`| -|creationSource|[plannerTaskCreation](../resources/plannertaskcreation.md)|Contains information about the origin of the task.| -|dueDateTime|DateTimeOffset|Date and time at which the task is due. 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`| -|hasDescription|Boolean|Read-only. Value is `true` if the details object of the task has a nonempty description and `false` otherwise.| -|id|String|Read-only. ID of the task. It is 28 characters long and case-sensitive. [Format validation](tasks-identifiers-disclaimer.md) is done on the service.| -|orderHint|String|Hint used to order items of this type in a list view. The format is defined as outlined [here](planner-order-hint-format.md).| -|percentComplete|Int32|Percentage of task completion. When set to `100`, the task is considered completed. | -|priority|Int32|Priority of the task. Valid range of values is between `0` and `10` (inclusive), with increasing value being lower priority (`0` has the highest priority and `10` has the lowest priority). Currently, Planner interprets values `0` and `1` as "urgent", `2` and `3` and `4` as "important", `5`, `6`, and `7` as "medium", and `8`, `9`, and `10` as "low". Currently, Planner sets the value `1` for "urgent", `3` for "important", `5` for "medium", and `9` for "low".| +|bucketId|String|Bucket ID to which the task belongs. The bucket needs to be in the same plan as the task. The value of the bucketId property is 28 characters long and case-sensitive. [Format validation](tasks-identifiers-disclaimer.md) is done on the service. | +|checklistItemCount|Int32|The number of checklist items that are present on the task.| +|completedBy|[identitySet](identityset.md)|The identity of the user that completed the task.| +|completedDateTime|DateTimeOffset|Read-only. The date and time at which the `'percentComplete'` of the task is set to `'100'`. 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`| +|conversationThreadId|String|The thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.| +|createdBy|[identitySet](identityset.md)|The identity of the user who created the task.| +|createdDateTime|DateTimeOffset|Read-only. The date and time at which the task is 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`| +|creationSource|[plannerTaskCreation](../resources/plannertaskcreation.md)|Information about the origin of the task.| +|dueDateTime|DateTimeOffset|The date and time at which the task is due. 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`| +|hasDescription|Boolean|Read-only. This value is `true` if the details object of the task has a nonempty description. Otherwise,`false`.| +|id|String|Read-only. The unique identifier of the task. The value of this property is 28 characters long and case-sensitive. [Format validation](tasks-identifiers-disclaimer.md) is done on the service.| +|isOnMyDay|Boolean|A Boolean value that indicates whether to show this task in the MyDay view. `true` to show the task. Otherwise, `false`.| +|isOnMyDayLastModifiedDate|Date|Read-only. The date on which task is added to or removed from MyDay.| +|orderHint|String|The hint used to order items of this type in a list view. For more information, see [Using order hints in Planner](planner-order-hint-format.md)n.| +|percentComplete|Int32|The percentage of task completion. When set to `100`, the task is completed. | +|priority|Int32|The priority of the task. Valid values are between `0` and `10`, inclusive. Larger values indicate lower priority. For example, `0` has the highest priority and `10` has the lowest priority. Currently, Planner interprets values `0` and `1` as "urgent", `2` and `3` and `4` as "important", `5`, `6`, and `7` as "medium", and `8`, `9`, and `10` as "low". Currently, Planner sets the value `1` for "urgent", `3` for "important", `5` for "medium", and `9` for "low".| |planId|String|Plan ID to which the task belongs.|-|previewType|String|This sets the type of preview that shows up on the task. Possible values are: `automatic`, `noPreview`, `checklist`, `description`, `reference`.| +|previewType|String|The type of preview that shows up on the task. Possible values are: `automatic`, `noPreview`, `checklist`, `description`, `reference`.| |recurrence|[plannerTaskRecurrence](../resources/plannertaskrecurrence.md)|Defines active or inactive recurrence for the task. `null` when the recurrence has never been defined for the task.| |referenceCount|Int32|Number of external references that exist on the task.|-|specifiedCompletionRequirements|[plannerTaskCompletionRequirements](../resources/plannertask.md#plannertaskcompletionrequirements-values)|Indicates all the requirements specified on the **plannerTask**. Possible values are: `none`, `checklistCompletion`, `unknownFutureValue`. Read-only. The [plannerTaskCompletionRequirementDetails](plannertaskcompletionrequirementdetails.md) in [plannerTaskDetails](plannertaskdetails.md) has details of the requirements specified, if any. | +|specifiedCompletionRequirements|[plannerTaskCompletionRequirements](../resources/plannertask.md#plannertaskcompletionrequirements-values)|Indicates all the requirements specified on the **plannerTask**. Possible values are: `none`, `checklistCompletion`, `unknownFutureValue`, `formCompletion`, `approvalCompletion`. Read-only. 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): `formCompletion`, `approvalCompletion`. The [plannerTaskCompletionRequirementDetails](plannertaskcompletionrequirementdetails.md) in [plannerTaskDetails](plannertaskdetails.md) has details of the requirements specified, if any. | |startDateTime|DateTimeOffset|Date and time at which the task starts. 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`| |title|String|Title of the task.| ### plannerTaskCompletionRequirements values -| Member | Description | -|:--|:| -| none | No requirement. | -| checklistCompletion | Some or all of the checklist items are required to be checked. | -| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +| Member | Description | +|:--|:| +| none | No requirement. | +| checklistCompletion | Some or all of the checklist items are required to be checked. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +| formCompletion | Some or all of the forms must be submitted to complete the planner task.| +| approvalCompletion | Approval is required. | ## Relationships Represents a Planner task in Microsoft 365. A Planner task is contained in a [pl |:|:--|:-| |assignedToTaskBoardFormat|[plannerAssignedToTaskBoardTaskFormat](plannerassignedtotaskboardtaskformat.md)| Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.| |bucketTaskBoardFormat|[plannerBucketTaskBoardTaskFormat](plannerbuckettaskboardtaskformat.md)| Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.|-|details|[plannerTaskDetails](plannertaskdetails.md)| Read-only. Nullable. Additional details about the task.| +|details|[plannerTaskDetails](plannertaskdetails.md)| Read-only. Nullable. More details about the task.| |progressTaskBoardFormat|[plannerProgressTaskBoardTaskFormat](plannerprogresstaskboardtaskformat.md)| Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.| ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. "dueDateTime": "String (timestamp)", "hasDescription": "Boolean", "id": "String (identifier)",+ "isOnMyDay": "Boolean", + "isOnMyDayLastModifiedDate": "Date", "orderHint": "String", "percentComplete": "Int32", "planId": "String", |
v1.0 | Plannertaskcompletionrequirementdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannertaskcompletionrequirementdetails.md | Represents detailed information about [completionRequirements](plannertask.md#pl |Property|Type|Description| |:|:|:|+|approvalRequirement |[plannerApprovalRequirement](plannerapprovalrequirement.md) |Information about the requirements of an approval.| |checklistRequirement|[plannerChecklistRequirement](plannerchecklistrequirement.md)|Information about the requirements for completing the checklist.|+|formsRequirement|[plannerFormsRequirement](plannerformsrequirement.md)|Information about the requirements for completing the forms.| ## Relationships None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.plannerTaskCompletionRequirementDetails",- "checklistRequirement": {"@odata.type": "microsoft.graph.plannerChecklistRequirement"} + "checklistRequirement": {"@odata.type": "microsoft.graph.plannerChecklistRequirement"}, + "formsRequirement": {"@odata.type": "microsoft.graph.plannerFormsRequirement"}, + "approvalRequirement": {"@odata.type": "microsoft.graph.plannerApprovalRequirement" } } ``` |
v1.0 | Plannertaskconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannertaskconfiguration.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Plannertaskdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannertaskdetails.md | Represents the additional information about a task. Each [task](plannertask.md) ## Properties | Property | Type |Description| |:|:--|:-|+|approvalAttachment|[plannerBaseApprovalAttachment](../resources/plannerbaseapprovalattachment.md)|Detailed information about the approval that is attached to the task.| |checklist|[plannerChecklistItems](plannerchecklistitems.md)|The collection of checklist items on the task.|+|forms|[plannerFormsDictionary](plannerformsdictionary.md)| Read-only. Represents a dictionary of data about the forms associated with a task. Each entry in the dictionary is a key-value pair, and the value is a [plannerFormReference](plannerformreference.md) object.| |completionRequirements|[plannerTaskCompletionRequirementDetails](plannertaskcompletionrequirementdetails.md)|Contains detailed information about requirements on the task.| |description|String|Description of the task.| |id|String| Read-only. ID of the task details. It's 28 characters long and case-sensitive. [Format validation](tasks-identifiers-disclaimer.md) is done on the service.| None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. ```json { "checklist": {"@odata.type": "microsoft.graph.plannerChecklistItems"},+ "forms": {"@odata.type": "microsoft.graph.plannerFormsDictionary"}, "completionRequirements": {"@odata.type": "microsoft.graph.plannerTaskCompletionRequirementDetails"}, "description": "String", "id": "String (identifier)", "notes": {"@odata.type": "microsoft.graph.itemBody"}, "previewType": "String",- "references": {"@odata.type": "microsoft.graph.plannerExternalReferences"} + "references": {"@odata.type": "microsoft.graph.plannerExternalReferences"}, + "approvalAttachment": {"@odata.type": "microsoft.graph.plannerBaseApprovalAttachment"} } ``` |
v1.0 | Plannertaskpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannertaskpolicy.md | 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.plannerTaskPolicy" |
v1.0 | Plannertaskpropertyrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannertaskpropertyrule.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents specific restrictions that apply to editing a [plannerTask](../resources/plannertask.md). For more details, see [Configuring task rules in Planner](/graph/planner-task-rules-overview). +Represents specific restrictions that apply to editing a [plannerTask](../resources/plannertask.md). For more information, see [Configuring task rules in Planner](/graph/planner-task-rules-overview). Inherits from [plannerPropertyRule](../resources/plannerpropertyrule.md). Inherits from [plannerPropertyRule](../resources/plannerpropertyrule.md). |Property|Type|Description| |:|:|:|-|appliedCategories|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for applied categories. This value does not currently support overrides. Accepted values for the default rule and individual overrides are `allow`, `block`.| +|appliedCategories|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for applied categories. This value doesn't currently support overrides. Accepted values for the default rule and individual overrides are `allow`, `block`.| +|approvalAttachment|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for approval. Allowed overrides are `userCreated` and `applicationCreated`. Accepted values for the default rule and individual overrides are: `allow`, `add`, `remove`, `block`.| |assignments|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for assignments. Allowed overrides are `userCreated` and `applicationCreated`. Accepted values for the default rule and individual overrides are `allow`, `add`, `addSelf`, `addOther`, `remove`, `removeSelf`, `removeOther`, `block`.| |checkLists|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for checklist. Allowed overrides are `userCreated` and `applicationCreated`. Accepted values for the default rule and individual overrides are `allow`, `add`, `remove`, `update`, `check`, `reorder`, `block`.| |completionRequirements|String collection|Rules and restrictions for completion requirements of the task. Accepted values are `allow`, `add`, `remove`, `edit`, and `block`. | |delete|String collection|Rules and restrictions for deleting the task. Accepted values are `allow` and `block`.| |dueDate|String collection|Rules and restrictions for changing the due date of the task. Accepted values are `allow` and `block`.|+|forms|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for forms. Allowed overrides are `userCreated` and `applicationCreated`. The following are the accepted values for the default rule and individual overrides: `allow`, `add`, `addResponse`, `remove`, `update`, `block`.| |move|String collection|Rules and restrictions for moving the task between buckets or plans. Accepted values are `allow`, `moveBetweenPlans`, `moveBetweenBuckets`, and `block`.| |notes|String collection|Rules and restrictions for changing the notes of the task. Accepted values are `allow` and `block`.| |order|String collection|Rules and restrictions for changing the order of the task. Accepted values are `allow` and `block`.| Inherits from [plannerPropertyRule](../resources/plannerpropertyrule.md). |previewType|String collection|Rules and restrictions for changing the preview type of the task. Accepted values are `allow` and `block`.| |priority|String collection|Rules and restrictions for changing the priority of the task. Accepted values are `allow` and `block`.| |references|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for references. Allowed overrides are `userCreated` and `applicationCreated`. Accepted values for the default rule and individual overrides are `allow`, `add`, `remove`, `block`.|-|ruleKind|plannerRuleKind|Identifies which type of property rules is represented by this instance. Must be set to `taskRule`. The possible values are: `taskRule`, `bucketRule`, `planRule`, `unknownFutureValue`. Inherited from [plannerPropertyRule](../resources/plannerpropertyrule.md).| +|ruleKind|plannerRuleKind|Identifies which type of property rules this instance represents. Must be set to `taskRule`. The possible values are: `taskRule`, `bucketRule`, `planRule`, `unknownFutureValue`. Inherited from [plannerPropertyRule](../resources/plannerpropertyrule.md).| |startDate|String collection|Rules and restrictions for changing the start date of the task. Accepted values are `allow` and `block`.| |title|String collection|Rules and restrictions for changing the title of the task. Accepted values are `allow` and `block`.| None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.plannerTaskPropertyRule" The following is a JSON representation of the resource. "appliedCategories": {"@odata.type": "microsoft.graph.plannerFieldRules"}, "assignments": {"@odata.type": "microsoft.graph.plannerFieldRules"}, "checkLists": {"@odata.type": "microsoft.graph.plannerFieldRules"},+ "approvalAttachment": {"@odata.type": "microsoft.graph.plannerFieldRules"}, "completionRequirements": ["String"], "delete": ["String"], "dueDate": ["String"], |
v1.0 | Planneruser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/planneruser.md | Provides access to Planner resources for a [user](user.md). | Method | Return Type |Description| |:|:--|:-| |[List tasks](../api/planneruser-list-tasks.md) |[plannerTask](plannertask.md) collection| Get the [plannerTasks](plannertask.md) assigned to the user.|+|[List myDayTasks](../api/planneruser-list-mydaytasks.md) |[plannerTask](plannertask.md) collection| Get the [plannerTasks](plannertask.md) to be shown in the user's MyDay view.| |[List favoritePlans](../api/planneruser-list-favoriteplans.md) |[plannerPlan](plannerplan.md) collection| Get the [plannerPlans](plannerplan.md) marked as favorite by the user.| |[List recentPlans](../api/planneruser-list-recentplans.md) |[plannerPlan](plannerplan.md) collection| Get the [plannerPlans](plannerplan.md) recently viewed by the user.| |[List rosterPlans](../api/planneruser-list-rosterplans.md)|[plannerPlan](plannerplan.md) collection| Get the [plannerPlans](plannerplan.md) contained by the [plannerRosters](plannerroster.md) that the user is a member.| Provides access to Planner resources for a [user](user.md). | Property | Type |Description| |:|:--|:-| |id|String| Read-only. Unique identifier for the **plannerUser** object.|-|favoritePlanReferences|[plannerFavoritePlanReferenceCollection](plannerfavoriteplanreferencecollection.md)| A collection that contains the references to the plans that the user has marked as favorites.| -|recentPlanReferences|[plannerRecentPlanReferenceCollection](plannerrecentplanreferencecollection.md)| A collection that contains references to the plans that were viewed recently by the user in apps that support recent plans.| +|favoritePlanReferences|[plannerFavoritePlanReferenceCollection](plannerfavoriteplanreferencecollection.md)| A collection that contains the references to the plans that the user marked as favorites.| +|recentPlanReferences|[plannerRecentPlanReferenceCollection](plannerrecentplanreferencecollection.md)| A collection that contains references to the plans that the user recently viewed in apps that support recent plans.| ## Relationships | Relationship | Type |Description| |:|:--|:-| |favoritePlans|[plannerPlan](plannerplan.md) collection| Read-only. Nullable. Returns the [plannerPlans](plannerplan.md) that the user marked as favorites.|-|recentPlans|[plannerPlan](plannerplan.md) collection| Read-only. Nullable. Returns the [plannerPlans](plannerplan.md) that have been recently viewed by the user in apps that support recent plans. | +|recentPlans|[plannerPlan](plannerplan.md) collection| Read-only. Nullable. Returns the [plannerPlans](plannerplan.md) that the user recently viewed in apps that support recent plans. | |rosterPlans|[plannerPlan](../resources/plannerplan.md) collection|Read-only. Nullable. Returns the [plannerPlans](plannerplan.md) contained by the [plannerRosters](plannerroster.md) the user is a member.| |tasks|[plannerTask](plannertask.md) collection| Read-only. Nullable. Returns the [plannerTasks](plannertask.md) assigned to the user.|+|myDayTasks|[plannerTask](plannertask.md) collection| Read-only. Nullable. Returns the [plannerTasks](plannertask.md) to be shown in the My Day view of the user.| ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Planneruserids | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/planneruserids.md | Properties of an Open Type can be defined by the client. In this case, the clien ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ ],- "@odata.type": "microsoft.graph.plannerUserIds" + "@odata.type": "microsoft.graph.plannerUserIds", + "openType": true }--> ```json |
v1.0 | Policyroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/policyroot.md | Title: "policyRoot resource type" description: "Resource type exposing navigation properties for the policies singleton."-+ ms.localizationpriority: medium-+ doc_type: resourcePageType None | tokenLifetimePolicies | [tokenLifetimePolicy](tokenlifetimepolicy.md) collection | The policy that controls the lifetime of a JWT access token, an ID token, or a SAML 1.1/2.0 token issued by Microsoft Entra ID. | ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Policytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/policytemplate.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/post.md | This resource lets you add your own data to custom properties using [extensions] ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Preapprovedpermissions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/preapprovedpermissions.md | A **preApprovedPermissions** type describes the set of permissions that are pre- 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.preApprovedPermissions" |
v1.0 | Preauthorizedapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/preauthorizedapplication.md | In some rare cases, an identifier listed in the `permissionIds` property may ref |permissionIds|String collection| The unique identifier for the [scopes](permissionscope.md) the client application is granted. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Presence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/presence.md | Contains information about a user's presence, including their availability and u > **Note:** This resource is currently only supported for Microsoft Teams users. -This resource supports subscribing to [change notifications](/graph/webhooks). +This resource supports subscribing to [change notifications](/graph/changenotifications-for-presence). ## Methods |
v1.0 | Presencestatusmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/presencestatusmessage.md | Represents a presence status message related to the [presence](presence.md) of a ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Principalresourcemembershipsscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/principalresourcemembershipsscope.md | You must also specify the **@odata.type** type property with the value `#microso 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.principalResourceMembershipsScope" |
v1.0 | Printdocumentuploadproperties | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printdocumentuploadproperties.md | Describes the document that is being uploaded ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Printercapabilities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printercapabilities.md | Represents the capabilities reported by a printer. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Printerstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printerstatus.md | Represents the processing status of the printer, including any errors. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Printidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printidentity.md | Represents an identity within the Universal Print service. Maps to an [Microsoft ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Printjobconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printjobconfiguration.md | A group of settings that a printer should use to print a job. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Printjobstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printjobstatus.md | Represents the current status of a print job. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Printservice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printservice.md | Represents a Microsoft Entra tenant-specific description of a print service inst ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Printtasktrigger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printtasktrigger.md | For details about how to use this resource to add pull printing support to Unive ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Printusagebyprinter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printusagebyprinter.md | Describes print activity for a printer during a specified time period (usageDate |incompleteJobCount|Int64|The number of print jobs that were queued for the printer, but not completed.| |mediaSheetCount|Int64|The estimated number of media sheets printed based on reporting by the printer.| |pageCount|Int64|The estimated number of pages printed based on reporting by the printer.|-|printerID|String|The ID of the printer represented by these statistics.| +|printerId|String|The ID of the printer represented by these statistics.| |printerName|String|The name of the printer represented by these statistics.| |singleSidedSheetCount|Int64|The estimated number of single-sided media sheets printed based on reporting by the printer.| |usageDate|Date|The date associated with these statistics.| |
v1.0 | Privacyprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privacyprofile.md | description: "Represents a company's privacy profile, which includes a privacy s ms.localizationpriority: medium doc_type: resourcePageType -+ # privacyProfile resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a company's privacy profile, which includes a privacy statement URL and a contact person for questions regarding the privacy statement. +Represents a [company's](organization.md) privacy profile, which includes a privacy statement URL and a contact person for questions regarding the privacy statement. ## Properties | Property | Type|Description| Represents a company's privacy profile, which includes a privacy statement URL a ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Privilegedaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegedaccess.md | Represents a group of functionalities provided by the Privileged Identity Manage ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Privilegedaccessgroupassignmentschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegedaccessgroupassignmentschedule.md | Inherits from [privilegedAccessSchedule](../resources/privilegedaccessschedule.m |principal|[directoryObject](../resources/directoryobject.md)|References the principal that's in the scope of this membership or ownership assignment request to the group that's governed by PIM. Supports `$expand` and `$select` nested in `$expand` for **id** only.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Privilegedaccessgroupassignmentscheduleinstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegedaccessgroupassignmentscheduleinstance.md | Inherits from [privilegedAccessScheduleInstance](../resources/privilegedaccesssc |principal|[directoryObject](../resources/directoryobject.md)|References the principal that's in the scope of the membership or ownership assignment request through the group that's governed by PIM. Supports `$expand`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Privilegedaccessgroupeligibilityschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegedaccessgroupeligibilityschedule.md | Inherits from [privilegedAccessSchedule](../resources/privilegedaccessschedule.m |principal|[directoryObject](../resources/directoryobject.md)|References the principal that's in the scope of this membership or ownership eligibility request to the group that's governed by PIM. Supports `$expand`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Privilegedaccessschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegedaccessschedule.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Privilegedaccessscheduleinstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegedaccessscheduleinstance.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
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 mana 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." ms.localizationpriority: medium -doc_type: resourcePageType Last updated 10/12/2023 |
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 ma 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." ms.localizationpriority: medium -doc_type: resourcePageType Last updated 10/12/2023 Last updated 10/12/2023 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 (ARM)](/rest/api/authorization/privileged-role-eligibility-rest-sample). +> To manage Azure resource roles use the [PIM APIs for Azure Resource Manager](/rest/api/authorization/privileged-role-eligibility-rest-sample). ## PIM APIs for managing active role assignments The following permissions are supported for PIM for Microsoft Entra roles API op | 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. +For delegated scenarios, the signed-in user must be assigned the *Privileged Role Administrator* or *Global Administrator* role in Microsoft Entra ID. --> ## Licensing |
v1.0 | Privilegeescalation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegeescalation.md | description: "A container for privilege escalation events." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Privilegeescalationawsresourcefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegeescalationawsresourcefinding.md | description: "AWS resources with privilege escalation." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Privilegeescalationawsrolefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegeescalationawsrolefinding.md | description: "AWS roles with privilege escalation." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Privilegeescalationfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegeescalationfinding.md | description: "Represents findings for a list of privilege escalations in AWS or ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Privilegeescalationgcpserviceaccountfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegeescalationgcpserviceaccountfinding.md | description: "GCP service accounts with privilege escalation" ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Privilegeescalationuserfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegeescalationuserfinding.md | description: "Represents findings for a list of users who can escalate privilege ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Profile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/profile.md | Title: "profile resource type" description: "Represents properties that are descriptive of a user and that are surfaced in shared, people experiences across Microsoft 365 and third-party services and experiences via Microsoft Graph." ms.localizationpriority: medium + doc_type: "resourcePageType" - + # profile resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents properties that are descriptive of a user in a tenant, for example, anniversaries and education activities. These properties are surfaced in shared, people experiences across Microsoft 365 and third-party services and experiences via Microsoft Graph. +Represents properties that are descriptive of a user in a tenant, for example, anniversaries and education activities. These properties are surfaced in shared, people experiences across Microsoft 365 and third-party services and experiences via Microsoft Graph. Programmatically, these properties are expressed as [relationships](#relationships) of the **profile** resource. To get one of these navigation properties or create an instance of these properties for the user, use the corresponding GET or POST method on that property, where applicable. See the [methods](#methods) listed below. |
v1.0 | Profilesourceannotation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/profileSourceAnnotation.md | + + Title: "profileSourceAnnotation resource type" +description: "Represents the sources the user data comes from, such as Entra, UPA, Connector, and so on." +ms.localizationpriority: medium ++++++# profileSourceAnnotation resource type ++Namespace: microsoft.graph +++Represents the sources the user data comes from, such as Entra, UPA, Connector, and so on. ++## Properties +|Property |Type |Description| +|:--|:-|:-| +|id|String|The unique identifier of the source.| +|isDefaultSource|Boolean|Indicates whether the source is the default one.| +|properties|Collection(String)|The names of properties that have data from this source.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.profileSourceAnnotation" +}--> ++```json +{ + "id": "String (GUID)", + "isDefaultSource": "Boolean", + "properties": "Collection(String)" +} +``` |
v1.0 | Program | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/program.md | Each tenant that has on-boarded Microsoft Entra access reviews has one program, ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Programcontrol | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/programcontrol.md | In the Microsoft Entra [access reviews](accessreviews-root.md) feature, the prog ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Programcontroltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/programcontroltype.md | None. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Project Rome Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/project-rome-overview.md | -Three key Project Rome capabilities are exposed via Microsoft Graph to help you enable great cross-device experiences: activities, devices, and notifications. +The following key capabilities are exposed via Microsoft Graph to help you enable cross-device experiences. ## Activities You can use the following Microsoft Graph APIs to communicate with other Windows - [Send a command to a device](../api/send-device-command.md) - [Get command status](../api/get-device-command-status.md) +## Roaming data ++Access Windows data stored in the cloud via the cloud clipboard and Windows settings APIs. ++The Cloud Clipboard feature in Windows enables users to copy and paste items such as text, images, and links across their applications and devices. You can use the cloud clipboard APIs in Microsoft Graph to: ++- [List cloud clipboard items for the signed-in user](/graph//api/cloudclipboardroot-list-items) +- [Get a cloud clipboard item for a user](/graph/api/cloudclipboarditem-get) ++The Windows setting API in Microsoft Graph enables users and authorized third parties acting on behalf of users to retrieve their Windows operating system settings data stored in the Microsoft cloud. For details about using the Windows setting API, see [Use the Windows settings API](/graph/api/resources/windows-setting-api-overview). |
v1.0 | Projectrome Activity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/projectrome-activity.md | Title: "activity resource type" -description: "Represents a single activity within an app - for example, a TV show, a document, or a current campaign in a video game. When a user engages with that activity, the engagement is captured as a history item that indicates the start and end time for that activity. As the user re-engages with that activity over time, multiple history items are recorded for a single user activity." + Title: "userActivity resource type" +description: Represents a single activity within an app - for example, a TV show, a document, or a current campaign in a video game" ms.localizationpriority: medium doc_type: resourcePageType -# activity resource type +# userActivity resource type Namespace: microsoft.graph Your user activities will be showcased in Cortana and Windows Timeline user expe |Method | Return Type | Description| |:|:|:--|-|[Create or replace activity](../api/projectrome-put-activity.md) | [activity](projectrome-activity.md) |Creates or replaces an existing activity (upsert). The appActivityId needs to be URL-safe (all characters except for RFC 2396 unreserved characters must be converted to their hexadecimal representation), but the original appActivityId does not have to be URL-safe. | -|[Delete an activity](../api/projectrome-delete-activity.md) | No Content | Deletes the specified activity for that user from your app.| -|[Get activities](../api/projectrome-get-activities.md) | Collection of [activities](projectrome-activity.md) | Gets the activities for your app for a given user.| -|[Get recent activities](../api/projectrome-get-recent-activities.md) | Collection of [activities](projectrome-activity.md) | Gets the most recent activities for your app for a given user, sorted and based on the most recently created or updated [historyItems](projectrome-historyitem.md).| +|[Create or replace userActivity](../api/projectrome-put-activity.md) | [userActivity](projectrome-activity.md) |Creates or replaces an existing activity (upsert). The appActivityId needs to be URL-safe (all characters except for RFC 2396 unreserved characters must be converted to their hexadecimal representation), but the original appActivityId does not have to be URL-safe. | +|[Delete an userActivity](../api/projectrome-delete-activity.md) | No Content | Deletes the specified activity for that user from your app.| +|[Get activities](../api/projectrome-get-activities.md) | Collection of [userActivity](projectrome-activity.md) | Gets the activities for your app for a given user.| +|[Get recent activities](../api/projectrome-get-recent-activities.md) | Collection of [userActivity](projectrome-activity.md) | Gets the most recent activities for your app for a given user, sorted and based on the most recently created or updated [activityHistoryItems](projectrome-historyitem.md).| ## Properties Your user activities will be showcased in Cortana and Windows Timeline user expe |Relationship | Type | Description| |:|:--|:--|-|historyItems| [historyItem](../resources/projectrome-historyitem.md) collection | Optional. NavigationProperty/Containment; navigation property to the activity's historyItems.| +|historyItems| [activityHistoryItem](../resources/projectrome-historyitem.md) collection | Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.| ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here is a JSON representation of the resource. "status": "string", "contentInfo": { "@data.type": "microsoft.graph.Json" }, "visualElements": { "@data.type": "microsoft.graph.visualInfo" },- "historyItems": [{ "@odata.type": "microsoft.graph.historyItem" }] + "historyItems": [{ "@odata.type": "microsoft.graph.activityHistoryItem" }] } ``` |
v1.0 | Projectrome Historyitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/projectrome-historyitem.md | Title: "historyItem resource type" + Title: "activityHistoryItem resource type" description: "Represents a history item for an activity in an app." ms.localizationpriority: medium doc_type: resourcePageType -# historyItem resource type +# activityHistoryItem resource type Namespace: microsoft.graph Namespace: microsoft.graph Represents a history item for an [activity](projectrome-activity.md) in an app. User activities represent a single destination within your app; for example, a TV show, a document, or a current campaign in a video game. When a user engages with that activity, the engagement is captured as a history item that indicates the start and end time for that activity. As the user re-engages with that activity over time, multiple history items are recorded for a single user activity. -When an app creates a session, a **historyItem** object should be added to the **activity** object to reflect the period of user engagement. Each time a user re-engages with an activity, a new **historyItem** is added to the activity to accrue user engagement. +When an app creates a session, a **activityHistoryItem** object should be added to the **activity** object to reflect the period of user engagement. Each time a user re-engages with an activity, a new **activityHistoryItem** is added to the activity to accrue user engagement. ## Methods |Method | Return Type | Description| |:|:|:--|-|[Create or replace historyItem](../api/projectrome-put-historyitem.md) | [historyItem](projectrome-historyitem.md) | Create or replace an existing **historyItem** for that activity (upsert). The ID needs to be a GUID.| -|[Delete a historyItem](../api/projectrome-delete-historyitem.md) | No Content | Delete the specified **historyItem** for that activity.| +|[Create or replace activityHistoryItem](../api/projectrome-put-historyitem.md) | [activityHistoryItem](projectrome-historyitem.md) | Create or replace an existing **activityHistoryItem** for that activity (upsert). The ID needs to be a GUID.| +|[Delete a activityHistoryItem](../api/projectrome-delete-historyitem.md) | No Content | Delete the specified **activityHistoryItem** for that activity.| ## Properties When an app creates a session, a **historyItem** object should be added to the * |userTimezone | String | Optional. The timezone in which the user's device used to generate the activity was located at activity creation time. Values supplied as Olson IDs in order to support cross-platform representation.| |createdDateTime | DateTimeOffset | Set by the server. DateTime in UTC when the object was created on the server.| |lastModifiedDateTime | DateTimeOffset | Set by the server. DateTime in UTC when the object was modified on the server.|-|id | String | Required. Client-set GUID for the **historyItem** object.| -|startedDateTime | DateTimeOffset | Required. UTC DateTime when the **historyItem** (activity session) was started. Required for timeline history.| -|lastActiveDateTime | DateTimeOffset | Optional. UTC DateTime when the **historyItem** (activity session) was last understood as active or finished - if null, **historyItem** status should be Ongoing.| -|expirationDateTime | DateTimeOffset | Optional. UTC DateTime when the **historyItem** will undergo hard-delete. Can be set by the client.| +|id | String | Required. Client-set GUID for the **activityHistoryItem** object.| +|startedDateTime | DateTimeOffset | Required. UTC DateTime when the **activityHistoryItem** (activity session) was started. Required for timeline history.| +|lastActiveDateTime | DateTimeOffset | Optional. UTC DateTime when the **activityHistoryItem** (activity session) was last understood as active or finished - if null, **activityHistoryItem** status should be Ongoing.| +|expirationDateTime | DateTimeOffset | Optional. UTC DateTime when the **activityHistoryItem** will undergo hard-delete. Can be set by the client.| |activeDurationSeconds | int | Optional. The duration of active user engagement. if not supplied, this is calculated from the **startedDateTime** and **lastActiveDateTime**.| ## Relationships The following is a JSON representation of the resource. "activeDurationSeconds" ], "keyProperty": "id",- "@odata.type": "microsoft.graph.historyItem" + "@odata.type": "microsoft.graph.activityHistoryItem" }--> ```json |
v1.0 | Projectrome Imageinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/projectrome-imageinfo.md | A complex type for representing the **attribution** property in the [visualInfo] ## JSON Representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Projectrome Notification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/projectrome-notification.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. ```json { "targetHostName": "String",- "appNotificationid": "String (identifier)", + "appNotificationId": "String (identifier)", "groupName": "String", "targetPolicy": {"@odata.type": "microsoft.graph.targetPolicyEndpoints"}, "payload": {"@odata.type": "microsoft.graph.payloadTypes"}, |
v1.0 | Protectdonotforwardaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/protectdonotforwardaction.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Provisionedidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/provisionedidentity.md | Describes the identity associated with the provisioning object summary event. In ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Provisionedplan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/provisionedplan.md | Title: "provisionedPlan resource type" -description: "The **provisionedPlans** property of the user entity and the organization entity is a collection of **provisionedPlan**." +description: "The provisionedPlans property of the user entity and the organization entity is a collection of provisionedPlan objects." ms.localizationpriority: medium doc_type: resourcePageType -+ # provisionedPlan resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The **provisionedPlans** property of the [user](user.md) entity and the [organization](organization.md) entity is a collection of **provisionedPlan**. +Used by the **provisionedPlans** property of the [user](user.md) entity and the [organization](organization.md) entity. ## Properties The **provisionedPlans** property of the [user](user.md) entity and the [organiz ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Provisioningerrorinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/provisioningerrorinfo.md | Describes the status of the provisioning event and the associated errors. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Provisioningserviceprincipal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/provisioningserviceprincipal.md | Represents the service principal used for provisioning. Inherits from [identity] ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Provisioningstatusinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/provisioningstatusinfo.md | Describes the status of the provisioning summary event. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Publicclientapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/publicclientapplication.md | Specifies settings for nonweb app or nonweb API (for example, mobile or other pu |redirectUris|String collection| Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Quota | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/quota.md | The **quota** resource provides details about space constraints on a [drive](dri ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Rankedemailaddress | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/rankedemailaddress.md | Represents a ranked email address. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Recipient | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/recipient.md | Represents information about a user in the sending or receiving end of an event, ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Recommendationbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/recommendationbase.md | None. |recommendationType|recommendationType|Friendly shortname to identify the [recommendation](../resources/recommendation.md). The possible values are: `adfsAppsMigration`, `enableDesktopSSO`, `enablePHS`, `enableProvisioning`, `switchFromPerUserMFA`, `tenantMFA`, `thirdPartyApps`, `turnOffPerUserMFA`, `useAuthenticatorApp`, `useMyApps`, `staleApps`, `staleAppCreds`, `applicationCredentialExpiry`, `servicePrincipalKeyExpiry`, `adminMFAV2`, `blockLegacyAuthentication`, `integratedApps`, `mfaRegistrationV2`, `pwagePolicyNew`, `passwordHashSync`, `oneAdmin`, `roleOverlap`, `selfServicePasswordReset`, `signinRiskPolicy`, `userRiskPolicy`, `verifyAppPublisher`, `privateLinkForAAD`, `appRoleAssignmentsGroups`, `appRoleAssignmentsUsers`, `managedIdentity`, `overprivilegedApps`, `unknownFutureValue`, `longLivedCredentials`, `aadConnectDeprecated`, `adalToMsalMigration`, `ownerlessApps`, `inactiveGuests`, `aadGraphDeprecationApplication`, `aadGraphDeprecationServicePrincipal`, `mfaServerDeprecation`. Also, please 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): `longLivedCredentials`, `aadConnectDeprecated`, `adalToMsalMigration`, `ownerlessApps`, `inactiveGuests`. | |releaseType|releaseType|The current release type of the recommendation. The possible values are: `preview`, `generallyAvailable`, `unknownFutureValue`. | |remediationImpact|String|Description of the impact on users of the remediation. Only applies to [recommendations](../resources/recommendation.md) with **category** set to `identitySecureScore`.|+|requiredLicenses|requiredLicenses|The required licenses to view the recommendation. The possible values are: `notApplicable`, `microsoftEntraIdFree`, `microsoftEntraIdP1`, `microsoftEntraIdP2`, `microsoftEntraIdGovernance`, `microsoftEntraWorkloadId`, `unknownFutureValue`.| |status|recommendationStatus| Indicates the status of the [recommendation](../resources/recommendation.md) based on user or system action. The possible values are: `active`, `completedBySystem`, `completedByUser`, `dismissed`, `postponed`, `unknownFutureValue`. By default, a recommendation's **status** is set to `active` when the recommendation is first generated. **Status** is set to `completedBySystem` when our service detects that a recommendation which was previously active no longer applies. | ## Relationships The following JSON representation shows the resource type. "String" ], "releaseType": "String",+ "requiredLicenses": "String", "impactType": "String", "impactStartDateTime": "String (timestamp)", "insights": "String", |
v1.0 | Recommendations Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/recommendations-api-overview.md | Title: "Use the Microsoft Entra recommendations API to implement Microsoft Entra description: "Microsoft Entra recommendations are personalized and actionable insights for you to implement Microsoft Entra ID best practices in your tenant." ms.localizationpriority: medium -doc_type: resourcePageType Last updated 02/10/2023 |
v1.0 | Recurrencerange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/recurrencerange.md | Use the **type** property to specify the different types of **recurrenceRange**. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Recyclebin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/recyclebin.md | -doc_type: apiPageType # recycleBin resource type |
v1.0 | Recyclebinitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/recyclebinitem.md | -doc_type: apiPageType # recycleBinItem resource type |
v1.0 | Redirecturisettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/redirecturisettings.md | Specifies the index of the URLs where user tokens are sent for sign-in. This is ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Redundantassignmentalertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/redundantassignmentalertconfiguration.md | Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrole |alertDefinition|[unifiedRoleManagementAlertDefinition](../resources/unifiedrolemanagementalertdefinition.md)| The definition of the alert that contains its description, impact, and measures to mitigate or prevent it. Supports `$expand`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Referenceattachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/referenceattachment.md | None ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Regexreplacetransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/regexreplacetransformation.md | + + Title: "regexReplaceTransformation resource type" +description: "Creates a new value by performing a regex replacement on the input." ++ms.localizationpriority: medium ++++# regexReplaceTransformation resource type ++Namespace: microsoft.graph +++Creates a new value by performing a regex replacement on the input. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|additionalAttributes|[sourcedAttribute](../resources/sourcedattribute.md) collection|Additional attributes that can be referenced within the replacement string.| +|input|[transformationAttribute](../resources/transformationattribute.md)|Provides the source for the transformation. This parameter is required if it's the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|regex|String|The regular expression to be applied on the input directory attribute or constant.| +|replacement|String|The transformation output replacement pattern with regular expression output group and input parameter group reference.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.regexReplaceTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.regexReplaceTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "regex": "String", + "replacement": "String", + "additionalAttributes": [ + { + "@odata.type": "microsoft.graph.sourcedAttribute" + } + ] +} +``` |
v1.0 | Regionalandlanguagesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/regionalandlanguagesettings.md | Title: "regionalAndLanguageSettings resource type" description: "A resource representing a users regional and language preferences" ms.localizationpriority: medium + doc_type: resourcePageType |
v1.0 | Regionalformatoverrides | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/regionalformatoverrides.md | Title: "regionalFormatOverrides resource type" description: "A resource representing regional formatting overrides for calendars, dates, and times." ms.localizationpriority: medium + doc_type: resourcePageType # regionalFormatOverrides resource type |
v1.0 | Registrationenforcement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/registrationenforcement.md | Enforce registration at sign-in time. This can currently only be used to remind 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.registrationEnforcement" |
v1.0 | Reminder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/reminder.md | A reminder for an [event](event.md) in a user [calendar](calendar.md). ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Removeaccessapplyaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/removeaccessapplyaction.md | None. 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.removeAccessApplyAction" |
v1.0 | Report M365defender Reports Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/report-m365defender-reports-overview.md | Title: "Reports API overview for attack simulation training as part of Microsoft description: "This section describes reporting capabilities of Microsoft Defender for Office 365, specifically APIs that access reports on a tenant's participation in attack simulation training." ms.localizationpriority: high -doc_type: resourcePageType # Reports API overview for attack simulation training as part of Microsoft Defender for Office 365 |
v1.0 | Reportroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/reportroot.md | Title: "reportRoot resource type" -description: "Represents a container for Microsoft Entra ID reporting resources." +description: "Represents a container for Microsoft Entra ID and Microsoft 365 reporting resources." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a container for Microsoft Entra ID reporting resources. +Represents a container for Microsoft Entra ID and Microsoft 365 reporting resources. ## Methods -None. +### 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. | ++### 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. | ++### 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. | +| [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. | +| [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. | ++### 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. | +| [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. | +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | +| [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. | ++### 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 | +|:|:|:--| +| [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. | ++### 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. | ++### 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. | +| [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. | ++### 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. | +| [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. | +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | +| [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. | +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | ++### 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 | +|:|:|:--| +| [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. | ++### 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. | +| [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. | ## Properties+ None. ## Relationships-| Relationship | Type | Description | -| :-- | : | : | -| appCredentialSignInActivities | [appCredentialSignInActivity](../resources/appcredentialsigninactivity.md) collection | Represents a collection of sign-in activities of application credentials. | -| applicationSignInDetailedSummary | [applicationSignInDetailedSummary](../resources/applicationsignindetailedsummary.md) collection | Represents a detailed summary of an application sign-in. | -| authenticationMethods | [authenticationMethodsRoot](../resources/authenticationmethodsroot.md) | Container for navigation properties for Microsoft Entra authentication methods resources. | -| credentialUserRegistrationDetails | [credentialUserRegistrationDetails](../resources/credentialuserregistrationdetails.md) collection | Details of the usage of self-service password reset and multifactor authentication (MFA) for all registered users. | -| dailyPrintUsageByPrinter | [printUsageByPrinter](../resources/printusagebyprinter.md) collection | Retrieve a list of daily print usage summaries, grouped by printer. | -| dailyPrintUsageByUser | [printUsageByUser](../resources/printusagebyuser.md) collection | Retrieve a list of daily print usage summaries, grouped by user. | -| monthlyPrintUsageByPrinter | [printUsageByPrinter](../resources/printusagebyprinter.md) collection | Retrieve a list of monthly print usage summaries, grouped by printer. | -| monthlyPrintUsageByUser | [printUsageByUser](../resources/printusagebyuser.md) collection | Retrieve a list of monthly print usage summaries, grouped by user. | -| partners | [partners](../resources/partners.md) | Represents billing details for a Microsoft direct partner. | -| security | [securityReportsRoot](../resources/securityreportsroot.md) | Provides the ability to launch a simulated phishing attack that organizations can learn from. | -| servicePrincipalSignInActivities | [servicePrincipalSignInActivity](../resources/serviceprincipalsigninactivity.md) collection | Represents a collection of sign-in activities of service principals. | -| serviceActivity | [serviceActivity](../resources/serviceactivity.md) | Reports that relate to tenant-level authentication activities in Microsoft Entra. | -| sla | [serviceLevelAgreementRoot](../resources/servicelevelagreementroot.md) | Reports that relate to tenant-level Microsoft Entra SLA attainment. | -| userCredentialUsageDetails | [userCredentialUsageDetails](../resources/usercredentialusagedetails.md) collection | Represents the self-service password reset (SSPR) usage for a given tenant. | -|userInsights|[userInsightsRoot](../resources/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. | +| 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. | +| 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. | ## JSON representation+ The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Reportsuspiciousactivitysettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/reportsuspiciousactivitysettings.md | Defines the report suspicious activity settings for the tenant, whether it's ena 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.reportSuspiciousActivitySettings" |
v1.0 | Requiredresourceaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/requiredresourceaccess.md | Specifies the set of OAuth 2.0 permission scopes and app roles under the specifi ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Resourcedata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/resourcedata.md | description: "Represents the resource data attached to the change notification s ms.localizationpriority: medium doc_type: resourcePageType+ # resourceData resource type None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Responsestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/responsestatus.md | You can get the response status of an attendee or organizer through the **respon ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Resulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/resulttemplate.md | The following is a JSON representation of the resource. "optionalProperties": [ ],- "@odata.type": "microsoft.graph.resultTemplate", - "baseType": null + "@odata.type": "microsoft.graph.resultTemplate" }--> ```json {- "resultTemplateId": { - "displayName": "String", - "body": "Json schema" - } + "displayName": "String", + "body": "Json schema" } ``` |
v1.0 | Riskdetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/riskdetection.md | Title: "riskDetection resource type" -description: "Represents all risk detections in AzureAD tenants." +description: "Represents all risk detections in a Microsoft Entra tenant." ms.localizationpriority: medium doc_type: resourcePageType + # riskDetection resource type Namespace: microsoft.graph For more information about risk detection, see [Microsoft Entra ID Protection](/ |lastUpdatedDateTime|DateTimeOffset|Date and time that the risk detection was last updated. | |location|[signInLocation](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.|-|riskEventType|String|The type of risk event detected. The possible values are `adminConfirmedUserCompromised`, `anomalousUserActivity`, `anonymizedIPAddress`, `generic`, `investigationsThreatIntelligence`, `investigationsThreatIntelligenceSigninLinked`,`leakedCredentials`, `maliciousIPAddress`, `maliciousIPAddressValidCredentialsBlockedIP`, `malwareInfectedIPAddress`, `mcasImpossibleTravel`, `mcasSuspiciousInboxManipulationRules`, `suspiciousAPITraffic`, `suspiciousIPAddress`, `unfamiliarFeatures`, `unlikelyTravel`, `userReportedSuspiciousActivity`. <br/> For more information about each value, see [Risk types and detection](/entra/id-protection/concept-identity-protection-risks#risk-types-and-detection).| +|riskEventType|String|The type of risk event detected. The possible values are `adminConfirmedUserCompromised`, `anomalousUserActivity`, `anonymizedIPAddress`,`attackerinTheMiddle`,`attemptedPRTAccess`, `generic`, `investigationsThreatIntelligence`, `investigationsThreatIntelligenceSigninLinked`,`leakedCredentials`, `maliciousIPAddress`, `maliciousIPAddressValidCredentialsBlockedIP`, `malwareInfectedIPAddress`, `mcasImpossibleTravel`,`mcasFinSuspiciousFileAccess`, `mcasSuspiciousInboxManipulationRules`,`nationStateIP`, `suspiciousAPITraffic`, `suspiciousIPAddress`,`suspiciousSendingPatterns`, `unfamiliarFeatures`, `unlikelyTravel`, `userReportedSuspiciousActivity`. <br/> For more information about each value, see [Risk types and detection](/entra/id-protection/concept-identity-protection-risks#risk-types-and-detection).| |riskDetail|riskDetail|Details of the detected risk. The possible values are: `none`, `adminGeneratedTemporaryPassword`, `userPerformedSecuredPasswordChange`, `userPerformedSecuredPasswordReset`, `adminConfirmedSigninSafe`, `aiConfirmedSigninSafe`, `userPassedMFADrivenByRiskBasedPolicy`, `adminDismissedAllRiskForUser`, `adminConfirmedSigninCompromised`, `hidden`, `adminConfirmedUserCompromised`, `unknownFutureValue`, `adminConfirmedServicePrincipalCompromised`, `adminDismissedAllRiskForServicePrincipal`, `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): `adminConfirmedServicePrincipalCompromised` , `adminDismissedAllRiskForServicePrincipal` , `m365DAdminDismissedDetection`. <br/><br />**Note:** Details for this property are only available for Microsoft Entra ID P2 customers. P1 customers will be returned `hidden`.| |riskLevel|riskLevel|Level of the detected risk. The possible values are `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`. <br />**Note:** Details for this property are only available for Microsoft Entra ID P2 customers. P1 customers will be returned `hidden`.| |riskState|riskState|The state of a detected risky user or sign-in. The possible values are `none`, `confirmedSafe`, `remediated`, `dismissed`, `atRisk`, `confirmedCompromised`, and `unknownFutureValue`. | |
v1.0 | Riskprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/riskprofile.md | description: "Contains information for human and workload identity counts in a s ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Riskserviceprincipalactivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/riskserviceprincipalactivity.md | Represents the risk activity of a Microsoft Entra service principal as determine | Property | Type |Description| |:|:--|:-|-|riskEventType|String|The type of risk event detected. The possible values are: `investigationsThreatIntelligence`, `generic`, `adminConfirmedServicePrincipalCompromised`, `suspiciousSignins`, `leakedCredentials`, `anomalousServicePrincipalActivity`, `maliciousApplication`, `suspiciousApplication`.| +| riskEventTypes|String collection|The type of risk event detected. The possible values are: `investigationsThreatIntelligence`, `generic`, `adminConfirmedServicePrincipalCompromised`, `suspiciousSignins`, `leakedCredentials`, `anomalousServicePrincipalActivity`, `maliciousApplication`, `suspiciousApplication`.| | detail | riskDetail | Details of the detected risk. <br>**Note:** Details for this property are only available for Workload Identities Premium customers. Events in tenants without that 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`.| ## JSON representation |
v1.0 | Riskuseractivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/riskuseractivity.md | Namespace: microsoft.graph | Property | Type |Description| |:|:--|:-| | detail | riskDetail | The possible values are `none`, `adminGeneratedTemporaryPassword`, `userPerformedSecuredPasswordChange`, `userPerformedSecuredPasswordReset`, `adminConfirmedSigninSafe`, `aiConfirmedSigninSafe`, `userPassedMFADrivenByRiskBasedPolicy`, `adminDismissedAllRiskForUser`, `adminConfirmedSigninCompromised`, `hidden`, `adminConfirmedUserCompromised`, `unknownFutureValue`. |-| riskEventType | String collection | The type of risk event detected. The possible values are: `anonymizedIPAddress`, `investigationsThreatIntelligence`, `investigationsThreatIntelligenceSigninLinked`,`leakedCredentials`, `maliciousIPAddress`, `maliciousIPAddressValidCredentialsBlockedIP`, `malwareInfectedIPAddress`, `mcasImpossibleTravel`, `mcasSuspiciousInboxManipulationRules`, `suspiciousAPITraffic`, `suspiciousIPAddress`, `unfamiliarFeatures`, `unlikelyTravel`. <br/>For more information about each value, see [Risk types and detection](/entra/id-protection/concept-identity-protection-risks#risk-types-and-detection). | +| riskEventTypes | String collection | The type of risk event detected. The possible values are: `anonymizedIPAddress`, `investigationsThreatIntelligence`, `investigationsThreatIntelligenceSigninLinked`,`leakedCredentials`, `maliciousIPAddress`, `maliciousIPAddressValidCredentialsBlockedIP`, `malwareInfectedIPAddress`, `mcasImpossibleTravel`, `mcasSuspiciousInboxManipulationRules`, `suspiciousAPITraffic`, `suspiciousIPAddress`, `unfamiliarFeatures`, `unlikelyTravel`. <br/>For more information about each value, see [Risk types and detection](/entra/id-protection/concept-identity-protection-risks#risk-types-and-detection). | | eventTypes (deprecated) | riskEventType collection |List of risk event types. Deprecated. Use **riskEventType** instead. | ## JSON representation Namespace: microsoft.graph ```json { "eventTypes": ["String"],- "riskEventType": ["String"], + "riskEventTypes": ["String"], "detail": "String" } ``` |
v1.0 | Rolemanagementalert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/rolemanagementalert.md | None. |operations|[longRunningOperation](../resources/longrunningoperation.md) collection|Represents operations on resources that take a long time to complete and can run in the background until completion. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Rolesassignedoutsideprivilegedidentitymanagementalertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/rolesassignedoutsideprivilegedidentitymanagementalertincident.md | Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanag |Property|Type|Description| |:|:|:| |assigneeDisplayName|String|Display name of the subject that the incident applies to.|+|assignmentCreatedDateTime|DateTimeOffset|Date and time of assignment creation.| |assigneeId|String|The identifier of the subject that the incident applies to.| |assigneeUserPrincipalName|String|User principal name of the subject that the incident applies to. Applies to user principals.| |id|String|The identifier for an alert incident. For example, it could be a role assignment id if the incident represents a role assignment Inherited from [entity](../resources/entity.md). Supports `$filter` (`eq`, `ne`).| |
v1.0 | Rubriclevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/rubriclevel.md | A level of a rubric. See [educationRubric](educationrubric.md) for a description ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Samlidentitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/samlidentitysource.md | description: "Represents source for SAML identities." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Samlnameidclaim | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/samlnameidclaim.md | + + Title: "samlNameIdClaim resource type" +description: "A nameID claim to be included in the SAML tokens affected by this policy." ++ms.localizationpriority: medium ++++# samlNameIdClaim resource type ++Namespace: microsoft.graph +++A nameID claim included in the SAML tokens affected by this policy. ++Inherits from [customClaimBase](../resources/customclaimbase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|configurations|[customClaimConfiguration](../resources/customclaimconfiguration.md) collection|One or more configurations that describe how the claim is sourced and under what conditions. Inherited from [customClaimBase](../resources/customclaimbase.md).| +|nameIdFormat|samlNameIDFormat|Allows to specify the format of the saml nameID claim value. The possible values are: `default`, `unspecified`, `emailAddress`, `windowsDomainQualifiedName`, `persistent`, `unknownFutureValue`.| +|serviceProviderNameQualifier|String|Allows the specification of a service provider name qualifier reflected in the sAML response. The value provided must match one of the service provider names configured for the application and is only applicable for IdP-initiated applications (the sign-on URL should be empty for the IdP-initiated applications), in all other cases this value is ignored.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.samlNameIdClaim" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.samlNameIdClaim", + "configurations": [ + { + "@odata.type": "microsoft.graph.customClaimConfiguration" + } + ], + "serviceProviderNameQualifier": "String", + "nameIdFormat": "String" +} +``` + |
v1.0 | Samlsinglesignonsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/samlsinglesignonsettings.md | Represents a container for settings related to SAML single sign-on. ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Scheduledpermissionsrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/scheduledpermissionsrequest.md | description: "Represents a request for permissions on resources in a target auth ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Schedulinggroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/schedulinggroup.md | A logical grouping of users in a [schedule](schedule.md) (usually by role). ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Schemaextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/schemaextension.md | description: "Schema extensions allow you to define a schema to extend and add s ms.localizationpriority: medium doc_type: resourcePageType+ # schemaExtension resource type (schema extensions) The owner app can move the extension through different states of a lifecycle, us ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Scopedrolemembership | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/scopedrolemembership.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ ],- "@odata.type": "microsoft.graph.scopedRoleMembership" + "@odata.type": "microsoft.graph.scopedRoleMembership", + "baseType": "microsoft.graph.entity" }--> ```json |
v1.0 | Search Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/search-api-overview.md | Title: "Use the Microsoft Search API to query data" description: "Using the search API, apps can search Microsoft 365 data in the context of the authenticated user" ms.localizationpriority: high -doc_type: resourcePageType # Use the Microsoft Search API to query data See [Use search display layout](/graph/search-concept-display-layout) for exampl ## Guest search -The Search API enables guest users to search for items within SharePoint or OneDrive that have been shared with them. To access the list of guest users, go to the <a href="https://go.microsoft.com/fwlink/p/?linkid=2074830" target="_blank">Microsoft 365 admin center</a>, and in the left navigation, choose **Users**, and select **Guest users**. +The Search API enables guest users to search for items within SharePoint or OneDrive that have been shared with them. To access the list of guest users, go to the <a href="https://go.microsoft.com/fwlink/p/?linkid=2074830" target="_blank">Microsoft 365 admin center</a>, and in the left navigation, choose **Users**, and select **Guest users**. ## Error handling The search API has the following limitations: | externalItem | - | - | - | - | True | True | - | True | True | True | - | - | True | | list | - | - | - | - | True | True | - | True | True | True | - | - | True | | listItem | - | - | - | - | True | True | - | True | True | True | - | - | True |- | message | - | - | True | - | - | - | - | - | - | - | - | - | - | + | message | - | - | True | - | - | - | - | - | - | - | - | - | - | | person | - | - | - | - | - | - | - | - | - | - | True | - | - | | qna | True | True | - | - | - | - | - | - | - | - | - | True | - | | site | - | - | - | - | True | True | - | True | True | True | - | - | True | |
v1.0 | Searchhit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/searchhit.md | The following is a JSON representation of the resource. "description": "searchHit resource", "keywords": "", "section": "documentation",- "tocPath": "" + "tocPath": "", + "suppressions": [ + "Error: /resources/searchhit.md: + Property '_id' found in resource definition for 'microsoft.graph.searchHit', but not described in markdown table.", + "Error: /resources/searchhit.md: + Property '_score' found in resource definition for 'microsoft.graph.searchHit', but not described in markdown table.", + "Error: /resources/searchhit.md: + Property '_sortField' found in resource definition for 'microsoft.graph.searchHit', but not described in markdown table.", + "Error: /resources/searchhit.md: + Property '_summary' found in resource definition for 'microsoft.graph.searchHit', but not described in markdown table.", + "Error: /resources/searchhit.md: + Property '_source' found in resource definition for 'microsoft.graph.searchHit', but not described in markdown table." + ] }--> |
v1.0 | Secretinformationaccessawsresourcefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/secretinformationaccessawsresourcefinding.md | description: "View AWS resources that have privileges to read, modify, or delete ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Secretinformationaccessawsrolefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/secretinformationaccessawsrolefinding.md | description: "*View AWS identities that have privileges to read, modify, or dele ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Secretinformationaccessawsserverlessfunctionfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/secretinformationaccessawsserverlessfunctionfinding.md | description: "View AWS serverless functions that have privileges to read, modify ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Secretinformationaccessawsuserfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/secretinformationaccessawsuserfinding.md | description: "View AWS users that have privileges to read, modify, or delete sec ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Sectiongroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sectiongroup.md | A section group in a OneNote notebook. Section groups can contain sections and s ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sectionlinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sectionlinks.md | Links for opening a OneNote section. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Securescorecontrolprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/securescorecontrolprofiles.md | Represents a tenant's secure score per control data. By default, it returns all ## Properties -|Name |Type |Description | +|Property|Type|Description| |:--|:--|:--|-| azureTenantId | String | GUID string for tenant ID. | -| controlName | String | Name of the control. | -| title | String | Title of the control. | -| complianceInformation | [complianceInformation](complianceinformation.md) collection | The collection of compliance information associated with secure score control | -| controlCategory | String | Control action category (Account, Data, Device, Apps, Infrastructure). | -| actionType | String | Control action type (Config, Review, Behavior). | -| service | String | Service that owns the control (Exchange, Sharepoint, Microsoft Entra ID). | -| maxScore | String | Current obtained max score on specified date. | -| tier | String | Control tier (Core, Defense in Depth, Advanced.) | -| userImpact | String | User impact of implementing control (low, moderate, high). | -| implementationCost | String | Resource cost of implemmentating control (low, moderate, high). | -| rank | Int32 | Microsoft's stack ranking of control. | -| threats | String Collection | List of threats the control mitigates (accountBreach,dataDeletion,dataExfiltration,dataSpillage,elevationOfPrivilege,maliciousInsider,passwordCracking,phishingOrWhaling,spoofing). | -| deprecated | Boolean | Flag to indicate if a control is depreciated. | -| remediation | String | Description of what the control will help remediate. | -| remediationImpact | String | Description of the impact on users of the remediation. | -| actionUrl | String | URL to where the control can be actioned. | -| controlStateUpdates | [secureScoreControlStateUpdate](securescorecontrolstateupdate.md) collection | Flag to indicate where the tenant has marked a control (ignore, thirdParty, reviewed) (supports [update](../api/securescorecontrolprofiles-update.md)). | -| vendorInformation | [securityVendorInformation](securityvendorinformation.md) | +|actionType|String|Control action type (Config, Review, Behavior).| +|actionUrl|String|URL to where the control can be actioned.| +|azureTenantId|String|GUID string for tenant ID.| +|complianceInformation|[complianceInformation](complianceinformation.md) collection|The collection of compliance information associated with secure score control| +|controlCategory|String|Control action category (Account, Data, Device, Apps, Infrastructure).| +|controlName|String|Name of the control.| +|controlStateUpdates|[secureScoreControlStateUpdate](securescorecontrolstateupdate.md) collection|Flag to indicate where the tenant has marked a control (ignored, thirdParty, reviewed) (supports [update](../api/securescorecontrolprofiles-update.md)).| +|deprecated|Boolean|Flag to indicate if a control is depreciated.| +|id|String|Provider-generated GUID/unique identifier. Read-only. Required.| +|implementationCost|String|Resource cost of implemmentating control (low, moderate, high).| +|lastModifiedDateTime|DateTimeOffset|Time at which the control profile entity was last modified. The Timestamp type represents date and time| +|maxScore|String|Current obtained max score on specified date.| +|rank|Int32|Microsoft's stack ranking of control.| +|remediation|String|Description of what the control will help remediate.| +|remediationImpact|String|Description of the impact on users of the remediation.| +|service|String|Service that owns the control (Exchange, Sharepoint, Microsoft Entra ID).| +|threats|String collection|List of threats the control mitigates (accountBreach, dataDeletion, dataExfiltration, dataSpillage, elevationOfPrivilege, maliciousInsider, passwordCracking, phishingOrWhaling, spoofing).| +|tier|String|Control tier (Core, Defense in Depth, Advanced.)| +|title|String|Title of the control.| +|userImpact|String|User impact of implementing control (low, moderate, high).| +|vendorInformation|[securityVendorInformation](securityvendorinformation.md)|Complex type containing details about the security product/service vendor, provider, and subprovider (for example, vendor=Microsoft; provider=SecureScore). Required.| ## Relationships The following is a JSON representation of the resource. ```json {- "title": "String", - "azureTenantId": "String (identifier)", - "maxScore": 1024.13, "actionType": "String",- "service": "String", - "tier": "String", - "userImpact": "string", - "implementationCost ": "String", - "rank ": 100, - "threats": ["string"], - "deprecated ": false, - "remediation": "String", - "remediationImpact ": "String", "actionUrl": "String",- "controlStateUpdates": [{"@odata.type": "microsoft.graph.secureScoreControlStateUpdate"}], - "vendorInformation": {"@odata.type": "microsoft.graph.securityVendorInformation"}, + "azureTenantId": "String", "complianceInformation": [{"@odata.type": "microsoft.graph.complianceInformation"}],- "controlCategory": "string", - "lastModifiedDateTime": "String (timestamp)" + "controlCategory": "String", + "controlStateUpdates": [{"@odata.type": "microsoft.graph.secureScoreControlStateUpdate"}], + "deprecated": false, + "id": "String (identifier)", + "implementationCost": "String", + "lastModifiedDateTime": "String (timestamp)", + "maxScore": 1024.13, + "rank": 100, + "remediation": "String", + "remediationImpact": "String", + "service": "String", + "threats": ["String"], + "tier": "String", + "title": "String", + "userImpact": "String", + "vendorInformation": {"@odata.type": "microsoft.graph.securityVendorInformation"} }-- ``` |
v1.0 | Securescorecontrolstateupdate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/securescorecontrolstateupdate.md | Title: " secureScoreControlStateUpdate resource type" + Title: secureScoreControlStateUpdate resource type description: "This resource contains history of control states updated by user (control states include Default, Ignored, ThirdParty, Reviewed)." ms.localizationpriority: medium doc_type: resourcePageType- # secureScoreControlStateUpdate resource type - +# secureScoreControlStateUpdate resource type + Contains the history of the control states updated by the user (control states include Default, Ignored, ThirdParty, Reviewed). +## Properties + |Property |Type |Description | |:--|:--|:--| |assignedTo | string | Assign the control to the user who will take the action | |
v1.0 | Securescores | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/securescores.md | The following is a JSON representation of the resource. { "activeUserCount": "Int32", "averageComparativeScores": "Collection(microsoft.graph.SecureScore.averageComparativeScores)",- "averageScore": "Double", "azureTenantId": "Guid", "controlScores": "Collection(microsoft.graph.SecureScore.controlScores)",- "createdDate": "DateTimeOffset", "createdDateTime": "2019-02-07T20:33:53.156Z", "currentScore": "Int32", "enabledServices": "Collection(string)", |
v1.0 | Securesigninsessioncontrol | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/securesigninsessioncontrol.md | The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.secureSignInSessionControl",- "isEnabled": "Boolean", - "secureAppSessionMode": "String" + "isEnabled": "Boolean" } ``` |
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 None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Alertevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-alertevidence.md | This resource is the base type for the following evidence types: 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.security.alertEvidence" |
v1.0 | Security Analyzedemail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-analyzedemail.md | Contains metadata for email messages that are analyzed for security threats. |phishConfidenceLevel|String|The phish confidence level associated with the email| |policy|String|The action policy that took effect.| |policyAction|String|The action taken on the email based on the configured policy.|-|recipientEmailAddresses|String collection|Contains the email addresses of the recipients.| +|recipientEmailAddress|String|Contains the email address of the recipient.| |returnPath|String|A field that indicates where and how bounced emails are processed.| |senderDetail|[microsoft.graph.security.analyzedEmailSenderDetail](../resources/security-analyzedemailsenderdetail.md)|Sender details of the email.| |sizeInBytes|Int32| Size of the email in bytes.| |spamConfidenceLevel|String|Spam confidence of the email.| |subject|String|Subject of the email.|-|threatType|[microsoft.graph.security.threatType](#threattype-values)|Indicates the threat types. The possible values are: `unknown`, `spam`, `malware`, `phishing`, `none`, `unknownFutureValue`.| +|threatTypes|[microsoft.graph.security.threatType](#threattype-values) collection|Indicates the threat types. The possible values are: `unknown`, `spam`, `malware`, `phish`, `none`, `unknownFutureValue`.| |urls|[microsoft.graph.security.analyzedEmailUrl](../resources/security-analyzedemailurl.md) collection|A collection of the URLs in the email.| |urlsCount|Int32|The number of URLs in the email.| Contains metadata for email messages that are analyzed for security threats. |unknown| |spam| |malware|-|phishing| +|phish| |none| |unknownFutureValue| The following JSON representation shows the resource type. "senderDetail": { "@odata.type": "microsoft.graph.security.analyzedEmailSenderDetail" },- "recipientEmailAddresses": [ - "String" - ], + "recipientEmailAddress": "String", "distributionList": "String", "subject": "String", "returnPath": "String",- "directionality": "String", + "directionality": "microsoft.graph.security.antispamDirectionality", "originalDelivery": { "@odata.type": "microsoft.graph.security.analyzedEmailDeliveryDetail" }, The following JSON representation shows the resource type. "overrideSources": [ "String" ],- "threatType": "String", + "threatTypes": [ + "microsoft.graph.security.threatType" + ], "detectionMethods": [ "String" ], The following JSON representation shows the resource type. "policy": "String" } ```- |
v1.0 | Security Analyzedmessageevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-analyzedmessageevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.analyzedMessageEvidence" + "@odata.type": "microsoft.graph.security.analyzedMessageEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-api-overview.md | Title: "Use the Microsoft Graph security API" description: "The Microsoft Graph security API provides a unified interface and schema to integrate with security solutions from Microsoft and ecosystem partners." ms.localizationpriority: high -doc_type: resourcePageType # Use the Microsoft Graph security API You can create advanced hunting [Custom detection rules](/microsoft-365/security ### Quotas -1. [Get multiple rules](../api/security-detectionrule-list.md): 10 rules per minute per application, 300 rules per hour per application, 600 rules per hour per tenant -2. [Get a single rule](../api/security-detectionrule-get.md): 100 rules per minute per application, 1,500 rules per hour per application, 1,800 rules per hour per tenant -3. [Create rule](../api/security-detectionrule-post-detectionRules.md): 10 rules per minute per application, 1,500 rules per hour per application, 1,800 rules per hour per tenant -4. [Update rule](../api/security-detectionrule-update.md): 100 rules per minute per application, 1,500 rules per hour per application, 1,800 rules per hour per tenant +1. [Get multiple rules](../api/security-detectionrule-list.md): 10 rules per minute per application, 300 rules per hour per application, 600 rules per hour per tenant +2. [Get a single rule](../api/security-detectionrule-get.md): 100 rules per minute per application, 1,500 rules per hour per application, 1,800 rules per hour per tenant +3. [Create rule](../api/security-detectionrule-post-detectionRules.md): 10 rules per minute per application, 1,500 rules per hour per application, 1,800 rules per hour per tenant +4. [Update rule](../api/security-detectionrule-update.md): 100 rules per minute per application, 1,500 rules per hour per application, 1,800 rules per hour per tenant 5. [Delete rule](../api/security-detectionrule-delete.md): 100 rules per minute per application, 1,500 rules per hour per application, 1,800 rules per hour per tenant ## Alerts 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: +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. These [alert](security-alert.md) resources first pull alert data from security p Alerts from the following security providers are available via these rich alerts and incidents: - [Microsoft Entra ID Protection](/azure/active-directory/identity-protection/overview-identity-protection) - [Microsoft 365 Defender](/microsoft-365/security/defender/microsoft-365-defender?view=o365-worldwide&preserve-view=true)-- [Microsoft Defender for Cloud Apps](/cloud-app-security/monitor-alerts) +- [Microsoft Defender for Cloud Apps](/cloud-app-security/monitor-alerts) - [Microsoft Defender for Endpoint](/microsoft-365/security/defender-endpoint/microsoft-defender-endpoint?view=o365-worldwide&preserve-view=true)-- [Microsoft Defender for Identity](/defender-for-identity/alerts-overview) +- [Microsoft Defender for Identity](/defender-for-identity/alerts-overview) - [Microsoft Defender for Office 365](/microsoft-365/security/office-365-security/overview?view=o365-worldwide&preserve-view=true) - [Microsoft Purview Data Loss Prevention](/microsoft-365/compliance/dlp-learn-about-dlp?view=o365-worldwide&preserve-view=true) - ### Legacy alerts -These [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 the management of security issues across all integrated solutions. They enable applications to correlate alerts and context to improve threat protection and response. +> [!NOTE] +> The legacy alerts API is deprecated and will be removed by April 2026. We recommend that you migrate to the new [alerts and incidents](/graph/api/resources/security-alert) API. ++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 the management of security issues across all integrated solutions. They enable 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 security providers are available via this legacy **alert** resource. Support for GET alerts, PATCH alerts, and subscribe (via webhooks) is indicated in the following table. +Alerts from the following security providers are available via the legacy **alert** resource. Support for GET alerts, PATCH alerts, and subscribe (via webhooks) is indicated in the following table. | Security provider | <p align="center">GET alert</p>| <p align="center">PATCH alert</p>| <p align="center">Subscribe to alert</p>| |:|:|:--|:| Alerts from the following security providers are available via this legacy **ale \*\* 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 Identity alerts are available via the Microsoft Defender for Cloud Apps integration. This means you will 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). +\*\*\* 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). ## Attack simulation and training Alerts from the following security providers are available via this legacy **ale ## 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/). +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/). -Microsoft 365 services and apps create  alerts  when they detect a suspicious or malicious event or activity. Individual alerts provide valuable clues about a completed or ongoing attack. However, attacks typically employ various techniques against different types of entities, such as devices, users, and mailboxes. The result is multiple  alerts for multiple entities in your tenant. +Microsoft 365 services and apps create  alerts  when they detect a suspicious or malicious event or activity. Individual alerts provide valuable clues about a completed or ongoing attack. However, attacks typically employ various techniques against different types of entities, such as devices, users, and mailboxes. The result is multiple  alerts for multiple entities in your tenant. -Because piecing the individual alerts together to gain insight into an attack can be challenging and time-consuming, Microsoft 365 Defender automatically aggregates the alerts and their associated information into an [incident](security-incident.md). +Because piecing the individual alerts together to gain insight into an attack can be challenging and time-consuming, Microsoft 365 Defender automatically aggregates the alerts and their associated information into an [incident](security-incident.md). -Grouping related alerts into an incident gives you a comprehensive view of an attack. For example, you can see: +Grouping related alerts into an incident gives you a comprehensive view of an attack. For example, you can see: -- Where the attack started. -- What tactics were used. -- How far the attack has gone 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. +- Where the attack started. +- What tactics were used. +- How far the attack has gone 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 through incidents to create an informed cyber security response. It exposes a collection of incidents, with their related  [alerts](security-alert.md), that were flagged in your network, within the time range you specified in your environment retention policy. +The  [incident](security-incident.md) resource and its APIs allow you to sort through incidents to create an informed cyber security response. It exposes a collection of incidents, with their related  [alerts](security-alert.md), that were flagged in your network, within the time range you specified in your environment retention policy. ## Information protection The  [incident](security-incident.md) resource and its APIs allow you to sort > **Note:** We recommend that you use the [threat submission](https://github.com/microsoftgraph/microsoft-graph-docs/pull/16242/files#threat-submission) API instead. ++## 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. + ## Secure Score [Microsoft Secure Score](https://techcommunity.microsoft.com/t5/Security-Privacy-and-Compliance/Office-365-Secure-Score-is-now-Microsoft-Secure-Score/ba-p/182358) is a security analytics solution that gives you visibility into your security portfolio and how to improve it. With a single score, you can better understand what you have done to reduce your risk in Microsoft solutions. You can also compare your score with other organizations and see how your score has been trending over time. The [secureScore](securescores.md) and [secureScoreControlProfile](securescorecontrolprofiles.md) entities help you balance your organization's security and productivity needs while enabling the appropriate mix of security features. You can also project what your score will be after you adopt security features. The threat intelligence APIs (preview) allow you to operationalize intelligence ## Threat intelligence indicators (preview) +> [!NOTE] +> The [tiIndicator](tiindicator.md) entity is deprecated and will be removed by April 2026. + Threat indicators also referred to as indicators of compromise (IoCs), represent data about known threats, such as malicious files, URLs, domains, and IP addresses. Customers can generate indicators through internal threat intelligence gathering or acquire indicators from threat intelligence communities, licensed feeds, and other sources. These indicators are then used in various security tools to defend against related threats. The [tiIndicator](tiindicator.md) entity allows customers to feed threat indicators to Microsoft security solutions to take a block or alert action on a malicious activity, or to allow the activity that has been determined to be irrelevant to the organization and suppress actions for the indicator. To send an indicator, specify the Microsoft security solution intended to utilize the indicator and the action to take for that indicator. Threat indicators sent via the Microsoft Graph security API are available today The Microsoft Graph threat submission API helps organizations to submit a threat received by any user in a tenant. This empowers customers to report spam or suspicious emails, phishing URLs, or malware attachments they receive to Microsoft. Microsoft checks the submission against the organizational policies in effect and sends it to human graders for analysis. The result then helps tenant administrators understand the threat scanning verdict and adjust their organizational policy. Admins can also use the results to report legitimate emails to prevent them from getting blocked. -> **Note:** We recommend that you use this 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. +> **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) [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 availbe 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). +> **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. ## Common use cases The following are some of the most popular requests for working with the Microso | **Email analysis and remediation**||| |Query email metadata|[LIST analyzedemails](../api/security-collaborationroot-list-analyzedemails.md)|[https://graph.microsoft.com/beta/security/collaboration/analyzedemails?startTime={startTime}&endTime={endTime}](https://developer.microsoft.com/graph/graph-explorer?request=security/collaboration/analyzedemails?startTime={startTime}&endTime={endTime}&method=GET&version=beta&GraphUrl=https://graph.microsoft.com)| |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|[analyzedEmai: 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)| +|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) | + 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 Appliedcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-appliedcategory.md | - Title: "appliedCategory resource type" -description: "Represents the file plan descriptor of type category applied to a particular retention label." ---doc_type: resourcePageType ---# appliedCategory resource type --Namespace: microsoft.graph.security ---Represents the file plan descriptor of type category applied to a particular retention label. ---Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). --## Properties -|Property|Type|Description| -|:|:|:| -|displayName|String|Unique string that defines a category name applied to the label. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|subCategory|[microsoft.graph.security.subCategory](../resources/security-subcategory.md)|Represents the file plan descriptor for a subcategory under a specific category, which has been assigned to a particular retention label.| --## Relationships -None. --## JSON representation -The following is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.security.appliedCategory" -} >-``` json -{ - "@odata.type": "#microsoft.graph.security.appliedCategory", - "displayName": "String", - "subCategory": { - "@odata.type": "microsoft.graph.security.subCategory" - } -} -``` - |
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). |keywordFilter|String|Free text field to search non-indexed properties of the audit log.| |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|String collection of microsoft.graph.security.auditLogRecordType|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`.| +|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.| |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_.| The following JSON representation shows the resource type. "displayName": "String", "filterStartDateTime": "String (timestamp)", "filterEndDateTime": "String (timestamp)",- "recordTypeFilter": "String", + "recordTypeFilters": [ + "String" + ], "keywordFilter": "String", "serviceFilter": "String", "operationFilters": [ |
v1.0 | Security Authority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-authority.md | - Title: "authority resource type" -description: "Represents the file plan descriptor of type authority applied to a particular retention label." ---doc_type: resourcePageType ---# authority resource type --Namespace: microsoft.graph.security ---Represents the file plan descriptor of type authority applied to a particular retention label. ---Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). --## Properties -|Property|Type|Description| -|:|:|:| -|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| --## Relationships -None. --## JSON representation -The following is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.security.authority" -} >-``` json -{ - "@odata.type": "#microsoft.graph.security.authority", - "displayName": "String" -} -``` - |
v1.0 | Security Authoritytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-authoritytemplate.md | Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Specifies the underlying authority that describes the type of content to be retained and its retention schedule. +Specifies the underlying authority that describes the type of content to be retained and its retention schedule. Supports CRUD operations to apply and manage the [filePlanAuthority](security-fileplanauthority.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **authority** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources ## Properties |Property|Type|Description| |:|:|:|-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the authority. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|createdDateTime|DateTimeOffset|Represents the date and time in which the authority is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|id|String|Unique ID of the authority. Inherited from [microsoft.graph.entity](../resources/entity.md).| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the authority descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only. | +|createdDateTime|DateTimeOffset|Represents the date and time in which the authority descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the authority. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ## Relationships None. |
v1.0 | Security Azureresourceevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-azureresourceevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.azureResourceEvidence" + "@odata.type": "microsoft.graph.security.azureResourceEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Caseoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-caseoperation.md | An abstract entity that represents a long-running eDiscovery process. It contain - [Add to review set operation](../resources/security-ediscoveryaddtoreviewsetoperation.md) - [Tag operation](../resources/security-ediscoverytagoperation.md) - [Export operation](../resources/security-ediscoveryexportoperation.md)+- [Search export operation](../resources/security-ediscoverysearchexportoperation.md) Inherits from [entity](../resources/entity.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. |-| estimateStatistics | The operation represents searching against Microsoft 365 services such as Exchange, SharePoint, and OneDrive for Business. | -| holdUpdate | The operation represent updating legal hold (apply/remove) for custodians and non-custodial data sources. | index | The operation represents indexing data sources of custodians and non-custodial 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 non-custodial data sources. +| 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 |Member|Description| |:-|--|-| notStarted | The operation has not yet started. | +| notStarted | The operation hasn't yet started. | | submissionFailed | Submission of the operation failed. | | running | The operation is currently running. | | succeeded | The operation was successfully completed without any errors. | | partiallySucceeded | The operation completed, but there were errors. For error details, see [resultInfo](../resources/resultinfo.md). | | failed | The operation failed. For error details, see [resultInfo](../resources/resultinfo.md). |+| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ## Relationships None. ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Categorytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-categorytemplate.md | Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Specifies a group of similar types of content in a particular department. -+Specifies a group of similar types of content in a particular department. This resource supports CRUD operations to apply and manage the [filePlanAppliedCategory](security-fileplanappliedcategory.md) descriptor, and any [filePlanSubcategory](security-fileplansubcategory.md) descriptor for a [retentionLabel](security-retentionlabel.md). These file plan descriptors supplement a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources |[Create categories](../api/security-labelsroot-post-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Create a new [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.| |[Get categories](../api/security-categorytemplate-get.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.| |[Delete categories](../api/security-labelsroot-delete-categories.md)|None|Delete a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.|-|[List subCategories](../api/security-categorytemplate-list-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) collection|Get the subCategoryTemplate resources from the subCategories navigation property.| -|[Create subCategories](../api/security-categorytemplate-post-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md)|Create a new subCategoryTemplate object.| +|[List subcategories](../api/security-categorytemplate-list-subcategories.md)|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) collection|Get the subcategoryTemplate resources from the subcategories navigation property.| +|[Create subcategories](../api/security-categorytemplate-post-subcategories.md)|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md)|Create a new subcategoryTemplate object.| ## Properties |Property|Type|Description| |:|:|:|-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the category. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|createdDateTime|DateTimeOffset|Represents the date and time in which the category is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|displayName|String|Unique string that defines a category name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|id|String|Unique ID of the category. Inherited from [microsoft.graph.entity](../resources/entity.md).| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the category descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the category descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines a category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the category. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ## Relationships |Relationship|Type|Description| |:|:|:|-|subCategories|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) collection|Represents all subcategories under a particular category.| +|subcategories|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) collection|Represents all subcategories under a particular category.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Citation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-citation.md | - Title: "citation resource type" -description: "Represents the file plan descriptor of type citation applied to a particular retention label." ---doc_type: resourcePageType ---# citation resource type --Namespace: microsoft.graph.security ---Represents the file plan descriptor of type citation applied to a particular retention label. ---Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). --## Properties -|Property|Type|Description| -|:|:|:| -|citationJurisdiction|String|Represents the jurisdiction or agency that published the citation.| -|citationUrl|String|Represents the URL to the published citation.| -|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| --## Relationships -None. --## JSON representation -The following is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.security.citation" -} >-``` json -{ - "@odata.type": "#microsoft.graph.security.citation", - "displayName": "String", - "citationUrl": "String", - "citationJurisdiction": "String" -} -``` - |
v1.0 | Security Citationtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-citationtemplate.md | Title: "citationTemplate resource type" -description: "The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted." +description: "Represents the specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted." ms.localizationpriority: medium Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted. -+Represents the specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted. This resource supports CRUD operations to apply and manage the [filePlanCitation](security-fileplancitation.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **citation** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources |:|:|:| |citationJurisdiction|String|Represents the jurisdiction or agency that published the citation.| |citationUrl|String|Represents the URL to the published citation.|-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the citation. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|createdDateTime|DateTimeOffset|Represents the date and time in which the citation is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|id|String|Unique ID of the citation. Inherited from [microsoft.graph.entity](../resources/entity.md).| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the citation descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the citation descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the citation. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ## Relationships None. ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Cloudapplicationevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-cloudapplicationevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.cloudApplicationEvidence" + "@odata.type": "microsoft.graph.security.cloudApplicationEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Contentinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-contentinfo.md | The following is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.security.contentInfo", "contentFormat": "String",- "format": "String", "identifier": "String", "metadata": [ { |
v1.0 | Security Datasource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-datasource.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Datasourcecontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-datasourcecontainer.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Department | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-department.md | - Title: "department resource type" -description: "Represents the file plan descriptor of type department applied to a particular retention label." ---doc_type: resourcePageType ---# department resource type --Namespace: microsoft.graph.security ---Represents the file plan descriptor of type department applied to a particular retention label. ---Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). --## Properties -|Property|Type|Description| -|:|:|:| -|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| --## Relationships -None. --## JSON representation -The following is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.security.department" -} >-``` json -{ - "@odata.type": "#microsoft.graph.security.department", - "displayName": "String" -} -``` - |
v1.0 | Security Departmenttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-departmenttemplate.md | Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Specifies the department or business unit of an organization to which a label belongs. -+Specifies the department or business unit of an organization to which a label belongs. This resource supports CRUD operations to apply and manage the [filePlanDepartment](security-fileplandepartment.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **department** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources ## Properties |Property|Type|Description| |:|:|:|-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the department. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|createdDateTime|DateTimeOffset|Represents the date and time in which the department is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|id|String|Unique ID of the department. Inherited from [microsoft.graph.entity](../resources/entity.md).| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the department descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the department descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the department. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ## Relationships None. |
v1.0 | Security Detectionrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-detectionrule.md | Title: "detectionRule resource type" -description: "Represents a custom detection rule written in **Advanced hunting** to automatically recognize security events when they occur, and to trigger alerts and response actions." +description: "Represents a custom detection rule written in Advanced hunting to automatically recognize security events when they occur, and to trigger alerts and response actions." ms.localizationpriority: medium Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Custom detection rules are types of protection rules you can design and tweak using [advanced hunting](../api/security-security-runhuntingquery.md) queries. +Represents a custom detection rule written in **Advanced hunting** to automatically recognize security events when they occur, and to trigger alerts and response actions. ++Custom detection rules are types of protection rules that you can design and tweak by using [advanced hunting](../api/security-security-runhuntingquery.md) queries. These rules let you proactively monitor various events and system states, including suspected breach activity and misconfigured endpoints. A custom detection rule automatically recognizes security events when they occur, and triggers alerts and response actions.-You can set them to run at regular intervals, generating alerts and taking response actions whenever there are matches. +You can set them to run at regular intervals, generating alerts and taking response actions whenever matches occur. Inherits from [microsoft.graph.security.protectionRule](../resources/security-protectionrule.md). ## Methods | Method | Return type | Description | |:--|:--|:|-| [List detectionRules](../api/security-detectionrule-list.md) | [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) collection | Get a list of the [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) objects and their properties. | -| [Get detectionRule](../api/security-detectionrule-get.md) | [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) | Read the properties and relationships of a [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) object. | -| [Create detectionRule](../api/security-detectionrule-post-detectionRules.md) | [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) | Create a [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md). | -| [Update detectionRule](../api/security-detectionrule-update.md) | [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) | Update the properties of a [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) object. | -| [Delete detectionRule](../api/security-detectionrule-delete.md) | None | Delete a [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) object. | +| [List](../api/security-detectionrule-list.md) | [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) collection | Get a list of the [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) objects and their properties. | +| [Get](../api/security-detectionrule-get.md) | [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) | Read the properties and relationships of a [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) object. | +| [Create](../api/security-detectionrule-post-detectionRules.md) | [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) | Create a [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md). | +| [Update](../api/security-detectionrule-update.md) | [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) | Update the properties of a [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) object. | +| [Delete](../api/security-detectionrule-delete.md) | None | Delete a [microsoft.graph.security.detectionRule](../resources/security-detectionrule.md) object. | ## Properties | Property | Type | Description | |
v1.0 | Security Deviceevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-deviceevidence.md | Inherits from [alertEvidence](../resources/security-alertevidence.md). 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.security.deviceEvidence" + "@odata.type": "microsoft.graph.security.deviceEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Dispositionreviewstage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-dispositionreviewstage.md | For details, see [Disposition of content](/microsoft-365/compliance/disposition) |id|String|Unique ID for each stage. | |name|String|Name representing each stage within a collection. | |reviewersEmailAddresses|String collection|A collection of reviewers at each stage. |-|stageNumber|Int32|The sequence number for each stage of the disposition review. | +|stageNumber|String|The unique sequence number for each stage of the disposition review. | ## Relationships None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", Here's a JSON representation of the resource. { "@odata.type": "#microsoft.graph.security.dispositionReviewStage", "id": "String (identifier)",- "stageNumber": "Integer", + "stageNumber": "String", "name": "String", "reviewersEmailAddresses": [ "String" |
v1.0 | Security Downgradejustification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-downgradejustification.md | Represents the user input on why downgrade was performed. The downgrade justific 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.security.downgradeJustification" |
v1.0 | Security Ediscoverycasesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoverycasesettings.md | Inherits from [entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
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). |createdBy|[identitySet](../resources/identityset.md)| The user who initiated the export operation.| |createdDateTime|DateTimeOffset| The date and time the export was created.| |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. | +|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. | Inherits from [caseOperation](../resources/security-caseoperation.md). ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Ediscoveryfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryfile.md | IM |Sent date. |tags|[microsoft.graph.security.ediscoveryReviewTag](../resources/security-ediscoveryreviewtag.md) collection|Tags associated with the file.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Ediscoveryholdoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryholdoperation.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Ediscoveryindexoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryindexoperation.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Ediscoverynoncustodialdatasource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoverynoncustodialdatasource.md | Inherits from [dataSourceContainer](../resources/security-datasourcecontainer.md |lastIndexOperation|[microsoft.graph.security.ediscoveryIndexOperation](../resources/security-ediscoveryindexoperation.md)|Operation entity that represents the latest indexing for the non-custodial data source.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Ediscoveryreviewsetquery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryreviewsetquery.md | The following is a JSON representation of the resource. "blockType": "resource", "keyProperty": "id", "@odata.type": "microsoft.graph.security.ediscoveryReviewSetQuery",+ "baseType": "microsoft.graph.security.ediscoverySearch", "openType": false } --> |
v1.0 | Security Ediscoveryreviewtag | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryreviewtag.md | Represents an eDiscovery tag, which is used to mark documents during review to s |childTags|[microsoft.graph.security.ediscoveryReviewTag](../resources/security-ediscoveryreviewtag.md) collection|Returns the tags that are a child of a tag.| |parent|[microsoft.graph.security.ediscoveryReviewTag](../resources/security-ediscoveryreviewtag.md)|Returns the parent tag of the specified tag.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
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 |[Delete ediscoverySearch](../api/security-ediscoverycase-delete-searches.md)|None|Delete an [microsoft.graph.security.ediscoverySearch](../resources/security-ediscoverysearch.md) object.| |[estimateStatistics](../api/security-ediscoverysearch-estimatestatistics.md)|None|Run an estimate statistics operation on the data contained in the eDiscovery search.| |[purgeData](../api/security-ediscoverysearch-purgedata.md)|None|Run a purge data operation on the Teams data contained in the eDiscovery search.|+|[exportReport](../api/security-ediscoverysearch-exportreport.md)|None|Export an item report from an estimated [ediscoverySearch](../resources/security-ediscoverysearch.md).| +|[exportResult](../api/security-ediscoverysearch-exportresult.md)|None|Export results from an estimated [ediscoverySearch](../resources/security-ediscoverysearch.md).| |[List additionalSources](../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 additionalSources](../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).| |[List ediscoveryEstimateOperation](../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 is a JSON representation of the resource. "contentQuery": "String", "dataSourceScopes": "String" }-``` +``` |
v1.0 | Security Ediscoverysearchexportoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/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 [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.| +|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).| ++### 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 Emailcontentthreatsubmission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-emailcontentthreatsubmission.md | Inherits from [emailThreatSubmission](../resources/security-emailthreatsubmissio None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Emailthreatsubmission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-emailthreatsubmission.md | Inherits from [threatSubmission](../resources/security-threatsubmission.md). Bas None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Emailthreatsubmissionpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-emailthreatsubmissionpolicy.md | Inherits from [entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Eventpropagationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-eventpropagationresult.md | The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.security.eventPropagationResult",- "workload": "String", + "serviceName": "String", "location": "String", "status": "String", "statusInformation": "String" |
v1.0 | Security Eventqueries | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-eventqueries.md | - Title: "eventQuery resource type" -description: "Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event." --doc_type: resourcePageType ---# eventQuery resource type --Namespace: microsoft.graph.security ---Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event. --## Properties -|Property|Type|Description| -|:|:|:| -|queryType|microsoft.graph.security.queryType|Represents the type of query associated with an event. 'files' for SPO and ODB and 'messages' for EXO.The possible values are: `files`, `messages`, `unknownFutureValue`.| -|query|String|Represents unique identification for the query. 'Asset ID' for SharePoint Online and OneDrive for Business, 'keywords' for Exchange Online.| --## Relationships -None. --## JSON representation -The following is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.security.eventQueries" -} >-``` json -{ - "@odata.type": "#microsoft.graph.security.eventQueries", - "queryType": "String", - "query": "String" -} -``` -- |
v1.0 | Security Eventquery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-eventquery.md | + + Title: "eventQuery resource type" +description: "Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event." ++ms.localizationpriority: medium +++# eventQuery resource type ++Namespace: microsoft.graph.security +++Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event. ++## Properties +|Property|Type|Description| +|:|:|:| +|queryType|microsoft.graph.security.queryType|Represents the type of query associated with an event. 'files' for SPO and ODB and 'messages' for EXO.The possible values are: `files`, `messages`, `unknownFutureValue`.| +|query|String|Represents unique identification for the query. 'Asset ID' for SharePoint Online and OneDrive for Business, 'keywords' for Exchange Online.| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.eventQuery" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.eventQuery", + "queryType": "String", + "query": "String" +} +``` ++ |
v1.0 | Security Fileevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.fileEvidence" + "@odata.type": "microsoft.graph.security.fileEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Filehash | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-filehash.md | 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.security.fileHash" |
v1.0 | Security Fileplanappliedcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplanappliedcategory.md | + + Title: "filePlanAppliedCategory resource type" +description: "Represents the file plan descriptor of type category applied to a particular retention label." ++ms.localizationpriority: medium ++++# filePlanAppliedCategory resource type ++Namespace: microsoft.graph.security +++Represents a file plan descriptor that specifies a group of similar types of content in a department. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete an **filePlanAppliedCategory** descriptor, use the [categoryTemplate](security-categorytemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a file plan category name applied to the label. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|subcategory|[microsoft.graph.security.filePlanSubcategory](../resources/security-fileplansubcategory.md)|Represents the file plan descriptor for a subcategory under a specific category, which has been assigned to a particular retention label.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanAppliedCategory" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanAppliedCategory", + "displayName": "String", + "subCategory": { + "@odata.type": "microsoft.graph.security.filePlanSubcategory" + } +} +``` + |
v1.0 | Security Fileplanauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplanauthority.md | + + Title: "filePlanAuthority resource type" +description: "Represents the file plan descriptor of type authority applied to a particular retention label." ++ms.localizationpriority: medium ++++# filePlanAuthority resource type ++Namespace: microsoft.graph.security +++Represents a file plan descriptor that specifies the type of the underlying authority which determines the content to be retained and its retention schedule. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete a **filePlanAuthority** descriptor, use the [authorityTemplate](security-authoritytemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a **filePlanAuthority** name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanAuthority" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanAuthority", + "displayName": "String" +} +``` + |
v1.0 | Security Fileplancitation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplancitation.md | + + Title: "filePlanCitation resource type" +description: "Represents the file plan descriptor of type citation applied to a particular retention label." ++ms.localizationpriority: medium ++++# filePlanCitation resource type ++Namespace: microsoft.graph.security +++Represents a file plan descriptor that specifies a rule or regulation created by a jurisdiction to determine whether certain content should be retained or deleted. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete a **filePlanCitation** descriptor, use the [citationTemplate](security-citationtemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|citationJurisdiction|String|Represents the jurisdiction or agency that published the filePlanCitation.| +|citationUrl|String|Represents the URL to the published filePlanCitation.| +|displayName|String|Unique string that defines a filePlanCitation name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanCitation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanCitation", + "displayName": "String", + "citationUrl": "String", + "citationJurisdiction": "String" +} +``` + |
v1.0 | Security Fileplandepartment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplandepartment.md | + + Title: "filePlanDepartment resource type" +description: "Represents the file plan descriptor of type department applied to a particular retention label." ++ms.localizationpriority: medium ++++# filePlanDepartment resource type ++Namespace: microsoft.graph.security +++Represents a file plan descriptor that specifies the department or business unit of an organization to which a [retention label](security-retentionlabel.md) applies. Used to supplement a retention label for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete a **filePlanDepartment** descriptor, use the [departmentTemplate](security-departmenttemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a filePlanDepartment name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanDepartment" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanDepartment", + "displayName": "String" +} +``` + |
v1.0 | Security Fileplandescriptor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplandescriptor.md | Title: "filePlanDescriptor resource type" -description: "Represents a group of columns associated with a particular retention label, to improve the manageability and organization of the content you need to label." +description: "Represents a set of optional descriptors to supplement a retention label and improve the manageability and organization of content in Microsoft 365 for an organization." ms.localizationpriority: medium Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a group of columns to improve the manageability and organization of the content you need to label. +Represents a _set_ of optional file plan descriptors to supplement a [retention label](security-retentionlabel.md) and improve the manageability and organization of Microsoft 365 content. +You can add a descriptor by using the POST operation of the corresponding file plan descriptor _template_, and specifying data for the descriptor. For example, to include a [filePlanCitation](security-fileplancitation.md) descriptor, use the [create citationTemplate](../api/security-labelsroot-post-citations.md) operation. Similarly, you can use the GET or DELETE operations on the template resource for the descriptor. ++To list the descriptors that supplement a retention label, use the [GET](../api/security-retentionlabel-get.md) operation on that [retentionLabel](security-retentionlabel.md) resource and apply `$expand` on the **descriptors** relationship. ++For information on how retention labels and file plan descriptors work in the [Microsoft Purview compliance portal](https://compliance.microsoft.com/), see [Use file plan to create and manage retention labels](/purview/file-plan-manager). Inherits from [microsoft.graph.entity](../resources/entity.md). None. ## Properties |Property|Type|Description| |:|:|:|-|authority|[microsoft.graph.security.authority](../resources/security-authority.md)|Represents the file plan descriptor of type authority applied to a particular retention label.| -|appliedcategory|[microsoft.graph.security.appliedCategory](../resources/security-appliedcategory.md)|Represents the file plan descriptor of type category applied to a particular retention label.| -|citation|[microsoft.graph.security.citation](../resources/security-citation.md)|Represents the file plan descriptor of type citation applied to a particular retention label.| -|department|[microsoft.graph.security.department](../resources/security-department.md)|Represents the file plan descriptor of type department applied to a particular retention label.| ++|authority|[microsoft.graph.security.authority](../resources/security-fileplanauthority.md)|Represents the file plan descriptor of type authority applied to a particular retention label.| +|category|[microsoft.graph.security.appliedCategory](../resources/security-fileplanappliedcategory.md)|Represents the file plan descriptor of type category applied to a particular retention label.| +|citation|[microsoft.graph.security.citation](../resources/security-fileplancitation.md)|Represents the file plan descriptor of type citation applied to a particular retention label.| +|authority|[microsoft.graph.security.filePlanAuthority](../resources/security-fileplanauthority.md)|Represents the file plan descriptor of type authority applied to a particular retention label.| +|appliedCategory|[microsoft.graph.security.filePlanAppliedCategory](../resources/security-fileplanappliedcategory.md)|Represents the file plan descriptor of type category applied to a particular retention label.| +|citation|[microsoft.graph.security.filePlanCitation](../resources/security-fileplancitation.md)|Represents the file plan descriptor of type citation applied to a particular retention label.| +|department|[microsoft.graph.security.filePlanDepartment](../resources/security-fileplandepartment.md)|Represents the file plan descriptor of type department applied to a particular retention label.| |filePlanReference|[microsoft.graph.security.filePlanReference](../resources/security-fileplanreference.md)|Represents the file plan descriptor of type filePlanReference applied to a particular retention label. ΓÇ»| None. |filePlanReferenceTemplate|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule.| ## JSON representation-The following is a JSON representation of the resource. +Here's a JSON representation of the resource. <!-- { "blockType": "resource", "keyProperty": "id", The following is a JSON representation of the resource. "@odata.type": "#microsoft.graph.security.filePlanDescriptor", "id": "String (identifier)", "authority": {- "@odata.type": "microsoft.graph.security.authority" + "@odata.type": "microsoft.graph.security.filePlanAuthority" }, "category": {- "@odata.type": "microsoft.graph.security.appliedCategory" + "@odata.type": "microsoft.graph.security.filePlanAppliedCategory" }, "citation": {- "@odata.type": "microsoft.graph.security.citation" + "@odata.type": "microsoft.graph.security.filePlanCitation" }, "department": {- "@odata.type": "microsoft.graph.security.department" + "@odata.type": "microsoft.graph.security.filePlanDepartment" }, "filePlanReference": { "@odata.type": "microsoft.graph.security.filePlanReference" |
v1.0 | Security Fileplandescriptorbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplandescriptorbase.md | Title: "filePlanDescriptorBase resource type" -description: "Represents the name for each file plan descriptor column associated with a particular label." +description: "Specifies properties common to file plan descriptor resources." ms.localizationpriority: medium Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the name for each [file plan descriptor](../resources/security-fileplandescriptor.md) column associated with a particular label. +Specifies properties common to file plan descriptor resources. Base type for each of the descriptors: [filePlanAppliedCategory](security-fileplanappliedcategory.md), [filePlanAuthority](security-fileplanauthority.md), [filePlanCitation](security-fileplancitation.md), [filePlanDepartment](security-fileplandepartment.md), [filePlanReference](security-fileplanreference.md), and [filePlanSubcategory](security-fileplansubcategory.md). ## Properties |Property|Type|Description| |:|:|:|-|displayName|String|Unique string that defines the name for each [file plan descriptor](../resources/security-fileplandescriptor.md) associated with a particular retention label.| +|displayName|String|Unique string that defines the name for the file plan descriptor associated with a particular retention label.| ## Relationships None. |
v1.0 | Security Fileplandescriptortemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplandescriptortemplate.md | Title: "filePlanDescriptorTemplate resource type" -description: "Represents a group of columns to improve the manageability and organization of the content you need to label." +description: "Specifies the properties common to the template resources for file plan descriptors." ms.localizationpriority: medium Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a group of columns to improve the manageability and organization of the content you need to label. +Specifies the properties common to the template resources for file plan descriptors. Base type for each of the template resources: [authorityTemplate](security-authoritytemplate.md), [categoryTemplate](security-categorytemplate.md), [citationTemplate](security-citationtemplate.md), [departmentTemplate](security-departmenttemplate.md), [filePlanReferenceTemplate](security-fileplanreferencetemplate.md), and [subcategoryTemplate](security-subcategorytemplate.md). Inherits from [microsoft.graph.entity](../resources/entity.md). ## Methods-|Method|Return type|Description| -|:|:|:| -|[List authorities](../api/security-labelsroot-list-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Get the authorityTemplate resources from the authorityTemplate navigation property.| -|[Add authorities](../api/security-labelsroot-post-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Add authorityTemplate by posting to the authorityTemplate collection.| -|[Remove authorities](../api/security-labelsroot-delete-authorities.md)|None|Remove a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.| -|[List categories](../api/security-labelsroot-list-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Get the categoryTemplate resources from the categoryTemplate navigation property.| -|[Add categories](../api/security-labelsroot-post-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Add categoryTemplate by posting to the categoryTemplate collection.| -|[Remove categories](../api/security-labelsroot-delete-categories.md)|None|Remove a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.| -|[List citations](../api/security-labelsroot-list-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|Get the citationTemplate resources from the citationTemplate navigation property.| -|[Add citations](../api/security-labelsroot-post-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Add citationTemplate by posting to the citationTemplate collection.| -|[Remove citations](../api/security-labelsroot-delete-citations.md)|None|Remove a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.| -|[List departments](../api/security-labelsroot-list-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Get the departmentTemplate resources from the departmentTemplate navigation property.| -|[Add departments](../api/security-labelsroot-post-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Add departmentTemplate by posting to the departmentTemplate collection.| -|[Remove departments](../api/security-labelsroot-delete-departments.md)|None|Remove a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.| -|[List filePlanReferences](../api/security-labelsroot-list-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Get the filePlanReferenceTemplate resources from the filePlanReferenceTemplate navigation property.| -|[Add filePlanReferences](../api/security-labelsroot-post-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Add filePlanReferenceTemplate by posting to the filePlanReferenceTemplate collection.| -|[Remove filePlanReferences](../api/security-labelsroot-delete-fileplanreferences.md)|None|Remove a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.| +None. ## Properties |Property|Type|Description| |:|:|:|-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the filePlanDescriptorTemplate column.| -|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanDescriptorTemplate is created.| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the filePlanDescriptorTemplate column. Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.| |displayName|String|Unique string that defines a filePlanDescriptorTemplate name.|-|id|String|Unique ID of the filePlanDecriptorTemplate column. Inherited from [microsoft.graph.entity](../resources/entity.md).| +|id|String|Unique ID of the filePlanDecriptorTemplate column. Read-only.| ## Relationships None. |
v1.0 | Security Fileplanreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplanreference.md | Title: "filePlanReference resource type" -description: "Represents the file plan descriptor of type filePlanReference applied to a particular retention label." +description: "Represents the file plan descriptor of a reference ID, supplementing a specified retention label." ms.localizationpriority: medium Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the file plan descriptor of type filePlanReference applied to a particular retention label. +Represents a file plan descriptor that specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md). +To create, get, or delete a **filePlanReference** descriptor, use the [filePlanReferenceTemplate](security-fileplanreferencetemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ## Properties |Property|Type|Description| |:|:|:|-|displayName|String|Unique string that defines a filePlanReference name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|displayName|String|Unique string that defines a reference ID. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| ## Relationships None. |
v1.0 | Security Fileplanreferencetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplanreferencetemplate.md | Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule. -+Supports CRUD operations to apply and manage the [filePlanReference](security-fileplanreference.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **filePlanReference** descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources ## Properties |Property|Type|Description| |:|:|:|-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the file plan reference. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanReference is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|displayName|String|Unique string that defines a filePlanReference name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the file plan reference descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanReference descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|displayName|String|Unique string that defines a filePlanReference name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| |id|String|Unique ID of the filePlanReference. Inherited from [microsoft.graph.entity](../resources/entity.md).| ## Relationships |
v1.0 | Security Fileplansubcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplansubcategory.md | + + Title: "filePlanSubcategory resource type" +description: "Represents a unique filePlanSubcategory applied to a retention label." ++ms.localizationpriority: medium ++++# filePlanSubcategory resource type ++Namespace: microsoft.graph.security +++Represents a unique filePlanSubcategory applied to a [retention label](security-retentionlabel.md). Used to supplement a retention label for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete a **filePlanSubcategory** descriptor, use the [subcategoryTemplate](security-subcategorytemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a filePlanSubcategory name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanSubcategory" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanSubcategory", + "displayName": "String" +} +``` + |
v1.0 | Security Filethreatsubmission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-filethreatsubmission.md | This is an abstract type. Inherits from [threatSubmission](../resources/security None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Fileurlthreatsubmission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileurlthreatsubmission.md | Inherits from [fileThreatSubmission](../resources/security-filethreatsubmission. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
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." ++ms.localizationpriority: medium Last updated : 03/20/2024+++# healthIssue resource type ++Namespace: microsoft.graph.security +++Represents potential issues within a customer's Microsoft Defender for Identity configuration that Microsoft Defender for Identity identified. ++Inherits from [microsoft.graph.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 of when the health issue was generated.| +|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.| +|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.| +|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", + "ID": "String (identifier)", + "displayName": "String", + "healthIssueType": "String", + "issueTypeId": "String", + "severity": "String", + "status": "String", + "createdDateTime": "String (timestamp)", + "lastModifiedDateTime": "String (timestamp)", + "domainNames": [ + "String" + ], + "sensorDNSNames": [ + "String" + ], + "description": "String", + "recommendations": [ + "String" + ], + "recommendedActionCommands": [ + "String" + ], + "additionalInformation": [ + "String" + ] +} +``` + |
v1.0 | Security Hostcomponent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-hostcomponent.md | Inherits from [artifact](../resources/security-artifact.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
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." ++ms.localizationpriority: medium Last updated : 03/27/2024+++# identityContainer resource type ++Namespace: microsoft.graph.security +++A container for security identities APIs. 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 within a customer's Microsoft Defender for Identity configuration that Microsoft Defender for Identity identified.| ++## 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 Incident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-incident.md | Because piecing the individual alerts together to gain insight into an attack ca |description|String|A rich text string describing the incident| |recommendedActions|String|A rich text string that represents the actions that are reccomnded to take in order to resolve the incident | |recommendedHuntingQueries|Collection(microsoft.graph.security.recommendedHuntingQuery)|List of hunting Kusto Query Language (KQL) queries related to the incident|+|resolvingComment|String|User input that explains the resolution of the incident and the classification choice. This property contains free editable text.| ### incidentStatus values |
v1.0 | Security Indicator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-indicator.md | This resource isn't directly addressable. You can interact with this resource th ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Security Informationprotectionpolicysetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-informationprotectionpolicysetting.md | Represents the settings for a Microsoft Purview Information Protection label pol | defaultLabel | [microsoft.graph.security.sensitivityLabel](../resources/security-sensitivitylabel.md) | Represents the default label for an organization. If no label is selected, the default label is applied. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Ipevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ipevidence.md | Inherits from [alertEvidence](../resources/security-alertevidence.md). 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.security.ipEvidence" + "@odata.type": "microsoft.graph.security.ipEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Labelsroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-labelsroot.md | Title: "labelsRoot resource type" -description: "Represents the entry point for the retentionLabels resource type." +description: "A root resource for capabilities that support records management for Microsoft 365 data in an organization." ms.localizationpriority: medium Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the entry point for the [retentionLabel](security-retentionlabel.md) resource type. +A root resource for capabilities that support records management for Microsoft 365 data in an organization. +Those capabilities include using a [retention label](security-retentionlabel.md) to configure retention and deletion settings for a type of content in the Microsoft 365 data, and using one or more [file plan descriptors](security-fileplandescriptor.md) to supplement the retention label and provide additional options to better manage and organize the content. Inherits from [microsoft.graph.entity](../resources/entity.md). |
v1.0 | Security Loggedonuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-loggedonuser.md | User that was logged in on the machine during the time of the alert. 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.security.loggedOnUser" |
v1.0 | Security Mailboxevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-mailboxevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.mailboxEvidence" + "@odata.type": "microsoft.graph.security.mailboxEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Mailclusterevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-mailclusterevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.mailClusterEvidence" + "@odata.type": "microsoft.graph.security.mailClusterEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Oauthapplicationevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-oauthapplicationevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.oauthApplicationEvidence" + "@odata.type": "microsoft.graph.security.oauthApplicationEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Processevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-processevidence.md | The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.processEvidence" + "@odata.type": "microsoft.graph.security.processEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Protectdonotforwardaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-protectdonotforwardaction.md | None. 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.security.protectDoNotForwardAction" |
v1.0 | Security Recordsmanagement Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-recordsmanagement-overview.md | doc_type: conceptualPageType [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The Microsoft Purview records management APIs help organizations manage retention and deletion of data to meet their legal obligations and compliance regulations, and increases efficiency by enabling the regular disposition of items that no longer have to be retained. +The Microsoft Purview records management APIs help organizations manage retention and deletion of data to meet their legal obligations and compliance regulations. The records management APIs increase efficiency by enabling the regular disposition of items that no longer have to be retained. The records management solution is a part of the Microsoft Purview compliance center. ## Manage retention labels-Records management admins and developers need to maintain records management systems with labels that are created, updated, and deleted periodically. +Many organizations need to manage their data to comply with industry regulations and internal policies, reduce risks of litigation or security breach, and let their employees effectively share knowledge that is current and relevant to them. Managing data commonly involves retaining or deleting different types of content. -Developers and compliance admins can use the records management APIs to perform operations on records management labels in order to maintain their systems. +You can use [retention labels](security-retentionlabel.md) to configure retention and deletion settings for Microsoft 365 content. For example, you can set retention periods from when the content was labeled and you can set disposition review as the action at the end of the retention period. ++In addition, you can use [file plan descriptors](security-fileplandescriptor.md) to supplement a retention label and improve the manageability and organization of Microsoft 365 content. Examples of file plan descriptors include [authority](security-fileplanauthority.md), [citation](security-fileplancitation.md), and [department](security-fileplandepartment.md). ## Trigger events for an existing label-When an employee leaves a company, information is updated in the HR management system. From the leave date, confidential documents need to be retained for a period for 7 years. These documents have the label `Employee_departure` applied. +Some scenarios require starting a retention period for certain documents upon a specific event, such as an employee leaving an organization, a contract expiring, or the fiscal year ending. ++You can use the [retentionLabel](security-retentionlabel.md) resource to support event-based retention, by setting the **retentionTrigger** property as `dateOfEvent` and associating the label with a [retentionEventType](security-retentioneventtype.md) resource. A [retentionEvent](security-retentionevent.md) is associated with a **retentionEventType** as well. When a triggering event happens, only content with that retention label applied is retained for the specified retention period. -Developers and compliance administrators can use records management APIs to read the label `Employee_departure` and look up the associated event type `Event-employee_departure`. +For example, in an organization, when an employee leaves, employment records must be retained for 5 years. Use the **retentionLabel** and **retentionEvent** APIs to do the following for each employee record when the employee starts: +1. Apply a **retentionLabel** configured as follows: + - A display name of "Personnel information" + - A **retentionDuration** of 1827 days (5 years) + - Listening to the **retentionEventType** named "Employee departure" +2. Define a **retentionEvent** with the same **retentionEventType** named "Employee departure", and as part of its [eventQuery](security-eventquery.md) collection, an `Asset ID` with an employee ID value as the ID information associated with the event. -Compliance admins can use records management APIs to create an event for the associated event type. The retention period for the confidential documents starts after the creation of this event. +When an employee with an ID of 1234 leaves Contoso, the information is updated in the HR management system. The employee departure can trigger a new instance of **retentionEvent** with the "Employee departure" event type, and as part of its **eventQueries** property, an [eventQuery](security-eventquery.md) with a query string of 'AssetID:1234'. This way, employee record items using the "Personnel information" retention label and associated with the employee ID of 1234 get their 5 year retention period started from the date of the employee departure event. ## Entities The records management API includes the following key entities. The records management API includes the following key entities. | Name | Type | Use case | |:-|:-|:-| | Label | [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) | Contains retention settings and actions that can be applied to an item at the end of a period. |+| File plan descriptors |[microsoft.graph.securty.fileplandescriptor](../resources/security-fileplandescriptor.md) | Represents a set of optional descriptors to supplement a retention label and improve their manageability for an organization. | | Retention event | [microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md) | Represents a trigger for event-based retention, where a retention period starts after the event occurs. | | Retention event type | [microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) | Represents a single group for the same type of retention events. | |
v1.0 | Security Registrykeyevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-registrykeyevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.registryKeyEvidence" + "@odata.type": "microsoft.graph.security.registryKeyEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Registryvalueevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-registryvalueevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.registryValueEvidence" + "@odata.type": "microsoft.graph.security.registryValueEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Retentiondurationforever | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-retentiondurationforever.md | None. 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.security.retentionDurationForever" |
v1.0 | Security Retentionevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-retentionevent.md | To learn more about it, see [Start retention when an event occurs](/microsoft-36 |createdDateTime|DateTimeOffset|The date time when the retentionEvent was created.| |description|String|Optional information about the event.| |displayName|String|Name of the event.|-|eventPropagationResult|[microsoft.graph.security.eventPropagationResult](../resources/security-eventpropagationresult.md)|Represents the success status of a created event and additional information.| -|eventQueries|[microsoft.graph.security.eventQueries](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| -|retentionEventStatus|[microsoft.graph.security.retentionEventStatus](../resources/security-retentioneventstatus.md) collection|Status of event propogation to the scoped locations after the event has been created.| +|eventPropagationResults|[microsoft.graph.security.eventPropagationResult](../resources/security-eventpropagationresult.md) collection|Represents the success status of a created event and additional information.| +|eventQueries|[microsoft.graph.security.eventQuery](../resources/security-eventquery.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| +|eventStatus|[microsoft.graph.security.retentionEventStatus](../resources/security-retentioneventstatus.md)|Status of event propogation to the scoped locations after the event has been created.| |eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| |id|String|Represents the unique ID of the user who created the retentionEvent. [entity](/graph/api/resources/entity).| |lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionEvent.| The following is a JSON representation of the resource. "description": "String", "eventQueries": [ {- "@odata.type": "microsoft.graph.security.eventQueries" + "@odata.type": "microsoft.graph.security.eventQuery" } ], "eventTriggerDateTime": "String (timestamp)", The following is a JSON representation of the resource. }, "lastStatusUpdateDateTime": "String (timestamp)" }-``` +``` |
v1.0 | Security Retentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-retentionlabel.md | Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents how customers can manage their data, including whether and for how long to retain or delete it. +Represents how organizations, for compliance and governance purposes, can manage their data at an item level (email or document), including whether and for how long to retain or delete the item. ++Organizations can use retention labels for different types of content that require different retention settings. For example, they can apply a retention label to tax forms and supporting documents to retain them for the period required by law. ++Organizations can configure retention labels with the retention periods and actions based on factors such as the date last modified or created. They can also start different retention periods by specifying an [event that can trigger retention](security-retentionevent.md) when the event occurs. ++For more information on how retention labels work, when to use them, and how Microsoft Purview supports retention labels to let you configure retention and deletion settings, see [Learn about retention policies and retention labels](/purview/retention). ## Methods |Method|Return type|Description| Represents how customers can manage their data, including whether and for how lo ## Properties |Property|Type|Description| |:|:|:|-|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to take on a document with this label applied during the retention period. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`.| +|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to take on the labeled document after the period specified by the retentionDuration property expires. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`.| |behaviorDuringRetentionPeriod|microsoft.graph.security.behaviorDuringRetentionPeriod|Specifies how the behavior of a document with this label should be during the retention period. The possible values are: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`, `unknownFutureValue`.| |createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the retentionLabel.| |createdDateTime|DateTimeOffset|Represents the date and time in which the retentionLabel is created.| |descriptionForAdmins|String|Provides label information for the admin. Optional.| |descriptionForUsers|String|Provides the label information for the user. Optional.| |displayName|String|Unique string that defines a label name.|-|id|String|Unique ID of the retentionLabel. [entity](/graph/api/resources/entity).| +|id|String|Unique ID of the retentionLabel.| |isInUse|Boolean|Specifies whether the label is currently being used.| |lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionLabel.| |lastModifiedDateTime|DateTimeOffset|The latest date time when the retentionLabel was modified.| |
v1.0 | Security Securitygroupevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-securitygroupevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.securityGroupEvidence" + "@odata.type": "microsoft.graph.security.securityGroupEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Singlepropertyschema | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-singlepropertyschema.md | The following is a JSON representation of the resource. --> ``` json {- "Name": "Timestamp", - "Type": "DateTime" + "name": "Timestamp", + "type": "DateTime" } ``` |
v1.0 | Security Sitesource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-sitesource.md | None. |site|[site](../resources/site.md)|The SharePoint site associated with the **siteSource**.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Subcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-subcategory.md | - Title: "subCategory resource type" -description: "Represents a unique subcategory applied to a retention label." ---doc_type: resourcePageType ---# subCategory resource type --Namespace: microsoft.graph.security ---Represents a unique subcategory applied to a retention label. ---Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). --## Properties -|Property|Type|Description| -|:|:|:| -|displayName|String|Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| --## Relationships -None. --## JSON representation -Here's a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.security.subCategory" -} >-``` json -{ - "@odata.type": "#microsoft.graph.security.subCategory", - "displayName": "String" -} -``` - |
v1.0 | Security Subcategorytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-subcategorytemplate.md | Title: "subCategoryTemplate resource type" + Title: "subcategoryTemplate resource type" description: "Represents the file plan descriptor of type subcategory for retention labels." ms.localizationpriority: medium-# subCategoryTemplate resource type +# subcategoryTemplate resource type Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the file plan descriptor of type subcategory for retention labels. -+Represents the file plan descriptor of type subcategory for retention labels. This resource supports CRUD operations to apply and manage the [filePlanSubcategory](security-fileplansubcategory.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **subcategory** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). ## Methods |Method|Return type|Description| |:|:|:|-|[List subCategories](../api/security-categorytemplate-list-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) collection|Get a list of the [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) objects and their properties.| -|[Create subCategories](../api/security-categorytemplate-post-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md)|Create a new [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object.| -|[Get subCategories](../api/security-subcategorytemplate-get.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object.| -|[Delete subCategories](../api/security-categorytemplate-delete-subcategories.md)|None|Delete a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object.| +|[List subcategories](../api/security-categorytemplate-list-subcategories.md)|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) collection|Get a list of the [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) objects and their properties.| +|[Create subcategories](../api/security-categorytemplate-post-subcategories.md)|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md)|Create a new [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object.| +|[Get subcategories](../api/security-subcategorytemplate-get.md)|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object.| +|[Delete subcategories](../api/security-categorytemplate-delete-subcategories.md)|None|Delete a [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object.| ## Properties |Property|Type|Description| |:|:|:|-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the subcategory. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|createdDateTime|DateTimeOffset|Represents the date and time in which the subcategory is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|displayName|String|Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| -|ID|String|Unique ID of the subcategory. Inherited from [microsoft.graph.entity](../resources/entity.md).| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the subcategory descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the subcategory descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the subcategory. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ## Relationships None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id",- "@odata.type": "microsoft.graph.security.subCategoryTemplate", + "@odata.type": "microsoft.graph.security.subcategoryTemplate", "baseType": "microsoft.graph.security.filePlanDescriptor", "openType": false } --> ``` json {- "@odata.type": "#microsoft.graph.security.subCategoryTemplate", + "@odata.type": "#microsoft.graph.security.subcategoryTemplate", "id": "String (identifier)", "displayName": "String", "createdBy": { |
v1.0 | Security Submissionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-submissionresult.md | Represents the result of a review after the threat submission is processed by Mi 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.security.submissionResult" |
v1.0 | Security Tenantallowblocklistentryresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-tenantallowblocklistentryresult.md | Represents the result of a tenant allow block list entry. An entry for a tenant 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.security.tenantAllowBlockListEntryResult" |
v1.0 | Security Tenantalloworblocklistaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-tenantalloworblocklistaction.md | Represents the tenant allow-or-block list action. When an admin creates an email 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.security.tenantAllowOrBlockListAction" |
v1.0 | Security Threatsubmission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-threatsubmission.md | This resource is an abstract type. It's the base type for [emailThreatSubmission None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Unclassifiedartifact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-unclassifiedartifact.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Unifiedgroupsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-unifiedgroupsource.md | None. |group|[group](../resources/group.md)|Represents a group.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Urlevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-urlevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.urlEvidence" + "@odata.type": "microsoft.graph.security.urlEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Userevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-userevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.userEvidence" + "@odata.type": "microsoft.graph.security.userEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Usersource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-usersource.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Vmmetadata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-vmmetadata.md | Metadata of the virtual machine (VM) Microsoft Defender for Endpoint is running 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.security.vmMetadata" |
v1.0 | Security | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security.md | None. |alerts_v2 | [microsoft.graph.security.alert](security-alert.md) collection | A collection of alerts in Microsoft 365 Defender.| |attackSimulation|[attackSimulationRoot](../resources/attacksimulationroot.md)|Provides tenants capability to launch a simulated and realistic phishing attack and learn from it.| |collaboration|[microsoft.graph.security.collaborationRoot](../resources/security-collaborationroot.md)|Enables read and other actions on collaborative entities in Microsoft 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.|+|partner| [microsoft.graph.partner.security.partnerSecurity](../resources/partner-security-partnersecurity.md) | A container that safeguards the Microsoft Azure resources of Microsoft Cloud Solution Provider (CSP) partnersΓÇÖ customers, including alerts, scores, and all aspects of security. | |secureScores | [secureScore](securescores.md) collection | Measurements of tenantsΓÇÖ security posture to help protect them from threats. | |securityactions|[securityAction](../resources/securityaction.md) collection|Actions that respond to alerts to block malicious activities.| |tiindicators|[tiIndicator](../resources/tiindicator.md) collection|Threat indicators sent to Microsoft that identify malicious activities.| |
v1.0 | Securityaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/securityaction.md | Take immediate action to defend against threats using the Microsoft Graph Securi |actionReason|String|Reason for invoking this action.| |appId|String|The Application ID of the calling application that submitted (POST) the action. The appId should be extracted from the auth token and not entered manually by the calling application.| |azureTenantId|String|Azure tenant ID of the entity to determine which tenant the entity belongs to (multi-tenancy support). The azureTenantId should be extracted from the auth token and not entered manually by the calling application.|+|clientContext|String|Unique client context string. Can have a maximum of 256 characters.| |completedDateTime|DateTimeOffset|Timestamp when the action was completed. 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|Timestamp when the action is 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`.| |errorInfo|[resultInfo](resultinfo.md)| Error info when the action fails.| |
v1.0 | Securitytoolawsresourceadministratorfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/securitytoolawsresourceadministratorfinding.md | description: "View AWS resources that can administer security tools." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Securitytoolawsroleadministratorfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/securitytoolawsroleadministratorfinding.md | description: "View AWS roles that can administer security tools." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Securitytoolawsserverlessfunctionadministratorfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/securitytoolawsserverlessfunctionadministratorfinding.md | description: "View AWS Serverless functions that can administer security tools." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Securitytoolawsuseradministratorfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/securitytoolawsuseradministratorfinding.md | description: "View AWS Users that can administer security tools." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Securityvendorinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/securityvendorinformation.md | Contains details about the security product/service vendor, provider, and subpro ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Selfservicesignupauthenticationflowconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/selfservicesignupauthenticationflowconfiguration.md | Represents the configurations related to self-service sign-up. 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.selfServiceSignUpAuthenticationFlowConfiguration" |
v1.0 | Selfsignedcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/selfsignedcertificate.md | Contains the public part of a signing certificate. It's the return type of the a ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sensitivitylabelassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sensitivitylabelassignment.md | Provides details about a sensitivity label assigned to a [file](./driveitem.md) |labels|[extractSensitivityLabelsResult](./extractsensitivitylabelsresult.md)|List of sensitivity labels assigned to a file.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.sensitivityLabelAssignment" |
v1.0 | Service Communications Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/service-communications-api-overview.md | Title: "Working with service communications APIs in Microsoft Graph" description: You can use the service communications API in Microsoft Graph to access the health status and message center posts about Microsoft services." ms.localizationpriority: medium -doc_type: resourcePageType # Working with service communications API in Microsoft Graph The service communications API provides service health and message center posts pertaining to the Microsoft cloud services subscribed by your tenant. You can get current and historical health data of a Microsoft service (for example, the Exchange Online service is down). You can check the service health to determine if an issue is tracked and a resolution is in progress before calling support or spending time troubleshooting. Message center posts let you keep track of upcoming changes, including new features, updates, and other important announcements (for example, Exchange Online is getting a new feature). ## Authorization-Microsoft Graph lets applications get authorized access to health and change communications about a Microsoft cloud service subscribed by a tenant. +Microsoft Graph lets applications get authorized access to health and change communications about a Microsoft cloud service subscribed by a tenant. With the appropriate delegated or application [permissions](/graph/permissions-reference#service-communications-permissions), your app can access the communications data on behalf of a signed-in user, or without any signed-in user in the tenant. Both delegated and application types of these permissions are granted by only an administrator. For more information on access tokens, app registration, and delegated and application permissions, see [Authentication and authorization basics](/graph/auth/auth-concepts). ### Access service communications API on behalf of signed-in user -Delegated permissions are needed to access the service communications API on behalf of a signed-in user. Customer-facing canvas applications, such as the [Microsoft 365 admin center](https://admin.microsoft.com/Adminportal/Home?source=applauncher#/homepage) (accessible only to admin roles), can call the service communications API to get the service health and service announcements data for the signed-in user's tenant, _on behalf of the signed-in user_. Users can find out whether their subscribed services are healthy or have issues. They can also learn about any current service issues affecting their tenants. +Delegated permissions are needed to access the service communications API on behalf of a signed-in user. Customer-facing canvas applications, such as the [Microsoft 365 admin center](https://admin.microsoft.com/Adminportal/Home?source=applauncher#/homepage) (accessible only to admin roles), can call the service communications API to get the service health and service announcements data for the signed-in user's tenant, _on behalf of the signed-in user_. Users can find out whether their subscribed services are healthy or have issues. They can also learn about any current service issues affecting their tenants. #### Role-based access control for delegation access The service communications API applies role-based access control (RBAC) to ident For more information about the Microsoft Entra administrator roles, see: * [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles) * [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json)-* [Roles in Microsoft 365, including Microsoft Entra ID, service-specific and cross-service roles](/azure/active-directory/roles/concept-understand-roles#how-azure-ad-roles-are-different-from-other-microsoft-365-roles) +* [Roles in Microsoft 365, including Microsoft Entra ID, service-specific and cross-service roles](/azure/active-directory/roles/concept-understand-roles#how-azure-ad-roles-are-different-from-other-microsoft-365-roles) ### Access service communications API without user -Application permissions are needed to access the service communications API without a signed-in user. Applications that run as backend services, such as monitoring or alert services, can call the service communications API with their own identity and not on behalf of a user. These backend services can build custom monitoring/alert pipelines and call the service communications API to get service health and service announcements data. +Application permissions are needed to access the service communications API without a signed-in user. Applications that run as backend services, such as monitoring or alert services, can call the service communications API with their own identity and not on behalf of a user. These backend services can build custom monitoring/alert pipelines and call the service communications API to get service health and service announcements data. ## Common use cases and required permissions |Use cases|API requests| Required permissions| Supported permission types| |:--|:--|:--|:--|-| List health overviews for tenant | [List healthOverviews](/graph/api/serviceannouncement-list-healthoverviews?view=graph-rest-beta&preserve-view=true) | _ServiceHealth.Read.All_ | Delegated and application | +| List health overviews for tenant | [List healthOverviews](/graph/api/serviceannouncement-list-healthoverviews?view=graph-rest-beta&preserve-view=true) | _ServiceHealth.Read.All_ | Delegated and application | | Get specific service health information for tenant | [Get serviceHealth](/graph/api/servicehealth-get?view=graph-rest-beta&preserve-view=true) | _ServiceHealth.Read.All_ | Delegated and application | | List all service issues for tenant | [List issues](/graph/api/serviceannouncement-list-issues?view=graph-rest-beta&preserve-view=true) | _ServiceHealth.Read.All_ | Delegated and application | | Get a specific service issue for tenant | [Get issue](/graph/api/servicehealthissue-get?view=graph-rest-beta&preserve-view=true) | _ServiceHealth.Read.All_ | Delegated and application | |
v1.0 | Serviceannouncementbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/serviceannouncementbase.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Servicehealth | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/servicehealth.md | Represents the health information of a service subscribed by a tenant. |issues|Collection([serviceHealthIssue](../resources/servicehealthissue.md))|A collection of issues that happened on the service, with detailed information for each issue.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Servicehostedmediaconfig | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/servicehostedmediaconfig.md | The media that's hosted remotely. This is inherited from [mediaConfig](mediaconf ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 |[Assign claimsMappingPolicy](../api/serviceprincipal-post-claimsmappingpolicies.md)| [claimsMappingPolicy](claimsmappingpolicy.md) collection| Assign a claimsMappingPolicy to this object.| |[List claimsMappingPolicies](../api/serviceprincipal-list-claimsmappingpolicies.md)| [claimsMappingPolicy](claimsmappingpolicy.md) collection| Get all claimsMappingPolicies assigned to this object.| |[Remove claimsMappingPolicy](../api/serviceprincipal-delete-claimsmappingpolicies.md)| [claimsMappingPolicy](claimsmappingpolicy.md) collection| Remove a claimsMappingPolicy from this object.|+|[Create or replace customClaimsPolicy](../api/serviceprincipal-put-claimspolicy.md)|[customClaimsPolicy](../resources/customclaimspolicy.md)|Create a new custom claims policy object if it doesn't exist, or replace an existing one.| |[Assign homeRealmDiscoveryPolicy](../api/serviceprincipal-post-homerealmdiscoverypolicies.md)| [homeRealmDiscoveryPolicy](homerealmdiscoverypolicy.md) collection| Assign a homeRealmDiscoveryPolicy to this object.| |[List homeRealmDiscoveryPolicies](../api/serviceprincipal-list-homerealmdiscoverypolicies.md)| [homeRealmDiscoveryPolicy](homerealmdiscoverypolicy.md) collection| Get all homeRealmDiscoveryPolicies assigned to this object.| |[Remove homeRealmDiscoveryPolicy](../api/serviceprincipal-delete-homerealmdiscoverypolicies.md)| [homeRealmDiscoveryPolicy](homerealmdiscoverypolicy.md) collection| Remove a homeRealmDiscoveryPolicy from this object.| This resource supports using [delta query](/graph/delta-query-overview) to track |appRoleAssignedTo|[appRoleAssignment](approleassignment.md)|App role assignments for this app or service, granted to users, groups, and other service principals.Supports `$expand`.| |appRoleAssignments|[appRoleAssignment](approleassignment.md) collection|App role assignment for another app or service, granted to this service principal. Supports `$expand`.| |claimsMappingPolicies|[claimsMappingPolicy](claimsmappingpolicy.md) collection|The claimsMappingPolicies assigned to this service principal. Supports `$expand`.|+|claimsPolicy|[customClaimsPolicy](../resources/customclaimspolicy.md)|A claims policy that allows application admins to customize the claims that will be emitted in tokens affected by this policy.| |createdObjects|[directoryObject](directoryobject.md) collection|Directory objects created by this service principal. Read-only. Nullable.| |delegatedPermissionClassifications|[delegatedPermissionClassification](delegatedpermissionclassification.md) collection|The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports `$expand`.| |endpoints|[endpoint](endpoint.md) collection|Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.| The following JSON representation shows the resource type. "signInAudience": "String", "tags": ["String"], "tokenEncryptionKeyId": "String",- "useCustomTokenSigningKey": false, "verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"} } ``` |
v1.0 | Serviceprincipalidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/serviceprincipalidentity.md | Inherits from [identity](../resources/identity.md). 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.servicePrincipalIdentity" |
v1.0 | Serviceprincipallockconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/serviceprincipallockconfiguration.md | For more information about managing this object, see [Lock sensitive properties | tokenEncryptionKeyId | Boolean | Locks the tokenEncryptionKeyId property for modification on the service principal. | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Serviceprovisioningerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/serviceprovisioningerror.md | Base type of [serviceProvisioningXmlError](../resources/serviceprovisioningxmler ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Serviceprovisioningxmlerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/serviceprovisioningxmlerror.md | Inherits from [serviceProvisioningError](../resources/serviceprovisioningerror.m ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Settingtemplatevalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/settingtemplatevalue.md | Represents an individual template setting definition, including the default valu ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Settingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/settingvalue.md | A setting represented by a name/value pair. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Shareddriveitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/shareddriveitem.md | The **sharedDriveItem** resource is derived from [**baseItem**](baseitem.md) and "list": { "@odata.type": "microsoft.graph.list" }, "listItem": { "@odata.type": "microsoft.graph.listItem" }, "permission": { "@odata.type": "microsoft.graph.permission" },- "root": { "@odata.type": "microsoft.graph.driveItem" }, "site": { "@odata.type": "microsoft.graph.site" } } ``` |
v1.0 | Sharepoint Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharepoint-activity-reports.md | - Title: "SharePoint activity reports" -description: "You can get the activity of every user licensed to use SharePoint by looking at their interaction with files. You can also look at the level of collaboration going on based on the number of files shared." ---doc_type: conceptualPageType ---# SharePoint activity reports --Namespace: microsoft.graph ---You can get the activity of every user licensed to use SharePoint by looking at their interaction with files. You can also look at the level of collaboration going on based on the number of files shared. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - SharePoint activity](https://support.office.com/client/SharePoint-activity-a91c958f-1279-499d-9959-12f0de08dc8f). --## Reports --| Function | CSV Return Type | JSON Return Type | Description | -| :-- | :-- | : | | -| [Get user detail](../api/reportroot-getsharepointactivityuserdetail.md) | Stream | Stream | Get details about SharePoint activity by user. | -| [Get file counts](../api/reportroot-getsharepointactivityfilecounts.md) | Stream | Stream | Get the number of unique, licensed users who interacted with files stored on SharePoint sites. | -| [Get user counts](../api/reportroot-getsharepointactivityusercounts.md) | Stream | 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 | Stream | Get the number of unique pages visited by users. | -- |
v1.0 | Sharepoint Site Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharepoint-site-usage-reports.md | - Title: "SharePoint site usage reports" -description: "You can get a high level view of the value you are getting from SharePoint in terms of the total number of files that users store in SharePoint sites, how many files are actively being used, and the storage consumed across all these sites. Then, you can drill into the SharePoint site usage report to understand the trends and per site level details for all sites." ---doc_type: conceptualPageType ---# SharePoint site usage reports --Namespace: microsoft.graph ---You can get a high level view of the value you are getting from SharePoint in terms of the total number of files that users store in SharePoint sites, how many files are actively being used, and the storage consumed across all these sites. Then, you can drill into the SharePoint site usage report to understand the trends and per site level details for all sites. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - SharePoint site usage](https://support.office.com/client/SharePoint-site-usage-4ecfb843-e5d5-464d-8bf6-7ed512a9b213). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get site detail](../api/reportroot-getsharepointsiteusagedetail.md) | Stream | Stream | Get details about SharePoint site usage. | -| [Get file counts](../api/reportroot-getsharepointsiteusagefilecounts.md) | Stream | 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 | Stream | Get the trend of total and active site count during the reporting period. | -| [Get storage](../api/reportroot-getsharepointsiteusagestorage.md) | Stream | Stream | Get the trend of storage allocated and consumed during the reporting period. | -| [Get pages](../api/reportroot-getsharepointsiteusagepages.md) | Stream | Stream | Get the number of pages viewed across all sites. | -- |
v1.0 | Sharepointids | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharepointids.md | The **SharePointIds** resource groups the various identifiers for an item stored ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sharepointonedriveoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharepointonedriveoptions.md | Provides the search content options when a search is performed using application | Property | Type | Description | |:-|:|:| |includeContent|searchContent| The type of search content. The possible values are: `privateContent`, `sharedContent`. Read-only. |+|includeHiddenContent|Boolean| Indicates whether the search results include content that is normally hidden, such as archived content and SharePoint Embedded (RaaS). The default value is `false`, which prevents hidden content from being returned. You can also optionally include KQL to scope your query for hidden content to specific content types. For more information, see [Search hidden content](/graph/search-concept-files#example-7-search-hidden-content). | ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", The following is a JSON representation of the resource. ```json {- "includeContent": "string" + "includeContent": "String", + "includeHiddenContent": "Boolean" } ``` |
v1.0 | Sharepointsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharepointsettings.md | Inherits from [entity](../resources/entity.md). | unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.sharepointSettings", |
v1.0 | Sharepointsharingabilities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharepointsharingabilities.md | + + Title: "sharePointSharingAbilities resource type" +description: "Provides information about which sharing links are available to the user." ++ms.localizationpriority: medium ++++# sharePointSharingAbilities resource type ++Namespace: microsoft.graph +++Provides information about which sharing links are available to the user. ++## Properties ++|Property|Type|Description| +|:|:|:| +|anyoneLinkAbilities|[linkScopeAbilities](../resources/linkscopeabilities.md)|The anyone link abilities.| +|directSharingAbilities|[directSharingAbilities](../resources/directsharingabilities.md)|The direct sharing abilities.| +|organizationLinkAbilities|[linkScopeAbilities](../resources/linkscopeabilities.md)|The organization link abilities.| +|specificPeopleLinkAbilities|[linkScopeAbilities](../resources/linkscopeabilities.md)|The specificPeople link abilities.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.sharePointSharingAbilities" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.sharePointSharingAbilities", + "anyoneLinkAbilities": { + "@odata.type": "microsoft.graph.linkScopeAbilities" + }, + "organizationLinkAbilities": { + "@odata.type": "microsoft.graph.linkScopeAbilities" + }, + "specificPeopleLinkAbilities": { + "@odata.type": "microsoft.graph.linkScopeAbilities" + }, + "directSharingAbilities": { + "@odata.type": "microsoft.graph.directSharingAbilities" + } +} +``` |
v1.0 | Sharinginvitation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharinginvitation.md | The **SharingInvitation** resource groups invitation-related data items into a s ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sharinglink | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharinglink.md | If a [**permission**](permission.md) resource has a non-null **sharingLink** fac ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sharinglinkexpirationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharinglinkexpirationstatus.md | + + Title: "sharingLinkExpirationStatus resource type" +description: "Indicates whether links must expire, and if link expiration is enabled, provides a default link expiration time." ++ms.localizationpriority: medium ++++# sharingLinkExpirationStatus resource type ++Namespace: microsoft.graph +++Indicates whether links must expire, and if link expiration is enabled, provides a default link expiration time. ++## Properties ++|Property|Type|Description| +|:|:|:| +|defaultExpirationInDays|Int32|Default link expiration in days. Returns -1 if there is no required expiration time.| +|disabledReason|String|Provides a description of why this operation is not enabled. Only returned if this operation is not enabled.| +|enabled|Boolean|Indicates whether this operation is enabled.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.sharingLinkExpirationStatus" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.sharingLinkExpirationStatus", + "enabled": "Boolean", + "disabledReason": "String", + "defaultExpirationInDays": "Integer" +} +``` |
v1.0 | Sharinglinkvariants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharinglinkvariants.md | + + Title: "sharingLinkVariants resource type" +description: "Represents the status of potential sharing link variants. The variants generate a separate sharing link from the link that would otherwise be generated, but with identical role and scope.." ++ms.localizationpriority: medium ++++# sharingLinkVariants resource type ++Namespace: microsoft.graph +++Represents the status of potential sharing link variants. The variants generate a separate sharing link from the link that would otherwise be generated, but with identical role and scope. ++## Properties ++|Property|Type|Description| +|:|:|:| +|addressBarLinkPermission|sharingRole|Indicates the most permissive role with which an address bar link can be created. The possible values are: `none`, `view`, `edit`, `manageList`, `review`, `restrictedView`, `submitOnly`, `unknownFutureValue`.| +|allowEmbed|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates whether a link can be embedded.| +|passwordProtected|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates whether a link can be password protected, meaning that link users would need to enter a password to access the item for which the sharing link is produced. Creating a passwordProtected link for the first time requires providing a password.| +|requiresAuthentication|[sharingOperationStatus](../resources/sharingoperationstatus.md)|Indicates whether a link requires identity authentication for recipients. Users can be verified through either an email address or identity.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.sharingLinkVariants" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.sharingLinkVariants", + "passwordProtected": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "requiresAuthentication": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + }, + "addressBarLinkPermission": "String", + "allowEmbed": { + "@odata.type": "microsoft.graph.sharingOperationStatus" + } +} +``` |
v1.0 | Sharingoperationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharingoperationstatus.md | + + Title: "sharingOperationStatus resource type" +description: "Represents the status of a particular sharing operation." ++ms.localizationpriority: medium ++++# sharingOperationStatus resource type ++Namespace: microsoft.graph +++Represents the status of a particular sharing operation. ++## Properties ++|Property|Type|Description| +|:|:|:| +|disabledReason|String|Provides a description of why this operation is not enabled. Only returned if this operation is not enabled.| +|enabled|Boolean|Indicates whether this operation is enabled.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.sharingOperationStatus" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.sharingOperationStatus", + "enabled": "Boolean", + "disabledReason": "String" +} +``` |
v1.0 | Sharingviewpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharingviewpoint.md | + + Title: "sharingViewpoint resource type" +description: "Represents the sharing operations the current user can take on the specified item." ++ms.localizationpriority: medium ++++# sharingViewpoint resource type ++Namespace: microsoft.graph +++Represents sharing operations the current user can take on the specified item. ++## Properties ++|Property|Type|Description| +|:|:|:| +|defaultSharingLink|[defaultSharingLink](../resources/defaultsharinglink.md)|The default sharing link the user can create for this item.| +|sharingAbilities|[sharePointSharingAbilities](../resources/sharepointsharingabilities.md)|Provides information about which sharing links are available to the user.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.sharingViewpoint" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.sharingViewpoint", + "sharingAbilities": { + "@odata.type": "microsoft.graph.sharePointSharingAbilities" + }, + "defaultSharingLink": { + "@odata.type": "microsoft.graph.defaultSharingLink" + } +} +``` |
v1.0 | Shiftactivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/shiftactivity.md | Represents an activity in a [shift](shift.md). ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Shiftitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/shiftitem.md | Represents a version of a [shift](shift.md). ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 |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).| |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.| |authenticationAppPolicyEvaluationDetails|[authenticationAppPolicyDetails](../resources/authenticationapppolicydetails.md) collection|Provides details of the Microsoft Entra policies applied to a user and client authentication app during an authentication step.| |authenticationContextClassReferences|[authenticationContext](authenticationcontext.md) collection|Contains a collection of values that represent the conditional access authentication contexts applied to the sign-in.| |authenticationDetails|[authenticationDetail](authenticationdetail.md) collection|The result of the authentication attempt and more details on the authentication method.| |authenticationMethodsUsed|String collection|The authentication methods used. Possible values: `SMS`, `Authenticator App`, `App Verification code`, `Password`, `FIDO`, `PTA`, or `PHS`.| |authenticationProcessingDetails|[keyValue](keyvalue.md) collection|More authentication processing details, such as the agent name for PTA and PHS, or a server or farm name for federated authentication.|-|authenticationProtocol|protocolType|Lists the protocol type or grant type used in the authentication. The possible values are: `oAuth2`, `ropc`, `wsFederation`, `saml20`, `deviceCode`, `unknownFutureValue`, `authenticationTransfer`, and `none`. Use `none` for all authentications that don't have a specific value in that list. | +|authenticationProtocol|protocolType|Lists the protocol type or grant type used in the authentication. The possible values are: `none`, `oAuth2`, `ropc`, `wsFederation`, `saml20`, `deviceCode`, `unknownFutureValue`, `authenticationTransfer`, `nativeAuth`. Use `none` for all authentications that don't have a specific value in that list. 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): `authenticationTransfer`, `nativeAuth`. | |authenticationRequirement | String | This holds the highest level of authentication needed through all the sign-in steps, for sign-in to succeed. <br/><br/> Supports `$filter` (`eq`, `startsWith`).| |authenticationRequirementPolicies|[authenticationRequirementPolicy](../resources/authenticationrequirementpolicy.md) collection|Sources of authentication requirement, such as conditional access, per-user MFA, identity protection, and security defaults.| |autonomousSystemNumber|Int32|The Autonomous System Number (ASN) of the network used by the actor.| |azureResourceId|String|Contains a fully qualified Azure Resource Manager ID of an Azure resource accessed during the sign-in.| |clientAppUsed|String|The legacy client used for sign-in activity. For example: `Browser`, `Exchange ActiveSync`, `Modern clients`, `IMAP`, `MAPI`, `SMTP`, or `POP`. <br/><br/> Supports `$filter` (`eq`). | |clientCredentialType|clientCredentialType|Describes the credential type that a user client or service principal provided to Microsoft Entra ID to authenticate itself. You can review this property to track and eliminate less secure credential types or to watch for clients and service principals using anomalous credential types. The possible values are: `none`, `clientSecret`, `clientAssertion`, `federatedIdentityCredential`, `managedIdentity`, `certificate`, `unknownFutureValue`.|+|conditionalAccessAudiences|String|A list that indicates the audience that was evaluated by Conditional Access during a sign-in event. <br/><br/> Supports `$filter` (`eq`).| |conditionalAccessStatus|conditionalAccessStatus| The status of the conditional access policy triggered. Possible values: `success`, `failure`, `notApplied`, or `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`).| |correlationId|String|The identifier the client sends when sign-in is initiated. This is used for troubleshooting the corresponding sign-in activity when calling for support. <br/><br/> Supports `$filter` (`eq`).| |createdDateTime|DateTimeOffset|The date and time the sign-in was initiated. The Timestamp type is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. <br/><br/> Supports `$orderby`, `$filter` (`eq`, `le`, and `ge`).|-|crossTenantAccessType|signInAccessType|Describes the type of cross-tenant access used by the actor to access the resource. Possible values are: `none`, `b2bCollaboration`, `b2bDirectConnect`, `microsoftSupport`, `serviceProvider`, `unknownFutureValue`, `passthrough`. Also, note that 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): `passthrough`. If the sign in didn't cross tenant boundaries, the value is `none`.| +|crossTenantAccessType|signInAccessType|Describes the type of cross-tenant access used by the actor to access the resource. Possible values are: `none`, `b2bCollaboration`, `b2bDirectConnect`, `microsoftSupport`, `serviceProvider`, `unknownFutureValue`, `passthrough`. 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): `passthrough`. If the sign in didn't cross tenant boundaries, the value is `none`.| |deviceDetail|[deviceDetail](devicedetail.md)|The device information from where the sign-in occurred. Includes information such as deviceId, OS, and browser. <br/><br/> Supports `$filter` (`eq`, `startsWith`) on **browser** and **operatingSystem** properties.| |federatedCredentialId|String|Contains the identifier of an application's federated identity credential, if a federated identity credential was used to sign in.| |flaggedForReview|Boolean|During a failed sign-in, a user can select a button in the Azure portal to mark the failed event for tenant admins. If a user selects the button to flag the failed sign-in, this value is `true`.|+|globalSecureAccessIpAddress|String|The Global Secure Access IP address that the sign-in was initiated from.| |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 has provided 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, note that 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`. <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`.| |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.| |isTenantRestricted|Boolean|Shows whether the sign in event was subject to a Microsoft Entra tenant restriction policy.|+|isThroughGlobalSecureAccess|Boolean|Indicates whether a user came through Global Secure Access service.| |location|[signInLocation](signinlocation.md)|The city, state, and two letter country code from where the sign-in occurred. <br/><br/> Supports `$filter` (`eq`, `startsWith`) on **city**, **state**, and **countryOrRegion** properties.| |managedServiceIdentity|[managedIdentity](../resources/managedidentity.md)|Contains information about the managed identity used for the sign in, including its type, associated Azure Resource Manager (ARM) resource ID, and federated token information.| |networkLocationDetails|[networkLocationDetail](networklocationdetail.md) collection|The network location details including the type of network used and its names.| The [Microsoft Entra data retention policies](/azure/active-directory/reports-mo |resourceId|String|The identifier of the resource that the user signed in to. <br/><br/> Supports `$filter` (`eq`).| |resourceServicePrincipalId|String|The identifier of the service principal representing the target resource in the sign-in event.| |resourceTenantId|String|The tenant identifier of the resource referenced in the sign in.|-|riskDetail|riskDetail|The reason behind a specific state of a risky user, sign-in, or a risk event. The possible values are `none`, `adminGeneratedTemporaryPassword`, `userPerformedSecuredPasswordChange`, `userPerformedSecuredPasswordReset`, `adminConfirmedSigninSafe`, `aiConfirmedSigninSafe`, `userPassedMFADrivenByRiskBasedPolicy`, `adminDismissedAllRiskForUser`, `adminConfirmedSigninCompromised`, `hidden`, `adminConfirmedUserCompromised`, `unknownFutureValue`, `adminConfirmedServicePrincipalCompromised`, `adminDismissedAllRiskForServicePrincipal`, `m365DAdminDismissedDetection`, `userChangedPasswordOnPremises`, `adminDismissedRiskForSignIn`, `adminConfirmedAccountSafe`. 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): `adminConfirmedServicePrincipalCompromised`, `adminDismissedAllRiskForServicePrincipal`, `m365DAdminDismissedDetection`, `userChangedPasswordOnPremises`, `adminDismissedRiskForSignIn`, `adminConfirmedAccountSafe`.The value `none` means that Microsoft Entra risk detection has not flagged the user or the sign-in as a risky event so far. <br/><br/> Supports `$filter` (`eq`).<br> **Note:** Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned `hidden`.| +|riskDetail|riskDetail|The reason behind a specific state of a risky user, sign-in, or a risk event. The possible values are `none`, `adminGeneratedTemporaryPassword`, `userPerformedSecuredPasswordChange`, `userPerformedSecuredPasswordReset`, `adminConfirmedSigninSafe`, `aiConfirmedSigninSafe`, `userPassedMFADrivenByRiskBasedPolicy`, `adminDismissedAllRiskForUser`, `adminConfirmedSigninCompromised`, `hidden`, `adminConfirmedUserCompromised`, `unknownFutureValue`, `adminConfirmedServicePrincipalCompromised`, `adminDismissedAllRiskForServicePrincipal`, `m365DAdminDismissedDetection`, `userChangedPasswordOnPremises`, `adminDismissedRiskForSignIn`, `adminConfirmedAccountSafe`. 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): `adminConfirmedServicePrincipalCompromised`, `adminDismissedAllRiskForServicePrincipal`, `m365DAdminDismissedDetection`, `userChangedPasswordOnPremises`, `adminDismissedRiskForSignIn`, `adminConfirmedAccountSafe`.The value `none` means that Microsoft Entra risk detection hasn't flagged the user or the sign-in as a risky event so far. <br/><br/> Supports `$filter` (`eq`).<br> **Note:** Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned `hidden`.| |riskEventTypes_v2|String collection|The list of risk event types associated with the sign-in. Possible values: `unlikelyTravel`, `anonymizedIPAddress`, `maliciousIPAddress`, `unfamiliarFeatures`, `malwareInfectedIPAddress`, `suspiciousIPAddress`, `leakedCredentials`, `investigationsThreatIntelligence`, `generic`, or `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `startsWith`).| |riskLevelAggregated|riskLevel|The aggregated risk level. Possible values: `none`, `low`, `medium`, `high`, `hidden`, or `unknownFutureValue`. The value `hidden` means the user or sign-in wasn't enabled for Microsoft Entra ID Protection. <br/><br/> Supports `$filter` (`eq`). <br>**Note:** Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned `hidden`.| |riskLevelDuringSignIn|riskLevel|The risk level during sign-in. Possible values: `none`, `low`, `medium`, `high`, `hidden`, or `unknownFutureValue`. The value `hidden` means the user or sign-in wasn't enabled for Microsoft Entra ID Protection. <br/><br/> Supports `$filter` (`eq`). <br>**Note:** Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned `hidden`.| The [Microsoft Entra data retention policies](/azure/active-directory/reports-mo |signInEventTypes|String collection|Indicates the category of sign in that the event represents. For user sign ins, the category can be `interactiveUser` or `nonInteractiveUser` and corresponds to the value for the **isInteractive** property on the signin resource. For managed identity sign ins, the category is `managedIdentity`. For service principal sign-ins, the category is **servicePrincipal**. Possible values are: `interactiveUser`, `nonInteractiveUser`, `servicePrincipal`, `managedIdentity`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`).| |signInIdentifier|String|The identification that the user provided to sign in. It can be the userPrincipalName, but is also populated when a user signs in using other identifiers.| |signInIdentifierType|signInIdentifierType|The type of sign in identifier. Possible values are: `userPrincipalName`, `phoneNumber`, `proxyAddress`, `qrCode`, `onPremisesUserPrincipalName`, `unknownFutureValue`.|-|signInTokenProtectionStatus|tokenProtectionStatus|Token protection creates a cryptographically secure tie between the token and the device it is issued to. This field indicates whether the signin token was bound to the device or not. The possible values are: `none`, `bound`, `unbound`, `unknownFutureValue`.| +|signInTokenProtectionStatus|tokenProtectionStatus|Token protection creates a cryptographically secure tie between the token and the device it's issued to. This field indicates whether the signin token was bound to the device or not. The possible values are: `none`, `bound`, `unbound`, `unknownFutureValue`.| |status|[signInStatus](signinstatus.md)|The sign-in status. Includes the error code and description of the error (for a sign-in failure). <br/><br/> Supports `$filter` (`eq`) on **errorCode** property.| |tokenIssuerName|String|The name of the identity provider. For example, `sts.microsoft.com`. <br/><br/> Supports `$filter` (`eq`).| |tokenIssuerType|tokenIssuerType|The type of identity provider. The possible values are: `AzureAD`, `ADFederationServices`, `UnknownFutureValue`, `AzureADBackupAuth`, `ADFederationServicesMFAAdapter`, `NPSExtension`. 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): `AzureADBackupAuth` , `ADFederationServicesMFAAdapter` , `NPSExtension`.| The [Microsoft Entra data retention policies](/azure/active-directory/reports-mo |userId|String|The identifier of the user. <br/><br/> Supports `$filter` (`eq`).| |userPrincipalName|String|The UPN of the user. <br/><br/> Supports `$filter` (`eq`, `startsWith`).| |userType|signInUserType|Identifies whether the user is a member or guest in the tenant. Possible values are: `member`, `guest`, `unknownFutureValue`.|-|mfaDetail (deprecated)|String|This property is deprecated.| +|mfaDetail (deprecated)|[mfaDetail](../resources/mfadetail.md)|This property is deprecated.| ## Relationships The following JSON representation shows the resource type. "@odata.type": "microsoft.graph.appliedAuthenticationEventListener" } ],- "appTokenProtectionStatus": "String", + "appTokenProtectionStatus": { + "@odata.type": "microsoft.graph.tokenProtectionStatus" + }, "authenticationAppDeviceDetails": { "@odata.type": "microsoft.graph.authenticationAppDeviceDetails" }, The following JSON representation shows the resource type. }, "processingTimeInMilliseconds": "Integer", "riskDetail": "String",- "riskEventTypes": [ - "String" - ], "riskEventTypes_v2": [ "String" ], |
v1.0 | Signinlocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/signinlocation.md | Provides the city, state and country/region from where the sign-in happened. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Simulation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/simulation.md | Inherits from [entity](../resources/entity.md). |Member|Description | |:|:|-|unknown| The simulation status is not defined. | +|unknown| The simulation status isn't defined. | |draft| The simulation is in draft mode. | |running| The simulation is running. | |scheduled| The simulation is scheduled. |-|succeeded| The simulation has succeeded. | -|failed| The simulation has failed. | +|succeeded| The simulation is complete with success status. | +|failed| The simulation is complete with fail status. | |cancelled| The simulation is cancelled. | |excluded| The simulation is excluded. |-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. | +|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. | ### simulationAttackTechnique values Inherits from [entity](../resources/entity.md). |driveByUrl| Attack technique that involves an end user clicking a URL link in the phishing payload. | |linkInAttachment| Attack technique that involves an end user clicking a URL link in an attachment. | |linkToMalwareFile| Attack technique that involves an end user clicking a URL link to a malware file. |-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. | +|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. | |oAuthConsentGrant| Attack technique that involves an end user who gives access consent to an app.|+|phishTraining| Attack technique that involves training end users on actions to be performed on a phish mail.| ### simulationAttackType values Inherits from [entity](../resources/entity.md). |social| Attack that uses social skills to manipulate victims psychologically, creating a false sense of curiosity, urgency, or fear. | |cloud| Attack on a host or user in a cloud environment, for example, denial of service attacks.| |endpoint| Attack on endpoints of a corporate network, such as desktops, laptops, mobile phones, and Internet of Things (IoT) devices. |-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. | +|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. | ### simulationContentStatus values |Member|Description | |:|:|-|unknown| The simulation content status is not defined. | +|unknown| The simulation content status isn't defined. | |draft| The simulation content status is in draft state. | |ready| The simulation content status is in ready state. | |archive| The simulation content status is archive state. | |delete| The simulation content status is in delete state. |-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. | +|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. | ### simulationContentSource values |Member|Description | |:|:|-|unknown| The simulation content source is not defined. | +|unknown| The simulation content source isn't defined. | |global| The simulation content source is global. | |tenant| The simulation content source is tenant. |-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. | +|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. | ## Relationships |
v1.0 | Simulationautomation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/simulationautomation.md | Inherits from [entity](../resources/entity.md). |runs|[simulationAutomationRun](../resources/simulationautomationrun.md) collection|A collection of simulation automation runs. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Singleresourceazurepermissionsdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/singleresourceazurepermissionsdefinition.md | description: "Represents permissions for an Azure resource." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Singleresourcegcppermissionsdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/singleresourcegcppermissionsdefinition.md | description: "Represents permissions for a GCP resource." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Singlevaluelegacyextendedproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/singlevaluelegacyextendedproperty.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sitearchivaldetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sitearchivaldetails.md | ++ +description: "Represents the archival details of a siteCollection." + Title: "siteArchivalDetails resource type" +ms.localizationpriority: "medium" +++# siteArchivalDetails resource type ++Represents the archival details of a [siteCollection](/graph/sitecollection). ++## Properties ++| Property | Type | Description | +|:- |: |:--| +| archiveStatus | siteArchiveStatus | Represents the current archive status of the site collection. Returned only on `$select`.| ++## siteArchiveStatus values ++| Value | Description | +|:--|:| +| recentlyArchived | The site collection was recently archived. | +| fullyArchived | The site collection is fully archived. | +| reactivating | The site collection is reactivating. | +| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. | ++## JSON representation +The following JSON representation shows the resource type. +<!-- { +"blockType": "resource", +"@odata.type": "microsoft.graph.siteArchivalDetails", +"optionalProperties": [] +}--> ++```json +{ + "archiveStatus": "fullyArchived" +} +``` ++<!-- { +"type": "#page.annotation", +"createdBy": "API Clinic", +"section": "documentation" +}--> |
v1.0 | Sitecollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sitecollection.md | description: Provides more information about a site collection. Last updated 09/10/2017 Title: SiteCollection + Title: aiteCollection resource type ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph Provides more information about a site collection. -If a [**site**](site.md) resource has a non-null **siteCollection** property, then the site is a root site for a site collection. +If a [**site**](site.md) resource has a non-null **siteCollection** property, the site is a root site for a site collection. ## Properties If a [**site**](site.md) resource has a non-null **siteCollection** property, th | **hostname** | string | The hostname for the site collection. Read-only. | | **dataLocationCode** | string | The geographic region code for where this site collection resides. Only present for multi-geo tenants. Read-only. | | **root** | [root][] | If present, indicates that this is a root site collection in SharePoint. Read-only. |+| **archivalDetails** | [siteArchivalDetails][] | Represents whether the site collection is recently archived, fully archived, or reactivating. Possible values are: `recentlyArchived`, `fullyArchived`, `reactivating`, `unknownFutureValue`. | ## JSON representation The following JSON representation shows the resource type. { "hostname": "contoso.sharepoint.com", "dataLocationCode": "EUR",- "root": { "@odata.type": "microsoft.graph.root" } + "root": { "@odata.type": "microsoft.graph.root" }, + "archivalDetails": { + "@odata.type": "microsoft.graph.siteArchivalDetails", + "archiveStatus": "fullyArchived" + } } ``` [root]: root.md+[siteArchivalDetails]: siteArchivalDetails.md <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
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). | [Update sitePage](../api/sitepage-update.md) | [sitePage](../resources/sitepage.md) | Update the properties of a [sitePage](../resources/sitepage.md) object. | | [Delete sitePage](../api/basesitepage-delete.md) | None | Deletes a [sitePage](../resources/sitepage.md) object. | | [Publish sitePage](../api/sitepage-publish.md) | None | Publish a [sitePage](../resources/sitepage.md) object. |-| [Get a collection of WebParts by position information](../api/sitepage-getwebpartsbyposition.md) | [webpart](../resources/webpart.md) collection | Get a collection of [WebPart](../resources/webpart.md) by providing [webPartPosition](../resources/webpartposition.md) information. | +| [Get a collection of WebParts by position information](../api/sitepage-getwebpartsbyposition.md) | [webPart](../resources/webpart.md) collection | Get a collection of [WebPart](../resources/webpart.md) by providing [webPartPosition](../resources/webpartposition.md) information. | ## Properties |
v1.0 | Sitepagedata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sitepagedata.md | description: "The sitePageData resource represents the properties of a webPart. As these properties vary by web part, this is an OpenType with no fixed properties." Last updated 09/01/2018 Title: SitePageData + Title: sitePageData resource type ms.localizationpriority: medium doc_type: resourcePageType -# sitePageData resource +# sitePageData resource type Namespace: microsoft.graph |
v1.0 | Sizerange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sizerange.md | Specifies the maximum and minimum sizes (in kilobytes) that an incoming message ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Skype For Business Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/skype-for-business-activity-reports.md | - Title: "Skype for Business activity reports" -description: "You can get details on activity across your organization. These details can help you investigate, plan, and make other business decisions for your organization." ---doc_type: conceptualPageType ---# Skype for Business activity reports --Namespace: microsoft.graph ---You can get details on activity across your organization. These details can help you investigate, plan, and make other business decisions for your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Skype for Business activity](https://support.office.com/client/Skype-for-Business-Online-activity-8cbe2eb2-1194-4fd7-b1ee-9f9287c82424). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get user detail](../api/reportroot-getskypeforbusinessactivityuserdetail.md) | Stream | Stream | Get details about Skype for Business activity by user. | -| [Get activity counts](../api/reportroot-getskypeforbusinessactivitycounts.md) | Stream | 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 | 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. | -- |
v1.0 | Skype For Business Device Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/skype-for-business-device-usage-reports.md | - Title: "Skype for Business device usage reports" -description: "You can get details on the types of clients and devices that are used across your organization. These details are helpful when you're investigating, planning, and making other business decisions for your organization." ---doc_type: conceptualPageType ---# Skype for Business device usage reports --Namespace: microsoft.graph ---You can get details on the types of clients and devices that are used across your organization. These details are helpful when you're investigating, planning, and making other business decisions for your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Skype for Business clients used](https://support.office.com/client/Skype-for-Business-clients-used-b9019c36-034f-40c7-acb0-c2a0400b03c3). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get user detail](../api/reportroot-getskypeforbusinessdeviceusageuserdetail.md) | Stream | Stream | Get details about Skype for Business device usage by user. | -| [Get distribution user counts](../api/reportroot-getskypeforbusinessdeviceusagedistributionusercounts.md) | Stream | 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 | Stream | Get the usage trends on how many users in your organization have connected using the Skype for Business app. You'll 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. | -- |
v1.0 | Skype For Business Organizer Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/skype-for-business-organizer-activity-reports.md | - Title: "Skype for Business organizer activity reports" -description: "You can get details on organized conferences activity across your organization. These details are helpful when you're investigating, planning, and making other business decisions for your organization." ---doc_type: conceptualPageType ---# Skype for Business organizer activity reports --Namespace: microsoft.graph ---You can get details on organized conferences activity across your organization. These details are helpful when you're investigating, planning, and making other business decisions for your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Skype for Business conference organizer activity](https://support.office.com/client/Skype-for-Business-Online-conference-organized-activity-03a255d4-0e1d-4b24-b73d-7a62fae36254). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get activity counts](../api/reportroot-getskypeforbusinessorganizeractivitycounts.md) | Stream | 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 | 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 | 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. | -- |
v1.0 | Skype For Business Participant Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/skype-for-business-participant-activity-reports.md | - Title: "Skype for Business participant activity reports" -description: "You can get details on conferencing activity across your organization. These details are helpful when you're investigating, planning, and making other business decisions for your organization." ---doc_type: conceptualPageType ---# Skype for Business participant activity reports --Namespace: microsoft.graph ---You can get details on conferencing activity across your organization. These details are helpful when you're investigating, planning, and making other business decisions for your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Skype for Business conference participant activity](https://support.office.com/client/Skype-for-Business-Online-conference-participant-activity-c3c89995-65dd-4715-9e38-bb244c742c6b). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get activity counts](../api/reportroot-getskypeforbusinessparticipantactivitycounts.md) | Stream | 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 | 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 | 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. | -- |
v1.0 | Skype For Business Peer To Peer Activity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/skype-for-business-peer-to-peer-activity.md | - Title: "Skype for Business peer-to-peer activity reports" -description: "You can get details on peer-to-peer activity across your organization. These details are very helpful when you are investigating, planning, and making other business decisions for your organization." ---doc_type: conceptualPageType ---# Skype for Business peer-to-peer activity reports --Namespace: microsoft.graph ---You can get details on peer-to-peer activity across your organization. These details are very helpful when you are investigating, planning, and making other business decisions for your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Skype for Business peer-to-peer activity](https://support.office.com/client/Skype-for-Business-Online-peertopeer-activity-d3b2d569-4ee9-44b8-92bf-d518142f0713). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get activity counts](../api/reportroot-getskypeforbusinesspeertopeeractivitycounts.md) | Stream | 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 | 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 | 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. | -- |
v1.0 | Smsauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/smsauthenticationmethodconfiguration.md | Inherits from [authenticationMethodConfiguration](../resources/authenticationmet |includeTargets|[smsAuthenticationMethodTarget](../resources/smsauthenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Smsauthenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/smsauthenticationmethodtarget.md | Title: "smsAuthenticationMethodTarget resource type" -description: "A collection of groups enabled to use Text Message authentication methods policy." +description: "A collection of groups enabled to use text message authentication methods policy." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A collection of groups enabled to use [Text Message authentication methods policy](../resources/smsAuthenticationMethodConfiguration.md) in Microsoft Entra ID. +A collection of groups enabled to use [text message authentication methods policy](../resources/smsAuthenticationMethodConfiguration.md) in Microsoft Entra ID. Inherits from [authenticationMethodTarget](authenticationMethodTarget.md). ## Properties |Property|Type|Description| A collection of groups enabled to use [Text Message authentication methods polic None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Softwareoathauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/softwareoathauthenticationmethod.md | This is a derived type that inherits from the [authenticationMethod](authenticat None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Solutionsroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/solutionsroot.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The entry point for [Microsoft Bookings](booking-api-overview.md), [virtual event webinar](virtualeventwebinar.md), and [business scenario](businessscenario-overview.md) APIs. +The entry point for [Microsoft Bookings](booking-api-overview.md), [virtual event](virtualevent.md), and [business scenario](businessscenario-overview.md) APIs. All Microsoft Graph calls to resources under `/solutions` use the following service root URL: To access virtual event webinars, use the following syntax: <!-- { "blockType": "ignored" } --> ```http-https://graph.microsoft.com/{version}/virtualEvents/webinars +https://graph.microsoft.com/{version}/solutions/virtualEvents/webinars +``` ++To access virtual event town halls, use the following syntax: ++<!-- { "blockType": "ignored" } --> +```http +https://graph.microsoft.com/{version}/solutions/virtualEvents/townhalls ``` ## Methods None. |bookingBusinesses|[bookingBusiness](bookingbusiness.md) collection | A collection of businesses in Microsoft Bookings. Read-only. Nullable.| |bookingCurrencies|[bookingcurrency](bookingcurrency.md) collection | A collection of monetary currencies supported by a [bookingBusiness](bookingbusiness.md). Read-only. Nullable.| |businessScenarios|[businessScenario](businessscenario.md) collection | A collection of scenarios that contain relevant data and configuration information for a specific problem domain.|-|virtualEvents|virtualEventsRoot collection | A collection of virtual events.| +|virtualEvents|[virtualEventsRoot](virtualeventsroot.md) collection | A collection of virtual events.| ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. "@odata.type": "microsoft.graph.solutionsRoot" } -->-``` json +```json { "@odata.type": "#microsoft.graph.solutionsRoot" } |
v1.0 | Sourcedattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sourcedattribute.md | + + Title: "sourcedAttribute resource type" +description: "An attribute specifying where the claim data is sourced." ++ms.localizationpriority: medium ++++# sourcedAttribute resource type ++Namespace: microsoft.graph +++An attribute specifying where the claim data is sourced. ++Inherits from [customClaimAttributeBase](../resources/customclaimattributebase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|The identifier of the attribute on the specified source.| +|isExtensionAttribute|Boolean|A flag that indicates if the name specified is that of an extension attribute.| +|source|String|The source where the claim is going to retrieve its value. Valid sources include user, application, resource, audience and company.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.sourcedAttribute" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.sourcedAttribute", + "id": "String", + "source": "String", + "isExtensionAttribute": "Boolean" +} +``` + |
v1.0 | Stalesigninalertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/stalesigninalertconfiguration.md | Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrole |alertDefinition|[unifiedRoleManagementAlertDefinition](../resources/unifiedrolemanagementalertdefinition.md)| The definition of the alert that contains its description, impact, and measures to mitigate or prevent it. Supports `$expand`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Stalesigninalertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/stalesigninalertincident.md | Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanag None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Standardtimezoneoffset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/standardtimezoneoffset.md | That means the transition from daylight saving time to standard occurs at 2 AM o ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Startswithtransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/startswithtransformation.md | + + Title: "startsWithTransformation resource type" +description: Contains the output of a transformation if the input starts with the specified value." ++ms.localizationpriority: medium ++++# startsWithTransformation resource type ++Namespace: microsoft.graph +++Contains the output of a transformation if the input starts with the specified value. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|Attribute that provides the source for the transformation. This parameter is required if it is the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|output|[transformationAttribute](../resources/transformationattribute.md)|The output attribute used, based on the condition applied in this transformation.| +|value|String|The value to be used as part of the transformation.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.startsWithTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.startsWithTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "output": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "value": "String" +} +``` |
v1.0 | Statusdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/statusdetails.md | Describes the status of the provisioning event and the associated errors. It's i ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Storage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/storage.md | + + Title: "storage resource type" +description: "Facilitates the structures of active and deleted fileStorageContainers." ++ms.localizationpriority: medium ++++# storage resource type ++Namespace: microsoft.graph +++Facilitates the structures of fileStorageContainers. +++## Relationships +|Relationship|Type|Description| +|:|:|:| +|fileStorage|[fileStorage](../resources/filestorage.md)|fileStorage resource| + |
v1.0 | Subjectrightsrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/subjectrightsrequest.md | Inherits from [entity](../resources/entity.md). |team|[team](../resources/team.md)|Information about the Microsoft Teams team that was created for the request.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", Here's a JSON representation of the resource. "mailboxLocations": { "@odata.type": "microsoft.graph.subjectRightsRequestMailboxLocation" },- "pauseAfterDownload": "Boolean", + "pauseAfterEstimate": "Boolean", "regulations": [ "String" ], |
v1.0 | Subjectset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/subjectset.md | This object is an abstract base type from which the following resources are deri + [requestorManager](requestormanager.md) + [ruleBasedSubjectSet](../resources/identitygovernance-ruleBasedSubjectSet.md) + [singleUser](singleuser.md)++ [groupBasedSubjectSet](../resources/identitygovernance-groupbasedsubjectset.md) ## Properties |
v1.0 | Subscribedsku | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/subscribedsku.md | Inherits from [directoryObject](directoryobject.md). | servicePlans | [servicePlanInfo](serviceplaninfo.md) collection | Information about the service plans that are available with the SKU. Not nullable | | skuId | String | The unique identifier (GUID) for the service SKU. | | skuPartNumber | String | The SKU part number; for example, `AAD_PREMIUM` or `RMSBASIC`. To get a list of commercial subscriptions that an organization has acquired, see [List subscribedSkus](../api/subscribedsku-list.md). |-| subscriptionsIds | String collection | A list of all [subscription IDs](../resources/companysubscription.md) associated with this SKU. | +| subscriptionIds | String collection | A list of all [subscription IDs](../resources/companysubscription.md) associated with this SKU. | ## Relationships |
v1.0 | Subscription | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/subscription.md | description: "Represents a subscription that allows a client app to receive chan ms.localizationpriority: medium doc_type: resourcePageType+ |
v1.0 | Substringtransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/substringtransformation.md | + + Title: "substringTransformation resource type" +description: "Creates a new value by extracting a substring, you can provide a zero-based starting index for the substring." ++ms.localizationpriority: medium ++++# substringTransformation resource type ++Namespace: microsoft.graph +++Creates a new value by extracting a substring, you can provide a zero-based starting index for the substring. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|index|Int32|The start index of the substring operation, where 0 is the first character in the string.| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it is the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|length|Int32|The maximum length of the string, starting from the provided index.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.substringTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.substringTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "index": "Integer", + "length": "Integer" +} +``` |
v1.0 | Superawsresourcefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/superawsresourcefinding.md | description: "Represents the super AWS resources." ms.localizationpriority: medium-doc_type: apiPageType + # superAwsResourceFinding resource type |
v1.0 | Superawsrolefinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/superawsrolefinding.md | description: "Represents the super AWS roles." ms.localizationpriority: medium-doc_type: apiPageType + # superAwsRoleFinding resource type |
v1.0 | Superazureserviceprincipalfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/superazureserviceprincipalfinding.md | description: "Represents the super Azure service principals." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Supergcpserviceaccountfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/supergcpserviceaccountfinding.md | description: "Represents the super GCP service accounts." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Superserverlessfunctionfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/superserverlessfunctionfinding.md | description: "Represents the super serverless functions in AWS, Azure, or GCP." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Superuserfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/superuserfinding.md | description: "Represents the super users in AWS, Azure, or GCP." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Synchronization Attributedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-attributedefinition.md | Describes an attribute of an object. |:--|:-|:| |anchor |Boolean | `true` if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is `false`. One, and only one, of the object's attributes must be designated as the anchor to support synchronization. | |caseExact |Boolean |`true` if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.|+|defaultValue |String |The default value of the attribute.| |flowNullValues |Boolean |'true' to allow null values for attributes.| |metadata |[attributeDefinitionMetadataEntry](../resources/synchronization-attributedefinitionmetadataentry.md) collection |Metadata for the given object.| |multivalued |Boolean |`true` if an attribute can have multiple values. Default is `false`.| |
v1.0 | Synchronization Attributemappingsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-attributemappingsource.md | Expression extracting first eight characters from the source attribute. ``` ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.attributeMappingSource" |
v1.0 | Synchronization Bulkupload | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-bulkupload.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the capability of the Microsoft Entra synchronization service to process bulk uploads. +Represents the capability of the Microsoft Entra synchronization service to process bulk uploads. For more information, see [API-driven inbound provisioning concepts](/entra/identity/app-provisioning/inbound-provisioning-api-concepts). ## Methods |
v1.0 | Synchronization Directorydefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-directorydefinition.md | Inherits from [entity](../resources/entity.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. "discoverabilities": "String", "discoveryDateTime": "DateTimeOffset", "id": "String",- "metadata": [ - { - "@odata.type": "microsoft.graph.stringKeyStringValuePair" - } - ], "name": "String", "objects": [ { |
v1.0 | Synchronization Filter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-filter.md | For more information, see [Attribute-based application provisioning with scoping ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Synchronization Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-overview.md | To work with the Microsoft Entra synchronization APIs, Microsoft Graph supports - Application.Read.All - Application.ReadWrite.All -And the following [Microsoft Entra directory roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): +And the following least privileged [Microsoft Entra directory roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): - Application Administrator - Cloud Application Administrator - Hybrid Identity Administrator-- Global Administrator For more information about the privileges you need to call each API, visit the respective API reference documentation. |
v1.0 | Synchronization Synchronization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-synchronization.md | The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.synchronization",- "version": "String", "secrets": [ { "@odata.type": "microsoft.graph.synchronizationSecretKeyStringValuePair" |
v1.0 | Synchronization Synchronizationjobrestartcriteria | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-synchronizationjobrestartcriteria.md | Defines the scope of the [synchronizationJob: restart](../api/synchronization-sy ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Synchronization Synchronizationschema | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-synchronizationschema.md | The following sections describe the high-level components of the synchronization |directories|[directoryDefinition](../resources/synchronization-directorydefinition.md) collection|Contains the collection of directories and all of their objects.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Synchronization Synchronizationsecretkeystringvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-synchronizationsecretkeystringvaluepair.md | Represents a single secret value. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Synchronization Synchronizationtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/synchronization-synchronizationtemplate.md | You can provide multiple templates for an application, and designate a default t ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Targetresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/targetresource.md | Represents target resource types associated with audit activity. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Targetusersponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/targetusersponsors.md | 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.targetUserSponsors" |
v1.0 | Tasks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/tasks.md | None. |lists|[baseTaskList](../resources/basetasklist.md) collection|The task lists in the users mailbox.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", "@odata.type": "microsoft.graph.tasks",- "openType": false + "openType": false, + "baseType": "microsoft.graph.entity" } --> ``` json |
v1.0 | Taskviewpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/taskviewpoint.md | Contains personal properties of a [task](task.md). When sharing or assigning a * 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.taskViewpoint" Here's a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.taskViewpoint",- "reminderDatetime": { + "reminderDateTime": { "@odata.type": "microsoft.graph.dateTimeTimeZone" }, "categories": ["string"] |
v1.0 | Teaminfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teaminfo.md | Base type of [associatedTeamInfo](associatedteaminfo.md) and [sharedWithChannelT ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
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: resourcePageType # teamsAppInstalledState enum type |
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: resourcePageType # teamsAsyncOperationStatus enum type |
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 will be added here as more async operations are supported." +description: "Types of teamsAsyncOperation. Members are added here as more async operations are supported." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Types of [teamsAsyncOperation](teamsasyncoperation.md). Members will be added here as more async operations are supported. +Types of [teamsAsyncOperation](teamsasyncoperation.md). Members are added here as more async operations are supported. ## Members-The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `teamifyGroup`, `createChannel`, `createChat`. +The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `teamifyGroup`, `createChannel`, `createChat`, `archiveChannel`, `unarchiveChannel`. | Member | Description | |:|:-| The following table lists the members of an [evolvable enumeration](/graph/best- |archiveTeam|Operation to archive a team.| |unarchiveTeam|Operation to restore an archived team.| |createTeam|Operation to create a team from scratch.|-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. | +|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. | |teamifyGroup |Operation to create a team from a group. | |createChannel |Operation to create a channel in a team. | |createChat|Operation to create a chat from scratch.|+|archiveChannel |Operation to archive a channel.| +|unarchiveChannel |Operation to unarchive a channel.| |
v1.0 | Teamstab | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamstab.md | Title: "teamsTab resource type" -description: "A teamsTab is a tab that's pinned (attached) to a channel within a team. " +description: "Represents a tab pinned (attached) to a channel or a chat." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A teamsTab is a [tab](../resources/teamstab.md) that's pinned (attached) to a [channel](channel.md) within a [team](team.md). +Represents a tab pinned (attached) to a [channel](channel.md) or a [chat](chat.md). ++For more information about tabs, see [Build tabs for Teams](/microsoftteams/platform/tabs/what-are-tabs). ## Methods A teamsTab is a [tab](../resources/teamstab.md) that's pinned (attached) to a [c | id | string | Identifier that uniquely identifies a specific instance of a channel tab. Read only. | | displayName | string | Name of the tab. | | name (deprecated) | string | Name of the tab. |-| teamsAppId (deprecated)| string | App definition identifier of the tab. This value cannot be changed after tab creation. Because this property is deprecated, we recommend expanding **teamsApp** to retrieve the application that is linked to the tab. | +| teamsAppId (deprecated)| string | App definition identifier of the tab. This value can't be changed after tab creation. Because this property is deprecated, we recommend expanding **teamsApp** to retrieve the application that is linked to the tab. | | sortOrderIndex | string | Index of the order used for sorting tabs. | | webUrl | string | Deep link URL of the tab instance. Read only. | | configuration | [teamsTabConfiguration](teamstabconfiguration.md) | Container for custom settings applied to a tab. The tab is considered configured only once this property is set. | A teamsTab is a [tab](../resources/teamstab.md) that's pinned (attached) to a [c ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { |
v1.0 | Teamworkactivitytopic | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamworkactivitytopic.md | Represents the topic of an activity feed notification. 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.teamworkActivityTopic" |
v1.0 | Teamworkdevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamworkdevice.md | Inherits from [entity](../resources/entity.md). |operations|[teamworkDeviceOperation](../resources/teamworkdeviceoperation.md) collection|The async operations on the device.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Teamworktag | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamworktag.md | When a tag is added, users can @mention it in a channel. Everyone who has been a |members|[teamworkTagMember](../resources/teamworktagmember.md) collection|Users assigned to the tag.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Temporaryaccesspassauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/temporaryaccesspassauthenticationmethod.md | +toc.keywords: [ TAP ] # temporaryAccessPassAuthenticationMethod resource type |
v1.0 | Tenantinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/tenantinformation.md | Namespace: microsoft.graph Information about your Microsoft Entra tenant that is publicly displayed to users in other Microsoft Entra tenants. +## Methods ++| Method | Return Type | Description | +|:-|:|:| +| [Find tenant by domain name](../api/tenantrelationship-findtenantinformationbydomainname.md) | tenantInformation | Given a domain name, search for a tenant and read its information. | +| [Find tenant by tenant ID](../api/tenantrelationship-findtenantinformationbytenantid.md) | tenantInformation | Given a tenant ID, search for a tenant and read its information. | + ## Properties |Property|Type|Description| |
v1.0 | Tenantreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/tenantreference.md | Title: "tenantReference resource type" description: "Represents the information used to identify a Microsoft Entra tenant." + ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Tenantrelationshipaccesspolicybase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/tenantrelationshipaccesspolicybase.md | The following is a JSON representation of the resource. "displayName": "String" } ```++<!-- +{ + "type": "#page.annotation", + "description": "tenantRelationshipAccessPolicyBase resource type", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: Property 'definition' found in resource definition for 'microsoft.graph.tenantRelationshipAccessPolicyBase', but not described in markdown table." + ] +} +--> |
v1.0 | Termstore Relation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/termstore-relation.md | Inherits from [entity](../resources/entity.md). |toTerm|[microsoft.graph.termStore.term](../resources/termstore-term.md)|The to [term] of the relation. The term to which the relationship is defined.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Textwebpart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/textwebpart.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Threatassessment Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/threatassessment-api-overview.md | Title: "Use the Microsoft Graph threat assessment API" description: "Microsoft Graph lets your app get authorized access to organization's threat assessment data." ms.localizationpriority: high -doc_type: resourcePageType # Use the Microsoft Graph threat assessment API |
v1.0 | Thumbnailset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/thumbnailset.md | It's used to represent a set of thumbnails associated with a DriveItem. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Tiindicator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/tiindicator.md | Title: "tiIndicator resource type" + Title: "tiIndicator resource type (deprecated)" description: "Threat intelligence (TI) indicators represent data used to identify malicious activities." ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType -# tiIndicator resource type +# tiIndicator resource type (deprecated) Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!NOTE] +> The [tiIndicator](tiindicator.md) entity is deprecated and will be removed by April 2026. + Represents data used to identify malicious activities. If your organization works with threat indicators, either by generating your own, obtaining them from open source feeds, sharing with partner organizations or communities, or by purchasing feeds of data, you might want to use these indicators in various security tools for matching with log data. The **tiIndicators** entity allows you to upload your threat indicators to Microsoft security tools for the actions of allow, block, or alert. None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timecardbreak | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/timecardbreak.md | Represents a specific [timeCard](timecard.md) break. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timecardentry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/timecardentry.md | Represents a specific [timeCard](timecard.md) entry. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timecardevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/timecardevent.md | Represents a specific [timeCard](timecard.md) event. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timeclocksettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/timeclocksettings.md | Represents timeclock settings for a [schedule](schedule.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timeconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/timeconstraint.md | Restricts meeting time suggestions to certain hours and days of the week accordi ## JSON representation-Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timeoffitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/timeoffitem.md | Represents a version of the [timeOff](timeoff.md). ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timestamp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/timestamp.md | Date and time information for a point in time. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timezonebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/timezonebase.md | The basic representation of a time zone. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timezoneinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/timezoneinformation.md | format as well when the current known problem is fixed. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Todosettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/todosettings.md | Company-wide settings for Microsoft Todo. 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.todoSettings" |
v1.0 | Tolowercasetransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/tolowercasetransformation.md | + + Title: "toLowercaseTransformation resource type" +description: "Converts the characters of the selected attribute into lowercase characters." ++ms.localizationpriority: medium ++++# toLowercaseTransformation resource type ++Namespace: microsoft.graph +++Converts the characters of the selected attribute into lowercase characters. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute that provides the source for the transformation. This parameter is required if it is the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.toLowercaseTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.toLowercaseTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + } +} +``` + |
v1.0 | Touppercasetransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/touppercasetransformation.md | + + Title: "toUppercaseTransformation resource type" +description: "Converts the characters of the selected attribute into uppercase characters." ++ms.localizationpriority: medium ++++# toUppercaseTransformation resource type ++Namespace: microsoft.graph +++Converts the characters of the selected attribute into uppercase characters. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|The input attribute provides the source for the transformation. This parameter is required if it is the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.toUppercaseTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.toUppercaseTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + } +} +``` |
v1.0 | Training | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/training.md | Inherits from [entity](../resources/entity.md). |Property|Type|Description| |:|:|:|-|availabilityStatus|trainingAvailabilityStatus|Training availability status. Possible values are: `unknown`, `notAvailable`, `available`, `archive`, `delete`, `unknownFutureValue`.| -|createdBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who created the training.| -|createdDateTime|DateTimeOffset|Date and time when the training 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`.| +|availabilityStatus|trainingAvailabilityStatus|The training availability status. Possible values are: `unknown`, `notAvailable`, `available`, `archive`, `delete`, `unknownFutureValue`.| +|createdBy|[emailIdentity](../resources/emailidentity.md)|The identity of the user who created the training.| +|createdDateTime|DateTimeOffset|The date and time when the training 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`.| +|customUrl|String|The training URL| |description|String|The description for the training.| |displayName|String|The display name for the training.|-|durationInMinutes|Int32|Training duration.| -|hasEvaluation|Boolean|Indicates whether the training has any evaluation.| -|id|String|Unique identifier for the **training** object. Inherited from [entity](../resources/entity.md).| -|lastModifiedBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who last modified the training.| -|lastModifiedDateTime|DateTimeOffset|Date and time when the training was last modified. 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`.| -|source|[simulationContentSource](../resources/simulation.md#simulationcontentsource-values)|Training content source. Possible values are: `unknown`, `global`, `tenant`, `unknownFutureValue`.| -|supportedLocales|String collection|Supported locales for content for the associated training.| +|durationInMinutes|Int32|The duration of the training in minutes.| +|hasEvaluation|Boolean|Whether the training has any evaluation.| +|id|String|The unique identifier for the **training** object. Inherited from [entity](../resources/entity.md).| +|lastModifiedBy|[emailIdentity](../resources/emailidentity.md)|The identity of the user who last modified the training.| +|lastModifiedDateTime|DateTimeOffset|The date and time when the training was last modified. 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`.| +|source|[simulationContentSource](../resources/simulation.md#simulationcontentsource-values)|The source of the training content. Possible values are: `unknown`, `global`, `tenant`, `unknownFutureValue`.| +|supportedLocales|String collection|The supported locales for content for the associated training.| |tags|String collection|Training tags.| |type|trainingType|The type of training. Possible values are: `unknown`, `phishing`, `unknownFutureValue`.| Inherits from [entity](../resources/entity.md). |Relationship|Type|Description| |:|:|:|-|languageDetails|[trainingLanguageDetail](../resources/traininglanguagedetail.md) collection|Language specific details on a training.| +|languageDetails|[trainingLanguageDetail](../resources/traininglanguagedetail.md) collection|Details about the language used in the training.| ## JSON representation The following JSON representation shows the resource type. "id": "String (identifier)", "lastModifiedBy": {"@odata.type": "microsoft.graph.emailIdentity"}, "lastModifiedDateTime": "String (timestamp)",+ "customUrl": "String", "source": "String", "supportedLocales": ["String"], "tags": ["String"], |
v1.0 | Trainingcampaign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trainingcampaign.md | + + Title: "trainingCampaign resource type" +description: "Represents a training campaign." ++ms.localizationpriority: medium +++# trainingCampaign resource type ++Namespace: microsoft.graph +++Represents a training campaign. In Attack simulation training in Microsoft 365 E5 or Microsoft Defender for Office 365 Plan 2, training campaigns are a fast, direct way to provide security training to users. Instead of creating and launching simulated phishing attacks that eventually lead to training, you can create and assign training campaigns directly to users. ++A training campaign contains one or more built-in training modules that you select. Currently, there are over 70 training modules to select from. For more information about training modules, see training modules for Training campaigns in Attack simulation training. +++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List trainingCampaigns](../api/attacksimulationroot-list-trainingcampaigns.md)|[trainingCampaign](../resources/trainingcampaign.md) collection|Get a list of the [trainingCampaign](../resources/trainingcampaign.md) objects and their properties.| +|[Create trainingCampaign](../api/attacksimulationroot-post-trainingcampaigns.md)|[trainingCampaign](../resources/trainingcampaign.md)|Create a new [trainingCampaign](../resources/trainingcampaign.md) object.| +|[Get trainingCampaign](../api/trainingcampaign-get.md)|[trainingCampaign](../resources/trainingcampaign.md)|Read the properties and relationships of a [trainingCampaign](../resources/trainingcampaign.md) object.| +|[Update trainingCampaign](../api/trainingcampaign-update.md)|[trainingCampaign](../resources/trainingcampaign.md)|Update the properties of a [trainingCampaign](../resources/trainingcampaign.md) object.| +|[Delete trainingCampaign](../api/attacksimulationroot-delete-trainingcampaigns.md)|None|Delete a [trainingCampaign](../resources/trainingcampaign.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|campaignSchedule|[campaignSchedule](../resources/campaignschedule.md)|Details about the schedule and current status for a training campaign| +|createdBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who created the training campaign| +|createdDateTime|DateTimeOffset|Date and time of creation of the training campaign.| +|description|String|Description of the training campaign.| +|displayName|String|Display name of the training campaign. Supports `$filter` and `$orderby`.| +|endUserNotificationSetting|[endUserNotificationSetting](../resources/endusernotificationsetting.md)|Details about the end user notification setting.| +|excludedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|Users excluded from the training campaign.| +|id|String|Unique identifier for the training campaign. Inherited from [entity](../resources/entity.md).| +|includedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|Users targeted in the training campaign.| +|lastModifiedBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who most recently modified the training campaign.| +|lastModifiedDateTime|DateTimeOffset|Date and time of the most recent modification of the training campaign.| +|report|[trainingCampaignReport](../resources/trainingcampaignreport.md)|Report of the training campaign.| +|trainingSetting|[trainingSetting](../resources/trainingsetting.md)|Details about the training settings for a training campaign.| ++### campaignStatus values ++|Member|Description | +|:|:| +|unknown| The campaign status isn't defined. | +|draft| The campaign is in draft mode. | +|inProgress| The campaign is in progress. | +|scheduled| The campaign is scheduled. | +|completed| The campaign is complete. | +|failed| The campaign failed. | +|cancelled| The campaign is cancelled. | +|excluded| The campaign is excluded. | +|deleted| The campaign is in draft mode. | +|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.trainingCampaign", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.trainingCampaign", + "id": "String (identifier)", + "createdBy": { + "@odata.type": "microsoft.graph.emailIdentity" + }, + "createdDateTime": "String (timestamp)", + "description": "String", + "displayName": "String", + "endUserNotificationSetting": { + "@odata.type": "microsoft.graph.endUserNotificationSetting" + }, + "excludedAccountTarget": { + "@odata.type": "microsoft.graph.accountTargetContent" + }, + "includedAccountTarget": { + "@odata.type": "microsoft.graph.accountTargetContent" + }, + "lastModifiedBy": { + "@odata.type": "microsoft.graph.emailIdentity" + }, + "lastModifiedDateTime": "String (timestamp)", + "report": { + "@odata.type": "microsoft.graph.trainingCampaignReport" + }, + "trainingSetting": { + "@odata.type": "microsoft.graph.trainingSetting" + }, + "campaignSchedule": { + "@odata.type": "microsoft.graph.campaignSchedule" + } +} +``` ++## Related content +- [Training campaigns in Attack simulation training](/microsoft-365/security/office-365-security/attack-simulation-training-training-campaigns?view=o365-worldwide&preserve-view=true) + |
v1.0 | Trainingcampaignreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trainingcampaignreport.md | + + Title: "trainingCampaignReport resource type" +description: "Represents a report of a training campaign, including an overview and a list of the users who participated in the campaign." ++ms.localizationpriority: medium +++# trainingCampaignReport resource type ++Namespace: microsoft.graph +++Represents a report of a training campaign, including an overview and a list of the users who participated in the campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|campaignUsers|[userSimulationDetails](../resources/usersimulationdetails.md) collection|The overview of the attack simulation and training campaign.| +|overview|[trainingCampaignReportOverview](../resources/trainingcampaignreportoverview.md)|The tenant users and their online actions in a training campaign.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.trainingCampaignReport" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.trainingCampaignReport", + "overview": { + "@odata.type": "microsoft.graph.trainingCampaignReportOverview" + }, + "campaignUsers": [ + { + "@odata.type": "microsoft.graph.userSimulationDetails" + } + ] +} +``` + |
v1.0 | Trainingcampaignreportoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trainingcampaignreportoverview.md | + + Title: "trainingCampaignReportOverview resource type" +description: "Represents an overview report of a training campaign." ++ms.localizationpriority: medium +++# trainingCampaignReportOverview resource type ++Namespace: microsoft.graph +++Represents an overview report of a training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|trainingModuleCompletion|[trainingEventsContent](../resources/trainingeventscontent.md)|Aggregate data of training completion.| +|trainingNotificationDeliveryStatus|[trainingNotificationDelivery](../resources/trainingnotificationdelivery.md)|Aggregate data of training mail delivery over the course of the training campaign.| +|userCompletionStatus|[userTrainingCompletionSummary](../resources/usertrainingcompletionsummary.md)|Aggregate data of users training progress.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.trainingCampaignReportOverview" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.trainingCampaignReportOverview", + "trainingModuleCompletion": { + "@odata.type": "microsoft.graph.trainingEventsContent" + }, + "userCompletionStatus": { + "@odata.type": "microsoft.graph.userTrainingCompletionSummary" + }, + "trainingNotificationDeliveryStatus": { + "@odata.type": "microsoft.graph.trainingNotificationDelivery" + } +} +``` + |
v1.0 | Trainingnotificationdelivery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trainingnotificationdelivery.md | + + Title: "trainingNotificationDelivery resource type" +description: "Contains aggregate data about training mail delivery over the course of the training campaign." ++ms.localizationpriority: medium +++# trainingNotificationDelivery resource type ++Namespace: microsoft.graph +++Contains aggregate data about training mail delivery over the course of the training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|failedMessageDeliveryCount|Int32|The number of users to whom mails couldn't be delivered.| +|resolvedTargetsCount|Int32|The number of users whose email address was successfully resolved from target users.| +|successfulMessageDeliveryCount|Int32|The number of users who received a mail while the training campaign was in the "in progress" state.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.trainingNotificationDelivery" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.trainingNotificationDelivery", + "resolvedTargetsCount": "Integer", + "successfulMessageDeliveryCount": "Integer", + "failedMessageDeliveryCount": "Integer" +} +``` + |
v1.0 | Transformationattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/transformationattribute.md | + + Title: "transformationAttribute resource type" +description: "Represents an attribute used to support transformations." ++ms.localizationpriority: medium ++++# transformationAttribute resource type ++Namespace: microsoft.graph +++Represents an attribute used to support transformations. ++## Properties +|Property|Type|Description| +|:|:|:| +|attribute|[customClaimAttributeBase](../resources/customclaimattributebase.md)|Attribute to be used as input for the transformation.| +|treatAsMultiValue|Boolean|This flag is only relevant in the case where the attribute is multivalued. By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to `true` ensures the transformation is applied to all values, resulting in a multivalued output.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.transformationAttribute" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.transformationAttribute", + "attribute": { + "@odata.type": "microsoft.graph.customClaimAttributeBase" + }, + "treatAsMultiValue": "Boolean" +} +``` |
v1.0 | Translationlanguageoverride | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/translationlanguageoverride.md | Title: "translationLanguageOverride resource type" description: "A resource representing an entry in the translation language override list." ms.localizationpriority: medium + doc_type: resourcePageType # translationLanguageOverride resource type |
v1.0 | Translationpreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/translationpreferences.md | Title: "translationPreferences resource type" description: "A resource representing the user's translation settings preferences." ms.localizationpriority: medium + doc_type: resourcePageType # translationPreferences resource type |
v1.0 | Trimtransformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trimtransformation.md | + + Title: "trimTransformation resource type" +description: "Eliminates leading and trailing characters that match the provided input." ++ms.localizationpriority: medium ++++# trimTransformation resource type ++Namespace: microsoft.graph +++Eliminates leading and trailing characters that match the provided input. ++Inherits from [customClaimTransformation](../resources/customclaimtransformation.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|input|[transformationAttribute](../resources/transformationattribute.md)|Attribute that provides the source for the transformation. This parameter is required if it is the first or only transformation in the list of transformations to be applied. Subsequent transformations use the output of the prior transformation as input. Inherited from [customClaimTransformation](../resources/customclaimtransformation.md).| +|type|transformationTrimType|The type of trim transformation to apply. The possible values are: `leading`, `trailing`, `leadingAndTrailing`, `unknownFutureValue`.| +|value|String|The value to be used as part of the transformation.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.trimTransformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.trimTransformation", + "input": { + "@odata.type": "microsoft.graph.transformationAttribute" + }, + "type": "String", + "value": "String" +} +``` |
v1.0 | Trustframeworkkey_V2 | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trustFrameworkkey_v2.md | + + Title: "trustFrameworkKey_v2 resource type" +description: "Represents a JWK (JSON Web Key). TrustFrameworkKey_v2 is a JSON data structure that represents a cryptographic key. The structure of this resource follows the format defined in RFC 7517 Section 4." ++ms.localizationpriority: medium ++++# trustFrameworkKey_v2 resource type ++Namespace: microsoft.graph +++Represents a JWK (JSON Web Key). TrustFrameworkKey_v2 is a JSON data structure that represents a cryptographic key. The structure of this resource follows the format defined in [RFC 7517 Section 4](https://tools.ietf.org/html/rfc7517#section-4). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get](../api/trustframeworkkey_v2-get.md)|[trustFrameworkKey_v2](../resources/trustframeworkkey_v2.md)|Read the properties and relationships of a [trustFrameworkKey_v2](../resources/trustframeworkkey_v2.md) object.| +|[Update](../api/trustframeworkkey_v2-update.md)|[trustFrameworkKey_v2](../resources/trustframeworkkey_v2.md)|Update the properties of a [trustFrameworkKey_v2](../resources/trustframeworkkey_v2.md) object.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|d|String|RSA Key - private exponent. The field isn't readable.| +|dp|String|RSA Key - first exponent. The field isn't readable.| +|dq|String|RSA Key - second exponent. The field isn't readable.| +|e|String|RSA Key - public exponent. | +|exp|Int64|This value is a NumericDate as defined in RFC 7519. That is, a JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds.| +|k|String|Symmetric Key for oct key type. The field isn't readable.| +|kid|String|The unique identifier for the key. Primary key.| +|kty|String|The **kty** (key type) parameter identifies the cryptographic algorithm family used with the key. The valid values are `rsa`, `oct`.| +|n|String|RSA Key - modulus.| +|nbf|Int64|This value is a NumericDate as defined in RFC 7519. That is, a JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds.| +|p|String|RSA Key - first prime. The field isn't readable.| +|q|String|RSA Key - second prime. The field isn't readable.| +|qi|String|RSA Key - Coefficient. The field isn't readable.| +|status|trustFrameworkKeyStatus|Status of the key. The possible values are: `enabled`, `disabled`, `unknownFutureValue`.| +|use|String|The **use** (public key use) parameter identifies the intended use of the public key. The **use** parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Possible values are: `sig` (signature), `enc` (encryption).| +|x5c|String collection|The **x5c** (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates. For more information, see [RFC 5280](https://tools.ietf.org/html/rfc5280).| +|x5t|String|The **x5t** (X.509 certificate SHA-1 thumbprint) parameter is a base64url-encoded SHA-1 thumbprint (also known as digest) of the DER encoding of an X.509 certificate. For more information, see [RFC 5280](https://tools.ietf.org/html/rfc5280).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "kid", + "@odata.type": "microsoft.graph.trustFrameworkKey_v2", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.trustFrameworkKey_v2", + "k": "String", + "x5c": [ + "String" + ], + "x5t": "String", + "kty": "String", + "use": "String", + "status": "String", + "exp": "Integer", + "nbf": "Integer", + "kid": "String (identifier)", + "e": "String", + "n": "String", + "d": "String", + "p": "String", + "q": "String", + "dp": "String", + "dq": "String", + "qi": "String" +} +``` + |
v1.0 | Trustframeworkkey | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trustframeworkkey.md | Title: "trustFrameworkKey resource type" description: "Represents a JWK (JSON Web Key). TrustFrameworkKey is a JSON data structure that represents a cryptographic key. The structure of this resource follows the format defined in RFC 7517 Section 4."+ ms.localizationpriority: medium- -doc_type: "resourcePageType" # trustFrameworkKey resource type Represents a JWK (JSON Web Key). TrustFrameworkKey is a JSON data structure that ## Properties -| Property | Type | Description | -|:-|:|:| -| kid | string | The unique identifier for the key. | -| kty | String | The **kty** (key type) parameter identifies the cryptographic algorithm family used with the key, The valid values are `rsa`, `oct`. | -| use | String | The **use** (public key use) parameter identifies the intended use of the public key. The **use** parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Possible values are: `sig` (signature), `enc` (encryption) | -| x5c | string collection | The **x5c** (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC 5280](https://tools.ietf.org/html/rfc5280). | -| x5t | string | The **x5t** (X.509 certificate SHA-1 thumbprint) parameter is a base64url-encoded SHA-1 thumbprint (also known as digest) of the DER encoding of an X.509 certificate [RFC 5280](https://tools.ietf.org/html/rfc5280). | -| e | string | RSA Key - public exponent | -| d| string | RSA Key - private exponent. Field can't be read back. | -| n | string | RSA Key - modulus | -| p | string | RSA Key - first prime. Field can't be read back. | -| q | string | RSA Key - second prime. Field can't be read back. | -| dp | string | RSA Key - first exponent. Field can't be read back. | -| dq | string | RSA Key - second exponent. Field can't be read back. | -| qi | string | RSA Key - Coefficient. Field can't be read back. | -| k | string | Symmetric Key for oct key type. Field can't be read back. | -| nbf | int | This value is a NumericDate as defined in RFC 7519 (A JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds.) | -| exp | int | This value is a NumericDate as defined in RFC 7519 (A JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds.) | --+|Property|Type|Description| +|:|:|:| +|d|String|RSA Key - private exponent. The field isn't readable.| +|dp|String|RSA Key - first exponent. The field isn't readable.| +|dq|String|RSA Key - second exponent. The field isn't readable.| +|e|String|RSA Key - public exponent. | +|exp|Int64|This value is a NumericDate as defined in RFC 7519. That is, a JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds.| +|k|String|Symmetric Key for oct key type. The field isn't readable.| +|kid|String|The unique identifier for the key.| +|kty|String|The **kty** (key type) parameter identifies the cryptographic algorithm family used with the key. The valid values are `rsa`, `oct`.| +|n|String|RSA Key - modulus.| +|nbf|Int64|This value is a NumericDate as defined in RFC 7519. That is, a JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds.| +|p|String|RSA Key - first prime. The field isn't readable.| +|q|String|RSA Key - second prime. The field isn't readable.| +|qi|String|RSA Key - Coefficient. The field isn't readable.| +|status|trustFrameworkKeyStatus|Status of the key. The possible values are: `enabled`, `disabled`, `unknownFutureValue`.| +|use|String|The **use** (public key use) parameter identifies the intended use of the public key. The **use** parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Possible values are: `sig` (signature), `enc` (encryption).| +|x5c|String collection|The **x5c** (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates. For more information, see [RFC 5280](https://tools.ietf.org/html/rfc5280).| +|x5t|String|The **x5t** (X.509 certificate SHA-1 thumbprint) parameter is a base64url-encoded SHA-1 thumbprint (also known as digest) of the DER encoding of an X.509 certificate. For more information, see [RFC 5280](https://tools.ietf.org/html/rfc5280).| ++## Relationships +None. ## JSON representation--Here's a JSON representation of the resource. -+The following JSON representation shows the resource type. <!-- { "blockType": "resource",- "optionalProperties": [ -- ], - "@odata.type": "microsoft.graph.trustFrameworkKey", - "baseType": null -}--> --```json + "@odata.type": "microsoft.graph.trustFrameworkKey" +} +--> +``` json {- "d": "String", - "dp": "String", - "dq": "String", - "e": "String", - "exp": 1024, + "@odata.type": "#microsoft.graph.trustFrameworkKey", "k": "String",- "kid": "String", + "x5c": [ + "String" + ], + "x5t": "String", "kty": "String",+ "use": "String", + "status": "String", + "exp": "Integer", + "nbf": "Integer", + "kid": "String (identifier)", + "e": "String", "n": "String",- "nbf": 1024, + "d": "String", "p": "String", "q": "String",- "qi": "String", - "use": "String", - "x5c": ["String"], - "x5t": "String" + "dp": "String", + "dq": "String", + "qi": "String" } ``` -<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 -2019-02-04 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "trustFrameworkKey resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> -- |
v1.0 | Trustframeworkkeyset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trustframeworkkeyset.md | Title: "trustFrameworkKeySet resource type" description: "Represents a trust framework keyset/policy key."+ ms.localizationpriority: medium- -doc_type: "resourcePageType" # trustFrameworkKeySet resource type Namespace: microsoft.graph Represents a trust framework keyset/policy key. The Identity Experience framework stores the secrets, which can be used in the policies. The secrets can be passwords, certificates, or other files. In the portal, these entities are shown as `Policy keys`. The Identity Experience framework uses the JSON Web Key (JWK) standard for the keysets. This entity follows the format specified in [RFC 7517 Section 5](https://tools.ietf.org/html/rfc7517#section-5). -## Methods +Inherits from [entity](../resources/entity.md). -| Method | Return Type | Description | -|:-|:|:| -| [List](../api/trustframework-list-keysets.md) | [trustFrameworkKeySet](trustframeworkkeyset.md) Collection | List trustFrameworkKeySets. | -| [Create](../api/trustframework-post-keysets.md) | [trustFrameworkKeySet](trustframeworkkeyset.md) | Create trustFrameworkKeySet. | -| [Get](../api/trustframeworkkeyset-get.md) | [trustFrameworkKeySet](trustframeworkkeyset.md) | Read properties and relationships of trustFrameworkKeySet object. | -| [Update](../api/trustframeworkkeyset-update.md) | [trustFrameworkKeySet](trustframeworkkeyset.md) | Update trustFrameworkKeySet object. | -| [Delete](../api/trustframeworkkeyset-delete.md) | None | Delete trustFrameworkKeySet object. | -|[Generate key](../api/trustframeworkkeyset-generatekey.md)|[trustFrameworkKey](trustframeworkkey.md)| Generate a key in keyset. | -|[Get active key](../api/trustframeworkkeyset-getactivekey.md)|[trustFrameworkKey](trustframeworkkey.md)| Get currently active key in the keyset. | -|[Upload certificate](../api/trustframeworkkeyset-uploadcertificate.md)|[trustFrameworkKey](trustframeworkkey.md)| Upload a X.509 certificate. | -|[Upload PKCS12](../api/trustframeworkkeyset-uploadpkcs12.md)|[trustFrameworkKey](trustframeworkkey.md)| Upload a PKCS12 format certificate. | -|[Upload secret](../api/trustframeworkkeyset-uploadsecret.md)|[trustFrameworkKey](trustframeworkkey.md)| Upload a string based secret. | +## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/trustframework-list-keysets.md)|[trustFrameworkKeySet](../resources/trustframeworkkeyset.md) collection|Get a list of the [trustFrameworkKeySet](../resources/trustframeworkkeyset.md) objects and their properties.| +|[Create](../api/trustframework-post-keysets.md)|[trustFrameworkKeySet](../resources/trustframeworkkeyset.md)|Create a new [trustFrameworkKeySet](../resources/trustframeworkkeyset.md) object.| +|[Get](../api/trustframeworkkeyset-get.md)|[trustFrameworkKeySet](../resources/trustframeworkkeyset.md)|Read the properties and relationships of a [trustFrameworkKeySet](../resources/trustframeworkkeyset.md) object.| +|[Update](../api/trustframeworkkeyset-update.md)|[trustFrameworkKeySet](../resources/trustframeworkkeyset.md)|Update the properties of a [trustFrameworkKeySet](../resources/trustframeworkkeyset.md) object.| +|[generateKey](../api/trustframeworkkeyset-generatekey.md)|[trustFrameworkKey](../resources/trustframeworkkey.md)|Generate a key in keyset.| +|[uploadSecret](../api/trustframeworkkeyset-uploadsecret.md)|[trustFrameworkKey](../resources/trustframeworkkey.md)|Upload a string based secret.| +|[getActiveKey](../api/trustframeworkkeyset-getactivekey.md)|[trustFrameworkKey](../resources/trustframeworkkey.md)|Get currently active key in the keyset.| +|[uploadCertificate](../api/trustframeworkkeyset-uploadcertificate.md)|[trustFrameworkKey](../resources/trustframeworkkey.md)|Upload a X.509 certificate.| +|[uploadPkcs12](../api/trustframeworkkeyset-uploadpkcs12.md)|[trustFrameworkKey](../resources/trustframeworkkey.md)|Upload a PKCS12 format certificate.| ## Properties--| Property | Type | Description | -|:-|:|:| -|id|String| Unique identifier of the trustframework keyset | -|keys|[trustFrameworkKey](trustframeworkkey.md) collection| A collection of the keys. | +|Property|Type|Description| +|:|:|:| +|id|String|Unique identifier of the trustframework keyset Inherited from [entity](../resources/entity.md).| +|keys|[trustFrameworkKey](../resources/trustframeworkkey.md) collection|A collection of the keys.| ## Relationships--None. +|Relationship|Type|Description| +|:|:|:| +|keys_v2|[trustFrameworkKey_v2](../resources/trustframeworkkey_v2.md) collection|A collection of the keys.| ## JSON representation--Here's a JSON representation of the resource. -+The following JSON representation shows the resource type. <!-- { "blockType": "resource",- "optionalProperties": [ -- ], + "keyProperty": "id", "@odata.type": "microsoft.graph.trustFrameworkKeySet",- "keyProperty": "id" -}--> --```json + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json {+ "@odata.type": "#microsoft.graph.trustFrameworkKeySet", "id": "String (identifier)",- "keys": [{"@odata.type": "microsoft.graph.trustFrameworkKey"}] + "keys": [ + { + "@odata.type": "microsoft.graph.trustFrameworkKey" + } + ] } ``` -<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 -2019-02-04 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "trustFrameworkKeySet resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> -- |
v1.0 | Typedemailaddress | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/typedemailaddress.md | Represents the name, email addresses, and their corresponding email address type ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Unenforcedmfaawsuserfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/unenforcedmfaawsuserfinding.md | description: "View AWS local users without MFA." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Unifiedrbacresourceaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/unifiedrbacresourceaction.md | None. --> ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Unifiedrbacresourcenamespace | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/unifiedrbacresourcenamespace.md | Represents the namespace of the area or service such as Microsoft Entra ID, Intu |resourceActions|[unifiedRbacResourceAction](unifiedrbacresourceaction.md) collection|Operations that an authorized principal is allowed to perform.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Unifiedroleassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/unifiedroleassignment.md | Title: "unifiedRoleAssignment resource type" -description: "A role assignment is the link between a role definition and a principal at a particular scope for the purpose of granting access." +description: "A role assignment is the link between a role definition and a principal at a particular scope for granting access." ms.localizationpriority: medium Represents a role definition assigned to a principal at a particular scope. Supp | Property | Type | Description | |:-|:|:|-|appScopeId|String|Identifier of the app specific scope when the assignment scope is app specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by a resource application only. For the entitlement management provider, use this property to specify a catalog, for example `/AccessPackageCatalog/beedadfe-01d5-4025-910b-84abb9369997`. Supports `$filter` (`eq`, `in`). For example `/roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/AccessPackageCatalog/{catalog id}'`.| +|appScopeId|String|Identifier of the app specific scope when the assignment scope is app specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by a resource application only. For the entitlement management provider, use this property to specify a catalog. For example, `/AccessPackageCatalog/beedadfe-01d5-4025-910b-84abb9369997`. Supports `$filter` (`eq`, `in`). For example `/roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/AccessPackageCatalog/{catalog id}'`.| |directoryScopeId|String|Identifier of the [directory object](directoryobject.md) representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications, unlike app scopes that are defined and understood by a resource application only. Supports `$filter` (`eq`, `in`).| |id|String| The unique identifier for the unifiedRoleAssignment. Key, not nullable, Read-only. | |principalId|String| Identifier of the principal to which the assignment is granted. Supported principals are users, role-assignable groups, and service principals. Supports `$filter` (`eq`, `in`). | Represents a role definition assigned to a principal at a particular scope. Supp | Relationship | Type |Description| |:|:--|:-|-|appScope|[appScope](appscope.md)|Details of the app specific scope when the assignment scope is app specific. Containment entity. | +|appScope|[appScope](appscope.md)|Details of the app specific scope when the assignment scope is app specific. Containment entity. Supports `$expand` for the entitlement provider only.| |directoryScope|[directoryObject](directoryobject.md)|The directory object that is the scope of the assignment. Provided so that callers can get the directory object using `$expand` at the same time as getting the role assignment. Read-only. Supports `$expand`. | |principal|[directoryObject](directoryobject.md)| The assigned principal. Provided so that callers can get the principal using `$expand` at the same time as getting the role assignment. Read-only. Supports `$expand`. | |roleDefinition|[unifiedRoleDefinition](unifiedroledefinition.md)|The roleDefinition the assignment is for. Provided so that callers can get the role definition using `$expand` at the same time as getting the role assignment. **roleDefinition.id** will be auto expanded. Supports `$expand`. | Represents a role definition assigned to a principal at a particular scope. Supp ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Unifiedrolemanagementalertdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/unifiedrolemanagementalertdefinition.md | Inherits from [entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Unifiedrolemanagementpolicyauthenticationcontextrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/unifiedrolemanagementpolicyauthenticationcontextrule.md | A type derived from the [unifiedRoleManagementPolicyRule](../resources/unifiedro None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Unifiedrolemanagementpolicyexpirationrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/unifiedrolemanagementpolicyexpirationrule.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Unifiedrolemanagementpolicyrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/unifiedrolemanagementpolicyrule.md | Inherits from [entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Unknownsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/unknownsource.md | description: "Represents an authorization system identity sourced from an unknow ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Updaterecordingstatusoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/updaterecordingstatusoperation.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Urlassessmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/urlassessmentrequest.md | Used to create and retrieve a URL threat assessment, derived from [threatAssessm ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Usageright | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/usageright.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/user.md | description: "Represents a Microsoft Entra user account. Inherits from directory ms.localizationpriority: high+ doc_type: resourcePageType This resource supports: | [Assign sponsors](../api/user-post-sponsors.md) | None | Assign a user a sponsor. | | [List sponsors](../api/user-list-sponsors.md) | [directoryObject](../resources/directoryobject.md) collection | Get the users and groups who are this user's sponsors. | | [Remove sponsors](../api/user-delete-sponsors.md) | None | Remove a user's sponsor. |+| [List invitedBy](../api/user-list-invitedby.md)|[directoryObject](../resources/directoryobject.md)|Get the user or service principal that invited the specified user into the tenant.| | **Teamwork** ||| |[List apps installed for user](../api/userteamwork-list-installedapps.md) | [userScopeTeamsAppInstallation](userscopeteamsappinstallation.md) collection | Lists apps installed in the personal scope of a user.| |[Get the installed app for user](../api/userteamwork-get-installedapps.md)| [userScopeTeamsAppInstallation](userscopeteamsappinstallation.md) | Lists the specified app installed in the personal scope of a user. | This resource supports: |[List cloudPCs](../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.| + ## Properties > [!IMPORTANT] This resource supports: | 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 one of the following Microsoft Entra roles: *Lifecycle Workflows Administrator*, *Global Reader*, or *Global Administrator*. 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><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).| | 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: | surname | String | The user's surname (family name or last name). Maximum length is 64 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). | | usageLocation | String | A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: `US`, `JP`, and `GB`. Not nullable. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| | userPrincipalName | String | The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's verified domain collection. This property is required when a user is created. The verified domains for the tenant can be accessed from the **verifiedDomains** property of [organization](organization.md).<br>NOTE: This property can't contain accent characters. Only the following characters are allowed `A - Z`, `a - z`, `0 - 9`, `' . - _ ! # ^ ~`. For the complete list of allowed characters, see [username policies](/azure/active-directory/authentication/concept-sspr-policy#userprincipalname-policies-that-apply-to-all-user-accounts). <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`) and `$orderby`.-| userType | String | A String value that can be used to classify user types in your directory, such as `Member` and `Guest`. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). **NOTE:** For more information about the permissions for member and guest users, see [What are the default user permissions in Microsoft Entra ID?](/azure/active-directory/fundamentals/users-default-permissions?context=graph/context#member-and-guest-users) | +| userType | String | A String value that can be used to classify user types in your directory. The possible values are `Member` and `Guest`. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). **NOTE:** For more information about the permissions for member and guest users, see [What are the default user permissions in Microsoft Entra ID?](/azure/active-directory/fundamentals/users-default-permissions?context=graph/context#member-and-guest-users) | > [!TIP] > Directory extensions and associated data are returned by default; schema extensions and associated data are returned only on `$select`; and open extensions and associated data are returned only on `$expand`. For example, Cameron is an administrator of a directory for an elementary school |extensions|[extension](extension.md) collection|The collection of open extensions defined for the user. Supports `$expand`. Nullable.| |inferenceClassification|[inferenceClassification](inferenceclassification.md)| Relevance classification of the user's messages based on explicit designations that override inferred relevance or importance. | |insights|[itemInsights](iteminsights.md) | Read-only. Nullable.|+|invitedBy|[directoryObject](directoryobject.md) | The user or service principal that invited the user.| |joinedGroups|[group](group.md) collection| Read-only. Nullable.| |mailFolders|[mailFolder](mailfolder.md) collection| The user's mail folders. Read-only. Nullable.| |manager|[directoryObject](directoryobject.md)|The user or contact that is this user's manager. Read-only. Supports `$expand`.| |
v1.0 | Useraccountinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/useraccountinformation.md | Inherits from [itemFacet](itemfacet.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Useranalytics | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/useranalytics.md | The following is a JSON representation of the resource. "optionalProperties": [ "activityStatistics" ],- "@odata.type": "microsoft.graph.userAnalytics" + "@odata.type": "microsoft.graph.userAnalytics", + "baseType": "microsoft.graph.entity" }--> ```json |
v1.0 | Userflowapiconnectorconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/userflowapiconnectorconfiguration.md | Defines which APIs are called at specific points in the user flow. Each relatio ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.userFlowApiConnectorConfiguration" |
v1.0 | Userflowlanguageconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/userflowlanguageconfiguration.md | For [Azure Active Directory B2C user flows](/azure/active-directory-b2c/user-flo ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Userflowlanguagepage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/userflowlanguagepage.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Useridentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/useridentity.md | Title: "userIdentity type" + Title: userIdentity resource type description: "Represents a Microsoft Entra user identity for a reviewer of an access review." ms.localizationpriority: medium -# userIdentity type +# userIdentity resource type Namespace: microsoft.graph |
v1.0 | Userregistrationdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/userregistrationdetails.md | The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.userRegistrationDetails",- "defaultMethod": "String", + "defaultMfaMethod": "String", "id": "String (identifier)", "isAdmin": "Boolean", "isMfaCapable": "Boolean", |
v1.0 | Userregistrationfeaturecount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/userregistrationfeaturecount.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Userregistrationfeaturesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/userregistrationfeaturesummary.md | Represents the summary of users capable of multifactor authentication, self-serv |userRoles|includedUserRoles|The role type of the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`, `unknownFutureValue`.| |userTypes|includedUserTypes|User type. Possible values are: `all`, `member`, `guest`, `unknownFutureValue`.| -The value `privilegedAdmin` consists of the following privileged admin roles: +The value `privilegedAdmin` consists of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): * Global Administrator * Security Administrator 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.userRegistrationFeatureSummary" |
v1.0 | Userregistrationmethodsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/userregistrationmethodsummary.md | Represents the summary of number of users registered for each authentication met |userRoles|includedUserRoles|The role type of the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`, `unknownFutureValue`.| |userTypes|includedUserTypes|User type. Possible values are: `all`, `member`, `guest`, `unknownFutureValue`.| -The value `privilegedAdmin` consists of the following privileged admin roles: +The value `privilegedAdmin` consists of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): * Global Administrator * Security Administrator |
v1.0 | Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/users.md | description: "Build compelling app experiences based on users, their relationshi ms.localizationpriority: high + doc_type: conceptualPageType Last updated 03/01/2024 |
v1.0 | Usersecuritystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/usersecuritystate.md | description: "Contains stateful information about the user account." ms.localizationpriority: medium + doc_type: resourcePageType |
v1.0 | Usersettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/usersettings.md | description: "The current user settings for content discovery. " ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Usertrainingcompletionsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/usertrainingcompletionsummary.md | + + Title: "userTrainingCompletionSummary resource type" +description: "Contains aggregate data about userss training progress." ++ms.localizationpriority: medium +++# userTrainingCompletionSummary resource type ++Namespace: microsoft.graph +++Contains aggregate data about userss training progress. ++## Properties +|Property|Type|Description| +|:|:|:| +|completedUsersCount|Int32|The number of users who completed all the trainings before the due date.| +|inProgressUsersCount|Int32|The number of users who started at least one training.| +|notCompletedUsersCount|Int32|The number of users who didn't complete all the trainings before the due date.| +|notStartedUsersCount|Int32|The number of users who didn't start any training.| +|previouslyAssignedUsersCount|Int32|The number of users who are already assigned the same training.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.userTrainingCompletionSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.userTrainingCompletionSummary", + "notStartedUsersCount": "Integer", + "completedUsersCount": "Integer", + "inProgressUsersCount": "Integer", + "notCompletedUsersCount": "Integer", + "previouslyAssignedUsersCount": "Integer" +} +``` + |
v1.0 | Validationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/validationresult.md | description: "Exposes the properties that specify the rules against which a user ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Valuebasedattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/valuebasedattribute.md | + + Title: "valueBasedAttribute resource type" +description: "Represents an attribute backed by a static value." ++ms.localizationpriority: medium ++++# valueBasedAttribute resource type ++Namespace: microsoft.graph +++Represents an attribute backed by a static value. ++Inherits from [customClaimAttributeBase](../resources/customclaimattributebase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|value|String|The static value to be used an the attribute.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.valueBasedAttribute" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.valueBasedAttribute", + "value": "String" +} +``` + |
v1.0 | Verifieddomain | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/verifieddomain.md | description: "Specifies a domain for a tenant. The verifiedDomains property of t ms.localizationpriority: medium doc_type: resourcePageType -+ # verifiedDomain resource type Namespace: microsoft.graph Specifies a domain for a tenant. The **verifiedDomains** property of the [organization](organization.md) entity is a collection of **verifiedDomain** objects. - ## Properties -| Property | Type | Description | -|:-|:--|:-| -| capabilities | String | For example, `Email`, `OfficeCommunicationsOnline`. | -| isDefault | Boolean | `true` if this is the default domain associated with the tenant; otherwise, `false`. | -| isInitial | Boolean | `true` if this is the initial domain associated with the tenant; otherwise, `false`. | -| name | String | The domain name; for example, contoso.com`. | -| type | String | For example, `Managed`. | +| Property | Type | Description| +|||| +| capabilities | String | For example, `Email`, `OfficeCommunicationsOnline`. | +| isDefault | Boolean | `true` if this is the default domain associated with the tenant; otherwise, `false`. | +| isInitial | Boolean | `true` if this is the initial domain associated with the tenant; otherwise, `false`. | +| name | String | The domain name; for example, `contoso.com`. | +| type | String | For example, `Managed`. | ## JSON representation |
v1.0 | Verifiedpublisher | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/verifiedpublisher.md | Represents a verified publisher of an [application](application.md). For more in ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Verticalsection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/verticalsection.md | Inherits from [entity](../resources/entity.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Video | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/video.md | The properties of the **Video** resource are populated by extracting metadata fr ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Virtualeventsroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualEventsRoot.md | + + Title: "virtualEventsRoot resource type" +description: "The container for virtual event APIs." ++ms.localizationpriority: medium ++++# virtualEventsRoot resource type ++Namespace: microsoft.graph +++The container for [virtual event](virtualevent.md) APIs. ++## Methods ++None. ++## Properties ++None. ++## Relationships ++| Relationship | Type |Description| +|:|:--|:-| +|webinars|[virtualEventWebinar](virtualeventwebinar.md) collection | A collection of webinars. Nullable.| +|townhalls|[virtualEventTownhall](virtualeventtownhall.md) collection | A collection of town halls. Nullable.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.solutionsRoot" +} +--> +```json +{ + "@odata.type": "#microsoft.graph.virtualEventsRoot" +} |
v1.0 | Virtualappointment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualappointment.md | The following is a JSON representation of the resource. "blockType": "resource", "keyProperty": "id", "@odata.type": "microsoft.graph.virtualAppointment",- "openType": false + "openType": false, + "baseType": "microsoft.graph.entity" } --> ``` json |
v1.0 | Virtualendpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualendpoint.md | Inherits from [entity](../resources/entity.md). |[Create cloudPcExternalPartnerSetting](../api/virtualendpoint-post-externalpartnersettings.md)|[cloudPcExternalPartnerSetting](../resources/cloudpcexternalpartnersetting.md)|Create a new [cloudPcExternalPartnerSetting](../resources/cloudpcexternalpartnersetting.md) object.| |[List frontLintServicePlans](../api/virtualendpoint-list-frontlineserviceplans.md) |[cloudPcFrontLineServicePlan](../resources/cloudpcfrontlineserviceplan.md) collection|Get a list of the [cloudPcFrontLineServicePlan](../resources/cloudpcfrontlineserviceplan.md) objects and their properties.| |[List sharedUseServicePlans](../api/virtualendpoint-list-shareduseserviceplans.md) (deprecated)|[cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) collection|List properties and relationships of the [cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) objects.|+|[List bulkActions](../api/virtualendpoint-list-bulkactions.md)|[cloudPcBulkAction](../resources/cloudpcbulkaction.md) collection|Get a list of the [cloudPcBulkAction](../resources/cloudpcbulkaction.md) objects and their properties.| +|[Create cloudPcBulkAction](../api/virtualendpoint-post-bulkactions.md)|[cloudPcBulkAction](../resources/cloudpcbulkaction.md)|Create a new [cloudPcBulkAction](../resources/cloudpcbulkaction.md) object.| ## Properties Inherits from [entity](../resources/entity.md). |Relationship|Type|Description| |:|:|:| |auditEvents|[cloudPcAuditEvent](../resources/cloudpcauditevent.md) collection|Cloud PC audit event.|+|bulkActions|[cloudPcBulkAction](../resources/cloudpcbulkaction.md) collection|Bulk actions applied to a Cloud PC.| |cloudPCs|[cloudPC](../resources/cloudpc.md) collection|Cloud managed virtual desktops.| |crossCloudGovernmentOrganizationMapping|[cloudPcCrossCloudGovernmentOrganizationMapping](../resources/cloudpccrosscloudgovernmentorganizationmapping.md)|Cloud PC organization mapping between public and US Government Community Cloud (GCC) organizations.| |deviceImages|[cloudPcDeviceImage](../resources/cloudpcdeviceimage.md) collection|The image resource on Cloud PC.| |
v1.0 | Virtualevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualevent.md | Title: "virtualEvent resource type" -description: "Information about a virtual event." -+description: "Represents an abstract base type for a virtual event." + ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a base virtual event. --This is an abstract type. The base type of [virtualEventWebinar](virtualEventWebinar.md). +Represents an abstract base type for a virtual event. Base type of [virtualEventTownhall](virtualeventtownhall.md) and [virtualEventWebinar](virtualeventwebinar.md). Inherits from [entity](../resources/entity.md). > [!TIP]-> This is an abstract type and can't be used directly. Use the derived type [virtualEventWebinar](virtualEventWebinar.md) instead. +> This is an abstract type and can't be used directly. Use the derived types [virtualEventTownhall](virtualeventtownhall.md) or [virtualEventWebinar](virtualeventwebinar.md) instead. ## Properties |Property|Type|Description| |:|:|:|-|createdBy|[communicationsIdentitySet](communicationsidentityset.md)|Identity information for the creator of the virtual event. Inherited from [virtualEvent](../resources/virtualevent.md).| -|description|[itemBody](../resources/itembody.md)|Description of the virtual event.| -|displayName|String|Display name of the virtual event. | -|endDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|End time of the virtual event. The **timeZone** property _can_ be set to any of the [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones).| -|id|String|Unique identifier of the virtual event. Inherited from [entity](../resources/entity.md).| -|startDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|Start time of the virtual event. The **timeZone** property _can_ be set to any of the [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones).| -|status|virtualEventStatus|Status of the virtual event. The possible values are: `draft`, `published`, `canceled`, `unknownFutureValue`.| +|createdBy|[communicationsIdentitySet](communicationsidentityset.md)|The identity information for the creator of the virtual event. Inherited from [virtualEvent](../resources/virtualevent.md).| +|description|[itemBody](../resources/itembody.md)|A description of the virtual event.| +|displayName|String|The display name of the virtual event. | +|endDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|The end time of the virtual event. 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).| +|id|String|The unique identifier of the virtual event. Inherited from [entity](../resources/entity.md).| +|startDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|Start time of the virtual event. 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).| +|status|[virtualEventStatus](#virtualeventstatus-values)|The status of the virtual event. The possible values are: `draft`, `published`, `canceled`, `unknownFutureValue`.| ++### virtualEventStatus values ++| Value | Description | +| -- | -- | +| draft | The virtual event is in draft and only visible to the organizer. | +| published | The organizer published the virtual event and it's visible to the audience. | +| canceled | The organizer canceled the virtual event. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ## Relationships |Relationship|Type|Description| |:|:|:| |presenters|[virtualEventPresenter](../resources/virtualeventpresenter.md) collection|The virtual event presenters.|-|sessions|[virtualEventSession](../resources/virtualeventsession.md) collection|Sessions for the virtual event.| +|sessions|[virtualEventSession](../resources/virtualeventsession.md) collection|The sessions for the virtual event.| ## JSON representation -The following JSON representation shows the resource type +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Virtualeventpresenter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventpresenter.md | Title: "virtualEventPresenter resource type" description: "Represents information about a presenter of a virtual event."-+ ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph Represents information about a presenter of a virtual event. +## Methods ++| Method | Return Type |Description | +| | -- | - | +| [List](../api/virtualevent-list-presenters.md) | [virtualEventPresenter](../resources/virtualeventpresenter.md) collection | Get the list of all [virtualEventPresenter](../resources/virtualeventpresenter.md) objects of a virtual event. | +| [Create](../api/virtualevent-post-presenters.md) | [virtualEventPresenter](../resources/virtualeventpresenter.md) | Create a new [virtualEventPresenter](../resources/virtualeventpresenter.md) object. | +| [Get](../api/virtualeventpresenter-get.md) | [virtualEventPresenter](../resources/virtualeventpresenter.md) | Read the properties and relationships of a [virtualEventPresenter](../resources/virtualeventpresenter.md) object. | +| [Update](../api/virtualeventpresenter-update.md) | [virtualEventPresenter](../resources/virtualeventpresenter.md) | Update the properties of a [virtualEventPresenter](../resources/virtualeventpresenter.md) object. | +| [Delete](../api/virtualeventpresenter-delete.md) | None | Delete a [virtualEventPresenter](../resources/virtualeventpresenter.md) object. | + ## Properties |Property|Type|Description| |:|:|:| |email|String|Email address of the presenter.| |id|String|Unique identifier of the presenter. Inherited from [entity](../resources/entity.md).|-|identity|[identity](../resources/identity.md)|Identity information of the presenter. The supported identites are: [communicationsGuestIdentity](../resources/communicationsguestidentity.md) and [communicationsUserIdentity](../resources/communicationsuseridentity.md). | -|presenterDetails|[virtualEventPresenterDetails](../resources/virtualeventpresenterdetails.md)|Other detail information of the presenter.| +|identity|[identity](../resources/identity.md)|Identity information of the presenter. The supported identities are: [communicationsGuestIdentity](../resources/communicationsguestidentity.md) and [communicationsUserIdentity](../resources/communicationsuseridentity.md). | +|presenterDetails|[virtualEventPresenterDetails](../resources/virtualeventpresenterdetails.md)|Other detail information of the presenter. This property returns `null` when the virtual event type is [virtualEventTownhall](../resources/virtualeventtownhall.md). | ## JSON representation |
v1.0 | Virtualeventpresenterdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventpresenterdetails.md | Title: "virtualEventPresenterDetails resource type" -description: "Detail information about a virtual event presenter." -+description: "Represents detail information about a virtual event presenter." + ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Detail information of a virtual event presenter. +Represents detail information about a virtual event presenter. ## Properties |
v1.0 | Virtualeventregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventregistration.md | Title: "virtualEventRegistration resource type" description: "Represents an attendee's registration record of a virtual event."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Virtualeventregistrationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventregistrationconfiguration.md | Title: "virtualEventRegistrationConfiguration resource type" description: "Represents the registration configuration of a virtual event."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Virtualeventregistrationquestion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventregistrationquestion.md | Title: "virtualEventRegistrationQuestion resource type" description: "Information about a virtual event registration question."-+ ms.localizationpriority: medium doc_type: resourcePageType Represents a registration question associated with a [virtualEventRegistration]( ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Virtualeventregistrationquestionanswer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventregistrationquestionanswer.md | Title: "virtualEventRegistrationQuestionAnswer resource type" description: "Information about registration question answer of a virtual event."-+ ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the answer(s) of a [virtualEventRegistrationQuestion](../resources/virtualeventregistrationquestion.md). +Represents one or more answers to a [virtualEventRegistrationQuestion](../resources/virtualeventregistrationquestion.md). ## Properties |
v1.0 | Virtualeventsession | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventsession.md | Title: "virtualEventSession resource type" description: "Represents information about a virtual event session."-+ ms.localizationpriority: medium doc_type: resourcePageType Inherits from [onlineMeetingBase](../resources/onlinemeetingBase.md). |Relationship|Type|Description| |:|:|:|-|attendanceReports|[meetingAttendanceReport](../resources/meetingattendancereport.md) collection|Attendance reports of this virtual event session. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md).| +|attendanceReports|[meetingAttendanceReport](../resources/meetingattendancereport.md) collection|Attendance reports of this virtual event session. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md).| ## JSON representation The following JSON representation shows the resource type. "blockType": "resource", "keyProperty": "id", "@odata.type": "microsoft.graph.virtualEventSession",- "baseType": "microsoft.graph.onlineMeeting", + "baseType": "microsoft.graph.onlineMeetingBase", "openType": false } --> The following JSON representation shows the resource type. "allowParticipantsToChangeName": "Boolean", "allowTeamworkReactions": "Boolean", "allowedPresenters": "String",- "alternativeRecording": "Stream", "anonymizeIdentityForRoles": ["String"], "audioConferencing": {"@odata.type": "microsoft.graph.audioConferencing"}, "chatInfo": {"@odata.type": "microsoft.graph.chatInfo"}, |
v1.0 | Virtualeventtownhall | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventtownhall.md | + + Title: "virtualEventTownhall resource type" +description: "Represents information about a virtual event town hall." ++ms.localizationpriority: medium ++++# virtualEventTownhall resource type ++Namespace: microsoft.graph +++Represents information about a virtual event town hall. ++Inherits from [virtualEvent](../resources/virtualevent.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +| [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).| ++## Properties ++|Property|Type|Description| +|:|:|:| +| audience | [meetingAudience](#meetingaudience-values) | The audience to whom the town hall is visible. Possible values are: `everyone`, `organization`, `unknownFutureValue`. | +| coOrganizers | [communicationsUserIdentity](communicationsuseridentity.md) collection | Identity information of the coorganizers of the town hall. | +| createdBy | [communicationsIdentitySet](communicationsidentityset.md) | Identity information of the creator of the town hall. Inherited from [virtualEvent](../resources/virtualevent.md). Read-only. | +| description | [itemBody](../resources/itembody.md) | Description of the town hall. Inherited from [virtualEvent](../resources/virtualevent.md). | +| displayName | String | Display name of the town hall. Inherited from [virtualEvent](../resources/virtualevent.md). | +| endDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Date and time when the town hall ends. 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). | +| 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`. | +| 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](#virtualeventstatus-values) | Status of the town hall. Possible values are: `draft`, `published`, `canceled`, `unknownFutureValue`. Inherited from [virtualEvent](../resources/virtualevent.md). | ++### meetingAudience values ++| Value | Description | +| -- | -- | +| everyone | The town hall is open to anyone. Select this choice to include attendees from outside your organization. | +| organization | The town hall is open to people in your organization and guests of your organization. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ++### virtualEventStatus values ++| Value | Description | +| -- | -- | +| draft | The virtual event is in draft and only visible to the organizer. | +| published | The organizer published the virtual event and it's visible to the audience. | +| canceled | The organizer canceled the virtual event. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +| presenters | [virtualEventPresenter](../resources/virtualeventpresenter.md) collection | Presenters' information of the town hall. Inherited from [virtualEvent](../resources/virtualevent.md).| +| sessions | [virtualEventSession](../resources/virtualeventsession.md) collection | Sessions of the town hall. Inherited from [virtualEvent](../resources/virtualevent.md). | ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.virtualEventTownhall", + "baseType": "microsoft.graph.virtualEvent", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.virtualEventTownhall", + "audience": "String", + "coOrganizers": [{"@odata.type": "microsoft.graph.communicationsUserIdentity"}], + "createdBy": {"@odata.type": "microsoft.graph.communicationsIdentitySet"}, + "description": {"@odata.type": "microsoft.graph.itemBody"}, + "displayName": "String", + "endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"}, + "id": "String (identifier)", + "invitedAttendees": [{"@odata.type": "microsoft.graph.identity"}], + "isInviteOnly": "Boolean", + "startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"}, + "status": "String" +} +``` |
v1.0 | Virtualeventwebinar | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventwebinar.md | Title: "virtualEventWebinar resource type" description: "Contains information about a virtual event webinar."-+ ms.localizationpriority: medium doc_type: resourcePageType Inherits from [virtualEvent](../resources/virtualevent.md). | 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 the tenant. | -| [Get virtualEventWebinar](../api/virtualeventwebinar-get.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) | Read the properties and relationships of a [virtualEventWebinar](../resources/virtualeventwebinar.md) object. | +| [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 tenant](../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. | Inherits from [virtualEvent](../resources/virtualevent.md). | createdBy | [communicationsIdentitySet](communicationsidentityset.md) | Identity information for the creator of the webinar. Inherited from [virtualEvent](../resources/virtualevent.md). | | description | [itemBody](../resources/itembody.md) | Description of the webinar. Inherited from [virtualEvent](../resources/virtualevent.md). | | displayName | String | Display name of the webinar. Inherited from [virtualEvent](../resources/virtualevent.md). |-| endDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | End time of the webinar. The **timeZone** property _can_ be set to any of the [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones). Inherited from [virtualEvent](../resources/virtualevent.md). | -| startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Start time of the webinar. The **timeZone** property _can_ be set to any of the [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones). Inherited from [virtualEvent](../resources/virtualevent.md). | +| endDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | End time of the webinar. 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). | +| startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Start time of the webinar. 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). | | id | String | Unique identifier of the webinar. Inherited from [entity](../resources/entity.md).| | status | [virtualEventStatus](#virtualeventstatus-values) | Status of the webinar. | Inherits from [virtualEvent](../resources/virtualevent.md). | Value | Description | | -- | -- |-| draft | The webinar is in draft and only visible to the organizer. | -| published | The organizer published the webinar and it's visible to the audience. | -| canceled | The organizer canceled the webinar. | +| draft | The virtual event is in draft and only visible to the organizer. | +| published | The organizer published the virtual event and it's visible to the audience. | +| canceled | The organizer canceled the virtual event. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ## Relationships | Relationship | Type | Description | | | - | -- |+| registrationConfiguration | [virtualEventWebinarRegistrationConfiguration](../resources/virtualeventwebinarregistrationconfiguration.md) | Registration configuration of the webinar. | | registrations | [virtualEventRegistration](../resources/virtualeventregistration.md) collection | Registration records of the webinar. | | sessions | [virtualEventSession](../resources/virtualeventsession.md) collection | Sessions of the webinar. Inherited from [virtualEvent](../resources/virtualevent.md). | The following JSON representation shows the resource type. "status": "String" } ```++## Related content ++[List meetingAttendanceReports](../api/meetingattendancereport-list.md) |
v1.0 | Virtualeventwebinarregistrationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventwebinarregistrationconfiguration.md | + + Title: "virtualEventWebinarRegistrationConfiguration resource type" +description: "Contains information about a webinar registration configuration." ++ms.localizationpriority: medium ++++# virtualEventWebinarRegistrationConfiguration resource type ++Namespace: microsoft.graph +++Contains information about a webinar registration configuration. ++Currently, the **virtualEventWebinarRegistrationConfiguration** resource inherits a subset of the properties and relationships from [virtualEventRegistrationConfiguration](../resources/virtualeventregistrationconfiguration.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +| [Get virtualEventWebinarRegistrationConfiguration](../api/virtualeventwebinarregistrationconfiguration-get.md) | [virtualEventWebinarRegistrationConfiguration](../resources/virtualeventwebinarregistrationconfiguration.md) | Read the properties and relationships of a [virtualEventWebinarRegistrationConfiguration](../resources/virtualeventwebinarregistrationconfiguration.md) object. | ++## Properties ++|Property|Type|Description| +|:|:|:| +| registrationWebUrl | String | Registration portal URL of the webinar. Inherited from [virtualEventRegistrationConfiguration](../resources/virtualeventregistrationconfiguration.md). | ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.virtualEventWebinarRegistrationConfiguration", + "baseType": "microsoft.graph.virtualEventRegistrationConfiguration", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.virtualEventWebinarRegistrationConfiguration", + "registrationWebUrl": "String" +} +``` |
v1.0 | Virtualmachinewithawsstoragebucketaccessfinding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualmachinewithawsstoragebucketaccessfinding.md | description: "View EC2 instances with S3 Bucket access." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Viva Learning Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/viva-learning-api-overview.md | The employee learning API in Microsoft Graph enables apps to make content from a ## How do integrations work? As administrators, you can integrate your content and learner records (employee assignments and completed course records) from your LMS or learning provider with Viva Learning, by using out-of-the-box integrations where Viva Learning can pull content metadata and learning records from your LMS or learning provider. You can also [use the employee learning API](#use-cases-for-the-employee-learning-api-in-microsoft-graph) in Microsoft Graph to push content metadata from your LMS or learning provider into Viva Learning. -When the content metadata, employee assignments, and their completed course records are uploaded to Viva Learning, they appear in Viva Learning at the following locations: -- The content appears on the home page under the **Browse courses** ΓÇô **Providers** section.-- Assignments and completed course records appear on the **My Learning** page under the **Assigned to you** and **Completed** sections, respectively.+When the content metadata, employee assignments, and their completed course records are uploaded to Viva Learning, they appear in Viva Learning in the following locations: ++- When the content metadata is synchronized, the content appears on the home page under the **Browse courses** ΓÇô **Providers** section. +- When the learning course activities are synchronized, assignments, recommendations, and self-learning course records appear on the **My Learning** tab. Based on progression, the status will move from **In Progress** to **Completed**. ++The learning course activities for the learners can be discovered outside of Viva Learning via APIs. ## Authorization With the appropriate delegated or application [employee learning permissions](/graph/permissions-reference#employee-learning-permissions), your app can use the employee learning API to manage learning providers and their content for a learning hub in a tenant. For more information about access tokens, app registration, and delegated and application permissions, see [Authentication and authorization basics](/graph/auth/auth-concepts). |
v1.0 | Voiceauthenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/voiceauthenticationmethodtarget.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A collection of groups enabled to use voice call authentication via the [voice call authentication methods policy](../resources/voiceAuthenticationMethodConfiguration.md) in Microsoft Entra ID. +A collection of groups enabled to use voice call authentication via the [voice call authentication methods policy](../resources/voiceAuthenticationMethodConfiguration.md) in Microsoft Entra ID. Inherits from [authenticationMethodTarget](authenticationMethodTarget.md). ## Properties |Property|Type|Description| A collection of groups enabled to use voice call authentication via the [voice c None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Vulnerabilitystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/vulnerabilitystate.md | Contains stateful information about the vulnerability. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Watermarkprotectionvalues | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/watermarkprotectionvalues.md | These flags indicate that a watermark is enabled for this particular meeting. An ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Webapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/webapplication.md | Specifies settings for a web application. |redirectUriSettings| [redirectUriSettings](redirecturisettings.md) collection | Specifies the index of the URLs where user tokens are sent for sign-in. This is only valid for applications using SAML.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Webpartdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/webpartdata.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Website | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/website.md | Represents a web site. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Windows Setting Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windows-setting-api-overview.md | + + Title: "Use the Windows settings API in Microsoft Graph" +description: "The Windows setting API enables users and authorized third parties acting on behalf of users to retrieve their Windows operating system settings data stored in the Microsoft cloud." +ms.localizationpriority: medium ++++# Use the Windows settings API in Microsoft Graph +++The Windows setting API enables users and authorized third parties acting on behalf of users to retrieve their Windows operating system settings data stored in the Microsoft cloud. The Windows settings data is available in the Microsoft cloud only when users activate the feature. The scope of data available for each user depends on their backup settings selections. The default values for any settings remain local and aren't transferred to the cloud. The Windows settings API only shares settings data that the user uploads to the cloud. ++## Windows settings ++The [**windowsSetting**](windowssetting.md) resource represents various Windows operating system settings that are stored in the cloud for a given user. Windows settings are of two types: `roaming` and `backup`. The **settingType** property of a [windowsSetting](../resources/windowssetting.md) object indicates the type of the setting. ++| Setting type | Description | +| :-- | : | +| roaming | The Windows setting is associated with a user's account. The setting is consistent across all devices and any changes to the setting value are synced or applied to all Windows devices that the user owns.| +| backup | The Windows setting doesn't roam or sync across devices. This type of setting is used in device backup and restore scenarios.| ++ A [windowsSetting](../resources/windowssetting.md) object of type `backup` might have a **windowsDeviceId** property that links the setting to a specific device. ++ The [List Windows settings](../api/usersettings-list-windows.md) API returns a collection of [windowsSetting](../resources/windowssetting.md) objects and their properties. You can filter the results by the **windowsDeviceId** and **settingType** properties. ++The [Get windowsSetting](../api/windowssetting-get.md) API allows you to pass the ID of a [windowsSetting](../resources/windowssetting.md) in the URL to read a specific Windows setting object. ++The following JSON representation shows an example of a **windowsSetting** resource type. The instances collection represents **windowsSettingInstance** objects. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.windowsSetting", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.windowsSetting", + "id": "{67585f9f-ee4b-4dd8-808e-d88375d66ef7}$windows.data.apps.devicemetadata", + "windowsDeviceId": "67585f9f-ee4b-4dd8-808e-d88375d66ef7", + "settingType": "backup", + "payloadType": "windows.data.apps.devicemetadata", + "instances": [ + { + "id": "14b50191-10e5-4da5-9099-8c909b8458bd", + "payload": "VGhpcyBpcyBqdXN0IGFuIGV4YW1wbGUh", + "lastModifiedDateTime": "2024-10-31T23:30:41Z", + "createdDateTime": "2024-02-12T19:34:35.223Z", + "expirationDateTime": "2034-02-09T19:34:33.771Z" + } + ] +} +``` ++> [!Warning] +> The structure of the ID of a [**windowsSetting**](../resources/windowssetting.md) object is not guaranteed and the caller should not take any dependency on it. The ID should be treated as an opaque string. ++## Windows setting instances ++A [**windowsSettingInstance**](../resources/windowssettinginstance.md) represents a setting instance from the Windows operating system that is stored in the cloud for a given user. A [windowsSettingInstance](../resources/windowssettinginstance.md) belongs to a [windowsSetting](../resources/windowssetting.md). ++The following JSON representation shows an example of a **windowsSettingInstance** resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.windowsSettingInstance", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.windowsSettingInstance", + "id": "6984732f-86b0-8e31-dc02-37fce0df6d61", + "payload": "VGhpcyBpcyBhbm90aGVyIGp1c3QgYW4gZXhhbXBsZSE=", + "lastModifiedDateTime": "2024-10-31T23:30:41Z", + "createdDateTime": "2024-02-12T19:34:35.223Z", + "expirationDateTime": "2034-02-09T19:34:33.771Z" +} +``` ++The [List Windows setting instances](../api/windowssetting-list-instances.md) API returns a collection of [windowsSettingInstance](../resources/windowssettinginstance.md) objects and their properties. The API requires the ID of a [windowsSetting](../resources/windowssetting.md) in the URL to read the setting instances. ++The [Get Windows setting instance](../api/windowssettinginstance-get.md) API allows you to pass the ID of a [windowsSetting](../resources/windowssetting.md) and [windowsSettingInstance](../resources/windowssettinginstance.md) in the URL to read a specific windows setting instance object. ++The **payload** property of a [**windowsSettingInstance**](../resources/windowssettinginstance.md) contains the actual setting value. The **payload** is a string in Base64-encoded format. The **payloadType** property of the [**windowsSetting**](../resources/windowssetting.md) object indicates the type of the setting value. The **payload** when decoded is a JSON object, which differs from setting to setting and is specific to the **payloadType**. ++### payloadType property +The **payloadType** defines the structure of a [windowsSettingInstance](./windowssettinginstance.md) payload. Windows includes a number of payload types that represent distinct setting structures used by different operating system experiences. As Windows evolves, more payload types are created and onboarded to the cloud. Querying the API and exploring the settings that are available is the best way to learn about the various payload types. The users and admins have control over which settings are uploaded to the cloud and most components don't upload default settings that the user hasn't customized. ++The following example shows a **windowsSettingsInstance** object returned by the API. ++```json +{ + "id": "default$windows.data.fileexplorerclassic.advancedsettings", + "settingType": "roaming", + "payloadType": "windows.data.fileexplorerclassic.advancedsettings", + "instances": [ + { + "id": "d9a7f6e2-8c4b-4e3a-bf7c-1e5a9d8c6f4b", + "payload": "eyJtaWdyYXRlZEZyb21TU0YiOmZhbHNlLCJhbHdheXNTaG93TWVudXMiOmZhbHNlLCJmb2xkZXJDb250ZW50c0luZm9UaXAiOmZhbHNlLCJoaWRlRHJpdmVzV2l0aE5vTWVkaWEiOmZhbHNlLCJuYXZQYW5lRXhwYW5kVG9DdXJyZW50Rm9sZGVyIjpmYWxzZSwibmF2UGFuZVNob3dBbGxGb2xkZXJzIjpmYWxzZSwibmF2UGFuZVNob3dGYXZvcml0ZXMiOmZhbHNlLCJwZXJzaXN0QnJvd3NlcnMiOmZhbHNlLCJzaGFyaW5nV2l6YXJkT24iOmZhbHNlLCJzaG93RHJpdmVMZXR0ZXJzIjpmYWxzZSwic2hvd1ByZXZpZXdIYW5kbGVycyI6ZmFsc2UsInR5cGVBaGVhZCI6ZmFsc2UsInNob3dTdGF0dXNCYXIiOmZhbHNlLCJzaG93TGlicmFyaWVzIjpmYWxzZSwic2hvd0NvbXBDb2xvciI6ZmFsc2V9", + "lastModifiedDateTime": "2022-06-27T00:53:00Z", + "createdDateTime": "2024-02-13T19:51:15.8217101Z", + "expirationDateTime": "2034-02-10T19:51:14.813Z" + } + ] +} +``` ++In this example, the **payloadType** `windows.data.fileexplorerclassic.advancedsettings` represents some of the settings that the File Explorer backs up to the cloud. The Base64 payload can be decoded to a UTF-8 string to see the JSON representation of this object. ++The following example shows the payload decoded. ++```json +{ + "migratedFromSSF": false, + "alwaysShowMenus": false, + "folderContentsInfoTip": false, + "hideDrivesWithNoMedia": false, + "navPaneExpandToCurrentFolder": false, + "navPaneShowAllFolders": false, + "navPaneShowFavorites": false, + "persistBrowsers": false, + "sharingWizardOn": false, + "showDriveLetters": false, + "showPreviewHandlers": false, + "typeAhead": false, + "showStatusBar": false, + "showLibraries": false, + "showCompColor": false +} +``` ++Properties in the object are commonly a subset of those that are available in the user experience of the component because component owners decide which settings provide the most value when uploaded to the cloud. ++#### Payload types ++The payload types described in this section have a special role in the Windows settings backup process. ++#### windows.data.platform.backuprestore.deviceprofile ++The windows.data.platform.backuprestore.deviceprofile payload type is not a setting the user applied; this type records information about devices that have opted into settings backup features. The following properties on this object are useful for understanding the rest of the settings: ++- **deviceDisplayName** - The name of the computer. This setting is found in Windows system settings at "**Start** > **Settings** > **System**". +- **profileId** - An identifier used to link [**windowsSetting**](../resources/windowssetting.md) items to the device that uploaded them. This property corresponds to **windowsSetting.windowsDeviceId** and can be used as a filter to get settings for a specific device from the [List Windows settings](../api/usersettings-list-windows.md) API. ++The following example shows this resource type. ++```json +{ + "id": "default$windows.data.platform.backuprestore.deviceprofile$deviceprofiles", + "settingType": "backup", + "payloadType": "windows.data.platform.backuprestore.deviceprofile", + "instances": [ + { + "id": "73b1a0b8-262a-4804-592a-b82a3a2a0c0d", + "payload": "ewogICAgInByb2ZpbGVJZCI6ICJ7OTViM2EyYzgtNDgyYS00YTA2LTdiM2EtZGEyYTVhNGIyYzBmfSIsCiAgICAiZGV2aWNlRGlzcGxheU5hbWUiOiAiRVhBTVBMRVVTRVJERVNLVE9QIiwKICAgICJjcmVhdGVkQnkiOiAid2luZG93cyIsCiAgICAic291cmNlUHJvZmlsZUlkIjogIiIsCiAgICAiY3JlYXRlZFRpbWUiOiAxNjY0NjgwNTg5LAogICAgIm1vZGlmaWVkVGltZSI6IDE2OTg3OTUwNDAsCiAgICAiaXNBY3RpdmUiOiB0cnVlLAogICAgImxhc3RGdWxsQmFja3VwQ29tcGxldGVkVGltZSI6IDE2OTgzMzIxMzcsCiAgICAib3NWZXJzaW9uIjogIjE4MDQ1LjM3NTAudmJfcmVsZWFzZSIKfQ==", + "lastModifiedDateTime": "2023-10-31T23:30:40Z", + "createdDateTime": "2024-02-13T22:49:02.376Z", + "expirationDateTime": "2034-02-10T22:49:03.365Z" + } + ] +} +``` +The following example shows the payload decoded. ++```json +{ + "profileId": "{95b3a2c8-482a-4a06-7b3a-da2a5a4b2c0f}", + "deviceDisplayName": "EXAMPLEUSERDESKTOP", + "createdBy": "windows", + "sourceProfileId": "", + "createdTime": 1664680589, + "modifiedTime": 1698795040, + "isActive": true, + "lastFullBackupCompletedTime": 1698332137, + "osVersion": "18045.3750.vb_release" +} +``` ++#### windows.data.platform.settingsbackup.backupunitstore ++The **backupUnitStore** payload type settings are unique in that the actual settings value is a **blob** in the data property. This is because **backupUnitStore** settings are collected directly from the Windows registry, on disk files, or other at rest locations throughout Windows. These settings weren't designed to be interoperable with experiences other than the components that created them. They are exposed in this API for comprehensive coverage of all Windows settings that are stored in the cloud. |
v1.0 | Windowsapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsapplication.md | Represents settings for apps running Microsoft Windows and published in the Micr | redirectUris | String collection | Specifies the URLs where user tokens are sent for sign-in or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Only available for applications that support the `PersonalMicrosoftAccount` **signInAudience**. | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Windowssetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowssetting.md | Inherits from [entity](../resources/entity.md). ## Methods |Method|Return type|Description| |:|:|:|-|[List Windows settings](../api/usersettings-list-windows.md)|[windowsSetting](../resources/windowssetting.md) collection|Get a list of the [windowsSetting](../resources/windowssetting.md) objects and their properties.| -|[Get windowsSetting](../api/windowssetting-get.md)|[windowsSetting](../resources/windowssetting.md)|Read the properties and relationships of a [windowsSetting](../resources/windowssetting.md) object.| +|[List](../api/usersettings-list-windows.md)|[windowsSetting](../resources/windowssetting.md) collection|Get a list of the [windowsSetting](../resources/windowssetting.md) objects and their properties.| +|[Get](../api/windowssetting-get.md)|[windowsSetting](../resources/windowssetting.md)|Read the properties and relationships of a [windowsSetting](../resources/windowssetting.md) object.| |[List instances](../api/windowssetting-list-instances.md)|[windowsSettingInstance](../resources/windowssettinginstance.md) collection|Read the properties and relationships of a [windowsSettingInstance](../resources/windowssettinginstance.md) object by passing the Windows setting ID and Windows setting instance ID in the URL.| ## Properties |
v1.0 | Windowsupdates Contentapplicabilitysettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-contentapplicabilitysettings.md | Represents settings for governing whether content is applicable to a device. 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.windowsUpdates.contentApplicabilitySettings" |
v1.0 | Windowsupdates Datedrivenrolloutsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-datedrivenrolloutsettings.md | Inherits from [gradualRolloutSettings](../resources/windowsupdates-gradualrollou 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.windowsUpdates.dateDrivenRolloutSettings" |
v1.0 | Windowsupdates Durationdrivenrolloutsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-durationdrivenrolloutsettings.md | Inherits from [gradualRolloutSettings](../resources/windowsupdates-gradualrollou 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.windowsUpdates.durationDrivenRolloutSettings" |
v1.0 | Windowsupdates Gradualrolloutsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-gradualrolloutsettings.md | Represents settings for governing how to rollout content to devices. 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.windowsUpdates.gradualRolloutSettings" |
v1.0 | Windowsupdates Qualityupdatecatalogentry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-qualityupdatecatalogentry.md | Inherits from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareu ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Windowsupdates Resourceconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-resourceconnection.md | This resource type is abstract. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Windowsupdates Softwareupdatecatalogentry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-softwareupdatecatalogentry.md | This is an abstract type. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Workbookchart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchart.md | Represents a chart object in a workbook. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookchartareaformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartareaformat.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartaxes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartaxes.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartaxis | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartaxis.md | Represents a single axis in a chart. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartaxisformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartaxisformat.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartaxistitle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartaxistitle.md | Represents the title of a chart axis. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartaxistitleformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartaxistitleformat.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartdatalabelformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartdatalabelformat.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartdatalabels | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartdatalabels.md | Represents a collection of all the data labels on a chart point. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartfont | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartfont.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartgridlines | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartgridlines.md | Represents major or minor gridlines on a chart axis. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookchartgridlinesformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartgridlinesformat.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartlegend | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartlegend.md | Represents the legend in a chart. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookchartlegendformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartlegendformat.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartlineformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartlineformat.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartpoint.md | Represents a point of a series in a chart. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartpointformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartpointformat.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookchartseries | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartseries.md | Represents a series in a chart. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookchartseriesformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookchartseriesformat.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookcharttitle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookcharttitle.md | Represents a chart title object of a chart. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookcharttitleformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookcharttitleformat.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbookfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookfilter.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookfiltercriteria | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookfiltercriteria.md | Namespace: microsoft.graph Represents the filtering criteria applied to a column. +## Properties ++| Property | Type |Description| +|:-|:-|:-| +| color | String | The color applied to the cell. | +| criterion1 | String | A custom criterion. | +| criterion2 | String | A custom criterion. | +| dynamicCriteria | String | A dynamic formula specified in a custom filter. | +| filterOn | String | Indicates whether a filter is applied to a column. | +| icon | [workbookIcon](workbookicon.md) | An icon applied via conditional formatting. | +| operator | String | An operator in a cell; for example, `=`, `>`, `<`, `<=`, or `<>`. | +| values | [Json](json.md) | The values that appear in the cell. | + ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookicon | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookicon.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookoperation.md | Represents the status of a long-running workbook operation. |status|String| The current status of the operation. Possible values are: `notStarted`, `running`, `succeeded`, `failed`.| |error|[workbookOperationError](workbookoperationerror.md)| The error returned by the operation.| |resourceLocation|String| The resource URI for the result.|+|statusCode| integer| Status code of the operation. | ## Relationships None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookoperationerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookoperationerror.md | Represents an error from a failed workbook operation. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookpivottable | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookpivottable.md | Represents an Excel PivotTable. |worksheet|[workbookWorksheet](workbookworksheet.md)| The worksheet containing the current PivotTable. Read-only. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookrange.md | Range represents a set of one or more contiguous cells such as a cell, a row, a ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookrangeborder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookrangeborder.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookrangefill | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookrangefill.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookrangefont | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookrangefont.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookrangeformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookrangeformat.md | A format object encapsulating the range's font, fill, borders, alignment, and ot ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookrangeview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookrangeview.md | RangeView represents a set of visible cells of the parent range. ## Properties | Property | Type |Description| |:|:--|:-|+|cellAddresses|Json|Represents the cell addresses| |columnCount|Int32|Returns the number of visible columns. Read-only.| |formulas|Json|Represents the formula in A1-style notation. | |formulasLocal|Json|Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. | RangeView represents a set of visible cells of the parent range. |rows|[workbookRangeView](workbookrangeview.md) collection| Represents a collection of range views associated with the range. Read-only. Read-only.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ ], |
v1.0 | Workbooksessioninfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbooksessioninfo.md | Provides information about workbook session. ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbooksortfield | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbooksortfield.md | Represents a condition in a sorting operation. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbooktable | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbooktable.md | Represents an Excel table. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbooktablecolumn | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbooktablecolumn.md | Represents a column in a table. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbooktablesort | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbooktablesort.md | Manages sorting operations on Table objects. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookworksheetprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookworksheetprotection.md | None. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookworksheetprotectionoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workbookworksheetprotectionoptions.md | Represents the options in sheet protection. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workforceintegration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workforceintegration.md | 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 | appropriate time zone. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workplace | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workplace.md | + + Title: "workplace resource type" +description: "Represents a workplace in a tenant." ++ms.localizationpriority: medium +++# workplace resource type ++Namespace: microsoft.graph +++Represents a workplace in a tenant. ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[List sensorDevices](../api/workplace-list-sensordevices.md)|[workplaceSensorDevice](../resources/workplacesensordevice.md) collection|Get a list of all workplace sensor devices created for a tenant.| +|[Create workplaceSensorDevice](../api/workplace-post-sensordevices.md)|[workplaceSensorDevice](../resources/workplacesensordevice.md)|Create a new sensor device.| ++## Properties ++None. ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|sensorDevices|[workplaceSensorDevice](../resources/workplacesensordevice.md) collection|A collection of sensor devices.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.workplace", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.workplace" +} +``` |
v1.0 | Workplacesensor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workplacesensor.md | + + Title: "workplaceSensor resource type" +description: "Represents a sensor on hardware that collects and reports data on physical or environmental conditions, including occupancy, headcount, inferred occupancy, temperature, and more." ++ms.localizationpriority: medium +++# workplaceSensor resource type ++Namespace: microsoft.graph +++Represents a sensor on hardware that collects and reports data on physical or environmental conditions, including occupancy, headcount, inferred occupancy, temperature, and more. ++## Properties ++|Property|Type|Description| +|:|:|:| +|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. | ++### workplaceSensorType values ++| Member | Description | +|:-|:| +| occupancy | The sensor detects if the place is occupied or not. Use it for motion sensors or other binary sensors that measure the occupancy of a place. | +| peopleCount | The sensor counts the number of people in the place. Use it for sensors that report people count as a number. | +| 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 ++None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.workplaceSensor" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.workplaceSensor", + "displayName": "String", + "placeId": "String", + "sensorId": "String", + "sensorType": "String" +} +``` + |
v1.0 | Workplacesensordevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workplacesensordevice.md | + + Title: "workplaceSensorDevice resource type" +description: "Represents hardware capable of hosting multiple sensors that collect and report data on physical or environmental conditions, including occupancy, headcount, inferred occupancy, temperature, and more." ++ms.localizationpriority: medium +++# workplaceSensorDevice resource type ++Namespace: microsoft.graph +++Represents hardware capable of hosting multiple sensors that collect and report data on physical or environmental conditions, including occupancy, headcount, inferred occupancy, temperature, and more. ++Inherits from [entity](../resources/entity.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[List sensorDevices](../api/workplace-list-sensordevices.md)|[workplaceSensorDevice](../resources/workplacesensordevice.md) collection|Get a list of all workplace sensor devices created for a tenant.| +|[Create workplaceSensorDevice](../api/workplace-post-sensordevices.md)|[workplaceSensorDevice](../resources/workplacesensordevice.md)|Create a new workplace sensor device.| +|[Get workplaceSensorDevice](../api/workplacesensordevice-get.md)|[workplaceSensorDevice](../resources/workplacesensordevice.md)|Get the properties of a workplace sensor device, including tags, MAC address, sensors, and more.| +|[Update workplaceSensorDevice](../api/workplacesensordevice-update.md)|[workplaceSensorDevice](../resources/workplacesensordevice.md)|Update the properties of a workplace sensor device.| +|[Delete workplaceSensorDevice](../api/workplacesensordevice-delete.md)|None|Delete a workplace sensor device.| +|[ingestTelemetry](../api/workplacesensordevice-ingesttelemetry.md)|None|Ingest sensor telemetry for a workplace sensor device.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|description|String| The description of the device. | +|deviceId|String| The user-defined unique identifier of the device provided at the time of creation. | +|displayName|String| The display name of the device. | +|id|String| The unique identifier of the device. It's system generated and a user can't change it. Inherited from [entity](../resources/entity.md).| +|ipV4Address|String| The IPv4 address of the device. | +|ipV6Address|String| The IPv6 address of the device. | +|macAddress|String| The MAC address of the device. | +|manufacturer|String| The manufacturer of the device. | +|placeId|String| The unique identifier of the place where the device is located. 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. | +|sensors|[workplaceSensor](../resources/workplacesensor.md) collection| A list of sensors associated with the device that collect and report data about physical or environmental conditions, such as occupancy, people count, inferred occupancy, temperature, and more. | +|tags|String collection| A list of custom tags associated with the device. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.workplaceSensorDevice", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.workplaceSensorDevice", + "description": "String", + "deviceId": "String", + "displayName": "String", + "id": "String (identifier)", + "ipV4Address": "String", + "ipV6Address": "String", + "macAddress": "String", + "manufacturer": "String", + "placeId": "String", + "sensors": [{"@odata.type": "microsoft.graph.workplaceSensor"}], + "tags": ["String"] +} +``` |
v1.0 | Workplacesensordevicetelemetry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workplacesensordevicetelemetry.md | + + Title: "workplaceSensorDeviceTelemetry resource type" +description: "Represents the data collected and reported by a sensor on a device, such as occupancy, people count, inferred occupancy, temperature, and more." ++ms.localizationpriority: medium +++# workplaceSensorDeviceTelemetry resource type ++Namespace: microsoft.graph +++Represents the data collected and reported by a sensor on a device, such as occupancy, people count, inferred occupancy, temperature, and more. ++## Properties ++|Property|Type|Description| +|:|:|:| +|boolValue|Boolean|The value of the sensor can be `true` or `false`. Use it for sensors that report binary values, such as occupancy or heartbeat.| +|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`.| +|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. | +|locationHint|String|The additional information to indicate the location of the device. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.workplaceSensorDeviceTelemetry" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.workplaceSensorDeviceTelemetry", + "boolValue": "Boolean", + "deviceId": "String", + "intValue": "Int32", + "sensorId": "String", + "sensorType": "String", + "timestamp": "String (timestamp)", + "eventValue": {"@odata.type": "microsoft.graph.workplaceSensorEventValue"}, + "locationHint": "String" +} +``` |
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." ++ms.localizationpriority: medium ++++# workplaceSensorEventValue resource type ++Namespace: microsoft.graph +++Represents the data collected and reported by a Wi-Fi or 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`. | +| user | [emailIdentity](../resources/emailidentity.md) | The unique identifier of a user. It could be an email or a Microsoft Entra ID. | ++### workplaceSensorEventType values +| Member | Description | +|:-|:| +| 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. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.workplaceSensorEventValue" +}--> +```json +{ + "@odata.type": "#microsoft.graph.workplaceSensorEventValue", + "eventType": "String", + "user": {"@odata.type": "microsoft.graph.emailIdentity"} +} +``` |
v1.0 | X509certificateauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/x509certificateauthenticationmethodconfiguration.md | +toc.keywords: [ certificate-based authentication, CBA ] # x509CertificateAuthenticationMethodConfiguration resource type |
v1.0 | X509certificatecombinationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/x509certificatecombinationconfiguration.md | description: "Configuration to require a specific certificate in an authenticati ms.localizationpriority: medium -doc_type: apiPageType |
v1.0 | Yammer Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/yammer-activity-reports.md | - Title: "Yammer activity reports" -description: "You can understand the level of your organization's engagement with Yammer by how much activity is generated across the organization and the number of unique users who post, like, and read messages on Yammer." ---doc_type: conceptualPageType ---# Yammer activity reports --Namespace: microsoft.graph ---You can understand the level of your organization's engagement with Yammer by how much activity is generated across the organization and the number of unique users who post, like, and read messages on Yammer. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Yammer Activity](https://support.office.com/client/Yammer-activity-c7c9f938-5b8e-4d52-b1a2-c7c32cb2312a). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get user detail](../api/reportroot-getyammeractivityuserdetail.md) | Stream | Stream | Get details about Yammer activity by user. | -| [Get activity counts](../api/reportroot-getyammeractivitycounts.md) | Stream | Stream | Get the trends on the amount of Yammer activity in your organization by how many messages were posted, read, and liked. | -| [Get user counts](../api/reportroot-getyammeractivityusercounts.md) | Stream | Stream | Get the trends on the number of unique users who posted, read, and liked Yammer messages. | -- |
v1.0 | Yammer Device Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/yammer-device-usage-reports.md | - Title: "Yammer device usage reports" -description: "The device usage reports for Yammer give you information about which devices your users utilize to engage on Yammer. You can view the number of users by device type over a selected time period and view details by user." ---doc_type: conceptualPageType ---# Yammer device usage reports --Namespace: microsoft.graph ---The device usage reports for Yammer give you information about which devices your users utilize to engage on Yammer. You can view the number of users by device type over a selected time period and view details by user. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Yammer device usage](https://support.office.com/client/Yammer-device-usage-b793ffdd-effa-43d0-849a-b1ca2e899f38). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | - | -| [Get user detail](../api/reportroot-getyammerdeviceusageuserdetail.md) | Stream | Stream | Get details about Yammer device usage by user. | -| [Get distribution user counts](../api/reportroot-getyammerdeviceusagedistributionusercounts.md) | Stream | Stream | Get the number of users by device type. | -| [Get user counts](../api/reportroot-getyammerdeviceusageusercounts.md) | Stream | Stream | Get the number of daily users by device type. | -- |
v1.0 | Yammer Groups Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/yammer-groups-activity-reports.md | - Title: "Yammer groups activity reports" -description: "You can gain insights into the activity of Yammer groups in your organization and see how many Yammer groups are being created and used." ---doc_type: conceptualPageType ---# Yammer groups activity reports --Namespace: microsoft.graph ---You can gain insights into the activity of Yammer groups in your organization and see how many Yammer groups are being created and used. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Yammer groups activity](https://support.office.com/client/Yammer-groups-activity-report-94dd92ec-ea73-43c6-b51f-2a11fd78aa31). --## Reports --| Function | CSV return type | JSON return type | Description | -| :-- | :-- | : | | -| [Get group detail](../api/reportroot-getyammergroupsactivitydetail.md) | Stream | Stream | Get details about Yammer groups activity by group. | -| [Get group counts](../api/reportroot-getyammergroupsactivitygroupcounts.md) | Stream | Stream | Get the total number of groups that existed and how many included group conversation activity. | -| [Get activity counts](../api/reportroot-getyammergroupsactivitycounts.md) | Stream | Stream | Get the number of Yammer messages posted, read, and liked in groups. | -- |
v1.0 | Accesspackage Delete Incompatibleaccesspackage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/accesspackage-delete-incompatibleaccesspackage.md | DELETE https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement [!INCLUDE [sample-code](../includes/snippets/php/remove-incompatibleaccesspackage-from-accesspackage-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/remove-incompatibleaccesspackage-from-accesspackage-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Accesspackage Delete Incompatiblegroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/accesspackage-delete-incompatiblegroup.md | DELETE https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement [!INCLUDE [sample-code](../includes/snippets/php/remove-incompatiblegroup-from-accesspackage-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/remove-incompatiblegroup-from-accesspackage-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Accessreviewset List Historydefinitions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/accessreviewset-list-historydefinitions.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "accessreviewset_list_historydefinitions" } --> [!INCLUDE [permissions-table](../includes/permissions/accessreviewset-list-historydefinitions-permissions.md)] -If the signed-in user is not a Global Admin directory role member or a Global Reader directory role member, only the definitions that the signed-in user created will be returned. +If the signed-in user doesn't have at least the Global Reader directory role member, only the definitions that the signed-in user created are returned. ## HTTP 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 one of the following directory roles. To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): -+ Global Administrator +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 |
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)] -When calling on behalf of a user, the user needs to belong to the [Global Administrator](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) directory role. +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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Privileged Role Administrator -* Global Administrator +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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Privileged Role Administrator -* Global Administrator +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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Privileged Role Administrator -* Global Administrator +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 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 <!-- { "blockType": "permissions", "name": "administrativeunit_list_members" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-list-members-permissions.md)] -> Note: To list the members of a hidden membership in an administrative unit, the Member.Read.Hidden permission is required. - [!INCLUDE [limited-info](../../includes/limited-info.md)] +> **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 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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Privileged Role Administrator -* Global Administrator +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, Group.ReadWrite.All, Directory.ReadWrite.All | -To create a new group in an administrative unit, the calling principal must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): +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): * Privileged Role Administrator-* Global Administrator * Groups Administrator ## HTTP request The following table shows the properties of the [group](../resources/group.md) r |:|:--|:-| | displayName | string | The name to display in the address book for the group. Required. | | description | string | A description for the group. Optional. |-| isAssignableToRole | Boolean | Set to **true** to enable the group to be assigned to a Microsoft Entra role. Only Privileged Role Administrator and Global Administrator can set the value of this property. Optional. | +| isAssignableToRole | Boolean | Set to **true** to enable the group to be assigned to a Microsoft Entra role. Privileged Role Administrator is the least privileged role to set the value of this property. Optional. | | mailEnabled | boolean | Set to **true** for mail-enabled groups. Required. | | mailNickname | string | The mail alias for the group. These characters cannot be used in the mailNickName: `@()\[]";:.<>,SPACE`. Required. | | securityEnabled | boolean | Set to **true** for security-enabled groups, including Microsoft 365 groups. Required. | Content-type: application/json { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",- "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4", - "deletedDateTime": null, - "classification": null, - "createdDateTime": "2018-12-22T02:21:05Z", - "description": "Self help community for golf", - "displayName": "Golf Assist", - "expirationDateTime": null, - "groupTypes": [ - "Unified" - ], + "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4", + "deletedDateTime": null, + "classification": null, + "createdDateTime": "2018-12-22T02:21:05Z", + "description": "Self help community for golf", + "displayName": "Golf Assist", + "expirationDateTime": null, + "groupTypes": [ + "Unified" + ], "isAssignableToRole": null,- "mail": "golfassist@contoso.com", - "mailEnabled": true, - "mailNickname": "golfassist", - "membershipRule": null, - "membershipRuleProcessingState": null, - "onPremisesLastSyncDateTime": null, - "onPremisesSecurityIdentifier": null, - "onPremisesSyncEnabled": null, - "preferredDataLocation": "CAN", - "preferredLanguage": null, - "proxyAddresses": [ - "SMTP:golfassist@contoso.com" - ], - "renewedDateTime": "2018-12-22T02:21:05Z", - "resourceBehaviorOptions": [], - "resourceProvisioningOptions": [], - "securityEnabled": false, - "securityIdentifier": "S-1-12-1-1753967289-1089268234-832641959-555555555", - "theme": null, - "visibility": "Public", - "onPremisesProvisioningErrors": [] + "mail": "golfassist@contoso.com", + "mailEnabled": true, + "mailNickname": "golfassist", + "membershipRule": null, + "membershipRuleProcessingState": null, + "onPremisesLastSyncDateTime": null, + "onPremisesSecurityIdentifier": null, + "onPremisesSyncEnabled": null, + "preferredDataLocation": "CAN", + "preferredLanguage": null, + "proxyAddresses": [ + "SMTP:golfassist@contoso.com" + ], + "renewedDateTime": "2018-12-22T02:21:05Z", + "resourceBehaviorOptions": [], + "resourceProvisioningOptions": [], + "securityEnabled": false, + "securityIdentifier": "S-1-12-1-1753967289-1089268234-832641959-555555555", + "theme": null, + "visibility": "Public", + "onPremisesProvisioningErrors": [] } ``` |
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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Privileged Role Administrator -* Global Administrator +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 | 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)] -To update an administrative unit, the calling principal must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Privileged Role Administrator -* Global Administrator +To update 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 | Appcatalogs List Teamsapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/appcatalogs-list-teamsapps.md | doc_type: apiPageType Namespace: microsoft.graph List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog.-This includes apps from the Microsoft Teams store, as well as apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request. +This includes apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request. > [!NOTE] > In general, the **id** of a **teamsApp** resource is generated by the server. It is not the same as the **id** specified in a Teams app manifest, unless its **distributionMethod** is `store`. For other cases, the **id** provided by the developer as part of the Teams app manifest is stamped as the **externalId** in the **teamsApp** resource. Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "appcatalogs_list_teamsapps" } --> [!INCLUDE [permissions-table](../includes/permissions/appcatalogs-list-teamsapps-permissions.md)] -> **Note**: -The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. +> [!NOTE] +> The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. ## HTTP request GET /appCatalogs/teamsApps This method supports the `$filter`, `$select`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. -Using `$expand=AppDefinitions` will return more information about the state of the app, such as the **publishingState**, which reflects the app submission review status and returns whether an app has been approved, rejected, or remains under review. +Using `$expand=AppDefinitions` returns more information about the state of the app, such as the **publishingState**, which reflects the app submission review status and returns whether an app is approved, rejected, or remains under review. > **Note:** You can filter on any of the fields of the [teamsApp](../resources/teamsapp.md) object to shorten the list of results. You can use any of the following filter operations: Equal, not-equal, and, or, and not. Content-Type: application/json ### Example 4: List applications with a given ID, and return the submission review state -The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the app's submission review state. `Submitted` means the review is pending, `published` means the app was approved by the admin, and `rejected` means the app was rejected by the admin. +The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the app's submission review state. `Submitted` means the review is pending, `published` means the admin approved the app, and `rejected` means the admin rejected the app. #### Request |
v1.0 | Application Addpassword | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/application-addpassword.md | Title: "application: addPassword" description: "Add a strong password to an application." ms.localizationpriority: medium-+ doc_type: "apiPageType" doc_type: "apiPageType" Namespace: microsoft.graph -Adds a strong password or secret to an [application](../resources/application.md). +Adds a strong password or secret to an [application](../resources/application.md). You can also [add passwords while creating the application](../api/application-post-applications.md#example-2-create-a-new-application-and-add-a-password-secret). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] POST /applications(appId='{appId}')/addPassword In the request body, provide an optional `passwordCredential` object with the following properties. -| Property | Type |Description| +| Property | Type |Description| |:|:--|:-| | displayName | String | Friendly name for the password. Optional. | | endDateTime | DateTimeOffset | The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Optional. The default value is "startDateTime + 2 years". | |
v1.0 | Application List Extensionproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/application-list-extensionproperty.md | Title: "List extensionProperties (directory extensions)" description: "Retrieve a list of directory extension definitions." ms.localizationpriority: medium + doc_type: "apiPageType" |
v1.0 | Application Post Applications | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/application-post-applications.md | Namespace: microsoft.graph Create a new [application](../resources/application.md) object. > [!IMPORTANT]-> Adding [**passwordCredential**](../resources/passwordcredential.md) when creating applications is not supported. Use the [addPassword](application-addpassword.md) method to add passwords or secrets for an application. > > Do not share application client IDs (**appId**) in API documentation or code samples. In the request body, supply a JSON representation of [application](../resources/ If successful, this method returns `201 Created` response code and an [application](../resources/application.md) object in the response body. ## Examples-### Request ++### Example 1: Create an application with the default settings ++#### Request The following example shows a request. Content-type: application/json -### Response +#### Response The following example shows the response. > **Note:** The response object shown here might be shortened for readability. Content-type: application/json } ``` +### Example 2: Create a new application and add a password secret ++#### Request +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_application_with_passwordcredentials" +}--> +```http +POST https://graph.microsoft.com/v1.0/applications +Content-type: application/json ++{ + "displayName": "MyAppName", + "passwordCredentials": [ + { + "displayName": "Password name" + } + ] +} +``` ++# [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 **secretText** property in the response object contains the strong passwords or secret generated by Microsoft Entra ID and is 16-64 characters in length. There is no way to retrieve this password in the future. ++> **Note**: The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.passwordCredential" +} --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#applications/$entity", + "id": "83ab4737-da9d-4084-86f2-f8fbec220647", + "deletedDateTime": null, + "appId": "9519e58c-bd06-4120-a7fd-2220d4de8409", + "applicationTemplateId": null, + "disabledByMicrosoftStatus": null, + "createdDateTime": "2024-04-01T19:10:02.6626202Z", + "displayName": "MyAppName", + "description": null, + "keyCredentials": [], + "parentalControlSettings": { + "countriesBlockedForMinors": [], + "legalAgeGroupRule": "Allow" + }, + "passwordCredentials": [ + { + "customKeyIdentifier": null, + "displayName": "Password name", + "endDateTime": "2026-04-01T19:10:02.6576213Z", + "hint": "puE", + "keyId": "09a0c91a-1bc3-4eaf-a945-c88c041fad6c", + "secretText": "1234567890abcdefghijklmnopqrstuvwxyzabcd", + "startDateTime": "2024-04-01T19:10:02.6576213Z" + } + ], + "publicClient": { + "redirectUris": [] + } +} +``` + <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!-- |
v1.0 | Application Post Calls | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/application-post-calls.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "application_post_calls" } --> [!INCLUDE [permissions-table](../includes/permissions/application-post-calls-permissions.md)] -> **Notes:** +> [!NOTE] > - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table.-> - Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. > - The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Application Post Extensionproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/application-post-extensionproperty.md | Title: "Create extensionProperty (directory extension)" description: "Create a new directory extension." ms.localizationpriority: medium + doc_type: "apiPageType" |
v1.0 | Application Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/application-update.md | In the request body, supply the values for relevant fields that should be update | spa | [spaApplication](../resources/spaapplication.md) | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. | | 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 encrypts all the tokens it emits by using the key this property points to. 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. |+| uniqueName | String | The unique identifier that can be assigned to an application and used as an alternate key. Can updated only if `null` and is immutable once set. | | web | [webApplication](../resources/webapplication.md) | Specifies settings for a web application. | ## Response |
v1.0 | Application Upsert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/application-upsert.md | + + Title: "Upsert application" +description: "Create a new application object if it doesn't exist, or update the properties of an existing application object." ++ms.localizationpriority: medium ++++# Upsert application ++Namespace: microsoft.graph ++Create a new [application](../resources/application.md) object if it doesn't exist, or update the properties of an existing [application](../resources/application.md) object. ++> [!IMPORTANT] +> Using PATCH to set [**passwordCredential**](../resources/passwordcredential.md) is not supported. Use the [addPassword](./application-addpassword.md) and [removePassword](./application-removepassword.md) methods to update the password 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). ++<!-- { "blockType": "permissions", "name": "application_post_applications" } --> ++## HTTP request ++To create or update an application, specify the **uniqueName** client-provided alternate key. ++<!-- { "blockType": "ignored" } --> +```http +PATCH /applications(uniqueName='{uniqueName}') +``` ++## Request headers +| Name | Description| +|:--|:-| +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required. | +| Prefer | `create-if-missing`. Required for upsert behavior, otherwise the request is treated as an update operation. | ++## Request body ++In the request body, supply a JSON representation of the [application](../resources/application.md) object. The request body must contain **displayName**, which is a required property. Specify other writable properties as necessary for your application, for creation or update. ++## Response ++If successful, if an application object with **uniqueName** doesn't exist, this method returns a `201 Created` response code and a new [application](../resources/application.md) object in the response body. ++If an application object with **uniqueName** already exists, this method updates the [application](../resources/application.md) object and returns a `204 No Content` response code. ++## Examples ++### Example 1: Create a new application if it doesn't exist ++The following example creates an application because an application with the specified **uniqueName** value doesn't exist. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "upsert_application_create" +} +--> ++``` http +PATCH https://graph.microsoft.com/v1.0/applications(uniqueName='app-65278') +Content-Type: application/json +Prefer: create-if-missing ++{ + "displayName": "Display name" +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [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.application" +} +--> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#applications/$entity", + "id": "03ef14b0-ca33-4840-8f4f-d6e91916010e", + "deletedDateTime": null, + "isFallbackPublicClient": null, + "appId": "631a96bc-a705-4eda-9f99-fdaf9f54f6a2", + "applicationTemplateId": null, + "identifierUris": [], + "createdDateTime": "2019-09-17T19:10:35.2742618Z", + "displayName": "Display name", + "isDeviceOnlyAuthSupported": null, + "groupMembershipClaims": null, + "optionalClaims": null, + "addIns": [], + "publisherDomain": "contoso.onmicrosoft.com", + "samlMetadataUrl": "https://graph.microsoft.com/2h5hjaj542de/app", + "signInAudience": "AzureADandPersonalMicrosoftAccount", + "tags": [], + "tokenEncryptionKeyId": null, + "api": { + "requestedAccessTokenVersion": 2, + "acceptMappedClaims": null, + "knownClientApplications": [], + "oauth2PermissionScopes": [], + "preAuthorizedApplications": [] + }, + "appRoles": [], + "publicClient": { + "redirectUris": [] + }, + "info": { + "termsOfServiceUrl": null, + "supportUrl": null, + "privacyStatementUrl": null, + "marketingUrl": null, + "logoUrl": null + }, + "keyCredentials": [], + "parentalControlSettings": { + "countriesBlockedForMinors": [], + "legalAgeGroupRule": "Allow" + }, + "passwordCredentials": [], + "requiredResourceAccess": [], + "uniqueName": "app-65278", + "web": { + "redirectUris": [], + "homePageUrl": null, + "logoutUrl": null, + "implicitGrantSettings": { + "enableIdTokenIssuance": false, + "enableAccessTokenIssuance": false + } + }, + "windows" : null +} +``` ++### Example 2: Update an existing application ++The following example updates the application because an application with the specified **uniqueName** value exists. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "application_upsert_update" +} +--> ++``` http +PATCH https://graph.microsoft.com/v1.0/applications(uniqueName='app-65278') +Content-Type: application/json +Prefer: create-if-missing ++{ + "displayName": "Display name" +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [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 | Applicationtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/applicationtemplate-get.md | Title: 'Get applicationTemplate' description: 'Retrieve the properties and relationships of applicationtemplate object.' ms.localizationpriority: medium-++ doc_type: apiPageType |
v1.0 | Applicationtemplate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/applicationtemplate-list.md | Title: 'List applicationTemplates' description: 'Retrieve a list of applicationtemplate objects.' ms.localizationpriority: medium-++ doc_type: apiPageType |
v1.0 | Attendancerecord List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/attendancerecord-list.md | GET /me/onlineMeetings/{meetingId}/attendanceReports/{reportId}/attendanceRecord GET /users/{userId}/onlineMeetings/{meetingId}/attendanceReports/{reportId}/attendanceRecords ``` -To get attendance records of a virtual event session's attendance report: +To get attendance records of a virtual event session's attendance report with delegated and app permission: <!-- {"blockType": "ignored"}--> ``` http GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports/{reportId}/attendanceRecords |
v1.0 | Authenticationconditionapplication Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationconditionapplication-delete.md | + + Title: "Delete authenticationConditionApplication (from a user flow)" +description: "Remove an application from an authenticationEventsFlow." ++ms.localizationpriority: medium ++++# Delete authenticationConditionApplication (from a user flow) +Namespace: microsoft.graph ++Remove or unlink [an application](../resources/authenticationconditionapplication.md) from an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. This disables the customized authentication experience defined for the 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). ++<!-- { "blockType": "permissions", "name": "authenticationconditionapplication_delete" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{appId} +``` ++## 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 `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details. ++## Examples ++#### Request +The following example shows a request. `63856651-13d9-4784-9abf-20758d509e19` represents the **appId** of the application, also known as the client ID, not the object ID. +<!-- { + "blockType": "request", + "name": "delete_includeApplications" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/conditions/applications/includeApplications/63856651-13d9-4784-9abf-20758d509e19 +``` ++#### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Authenticationconditionsapplications List Includeapplications | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationconditionsapplications-list-includeapplications.md | + + Title: "List includeApplications (for a user flow)" +description: "List applications for an authenticationEventsFlow." ++ms.localizationpriority: medium ++++# List includeApplications (for a user flow) +Namespace: microsoft.graph ++List the applications linked to an [authenticationEventsFlow](../resources/authenticationeventsflow.md). These are the applications for which the authentication experience defined by the user flow is enabled. ++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "authenticationconditionsapplications_list_includeapplications" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/ +``` ++## 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).| +|Content-Type|application/json. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` and a collection of [authenticationConditionApplication](../resources/authenticationconditionapplication.md) objects in the response body. ++## Examples ++### Request +The following example shows a request to retrieve the list of applications associated with a user flow. +<!-- { + "blockType": "request", + "name": "get_includeApplications" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/conditions/applications/includeApplications +``` ++### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.authenticationConditionApplication" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows('0313cc37-d421-421d-857b-87804d61e33e')/conditions/applications/includeApplications", + "value": [ + { + "appId": "63856651-13d9-4784-9abf-20758d509e19" + } + ] +} +``` |
v1.0 | Authenticationconditionsapplications Post Includeapplications | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationconditionsapplications-post-includeapplications.md | + + Title: "Add includeApplication (to a user flow)" +description: "Add application to an authenticationeEventsFlow." ++ms.localizationpriority: medium ++++# Add includeApplication (to a user flow) +Namespace: microsoft.graph ++Add or link an application to a user flow, or [authenticationEventsFlow](../resources/authenticationeventsflow.md). This enables the authentication experience defined by the user flow to be enabled for the application. An application can only be linked to one 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). ++<!-- { "blockType": "permissions", "name": "authenticationconditionsapplications_post_includeapplications" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications +``` ++## 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, provide a JSON representation of the **appId** of the application to associate with the user flow. ++## Response ++If successful, this method returns a `201 Created` response code and a new [authenticationConditionApplication](../resources/authenticationconditionapplication.md) object in the response body. If unsuccessful, a `4xx` error is returned with specific details. ++## Examples ++### Request +The following example shows a request. +<!-- { + "blockType": "request", + "name": "post_includeapplications" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/conditions/applications/includeApplications +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.authenticationConditionApplication", + "appId": "63856651-13d9-4784-9abf-20758d509e19" +} ++``` +++### Response +The following example shows the response. +<!-- { + "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/authenticationEventsFlows('0313cc37-d421-421d-857b-87804d61e33e')/conditions/applications/includeApplications/$entity", + "appId": "63856651-13d9-4784-9abf-20758d509e19" +} +``` |
v1.0 | Authenticationeventlistener Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationeventlistener-delete.md | + + Title: "Delete authenticationEventListener" +description: "Delete an authenticationEventListener object." ++ms.localizationpriority: medium ++++# Delete authenticationEventListener +Namespace: microsoft.graph ++Delete an [authenticationEventListener](../resources/authenticationeventlistener.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": "authenticationeventlistener_delete" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /identity/authenticationEventListeners/{authenticationEventListenerId} +``` ++## 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_authenticationeventlistener" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/identity/authenticationEventListeners/c7a1f2c5-3d36-4b3f-b75c-143af30a5246 +``` ++# [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 | Authenticationeventlistener Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationeventlistener-get.md | + + Title: "Get authenticationEventListener" +description: "Read the properties and relationships of an authenticationEventListener object." ++ms.localizationpriority: medium ++++# 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. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "authenticationeventlistener_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identity/authenticationEventListeners/{authenticationEventListenerId} +``` ++## 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 an [authenticationEventListener](../resources/authenticationeventlistener.md) object in the response body. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_authenticationeventlistener" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/authenticationEventListeners/6fc5012e-7665-43d6-9708-4370863f4e6e +``` ++# [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.authenticationEventListener" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity", + "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener", + "id": "6fc5012e-7665-43d6-9708-4370863f4e6e", + "conditions": { + "applications": { + "includeApplications@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners('6fc5012e-7665-43d6-9708-4370863f4e6e')/microsoft.graph.onTokenIssuanceStartListener/conditions/applications/includeApplications", + "includeApplications": [ + { + "appId": "77552a27-2fbf-4fb0-873e-af165ec071d5" + } + ] + } + } +} +``` + |
v1.0 | Authenticationeventlistener Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationeventlistener-update.md | + + Title: "Update authenticationEventListener" +description: "Update the properties of an authenticationEventListener object." ++ms.localizationpriority: medium ++++# 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. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "authenticationeventlistener_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /identity/authenticationEventListeners/{authenticationEventListenerId} +``` ++## 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 ++You must specify the **@odata.type** property and the value of the [authenticationEventListener](../resources/authenticationeventlistener.md) object type to update. For example, `"@odata.type": "#microsoft.graph.onTokenIssuanceStartListener"`. ++|Property|Type|Description| +|:|:|:| +|conditions|[authenticationConditions](../resources/authenticationconditions.md)|The conditions on which this authenticationEventListener should trigger. Optional.| +|handler|[onTokenIssuanceStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be updated for the **onTokenIssuanceStartListener** listener type.| ++## Response ++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: ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_authenticationeventlistener" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/identity/authenticationEventListeners/990d94e5-cc8f-4c4b-97b4-27e2678aac28 +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener", + "conditions": { + "applications": { + "includeApplications": [ + { + "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4" + } + ] + } + }, +} +``` ++# [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 | Authenticationeventsflow Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationeventsflow-delete.md | + + Title: "Delete authenticationEventsFlow" +description: "Delete an authenticationEventsFlow object." ++ms.localizationpriority: medium ++++# Delete authenticationEventsFlow +Namespace: microsoft.graph ++Delete a specific [authenticationEventsFlow](../resources/authenticationeventsflow.md) resource by ID. This operation also [removes or unlinks](authenticationconditionapplication-delete.md) all applications from the flow, which disables the customized authentication experience defined for the application. The following derived subtypes are supported: +- [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.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": "authenticationeventsflow_delete" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /identity/authenticationEventsFlows/{authenticationEventsFlow-id} +``` ++## 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", + "name": "delete_authenticationeventsflow" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e +``` +++### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Authenticationeventsflow Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationeventsflow-get.md | + + Title: "Get authenticationEventsFlow" +description: "Read the properties and relationships of an authenticationEventsFlow object." ++ms.localizationpriority: medium ++++# Get authenticationEventsFlow +Namespace: microsoft.graph ++Retrieve the properties and relationships of a specific [authenticationEventsFlow](../resources/authenticationeventsflow.md) object by ID. The **@odata.type** property in the response object indicates the type of the object, which can be one of the following derived subtypes: +- [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.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": "authenticationeventsflow_get" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identity/authenticationEventsFlows/{authenticationEventsFlow-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). ++## 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 [authenticationEventsFlow](../resources/authenticationeventsflow.md) object in the response body. ++## Examples ++### Request +The following example shows a request to retrieve a specific External Identities user flow. +<!-- { + "blockType": "request", + "name": "get_authenticationeventsflow" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e +``` ++### Response +The following example shows the response. In this example, the user flow retrieved is named "Woodgrove Drive Users Flow" and is set up to: ++- Allow users to create a local email with password account, or sign up with their Google or Facebook identity +- Collect **Display Name** and **Favorite Color** +- Create a "Member" user type. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.authenticationEventsFlow" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "0313cc37-d421-421d-857b-87804d61e33e", + "displayName": "Woodgrove Drive User Flow", + "description": "For onboarding consumers to the Woodgrove Drive application", + "conditions": { + "applications": { + "includeApplications@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows('0313cc37-d421-421d-857b-87804d61e33e')/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications", + "includeApplications": [] + } + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp", + "identityProviders": [ + { + "@odata.type": "#microsoft.graph.builtInIdentityProvider", + "id": "EmailPassword-OAUTH", + "displayName": "Email with password", + "identityProviderType": "EmailPassword" + }, + { + "@odata.type": "#microsoft.graph.socialIdentityProvider", + "id": "Google-OAUTH", + "displayName": "Google", + "identityProviderType": "Google", + "clientId": "137004260525-q8j2cp9hqceqa6hpvaa346e04g92tn8m.apps.googleusercontent.com", + "clientSecret": "******" + }, + { + "@odata.type": "#microsoft.graph.socialIdentityProvider", + "id": "Facebook-OAUTH", + "displayName": "Facebook", + "identityProviderType": "Facebook", + "clientId": "236028191057849", + "clientSecret": "******" + } + ] + }, + "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": [] + } + ] + } + ] + }, + "attributes": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "displayName", + "displayName": "Display Name", + "description": "Display Name of the User.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor", + "displayName": "Favorite color", + "description": "what is your favorite color", + "userFlowAttributeType": "custom", + "dataType": "string" + } + ] + }, + "onUserCreateStart": { + "@odata.type": "#microsoft.graph.onUserCreateStartExternalUsersSelfServiceSignUp", + "userTypeToCreate": "member", + "accessPackages": [] + } + } +} +``` + |
v1.0 | Authenticationeventsflow Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationeventsflow-update.md | + + Title: "Update authenticationEventsFlow" +description: "Update the properties of an authenticationEventsFlow object." ++ms.localizationpriority: medium ++++# Update authenticationEventsFlow +Namespace: microsoft.graph ++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) ++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "authenticationeventsflow_update" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /identity/authenticationEventsFlows/{authenticationEventsFlow-id} +``` ++## 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 +++You must include the **@odata.type** property with a value of the specific user flow type in the body. For example, `"@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow"`. ++|Property|Type|Description| +|:|:|:| +|id|String|The unique identifier for the entity. Read-only. | +|displayName|String|The display name for the events policy. | +|description|String|The description of the events policy.| +|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. | ++## Response ++If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details. ++## Examples ++### Example 1: Update the display name of an external identities self-service sign-up user flow ++#### Request +The following example shows a request that updates the display name of a specific external identities user flow. ++<!-- { + "blockType": "request", + "name": "authenticationeventsflow_update_beta_e1" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "displayName": "New user flow description", +} +``` ++#### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` ++### Example 2: Update the onAttributeCollection event of an external identities 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. ++#### Request ++<!-- { + "blockType": "request", + "name": "update_authenticationeventsflow_onattributecollection_beta_e2" +} +--> +``` 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": "city", + "label": "City", + "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": [] + } + ] + } + ] + } + } +} +``` ++#### 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 ++<!-- { + "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": [] + } + ] + } + ] + } + } +} +``` +++#### Response ++The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Authenticationmethodspolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationmethodspolicy-get.md | HTTP/1.1 200 OK Content-Type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#authenticationMethodsPolicy", + "@odata.context": "https://graph.microsoft.com/beta/$metadata#authenticationMethodsPolicy", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET policies/authenticationMethodsPolicy?$select=description,displayName", "id": "authenticationMethodsPolicy", "displayName": "Authentication Methods Policy", "description": "The tenant-wide policy that controls which authentication methods are allowed in the tenant, authentication method registration requirements, and self-service password reset settings",- "lastModifiedDateTime": "2022-01-26T10:47:26.6044384Z", - "policyVersion": "1.4", + "lastModifiedDateTime": "2024-04-26T12:44:42.0858664Z", + "policyVersion": "1.5", + "policyMigrationState": "preMigration", "registrationEnforcement": { "authenticationMethodsRegistrationCampaign": { "snoozeDurationInDays": 1,- "state": "default", + "enforceRegistrationAfterAllowedSnoozes": true, + "state": "disabled", "excludeTargets": [], "includeTargets": [ { Content-Type: application/json ] } },+ "systemCredentialPreferences": { + "state": "disabled", + "excludeTargets": [], + "includeTargets": [ + { + "id": "all_users", + "targetType": "group" + } + ] + }, + "reportSuspiciousActivitySettings": { + "state": "disabled", + "voiceReportingCode": 0, + "includeTarget": { + "id": "all_users", + "targetType": "group" + } + }, + "authenticationMethodConfigurations@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations", "authenticationMethodConfigurations": [ { "@odata.type": "#microsoft.graph.fido2AuthenticationMethodConfiguration", "id": "Fido2",- "state": "disabled", + "state": "enabled", "isSelfServiceRegistrationAllowed": true, "isAttestationEnforced": true,+ "defaultPasskeyProfile": null, + "excludeTargets": [ + { + "id": "dad4ae4a-730c-4e52-826c-0d9094971f04", + "targetType": "group" + } + ], "keyRestrictions": { "isEnforced": false, "enforcementType": "block", "aaGuids": [] },+ "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('Fido2')/microsoft.graph.fido2AuthenticationMethodConfiguration/includeTargets", "includeTargets": [ { "targetType": "group", "id": "all_users",- "isRegistrationRequired": false + "isRegistrationRequired": false, + "allowedPasskeyProfiles": [] }- ] + ], + "passkeyProfiles": [] }, { "@odata.type": "#microsoft.graph.microsoftAuthenticatorAuthenticationMethodConfiguration", "id": "MicrosoftAuthenticator",- "state": "disabled", + "state": "enabled", + "isSoftwareOathEnabled": false, + "excludeTargets": [ + { + "id": "dad4ae4a-730c-4e52-826c-0d9094971f04", + "targetType": "group" + } + ], + "featureSettings": { + "companionAppAllowedState": { + "state": "default", + "includeTarget": { + "targetType": "group", + "id": "all_users" + }, + "excludeTarget": { + "targetType": "group", + "id": "00000000-0000-0000-0000-000000000000" + } + }, + "numberMatchingRequiredState": { + "state": "enabled", + "includeTarget": { + "targetType": "group", + "id": "all_users" + }, + "excludeTarget": { + "targetType": "group", + "id": "00000000-0000-0000-0000-000000000000" + } + }, + "displayAppInformationRequiredState": { + "state": "default", + "includeTarget": { + "targetType": "group", + "id": "all_users" + }, + "excludeTarget": { + "targetType": "group", + "id": "00000000-0000-0000-0000-000000000000" + } + }, + "displayLocationInformationRequiredState": { + "state": "default", + "includeTarget": { + "targetType": "group", + "id": "all_users" + }, + "excludeTarget": { + "targetType": "group", + "id": "00000000-0000-0000-0000-000000000000" + } + } + }, + "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('MicrosoftAuthenticator')/microsoft.graph.microsoftAuthenticatorAuthenticationMethodConfiguration/includeTargets", "includeTargets": [ { "targetType": "group", "id": "all_users", "isRegistrationRequired": false,- "authenticationMode": "any", - "outlookMobileAllowedState": "default", - "displayAppInformationRequiredState": "default", - "numberMatchingRequiredState": "default" + "authenticationMode": "any" } ] }, { "@odata.type": "#microsoft.graph.smsAuthenticationMethodConfiguration", "id": "Sms",- "state": "enabled", + "state": "disabled", + "excludeTargets": [], + "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('Sms')/microsoft.graph.smsAuthenticationMethodConfiguration/includeTargets", "includeTargets": [ { "targetType": "group", "id": "all_users", "isRegistrationRequired": false,- "isUsableForSignIn": true + "isUsableForSignIn": false } ] }, { "@odata.type": "#microsoft.graph.temporaryAccessPassAuthenticationMethodConfiguration", "id": "TemporaryAccessPass",- "state": "disabled", + "state": "enabled", "defaultLifetimeInMinutes": 60, "defaultLength": 8, "minimumLifetimeInMinutes": 60, "maximumLifetimeInMinutes": 480, "isUsableOnce": false,+ "excludeTargets": [ + { + "id": "dad4ae4a-730c-4e52-826c-0d9094971f04", + "targetType": "group" + } + ], + "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('TemporaryAccessPass')/microsoft.graph.temporaryAccessPassAuthenticationMethodConfiguration/includeTargets", + "includeTargets": [ + { + "targetType": "group", + "id": "all_users", + "isRegistrationRequired": false + } + ] + }, + { + "@odata.type": "#microsoft.graph.hardwareOathAuthenticationMethodConfiguration", + "id": "HardwareOath", + "state": "enabled", + "excludeTargets": [], + "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('HardwareOath')/microsoft.graph.hardwareOathAuthenticationMethodConfiguration/includeTargets", + "includeTargets": [ + { + "targetType": "group", + "id": "all_users", + "isRegistrationRequired": false + } + ] + }, + { + "@odata.type": "#microsoft.graph.softwareOathAuthenticationMethodConfiguration", + "id": "SoftwareOath", + "state": "enabled", + "excludeTargets": [], + "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('SoftwareOath')/microsoft.graph.softwareOathAuthenticationMethodConfiguration/includeTargets", + "includeTargets": [ + { + "targetType": "group", + "id": "dad4ae4a-730c-4e52-826c-0d9094971f04", + "isRegistrationRequired": false + } + ] + }, + { + "@odata.type": "#microsoft.graph.voiceAuthenticationMethodConfiguration", + "id": "Voice", + "state": "disabled", + "isOfficePhoneAllowed": false, + "callerIdNumber": null, + "isCustomGreetingEnabled": false, + "excludeTargets": [], + "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('Voice')/microsoft.graph.voiceAuthenticationMethodConfiguration/includeTargets", "includeTargets": [ { "targetType": "group", Content-Type: application/json { "@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration", "id": "Email",- "state": "enabled", + "state": "disabled", "allowExternalIdToUseEmailOtp": "default",- "includeTargets": [] + "excludeTargets": [], + "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('Email')/microsoft.graph.emailAuthenticationMethodConfiguration/includeTargets", + "includeTargets": [ + { + "targetType": "group", + "id": "d2d5bae7-a7b7-4581-8d52-5a8d26f517b3", + "isRegistrationRequired": false + } + ] + }, + { + "@odata.type": "#microsoft.graph.x509CertificateAuthenticationMethodConfiguration", + "id": "X509Certificate", + "state": "enabled", + "excludeTargets": [], + "certificateUserBindings": [ + { + "x509CertificateField": "PrincipalName", + "userProperty": "userPrincipalName", + "priority": 1, + "trustAffinityLevel": "low" + }, + { + "x509CertificateField": "RFC822Name", + "userProperty": "userPrincipalName", + "priority": 2, + "trustAffinityLevel": "low" + } + ], + "authenticationModeConfiguration": { + "x509CertificateAuthenticationDefaultMode": "x509CertificateSingleFactor", + "x509CertificateDefaultRequiredAffinityLevel": "low", + "rules": [] + }, + "issuerHintsConfiguration": { + "state": "disabled" + }, + "crlValidationConfiguration": { + "state": "disabled", + "exemptedCertificateAuthoritiesSubjectKeyIdentifiers": [] + }, + "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('X509Certificate')/microsoft.graph.x509CertificateAuthenticationMethodConfiguration/includeTargets", + "includeTargets": [ + { + "targetType": "group", + "id": "eb2aa918-770c-40b4-97b8-f58a0087f8b5", + "isRegistrationRequired": false + }, + { + "targetType": "group", + "id": "d97d81ce-74be-46a4-ba6e-62eed46fabb9", + "isRegistrationRequired": false + } + ] + }, + { + "@odata.type": "#microsoft.graph.externalAuthenticationMethodConfiguration", + "id": "fda55161-0d73-48ec-b29f-d29689e3d1b6", + "state": "enabled", + "displayName": "Adatum - Broken", + "appId": "73f7c26a-7a24-4408-adfa-ff1ff19b5c10", + "excludeTargets": [ + { + "id": "18c6ce0e-243f-4130-ad7d-d9049806df0e", + "targetType": "group" + } + ], + "openIdConnectSetting": { + "clientId": "966c7a17-8cb9-47a6-8504-c1e50b05f21d", + "discoveryUrl": "https://Adatum.com/.well-known/openid-configurationx" + }, + "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('fda55161-0d73-48ec-b29f-d29689e3d1b6')/microsoft.graph.externalAuthenticationMethodConfiguration/includeTargets", + "includeTargets": [ + { + "targetType": "group", + "id": "all_users", + "isRegistrationRequired": false + } + ] } ] } |
v1.0 | Authenticationmethodsroot Usersregisteredbyfeature | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationmethodsroot-usersregisteredbyfeature.md | The following table shows the parameters that can be used with this function. |includedUserRoles|includedUserRoles|The role type for the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`.| |includedUserTypes|includedUserTypes|User type. Possible values are: `all`, `member`, `guest`.| -The value `privilegedAdmin` consists of the following privileged admin roles: +The value `privilegedAdmin` consists of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): * Global Administrator * Security Administrator |
v1.0 | Authenticationmethodsroot Usersregisteredbymethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationmethodsroot-usersregisteredbymethod.md | The following table shows the parameters that can be used with this function. |includedUserRoles|includedUserRoles|The role type for the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`.| |includedUserTypes|includedUserTypes|User type. Possible values are: `all`, `member`, `guest`.| -The value `privilegedAdmin` consists of the following privileged admin roles: +The value `privilegedAdmin` consists of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): * Global Administrator * Security Administrator |
v1.0 | B2xidentityuserflow Delete Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/b2xidentityuserflow-delete-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_delete_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-delete-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/b2xidentityuserflow-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Get Apiconnectorconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/b2xidentityuserflow-get-apiconnectorconfiguration.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_get_apiconnectorconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-get-apiconnectorconfiguration-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/b2xidentityuserflow-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_get" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow List Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/b2xidentityuserflow-list-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_list_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-list-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow List Languages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/b2xidentityuserflow-list-languages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_list_languages" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-list-languages-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Post Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/b2xidentityuserflow-post-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-post-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | B2xidentityuserflow Put Apiconnectorconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/b2xidentityuserflow-put-apiconnectorconfiguration.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_put_apiconnectorconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-put-apiconnectorconfiguration-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Basesitepage Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/basesitepage-delete.md | ++ +description: "Delete a sitePage from the site pages list in a site." + Title: "Delete baseSitePage" +ms.localizationpriority: medium ++# Delete baseSitePage ++Namespace: microsoft.graph ++Delete a [baseSitePage][] from the site pages [list][] in a [site][]. ++[baseSitePage]: ../resources/basesitepage.md +[list]: ../resources/list.md +[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). ++>**Note:** To delete an item, the user must have granted the application write access to the item to be deleted. ++<!-- { "blockType": "permissions", "name": "basesitepage_delete" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +DELETE /sites/{site-id}/pages/{page-id} +``` ++## Request headers ++| Name | Value | Description +|:--|:|:-- +|Authorization|Bearer {token}.| 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 ++Don't supply a request body with this method. ++## Response ++If successful, this method returns a `204 No Content`. It doesn't return anything in the response body. ++## Example ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "delete-page", "scopes": "files.readwrite sites.readwrite.all" } --> +```http +DELETE /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202 +``` ++# [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 +``` ++<!-- +{ + "type": "#page.annotation", + "description": "Delete a page in the SitePages list in a site.", + "keywords": "", + "section": "documentation", + "tocPath": "Pages/Delete", + "suppressions": [] +} +--> |
v1.0 | Basesitepage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/basesitepage-get.md | ++ +description: "Read the properties and relationships of a baseSitePage object." Last updated : 03/15/2018+ Title: Get baseSitePage +ms.localizationpriority: medium +++# Get baseSitePage ++Namespace: microsoft.graph ++Get the metadata for a [baseSitePage][] in the site pages [list][] in a [site][]. ++[baseSitePage]: ../resources/basesitepage.md +[list]: ../resources/list.md +[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": "basesitepage_get" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +GET /sites/{site-id}/pages/{page-id} +``` ++## 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 [baseSitePage](../resources/basesitepage.md) object in the response body. ++## Example ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!--{ + "blockType": "request", + "name": "get-basesitepage", + "scopes": "sites.read.all", + "tags": "service.sharepoint" +} +--> ++```msgraph-interactive +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202 +``` ++# [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.baseSitePage", + "truncated": true, + "isCollection":false +} +--> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.sitePage", + "@odata.etag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"", + "description": "Reiciendis placeat dolores.Mollitia veniam tempora tempora quidem voluptatum.Quos animi maiores facilis.Dolores officiis consequatur provident beatae deleniti accusamus magni quam tenetur.", + "eTag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"", + "id": "f45354cb-d634-45df-8b88-2b4e96a1dc45", + "lastModifiedDateTime": "2023-04-16T10:01:41Z", + "name": "Electronic Convertible.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Electronic Convertible.aspx", + "title": "Electronic Convertible", + "pageLayout": "article", + "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/_layouts/15/images/sitepagethumbnail.png", + "promotionKind": "page", + "showComments": false, + "showRecommendedPages": true, + "contentType": { + "id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A", + "name": "Site Page" + }, + "createdBy": { + "user": { + "displayName": "admin_contoso", + "email": "admin@contoso.onmicrosoft.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "admin_contoso", + "email": "admin@contoso.onmicrosoft.com" + } + }, + "parentReference": { + "siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3" + }, + "publishingState": { + "level": "draft", + "versionId": "0.4" + }, + "reactions": {} +} +``` ++<!-- +{ + "type": "#page.annotation", + "description": "Get a page in a site", + "keywords": "", + "section": "documentation", + "tocPath": "Pages/Get", + "suppressions": [ + ] +} +--> |
v1.0 | Basesitepage List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/basesitepage-list.md | ++ +description: "Get the collection of baseSitePage objects from the site pages list in a site." + Title: "List baseSitePages" +ms.localizationpriority: medium +++# List baseSitePages ++Namespace: microsoft.graph ++Get the collection of [baseSitePage][] objects from the site pages [list][] in a [site][]. All pages in the site are returned (with pagination). Sort alphabetically by **name** in ascending order. ++> **Note:** The [baseSitePage][] specified is a parent type and does not have any instance. As a result, the returned data only consists of available subtypes that are provided as a list. ++**The following table lists the available subtypes.** ++| Entity name | Description | +| :-- | :- | +| [sitePage][] | Represents a regular page. | ++[baseSitePage]: ../resources/basesitepage.md +[sitePage]: ../resources/sitepage.md +[list]: ../resources/list.md +[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": "basesitepage_list" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```msgraph-interactive +GET /sites/{site-id}/pages +``` ++## 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 OK` response code and a collection of [baseSitePage](../resources/basesitepage.md) objects in the response body. ++## Example ++### Request ++The following example shows a request. +<!-- +{ + "blockType": "request", + "name": "get-basesitepages", + "scopes": "sites.read.all", + "tags": "service.sharepoint" +} +--> ++# [HTTP](#tab/http) ++```msgraph-interactive +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages +``` ++# [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.baseSitePage)", + "truncated": true +} +--> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.sitePage", + "@odata.etag": "\"{5FA48F95-2FDF-40E8-A28C-6D0D8345BCD2},8\"", + "description": "Placeat porro perspiciatis maxime esse nobis illo.Voluptate vitae maxime totam consectetur fugit sit quos.Saepe ea veniam voluptate tempore quod deleniti necessitatibus repellat.", + "eTag": "\"{5FA48F95-2FDF-40E8-A28C-6D0D8345BCD2},8\"", + "id": "5fa48f95-2fdf-40e8-a28c-6d0d8345bcd2", + "lastModifiedDateTime": "2023-04-16T08:37:51Z", + "name": "Account holistic.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Account holistic.aspx", + "title": "CSS Global Lithuanian meter", + "pageLayout": "article", + "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/a830edad9050849vanaukyisx52.spgrid.com/_layouts/15/images/sitepagethumbnail.png", + "promotionKind": "page", + "showComments": false, + "showRecommendedPages": false, + "contentType": { + "id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A", + "name": "Site Page" + }, + "createdBy": { + "user": { + "displayName": "admin_contoso", + "email": "admin@contoso.onmicrosoft.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "admin_contoso", + "email": "admin@contoso.onmicrosoft.com" + } + }, + "parentReference": { + "siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3" + }, + "publishingState": { + "level": "draft", + "versionId": "0.4" + }, + "reactions": {} + }, + { + "@odata.type": "#microsoft.graph.sitePage", + "@odata.etag": "\"{DA0F67BE-977E-4D09-88AC-506A1002E678},5\"", + "eTag": "\"{DA0F67BE-977E-4D09-88AC-506A1002E678},5\"", + "id": "da0f67be-977e-4d09-88ac-506a1002e678", + "lastModifiedDateTime": "2023-04-16T06:39:30Z", + "name": "Analyst Fresh.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Analyst Fresh.aspx", + "title": "Lesotho Account Metal Analyst du", + "pageLayout": "article", + "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/a830edad9050849vanaukyisx52.spgrid.com/_layouts/15/images/sitepagethumbnail.png", + "promotionKind": "page", + "showComments": false, + "showRecommendedPages": false, + "contentType": { + "id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A", + "name": "Site Page" + }, + "createdBy": { + "user": { + "displayName": "admin_contoso", + "email": "admin@contoso.onmicrosoft.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "admin_contoso", + "email": "admin@contoso.onmicrosoft.com" + } + }, + "parentReference": { + "siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3" + }, + "publishingState": { + "level": "draft", + "versionId": "0.1" + }, + "reactions": {}, + "titleArea": { + "enableGradientEffect": false, + "imageWebUrl": "https://loremflickr.com/640/480", + "layout": "plain", + "showAuthor": false, + "showPublishedDate": false, + "showTextBlockAboveTitle": false, + "textAboveTitle": "generating ADP", + "textAlignment": "center", + "title": "strategic underneath protocol Buckinghamshire forecast", + "authors@odata.type": "#Collection(String)", + "authors": [], + "authorByline@odata.type": "#Collection(String)", + "authorByline": [], + "imageSourceType": 4, + "serverProcessedContent": { + "htmlStrings": [], + "searchablePlainTexts": [], + "links": [], + "imageSources": [] + } + } + } + ] +} +``` ++<!-- +{ + "type": "#page.annotation", + "description": "Enumerate the list of pages in a site", + "keywords": "", + "section": "documentation", + "tocPath": "Pages/Enumerate", + "suppressions": [ + ] +} +--> |
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 one of the following [directory roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): +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): -* Global administrator * Cloud device administrator * Helpdesk administrator * Intune service administrator |
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 one of the following [directory roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): -* Global administrator +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 |
v1.0 | Bookingappointment Cancel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingappointment-cancel.md | Namespace: microsoft.graph Cancel the specified [bookingAppointment](../resources/bookingappointment.md) in the specified [bookingBusiness](../resources/bookingbusiness.md) and send a message to the involved customer and staff members. ## Permissions |
v1.0 | Bookingappointment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingappointment-delete.md | Namespace: microsoft.graph Delete a [bookingAppointment](../resources/bookingappointment.md) in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingappointment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingappointment-get.md | Get the properties and relationships of a [bookingAppointment](../resources/book The **startDateTime** and **endDateTime** properties are always returned in UTC. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingappointment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingappointment-update.md | Namespace: microsoft.graph Update the properties of a [bookingAppointment](../resources/bookingappointment.md) object in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-delete.md | Namespace: microsoft.graph Delete a [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingbusiness Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-get.md | Namespace: microsoft.graph Get the properties and relationships of a [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingbusiness Getstaffavailability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-getstaffavailability.md | Namespace: microsoft.graph Get the availability information of [staff members](../resources/bookingstaffmember.md) of a [Microsoft Bookings calendar](../resources/bookingappointment.md). ## Permissions |
v1.0 | Bookingbusiness List Appointments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-list-appointments.md | Namespace: microsoft.graph Get a list of [bookingAppointment](../resources/bookingappointment.md) objects for the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness List Calendarview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-list-calendarview.md | Namespace: microsoft.graph Get the collection of [bookingAppointment](../resources/bookingappointment.md) objects for a [bookingBusiness](../resources/bookingbusiness.md) that occurs in the specified date range. ## Permissions |
v1.0 | Bookingbusiness List Customers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-list-customers.md | Namespace: microsoft.graph Get a list of [bookingCustomer](../resources/bookingcustomer.md) objects of a business. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingbusiness List Customquestions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-list-customquestions.md | Namespace: microsoft.graph Get the [bookingCustomQuestion](../resources/bookingcustomquestion.md) resources associated with a [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness List Services | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-list-services.md | Namespace: microsoft.graph Get a list of [bookingService](../resources/bookingservice.md) objects in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness List Staffmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-list-staffmembers.md | Namespace: microsoft.graph Get a list of [bookingStaffMember](../resources/bookingstaffmember.md) objects in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-list.md | This operation returns only the **id** and **displayName** of each Microsoft Boo > **Note:** Results are limited to 500 mailboxes. Pagination of the results is not currently supported. ## Permissions |
v1.0 | Bookingbusiness Post Appointments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-post-appointments.md | Namespace: microsoft.graph Create a new [bookingAppointment](../resources/bookingappointment.md) for the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingbusiness Post Bookingbusinesses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-post-bookingbusinesses.md | Create a new [Microsoft Bookings business](../resources/bookingbusiness.md) in a This is the first step in setting up a Bookings business where you must specify the business display name. You can include other information such as business address, web site address, and scheduling policy, or set that information later by [updating](bookingbusiness-update.md) the **bookingBusiness**. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingbusiness Post Customers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-post-customers.md | Namespace: microsoft.graph Create a new [bookingCustomer](../resources/bookingcustomer.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). |
v1.0 | Bookingbusiness Post Customquestions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-post-customquestions.md | Namespace: microsoft.graph Create a new [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions |
v1.0 | Bookingbusiness Post Services | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-post-services.md | Namespace: microsoft.graph Create a new [bookingService](../resources/bookingservice.md) for the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingbusiness Post Staffmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-post-staffmembers.md | Namespace: microsoft.graph Create a new [bookingStaffMember](../resources/bookingstaffmember.md) in the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingbusiness Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-publish.md | Make the scheduling page of a business available to external customers. Set the **isPublished** property to `true`, and the **publicUrl** property to the URL of the scheduling page. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingbusiness Unpublish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-unpublish.md | Make the scheduling page of this business not available to external customers. Set the **isPublished** property to `false`, and the **publicUrl** property to `null`. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingbusiness Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-update.md | Namespace: microsoft.graph Update the properties of a [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingcurrency Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingcurrency-get.md | Namespace: microsoft.graph Get the properties of a [bookingCurrency](../resources/bookingcurrency.md) object that is available to a Microsoft Bookings business. Use the **id** property, which is the currency code, to specify the currency. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingcurrency List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingcurrency-list.md | Namespace: microsoft.graph Get a list of [bookingCurrency](../resources/bookingcurrency.md) objects available to a Microsoft Bookings business. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingcustomer Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingcustomer-delete.md | Namespace: microsoft.graph Delete the specified [bookingCustomer](../resources/bookingcustomer.md) object. ## Permissions |
v1.0 | Bookingcustomer Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingcustomer-get.md | Namespace: microsoft.graph Get the properties and relationships of a [bookingCustomer](../resources/bookingcustomer.md) object. ## Permissions |
v1.0 | Bookingcustomer Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingcustomer-update.md | Namespace: microsoft.graph Update the properties of a [bookingCustomer](../resources/bookingcustomer.md) object. ## Permissions |
v1.0 | Bookingcustomquestion Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingcustomquestion-delete.md | Namespace: microsoft.graph Delete a [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions |
v1.0 | Bookingcustomquestion Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingcustomquestion-get.md | Namespace: microsoft.graph Read the properties and relationships of a [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions |
v1.0 | Bookingcustomquestion Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingcustomquestion-update.md | Namespace: microsoft.graph Update the properties of a [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions |
v1.0 | Bookingservice Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingservice-delete.md | Namespace: microsoft.graph Delete a [bookingService](../resources/bookingservice.md) object in the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingservice Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingservice-get.md | Namespace: microsoft.graph Get the properties and relationships of a [bookingService](../resources/bookingservice.md) object in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingservice Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingservice-update.md | The following are some examples you can customize for a service: - Any time buffer to set up before or finish up after the service - [Scheduling policy](../resources/bookingschedulingpolicy.md) parameters, such as minimum notice to book or cancel, and whether customers can select specific staff members for an appointment. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Bookingstaffmember Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingstaffmember-delete.md | Namespace: microsoft.graph Delete a [bookingStaffMember](../resources/bookingstaffmember.md) in the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Bookingstaffmember Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingstaffmember-get.md | Namespace: microsoft.graph Get the properties and relationships of a [bookingStaffMember](../resources/bookingstaffmember.md) in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions |
v1.0 | Bookingstaffmember Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingstaffmember-update.md | Namespace: microsoft.graph Update the properties of a [bookingStaffMember](../resources/bookingstaffmember.md) in the specified [bookingBusiness](../resources/bookingbusiness.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). |
v1.0 | Calendar Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/calendar-delete.md | The following example shows a request. DELETE https://graph.microsoft.com/v1.0/me/calendar ``` -# [C#](#tab/csharp) --# [CLI](#tab/cli) --# [Go](#tab/go) --# [Java](#tab/java) - # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/delete-calendar-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) --# [Python](#tab/python) - ##### Response |
v1.0 | Callrecording Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/callrecording-get.md | For a recording, this API returns the metadata of the single recording associate > * This API doesn't support meetings created using the [create onlineMeeting API](/graph/api/application-post-onlinemeetings) that are not associated with an event on the user's calendar. > * This API works differently in one or more national clouds. For details, see [Microsoft Teams API implementation differences in national clouds](/graph/teamwork-national-cloud-differences). ## Permissions |
v1.0 | Calltranscript Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/calltranscript-get.md | Retrieving the transcript returns the metadata of the single transcript associat > * This API works differently in one or more national clouds. For details, see [Implementation differences in national clouds](/graph/teamwork-national-cloud-differences). > * If you want to retrieve meeting transcripts, use the [Create event](../api/user-post-events.md) API instead. ## Permissions |
v1.0 | Certificatebasedauthconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/certificatebasedauthconfiguration-delete.md | Title: "Delete certificateBasedAuthConfiguration" description: "Delete certificateBasedAuthConfiguration." ms.localizationpriority: medium-+ doc_type: "apiPageType" |
v1.0 | Certificatebasedauthconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/certificatebasedauthconfiguration-get.md | Title: "Get certificateBasedAuthConfiguration" description: "Get the properties of a certificatebasedauthconfiguration object." ms.localizationpriority: medium-+ doc_type: "apiPageType" |
v1.0 | Certificatebasedauthconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/certificatebasedauthconfiguration-list.md | Title: "List certificateBasedAuthConfigurations" description: "Get a list of certificatebasedauthconfiguration objects." ms.localizationpriority: medium-+ doc_type: "apiPageType" |
v1.0 | Certificatebasedauthconfiguration Post Certificatebasedauthconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration.md | Title: "Create certificateBasedAuthConfiguration" description: "Use this API to create a new certificateBasedAuthConfiguration." ms.localizationpriority: medium-+ doc_type: "apiPageType" |
v1.0 | Channel Get Filesfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-get-filesfolder.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "channel_get_filesfolder" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-get-filesfolder-permissions.md)] -> **Note**: The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ## HTTP request <!-- { "blockType": "ignored" } --> |
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 <!-- { "blockType": "permissions", "name": "channel_list_messages" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-list-messages-permissions.md)] -> **Note**: The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Channel Patch Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-patch-tabs.md | Namespace: microsoft.graph Update the properties of the specified [tab](../resources/teamstab.md). This API can be used to configure the content of the tab. +> [!NOTE] +> You can't use this API to update a static tab. An attempt to update a static tab returns a `400 Bad Request` response code. + [!INCLUDE [national-cloud-support](../../includes/global-us.md)] ## Permissions |
v1.0 | Channel Post Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-post-members.md | Include the following properties in the request body. If successful, this method returns a `201 Created` response code and a [conversationMember](../resources/conversationmember.md) object in the response body. +> [!NOTE] +> The response code `404 Not Found` is returned when you attempt to add a disabled/blocked user. + ## Examples ### Example 1: Add a member to a private channel |
v1.0 | Channel Post Messages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-post-messages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "channel_post_messages" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-post-messages-permissions.md)] -> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. --> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. <!-- markdownlint-disable MD024 --> <!-- markdownlint-disable MD001 --> POST /teams/{team-id}/channels/{channel-id}/messages ## Request body -In the request body, supply a JSON representation of a [chatMessage](../resources/chatmessage.md) object. Only the body property is mandatory. )ther properties are optional. +In the request body, supply a JSON representation of a [chatMessage](../resources/chatmessage.md) object. Only the body property is mandatory. All other properties are optional. ## Response |
v1.0 | Channel Post Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-post-tabs.md | Namespace: microsoft.graph Add (pin) a [tab](../resources/teamstab.md) to the specified [channel](../resources/channel.md) within a [team](../resources/team.md). The app must be [preinstalled in the team](../api/team-list-installedapps.md) and have the [configurableTabs](/microsoftteams/platform/resources/schema/manifest-schema#configurabletabs) property defined in the app manifest. +> **Note**: If the app manifest for a given **appId** contains a static tab that matches the current scope (**team**), the static tab is pinned by default. + [!INCLUDE [national-cloud-support](../../includes/global-us.md)] ## Permissions POST /teams/{team-id}/channels/{channel-id}/tabs A [teamsTab](../resources/teamstab.md). +> [!NOTE] +> When you pin a static tab, Teams takes the **displayName** and **configuration** from the app manifest. If these properties are specified in the request body, this API returns a `400 Bad Request` response code. ## Response If successful, this method returns a `201 Created` response code. |
v1.0 | Channel Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-post.md | doc_type: apiPageType Namespace: microsoft.graph -Create a new [channel](../resources/channel.md) in a team, as specified in the request body. When you create a channel, the maximum length of the channel's `displayName` is 50 characters. This is the name that appears to the user in Microsoft Teams. +Create a new [channel](../resources/channel.md) in a team, as specified in the request body. When you create a channel, the maximum length of the channel's `displayName` is 50 characters. This is the name that appears to the user in Microsoft Teams. If you're creating a private channel, you can add a maximum of 200 members. If you're creating a private channel, you can add a maximum of 200 members. ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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) | Channel.Create, Group.ReadWrite.All, Directory.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Channel.Create.Group*, Channel.Create, Teamwork.Migrate.All, Group.ReadWrite.All, Directory.ReadWrite.All | +This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. -> **Notes**: -> The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). -> -> This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. -> -> In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported -using Teamwork.Migrate.All and/or [migration APIs](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). +<!-- { "blockType": "permissions", "name": "channel_post" } --> ++> [!NOTE] +> - The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> - The Channel.Create.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported using Teamwork.Migrate.All and/or [migration APIs](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). ## HTTP request <!-- { "blockType": "ignored" } --> Location: /teams('57fb72d0-d811-46f4-8947-305e6072eaa5')/channels('19:4b6bed8d24 #### Request -The following example shows a request to create a private channel and add a user as an team owner. +The following example shows a request to create a private channel and add a user as a team owner. # [HTTP](#tab/http) |
v1.0 | Chart Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chart-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChart](../resources/chart.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChart](../resources/workbookchart.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chart List Series | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chart-list-series.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookChartSeries](../resources/chartseries.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookChartSeries](../resources/workbookchartseries.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chart List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chart-list.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookChart](../resources/chart.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookChart](../resources/workbookchart.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chart Post Series | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chart-post-series.md | POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/se | Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body-In the request body, supply a JSON representation of [WorkbookChartSeries](../resources/chartseries.md) object. +In the request body, supply a JSON representation of [workbookChartSeries](../resources/workbookchartseries.md) object. ## Response -If successful, this method returns `201 Created` response code and [WorkbookChartSeries](../resources/chartseries.md) object in the response body. +If successful, this method returns `201 Created` response code and [workbookChartSeries](../resources/workbookchartseries.md) object in the response body. ## Example ##### Request Content-type: application/json -In the request body, supply a JSON representation of [WorkbookChartSeries](../resources/chartseries.md) object. +In the request body, supply a JSON representation of [workbookChartSeries](../resources/workbookchartseries.md) object. ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Chart Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chart-update.md | PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name} ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookChart](../resources/chart.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookChart](../resources/workbookchart.md) object in the response body. ## Example ##### Request The following example shows the request. |
v1.0 | Chartaxis Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartaxis-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChartAxis](../resources/chartaxis.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChartAxis](../resources/workbookchartaxis.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartaxis Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartaxis-update.md | Title: "Update chartaxis" -description: "Update the properties of chartaxis object." + Title: "Update chartAxis" +description: "Update the properties of chartAxis object." ms.localizationpriority: medium doc_type: apiPageType -# Update chartaxis +# Update chartAxis Namespace: microsoft.graph -Update the properties of chartaxis object. +Update the properties of chartAxis object. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookChartAxis](../resources/chartaxis.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookChartAxis](../resources/workbookchartaxis.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartaxistitle Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartaxistitle-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChartAxisTitle](../resources/chartaxistitle.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChartAxisTitle](../resources/workbookchartaxistitle.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartaxistitle Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartaxistitle-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookChartAxisTitle](../resources/chartaxistitle.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookChartAxisTitle](../resources/workbookchartaxistitle.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartcollection Add | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartcollection-add.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `200 OK` response code and [WorkbookChart](../resources/chart.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookChart](../resources/workbookchart.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Chartcollection Itemat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartcollection-itemat.md | Don't supply a request body for this method. ## Response -If successful, this method returns `200 OK` response code and [WorkbookChart](../resources/chart.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookChart](../resources/workbookchart.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Chartdatalabels Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartdatalabels-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChartDataLabels](../resources/chartdatalabels.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChartDataLabels](../resources/workbookchartdatalabels.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartdatalabels Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartdatalabels-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookChartDataLabels](../resources/chartdatalabels.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookChartDataLabels](../resources/workbookchartdatalabels.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartfont Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartfont-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChartFont](../resources/chartfont.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChartFont](../resources/workbookchartfont.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartfont Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartfont-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookChartFont](../resources/chartfont.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookChartFont](../resources/workbookchartfont.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartgridlines Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartgridlines-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChartGridlines](../resources/chartgridlines.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChartGridlines](../resources/workbookchartgridlines.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartgridlines Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartgridlines-update.md | Title: "Update chartgridlines" -description: "Update the properties of chartgridlines object." + Title: "Update chartGridLines" +description: "Update the properties of chartGridLines object." ms.localizationpriority: medium doc_type: apiPageType -# Update chartgridlines +# Update chartGridLines Namespace: microsoft.graph -Update the properties of chartgridlines object. +Update the properties of chartGridLines object. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookChartGridlines](../resources/chartgridlines.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookChartGridlines](../resources/workbookchartgridlines.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartlegend Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartlegend-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChartLegend](../resources/chartlegend.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChartLegend](../resources/workbookchartlegend.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartlegend Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartlegend-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookChartLegend](../resources/chartlegend.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookChartLegend](../resources/workbookchartlegend.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartlineformat Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartlineformat-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChartLineFormat](../resources/chartlineformat.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChartLineFormat](../resources/workbookchartlineformat.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartlineformat Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartlineformat-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookChartLineFormat](../resources/chartlineformat.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookChartLineFormat](../resources/workbookchartlineformat.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartpoint Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartpoint-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChartPoint](../resources/chartpoint.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChartPoint](../resources/workbookchartpoint.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartpoint List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartpoint-list.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookChartPoint](../resources/chartpoint.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookChartPoint](../resources/workbookchartpoint.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartpointscollection Itemat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartpointscollection-itemat.md | Don't supply a request body for this method. ## Response -If successful, this method returns `200 OK` response code and [WorkbookChartPoint](../resources/chartpoint.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookChartPoint](../resources/workbookchartpoint.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Chartseries Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartseries-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChartSeries](../resources/chartseries.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChartSeries](../resources/workbookchartseries.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartseries List Points | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartseries-list-points.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [ChartPoints](../resources/chartpoint.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [ChartPoints](../resources/workbookchartpoint.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartseries List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartseries-list.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookChartSeries](../resources/chartseries.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookChartSeries](../resources/workbookchartseries.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartseries Post Points | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartseries-post-points.md | POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/se | Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body-In the request body, supply a JSON representation of [ChartPoints](../resources/chartpoint.md) object. +In the request body, supply a JSON representation of [ChartPoints](../resources/workbookchartpoint.md) object. ## Response -If successful, this method returns `201 Created` response code and [ChartPoints](../resources/chartpoint.md) object in the response body. +If successful, this method returns `201 Created` response code and [ChartPoints](../resources/workbookchartpoint.md) object in the response body. ## Example ##### Request Content-type: application/json -In the request body, supply a JSON representation of [ChartPoints](../resources/chartpoint.md) object. +In the request body, supply a JSON representation of [ChartPoints](../resources/workbookchartpoint.md) object. ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Chartseries Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartseries-update.md | doc_type: apiPageType Namespace: microsoft.graph -Update the properties of [chartSeries](../resources/chartseries.md) object. +Update the properties of [chartSeries](../resources/workbookchartseries.md) object. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/s ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookChartSeries](../resources/chartseries.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookChartSeries](../resources/workbookchartseries.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chartseriescollection Itemat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chartseriescollection-itemat.md | Don't supply a request body for this method. ## Response -If successful, this method returns `200 OK` response code and [WorkbookChartSeries](../resources/chartseries.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookChartSeries](../resources/workbookchartseries.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Charttitle Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/charttitle-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookChartTitle](../resources/charttitle.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookChartTitle](../resources/workbookcharttitle.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Charttitle Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/charttitle-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookChartTitle](../resources/charttitle.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookChartTitle](../resources/workbookcharttitle.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Chat Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-delete.md | Soft-delete a [chat](../resources/chat.md). When invoked with delegated permissi > After chats are deleted, tenant admins have seven days to restore them. Chats deleted for more than seven days can't be restored. > One delete request per second per tenant is allowed. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 | Chat Get Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-get-installedapps.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_get_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-installedapps-permissions.md)] -> **Note:** -The TeamsAppInstallation.ReadWriteAndConsentSelfForChat and TeamsAppInstallation.ReadWriteAndConsentForChat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsAppInstallation.ReadWriteAndConsentSelfForChat and TeamsAppInstallation.ReadWriteAndConsentForChat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request Content-type: application/json ### Example 2: Get the set of resource-specific permissions consented for the app installed in the specified chat -The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameterd is required to show the consented permission set. +The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameter is required to show the consented permission set. #### Request |
v1.0 | Chat List Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-list-installedapps.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_list_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-installedapps-permissions.md)] -> **Note:** -The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): +> [!NOTE] +> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat > - TeamsAppInstallation.ReadWriteAndConsentForChat > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat.All |
v1.0 | Chat Patch Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-patch-tabs.md | Namespace: microsoft.graph Update the properties of the specified [tab](../resources/teamstab.md) in a [chat](../resources/chat.md). This can be used to configure the content of the tab. -> **Note**: If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then, effectively, the tab pinned in the meeting will be updated. +> [!NOTE] +> - If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then, effectively, the tab pinned in the meeting will be updated. +> - You can't use this API to update a static tab. An attempt to update a static tab returns a `400 Bad Request` response code. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Chat Post Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-post-installedapps.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_post_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-installedapps-permissions.md)] -> **Note:** These TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions cannot be used to install apps that require consent to resource-specific permissions. +> [!NOTE] +> These TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions cannot be used to install apps that require consent to resource-specific permissions. ## HTTP request POST /chats/{chat-id}/installedApps ## Request body The request body should include the generated app ID of the catalog app. For more information, see [teamsApp properties](../resources/teamsapp.md#properties).-The following table lists additional parameters that can be used with the request body. +The following table lists other parameters that can be used with the request body. |Parameter|Type|Description| |:|:|:| The following example shows the response. HTTP/1.1 201 Created ``` -### Example 2: Install app in a chat and and consent to the resource-specific permissions required by the app +### Example 2: Install app in a chat and consent to the resource-specific permissions required by the app To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). |
v1.0 | Chat Post Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-post-tabs.md | Namespace: microsoft.graph Add (pin) a [tab](../resources/teamstab.md) to the specified [chat](../resources/chat.md). The corresponding app must already be [installed in the chat](../api/chat-list-installedapps.md). -> **Note**: If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then, effectively, the tab will get added to the meeting. +> **Notes**: +> * If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then the tab is effectively added to the meeting. +> * If the app manifest for a given **appId** contains a static tab that matches the current scope (`chat`/`groupChat`), the static tab is pinned by default. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] POST /chats/{chat-id}/tabs In the request body include a JSON representation of a [teamsTab](../resources/teamstab.md). +> [!NOTE] +> When you pin a static tab, Teams takes the **displayName** and **configuration** from the app manifest. If these properties are specified in the request body, this API returns a `400 Bad Request` response code. + ## Response If successful, this method returns a `201 Created` response code and an instance of the [teamsTab](../resources/teamstab.md) resource in the body. |
v1.0 | Chat Sendactivitynotification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-sendactivitynotification.md | The following table shows the parameters that can be used with this action. |Parameter|Type|Description| |:|:|:| |topic|[teamworkActivityTopic](../resources/teamworkactivitytopic.md)|The topic of the notification. Specifies the resource being talked about.|-|activityType|String|The activity type. Activity types must be declared in the [Teams app manifest](/microsoftteams/platform/overview).| +|activityType|String|The activity type must be declared in the [Teams app manifest](/microsoftteams/platform/overview), except for the `systemDefault` [Reserved activity type](/graph/teams-send-activityfeednotifications/#reserved-activity-types), which provides free-form text in the `Actor+Reason` line of the notification.| |chainId|Int64|Optional. The chain ID of the notification. Used to override a previous notification. Use the same `chainId` in subsequent requests to override the previous notification.| |previewText|[itemBody](../resources/itembody.md)|The preview text for the notification. Microsoft Teams shows the first 150 characters.| |templateParameters|[keyValuePair](../resources/keyvaluepair.md) collection|The values for the template variables defined in the activity feed entry corresponding to `activityType` in the [Teams app manifest](/microsoftteams/platform/overview).| |
v1.0 | Chat Teamsappinstallation Upgrade | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-teamsappinstallation-upgrade.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chat_teamsappinstallation_upgrade" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-teamsappinstallation-upgrade-permissions.md)] -> **Note:** The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions can't be used to install apps that require consent to resource-specific permissions. +> [!NOTE] +> The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions can't be used to install apps that require consent to resource-specific permissions. ## HTTP request <!-- { "blockType": "ignored" } --> POST /chats/{chat-id}/installedApps/{app-installation-id}/upgrade In the request body, supply a JSON representation of the parameters. -The following table lists additional parameters that can be used with the upgrade action. +The following table lists other parameters that can be used with the upgrade action. |Parameter|Type|Description| |:|:|:| |
v1.0 | Chatmessage Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-delta.md | 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). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Chatmessage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-get.md | One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account)|Not supported.| |Application| Chat.Read.All, Chat.ReadWrite.All| -> **Note:** The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc). +> [!NOTE] +> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc). ## HTTP request GET /me/chats/{chat-id}/messages/{message-id} ``` ## Optional query parameters-This method does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This method doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers | Header | Value | |
v1.0 | Chatmessage List Hostedcontents | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-list-hostedcontents.md | doc_type: "apiPageType" Namespace: microsoft.graph -Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md) +Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco |Delegated (personal Microsoft account)|Not supported.| |Application| Chat.Read.All, Chat.ReadWrite.All| -> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Chatmessage List Replies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-list-replies.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chatmessage_list_replies" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-list-replies-permissions.md)] -> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Chatmessage Post Replies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-post-replies.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chatmessage_post_replies" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-replies-permissions.md)] -> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. --> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> [!NOTE] +> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Chatmessage Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-post.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chatmessage_post" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-permissions.md)] -> **Note**: The Group.ReadWrite.All permissino is supported only for backward compatibility. We recommend that you update your solutions to use the alternative permissions listed in the table. --> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft might require you or your customers to pay additional fees based on the amount of data imported. +> [!NOTE] +> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use the alternative permissions listed in the table. +> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft might require you or your customers to pay additional fees based on the amount of data imported. ### Permissions for chat <!-- { "blockType": "permissions", "name": "chatmessage_post_2" } --> |
v1.0 | Chatmessage Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-update.md | One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | ChannelMessage.UpdatePolicyViolation.All, Group.ReadWrite.All** | -> **Note:** The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ### Permissions for chat <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> |
v1.0 | Chatmessagehostedcontent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessagehostedcontent-get.md | One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account)|Not supported.| |Application| Chat.Read.All, Chat.ReadWrite.All| -> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request GET /users/{user-id | user-principal-name}/chats/{chat-id}/messages/{message-id} ## Optional query parameters -This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers |
v1.0 | Chats Getallmessages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chats-getallmessages.md | GET /users/{id | user-principal-name}/chats/getAllMessages You can use the `model` query parameter, which supports the values `A` and `B`, based on the preferred [licensing and payment model](/graph/teams-licenses), as shown in the following examples. +<!-- { "blockType": "ignored" } --> ```http GET /users/{id | user-principal-name}/chats/getAllMessages?model=A GET /users/{id | user-principal-name}/chats/getAllMessages?model=B If no `model` parameter is specified, [evaluation mode](/graph/teams-licenses#ev This method also supportsΓÇ»[date range parameters](/graph/query-parameters) to customize the response, as shown in the following example. +<!-- { "blockType": "ignored" } --> ``` http GET /users/{id}/chats/getAllMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z ``` |
v1.0 | Cloudclipboarditem Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudclipboarditem-get.md | Read the properties and relationships of a [cloudClipboardItem](../resources/clo This API doesn't support using another user's credentials to get a [cloudClipboardItem](../resources/cloudclipboarditem.md) for a 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). |
v1.0 | Cloudclipboardroot List Items | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudclipboardroot-list-items.md | Get a list of the [cloudClipboardItem](../resources/cloudclipboarditem.md) objec This API doesn't support using another user's credentials to get a [cloudClipboardItem](../resources/cloudclipboarditem.md) for a 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). |
v1.0 | Cloudpc Endgraceperiod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-endgraceperiod.md | Namespace: microsoft.graph End the grace period for a specific [cloudPC](../resources/cloudpc.md) object. The grace period is triggered when the Cloud PC license is removed or the provisioning policy is unassigned. It allows users to access Cloud PCs for up to seven days before deprovisioning occurs. Ending the grace period immediately deprovisions the Cloud PC without waiting the seven 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). If successful, this method returns a `204 No Content` response code. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "endgraceperiod_cloudpc" The following example shows a request. POST https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs/4b18de4b-ab05-4059-8c61-0323a7df4ced/endGracePeriod ``` +# [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 | Cloudpc Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-get.md | Namespace: microsoft.graph Read the properties and relationships of a specific [cloudPC](../resources/cloudpc.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). If successful, this method returns a `200 OK` response code and a [cloudPC](../r The following example shows a request to get the default properties of a Cloud PC. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpc_default_properties" The following example shows a request to get the default properties of a Cloud P GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs/9ec90ff8-fd63-4fb9-ab5a-aa4fdcc43ec9 ``` +# [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 | Cloudpc Reboot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-reboot.md | Namespace: microsoft.graph Reboot a specific [cloudPC](../resources/cloudpc.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). If successful, this method returns a `204 No Content` response code. The following example shows a request to reboot a Cloud PC for the administrator. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "reboot_cloudpc" The following example shows a request to reboot a Cloud PC for the administrator POST https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs/831dd62e-cfa1-4d49-a3b4-58d4e9920f8e/reboot ``` +# [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 | Cloudpc Rename | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-rename.md | Namespace: microsoft.graph Rename a specific [cloudPC](../resources/cloudpc.md) object. Use this API to update the **displayName** of a Cloud PC entity. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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. The following example shows a request to rename a Cloud PC for the administrator. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "rename_cloudpc" Content-Type: application/json } ``` +# [CLI](#tab/cli) ++# [JavaScript](#tab/javascript) +++ ### Response The following example shows the response. <!-- { |
v1.0 | Cloudpc Restore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-restore.md | Namespace: microsoft.graph Restore a specific [cloudPC](../resources/cloudpc.md) object to a previous state from a snapshot. Use this API to trigger a remote action that restores a Cloud PC device to a previous 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). If successful, this method returns a `204 No Content` response code. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "cloudpc_restore", Content-length: 37 } ``` +# [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 | Cloudpc Troubleshoot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-troubleshoot.md | Namespace: microsoft.graph Troubleshoot a specific [cloudPC](../resources/cloudpc.md) object. Use this API to check the health status of the Cloud PC and the session host. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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. ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "troubleshoot_cloudpc" The following example shows a request. POST https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs/ff4eb6ab-d56a-4edf-90c1-baaec8dd6032/troubleshoot ``` +# [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 | Cloudpcauditevent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcauditevent-get.md | Namespace: microsoft.graph Read the properties and relationships of a [cloudPcAuditEvent](../resources/cloudpcauditevent.md) object. ## Permissions If successful, this method returns a `200 OK` response code and a [cloudPcAuditE The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpcauditevent" The following example shows a request. ``` http GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/auditEvents/{id} ```++# [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 | Cloudpcauditevent Getauditactivitytypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcauditevent-getauditactivitytypes.md | Namespace: microsoft.graph Get audit activity types by tenant 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": "cloudpcauditevent_getAuditActivityTypes" } --> +<!-- { "blockType": "permissions", "name": "cloudpcauditevent_getauditactivitytypes" } --> [!INCLUDE [permissions-table](../includes/permissions/cloudpcauditevent-getauditactivitytypes-permissions.md)] ## HTTP request If successful, this method returns a `200 OK` response code and a String collect The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "cloudpcauditevent_getauditactivitytypes" The following example shows a request. ``` http GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/auditEvents/getAuditActivityTypes ```++# [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 | Cloudpcdeviceimage Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcdeviceimage-delete.md | Namespace: microsoft.graph Delete a [cloudPcDeviceImage](../resources/cloudpcdeviceimage.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). If successful, this method returns a `204 No Content` response code. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete_deviceimages_from_virtualendpoint" The following example shows a request. DELETE https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/deviceImages/435849e6-0263-4621-9f93-8657667af3bb ``` +# [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 | Cloudpcdeviceimage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcdeviceimage-get.md | Namespace: microsoft.graph Read the properties and relationships of a specific [cloudPcDeviceImage](../resources/cloudpcdeviceimage.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). If successful, this method returns a `200 OK` response code and a [cloudPcDevice The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpcdeviceimage" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/deviceImages/eda7ed64-7705-4079-9d08-c2bd883f4fff ``` +# [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 | Cloudpcdeviceimage Getsourceimages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcdeviceimage-getsourceimages.md | Namespace: microsoft.graph Get [cloudPcSourceDeviceImage](../resources/cloudpcsourcedeviceimage.md) objects that can be uploaded and used on Cloud PCs. View a list of all the managed image resources from your Microsoft Entra subscriptions. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 a collection of The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "cloudpcdeviceimage_getsourceimages" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/deviceImages/getSourceImages ``` +# [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 | Cloudpcgalleryimage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcgalleryimage-get.md | Namespace: microsoft.graph Read the properties and relationships of a specific [cloudPcGalleryImage](../resources/cloudpcgalleryimage.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). If successful, this method returns a `200 OK` response code and a [cloudPcGaller The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpcgalleryimage", The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/galleryImages/MicrosoftWindowsDesktop_windows-ent-cpc_19h2-ent-cpc-os ``` +# [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 | Cloudpconpremisesconnection Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpconpremisesconnection-delete.md | When you delete an Azure network connection, permissions to the service are remo You cannot delete an Azure network connection when it's in use, as indicated by the **inUse** property. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "cloudPcOnPremisesConnection_delete" } --> +<!-- { "blockType": "permissions", "name": "cloudpconpremisesconnection_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/cloudpconpremisesconnection-delete-permissions.md)] ## HTTP request If successful, this method returns a `204 No Content` response code. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete_onpremisesconnections_from_virtualendpoint" The following example shows a request. DELETE https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections/{id} ``` +# [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 | Cloudpconpremisesconnection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpconpremisesconnection-get.md | Read the properties and relationships of the [cloudPcOnPremisesConnection](../re [!INCLUDE [on-premise-rename-note](../../includes/on-premise-rename-note.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": "cloudPcOnPremisesConnection_get" } --> +<!-- { "blockType": "permissions", "name": "cloudpconpremisesconnection_get" } --> [!INCLUDE [permissions-table](../includes/permissions/cloudpconpremisesconnection-get-permissions.md)] ## HTTP request If successful, this method returns a `200 OK` response code and a [cloudPcOnPrem #### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpconpremisesconnection" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections/{id} ``` +# [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 Content-Type: application/json #### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpconpremisesconnection_withDetails" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections/{id}?$select=id,displayName,healthCheckStatus,healthCheckStatusDetail,inUse ``` +# [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 | Cloudpconpremisesconnection Runhealthcheck | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpconpremisesconnection-runhealthcheck.md | Run health checks on the [cloudPcOnPremisesConnection](../resources/cloudpconpre It triggers a new health check for the [cloudPcOnPremisesConnection (../resources/cloudpconpremisesconnection.md) object and changes the healthCheckStatus and [healthCheckStatusDetail](../resources/cloudpconpremisesconnectionstatusdetail.md) properties when check finished. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "cloudPcOnPremisesConnection_runhealthcheck" } --> +<!-- { "blockType": "permissions", "name": "cloudpconpremisesconnection_runhealthcheck" } --> [!INCLUDE [permissions-table](../includes/permissions/cloudpconpremisesconnection-runhealthcheck-permissions.md)] ## HTTP request If successful, this method returns a `204 No Content` response code. ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "cloudpconpremisesconnection_runhealthcheck_2" The following example shows a request. ``` http POST https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections/{id}/runHealthChecks ```++# [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 | Cloudpconpremisesconnection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpconpremisesconnection-update.md | Update the properties of a [cloudPcOnPremisesConnection](../resources/cloudpconp [!INCLUDE [on-premise-rename-note](../../includes/on-premise-rename-note.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": "cloudPcOnPremisesConnection_update" } --> +<!-- { "blockType": "permissions", "name": "cloudpconpremisesconnection_update" } --> [!INCLUDE [permissions-table](../includes/permissions/cloudpconpremisesconnection-update-permissions.md)] ## HTTP request If successful, this method returns a `200 OK` response code and an updated [clou ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_onpremisesconnections" 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 |
v1.0 | Cloudpcprovisioningpolicy Assign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcprovisioningpolicy-assign.md | Namespace: microsoft.graph Assign a [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md) to user 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). If successful, this method returns a `204 No Content` response code. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "assign_cloudpcprovisioningpolicy", 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 | Cloudpcprovisioningpolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcprovisioningpolicy-delete.md | Namespace: microsoft.graph Delete a [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md) object. You canΓÇÖt delete a policy thatΓÇÖs in use. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete_provisioningpolicies_from_virtualendpoint" The following example shows a request. DELETE https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff ``` +# [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 | Cloudpcprovisioningpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcprovisioningpolicy-get.md | Namespace: microsoft.graph Read the properties and relationships of a [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.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). The following example shows how to get the properties of the specified provision The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpcprovisioningpolicy_1" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff ``` +# [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 get the properties of the specified provision The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpcprovisioningpolicy_2" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff?$expand=assignments ``` +# [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 a request that retrieves the selected properties of The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpcprovisioningpolicy_3" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies/60b94f83-3e22-430e-a69d-440f65b922d6?$select=id,description,displayName,domainJoinConfigurations,imageDisplayName,imageId,imageType,windowsSetting,cloudPcGroupDisplayName,gracePeriodInHours,localAdminEnabled,alternateResourceUrl ``` +# [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 | Cloudpcprovisioningpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcprovisioningpolicy-update.md | Namespace: microsoft.graph Update the properties of a [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.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). If successful, this method returns a `204 No Content` response code. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_provisioningpolicy" 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 | Cloudpcusersetting Assign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcusersetting-assign.md | Namespace: microsoft.graph Assign a [cloudPcUserSetting](../resources/cloudpcusersetting.md) to user 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). If successful, this method returns a `204 No Content` response code. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "cloudpcusersetting_assign", 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 | Cloudpcusersetting Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcusersetting-delete.md | Namespace: microsoft.graph Delete a [cloudPcUserSetting](../resources/cloudpcusersetting.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). If successful, this method returns a `204 No Content` response code. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete_cloudpcusersetting" The following example shows a request. DELETE https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/userSettings/b0c2d35f-3385-46c8-a6f5-6c3dfad7ffff ``` +# [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 | Cloudpcusersetting Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcusersetting-get.md | Namespace: microsoft.graph Read the properties and relationships of a [cloudPcUserSetting](../resources/cloudpcusersetting.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). The following example shows how to get the properties of the specified user sett The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpcusersetting" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/userSettings/556092f8-92f8-5560-f892-6055f8926055 ``` +# [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 get the properties of the specified user sett The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_cloudpcusersetting_2" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/userSettings/b0c2d35f-3385-46c8-a6f5-6c3dfad7ffff?$expand=assignments ``` +# [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 | Cloudpcusersetting Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcusersetting-update.md | Namespace: microsoft.graph Update the properties of a [cloudPcUserSetting](../resources/cloudpcusersetting.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). If successful, this method returns a `200 OK` response code and an updated [clou The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_cloudpcusersetting" 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 | Conditionalaccesspolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/conditionalaccesspolicy-update.md | PATCH /identity/conditionalAccess/policies/{id} ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. For the list of properties, see [conditionalAccessPolicy](../resources/conditionalaccesspolicy.md). Content-type: application/json "signInRiskLevels": [ "high", "medium",- "low", + "low" ] } } |
v1.0 | Conversationmember Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/conversationmember-get.md | One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account)|Not supported.| |Application| For **user** or **chat** resource: Not supported.<br/><br/>For **channel** resource: TeamMember.Read.Group, ChannelMember.Read.All, ChannelMember.ReadWrite.All | -> **Note:** The TeamMember.Read.Group permmission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamMember.Read.Group permmission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Crosstenantaccesspolicy List Partners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/crosstenantaccesspolicy-list-partners.md | Content-Type: application/json { "tenantId": "123f4846-ba00-4fd7-ba43-dac1f8f63013", "inboundTrust": null,+ "isInMultiTenantOrganization": false, "automaticUserConsentSettings": { "inboundAllowed": null, "outboundAllowed": null |
v1.0 | Crosstenantaccesspolicyconfigurationdefault Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-get.md | Content-Type: application/json } ] }+ }, + "invitationRedemptionIdentityProviderConfiguration": + { + "primaryIdentityProviderPrecedenceOrder": [ + "externalFederation", + "azureActiveDirectory", + "socialIdentityProviders" + ], + "fallbackIdentityProvider": "defaultConfiguredIdp" } } ``` |
v1.0 | Crosstenantaccesspolicyconfigurationdefault Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-update.md | If successful, this method returns a `204 No Content` response code. ## Examples -### Request +### Example 1: Block outbound B2B collaboration for a group of users +#### Request # [HTTP](#tab/http) <!-- { If successful, this method returns a `204 No Content` response code. "name": "update_crosstenantaccesspolicyconfigurationdefault" } -->- ``` http PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/default Content-Type: application/json Content-Type: application/json -### Response +#### Response ++<!-- { + "blockType": "response", + "truncated": true +} +--> ++``` http +HTTP/1.1 204 No Content +``` ++### Example 2: Update default invitation redemption configuration ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_crosstenantaccesspolicyconfigurationdefault_idpconfiguration" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/default +Content-Type: application/json ++{ + "invitationRedemptionIdentityProviderConfiguration": { + "primaryIdentityProviderPrecedenceOrder": [ + "externalFederation", + "azureActiveDirectory", + "socialIdentityProviders" + ], + "fallbackIdentityProvider": "defaultConfiguredIdp" + } +} +``` ++# [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 +``` ++### Example 3: Disallow Microsoft accounts as an option for redeeming B2B invitations ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_crosstenantaccesspolicyconfigurationdefault_idpconfiguration_noMsa" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/default +Content-Type: application/json ++{ + "invitationRedemptionIdentityProviderConfiguration": { + "primaryIdentityProviderPrecedenceOrder": [ + "externalFederation", + "azureActiveDirectory", + "socialIdentityProviders" + ], + "fallbackIdentityProvider": "emailOneTimePasscode" + } +} +``` ++# [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", |
v1.0 | Crosstenantaccesspolicyconfigurationpartner Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationpartner-get.md | Content-Type: application/json { "tenantId": "9c5d131d-b1c3-4fc4-9e3f-c6557947d551", "inboundTrust": null,+ "isInMultiTenantOrganization": false, "automaticUserConsentSettings": { "inboundAllowed": null, |
v1.0 | Customauthenticationextension Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/customauthenticationextension-delete.md | + + Title: "Delete customAuthenticationExtension" +description: "Delete a customAuthenticationExtension object." ++ms.localizationpriority: medium ++++# Delete customAuthenticationExtension +Namespace: microsoft.graph ++Delete a [customAuthenticationExtension](../resources/customauthenticationextension.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": "customauthenticationextension_delete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /identity/customAuthenticationExtensions/{customAuthenticationExtensionId} +``` ++## 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_customauthenticationextension" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/identity/customAuthenticationExtensions/5c82815a-ee61-4c9b-9f4b-914a708a0c68 +``` ++# [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 | Customauthenticationextension Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/customauthenticationextension-get.md | + + Title: "Get customAuthenticationExtension" +description: "Read the properties and relationships of a customAuthenticationExtension object." ++ms.localizationpriority: medium ++++# Get customAuthenticationExtension +Namespace: microsoft.graph ++Read the properties and relationships of a [customAuthenticationExtension](../resources/customauthenticationextension.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": "customauthenticationextension_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identity/customAuthenticationExtensions/{customAuthenticationExtensionId} +``` ++## Optional query parameters +This method supports the `$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 [customAuthenticationExtension](../resources/customauthenticationextension.md) object in the response body. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_customauthenticationextension" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/customAuthenticationExtensions/6fc5012e-7665-43d6-9708-4370863f4e6e +``` ++# [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.customAuthenticationExtension" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/customAuthenticationExtensions/$entity", + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension", + "id": "6fc5012e-7665-43d6-9708-4370863f4e6e", + "displayName": "onTokenIssuanceStartCustomExtension", + "description": "Fetch additional claims from custom user store", + "clientConfiguration": null, + "authenticationConfiguration": { + "@odata.type": "#microsoft.graph.azureAdTokenAuthentication", + "resourceId": "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4" + }, + "endpointConfiguration": { + "@odata.type": "#microsoft.graph.httpRequestEndpoint", + "targetUrl": "https://authenticationeventsAPI.contoso.com" + }, + "claimsForTokenConfiguration": [ + { + "claimIdInApiResponse": "DateOfBirth" + }, + { + "claimIdInApiResponse": "CustomRoles" + } + ] +} +``` + |
v1.0 | Customauthenticationextension Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/customauthenticationextension-update.md | + + Title: "Update customAuthenticationExtension" +description: "Update the properties of a customAuthenticationExtension object." ++ms.localizationpriority: medium ++++# Update customAuthenticationExtension +Namespace: microsoft.graph ++Update the properties of a [customAuthenticationExtension](../resources/customauthenticationextension.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": "customauthenticationextension_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /identity/customAuthenticationExtensions/{customAuthenticationExtensionId} +``` ++## 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 ++You must specify the `@odata.type` property when updating a [customAuthenticationExtension](../resources/customauthenticationextension.md) object. For example, to update an [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) object type, set the `@odata.type` property to `#microsoft.graph.onTokenIssuanceStartCustomExtension`. ++|Property|Type|Description| +|:|:|:| +|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|The authentication configuration for this custom extension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.| +|description|String|Description for the custom extension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.| +|displayName|String|Display name for the custom extension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.| +|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|Configuration for the API endpoint that the custom extension will call. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.| +++## 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_customauthenticationextension" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/identity/customAuthenticationExtensions/6fc5012e-7665-43d6-9708-4370863f4e6e +Content-Type: application/json +Content-length: 468 ++{ + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension", + "displayName": "onTokenIssuanceStartCustomExtension", + "description": "Fetch additional claims from custom user store", + "endpointConfiguration": { + "@odata.type": "#microsoft.graph.httpRequestEndpoint", + "targetUrl": "https://authenticationeventsAPI.contoso.com" + }, + "authenticationConfiguration": { + "@odata.type": "#microsoft.graph.azureAdTokenAuthentication", + "resourceId": "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4" + }, + "claimsForTokenConfiguration": [ + { + "claimIdInApiResponse": "DateOfBirth" + }, + { + "claimIdInApiResponse": "CustomRoles" + } + ] +} +``` ++# [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 | Customauthenticationextension Validateauthenticationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/customauthenticationextension-validateauthenticationconfiguration.md | + + Title: "customAuthenticationExtension: validateAuthenticationConfiguration" +description: "An API to check validity of the endpoint and authentication configuration for a customAuthenticationExtension." ++ms.localizationpriority: medium ++++# customAuthenticationExtension: validateAuthenticationConfiguration +Namespace: microsoft.graph ++An API to check validity of the endpoint and and authentication configuration for a customAuthenticationExtension. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "customauthenticationextension_validateauthenticationconfiguration" } --> ++## HTTP request ++To validate the endpoint and authentication configuration for a customAuthenticationExtension by its ID. +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /identity/customAuthenticationExtensions/{customAuthenticationExtensionId}/validateAuthenticationConfiguration +``` ++To validate the endpoint and authentication configuration that's specified in the request body for a customAuthenticationExtension. The custom authentication extension object may not exist yet and you can use this endpoint to validate the configuration before creating the custom authentication extension. +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /identity/customAuthenticationExtensions/validateAuthenticationConfiguration +``` ++## 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. Supply a endpointConfiguration and authenticationConfiguration if querying at the root level. Otherwise, for a specific custom extension, do not supply a request body for this method. ++|Parameter|Type|Description| +|:|:|:| +|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The HTTP endpoint for the custom authentication extension to be validated.| +|authenticationConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The authentication configuration for the custom authenticaion extension to validate.| ++## Response ++If successful, this action returns a `200 OK` response code and a [authenticationConfigurationValidation](../resources/authenticationconfigurationvalidation.md) in the response body. ++## Examples ++### Example 1: Supply and validate a potential custom authentication extension configuration ++#### Request +The following example shows a request. +<!-- { + "blockType": "request", + "name": "customauthenticationextensionthis.validateauthenticationconfiguration" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/customAuthenticationExtensions/validateAuthenticationConfiguration +Content-Type: application/json ++{ + "endpointConfiguration": { + "@odata.type": "#microsoft.graph.httpRequestEndpoint", + "targetUrl": "https://australia.contoso.com/users" + }, + "authenticationConfiguration": { + "@odata.type": "#microsoft.graph.azureAdTokenAuthentication", + "resourceId": "api://extensibilityapi.azurwebsites.net/f9c5dc6b-d72b-4226-8ccd-801f7a290428" + } +} +``` +++#### 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.authenticationConfigurationValidation" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.authenticationConfigurationValidation", + "errors": [ + { + "code": "IncorrectResourceIdFormat", + "message": "ResourceId should be in the format of 'api://{fully qualified domain name}/{appid}'" + }, + { + "code": "DomainNameDoesNotMatch", + "message": "The fully qualified domain name in resourceId should match that of the targetUrl" + }, + { + "code": "ServicePrincipalNotFound", + "message": "The appId of the resourceId should correspond to a real service principal in the tenant" + } + ], + "warnings": [ + { + "code": "PermissionNotGrantedToServicePrincipal", + "message": "The permission CustomAuthenticationExtensions.Receive.Payload is not granted to the service principal of the resource app" + }, + ] +} +``` +++### Example 2: Validate the configuration of a specific existing custom authentication extension ++#### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "customauthenticationextensionthis.validateauthenticationconfiguration_byId" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/identity/customAuthenticationExtensions/9f39f3bb-457c-4a2a-8099-0e480e7ea142/validateAuthenticationConfiguration +``` ++# [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.authenticationConfigurationValidation" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.authenticationConfigurationValidation", + "errors": [ + { + "code": "IncorrectResourceIdFormat", + "message": "ResourceId should be in the format of 'api://{fully qualified domain name}/{appid}'" + }, + { + "code": "DomainNameDoesNotMatch", + "message": "The fully qualified domain name in resourceId should match that of the targetUrl" + }, + { + "code": "ServicePrincipalNotFound", + "message": "The appId of the resourceId should correspond to a real service principal in the tenant" + } + ], + "warnings": [ + { + "code": "PermissionNotGrantedToServicePrincipal", + "message": "The permission CustomAuthenticationExtensions.Receive.Payload is not granted to the service principal of the resource app" + }, + ] +} +``` ++ |
v1.0 | Delegatedadminrelationship Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/delegatedadminrelationship-update.md | doc_type: apiPageType # Update delegatedAdminRelationship Namespace: microsoft.graph -Update the properties of a [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object. You can only update a relationship when it's in the `created` **status**. However, you can update the **autoExtendDuration** property when the relationship is in either the `created` or `active` **status**. +Update the properties of a [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object. ++The following restrictions apply: +- You can update this relationship when its **status** property is `created`. +- You can update the **autoExtendDuration** property when **status** is either `created` or `active`. +- You can only remove the Microsoft Entra Global Administrator role when the **status** property is `active`, which indicates a long-running operation. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] PATCH /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationsh ## Response -If successful, this method returns a `200 OK` response code and an updated [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object in the response body. +If successful, this method returns either a `200 OK` or a `202 Accepted` response code. The response body contains a + [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object when the response is `200 OK`. ++### Response headers +|Name|Description| +|:|:| +|Content-Type|application/json.| +|Location|The location of the long-running operation.| +|Retry-After|The time after which a subsequent API call can be made to the Location URL to check the status of the long-running operation.| ++This method returns a `202 Accepted` response if you remove the Microsoft Entra Global Administrator role from the relationship while its **status** property is `active`. The response includes a URL in the Location header that you can use to monitor the operation's progress. ++If you don't supply the template ID that corresponds to the Microsoft Entra Global Administrator role in the `unifiedRoles` array in the `accessDetails` property of the request body, then the API returns `200 OK` and the original [delegatedAdminRelationship](../resources/delegatedAdminRelationship.md) object in the response body. ## Examples ### Request+The following example shows the request. # [HTTP](#tab/http) <!-- { Content-Type: application/json ### Response+The following example shows the request. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json } ``` +The following is an example response that returns a `202 Accepted` response code along with **Location** and **Retry-After** headers. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.delegatedAdminRelationship" +} +--> ++``` http +HTTP/1.1 202 Accepted +Location: https://graph.microsoft.com/v1.0/tenantRelationships/delegatedAdminRelationships/5e5594d3-6f82-458b-b567-77db4811f0cd-00000000-0000-0000-0000-000000001234/operations/d8dbb27b-7fe7-4523-a3df-f766355fe0f2 +Retry-After: 10 +Content-Type: application/json ++{ +} +``` + |
v1.0 | Deletedchat Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/deletedchat-get.md | Namespace: microsoft.graph Read the properties and relationships of a [deletedChat](../resources/deletedchat.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). GET https://graph.microsoft.com/v1.0/teamwork/deletedChats/19:64dedcac16b74a209b [!INCLUDE [sample-code](../includes/snippets/php/get-deletedchat-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-deletedchat-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Deletedchat Undodelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/deletedchat-undodelete.md | Restore a [deletedChat](../resources/deletedchat.md) to an active [chat](../res >**Note:** This operation is not supported for non-admin users. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). POST https://graph.microsoft.com/v1.0/teamwork/deletedChats/19:64dedcac16b74a209 [!INCLUDE [sample-code](../includes/snippets/php/deletedchatundodelete-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/deletedchatundodelete-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
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): *Global Administrator*, *Intune Administrator*, *Windows 365 Administrator*, or *Cloud Device Administrator*. +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*. ## HTTP request |
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): *Global Administrator*, *Intune Administrator*, or *Windows 365 Administrator*. +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 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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Global Administrator*, *Intune Administrator*. A calling user in the *Cloud Device Administrator* role can only enable or disable devices using this API and a user with the *Windows 365 Administrator* role can only update basic device properties. +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. ## HTTP request In the request body, supply the values for the [device](../resources/device.md) | Property | Type |Description| |:|:--|:-|-|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Only callers in *Global Administrator* and *Cloud Device Administrator* roles can update this property.| +|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Only callers with at least the *Cloud Device Administrator* role can update this property.| |operatingSystem|String|The type of operating system on the device.| |operatingSystemVersion|String|The version of the operating system on the device| |displayName|String|The display name for the device.| |
v1.0 | Directory Deleteditems List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directory-deleteditems-list.md | ConsistencyLevel: eventual This example requires the **ConsistencyLevel** header because the `$orderby` and `$count` query parameters are used in the query. -### Examples using the $orderby OData query parameter +### $orderby OData query parameter examples -The `$orderby` OData query parameter is supported on the **deletedDateTime**, **displayName**, and **userPrincipalName** properties of the deleted object types. On the **deletedDateTime** property, the query requires adding the [advanced query parameters](/graph/aad-advanced-queries) (**ConsistencyLevel** header set to `true` and `$count=true` query string). +The `$orderby` OData query parameter is supported on the **deletedDateTime**, **displayName**, and **userPrincipalName** properties of the deleted object types. On the **deletedDateTime** property, the query requires adding the [advanced query parameters](/graph/aad-advanced-queries) (**ConsistencyLevel** header set to `eventual` and `$count=true` query string). | OData cast | Properties supporting $orderby | Example | | : | : | : | |
v1.0 | Directory Post Administrativeunits | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directory-post-administrativeunits.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)] -To create an administrative unit, the calling principal must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Privileged Role Administrator -* Global Administrator +To create 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 | Directory Post Attributesets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directory-post-attributesets.md | The following table shows the properties that you can configure when you create |Property|Type|Description| |:|:|:| |description|String|Description of the attribute set. Can be up to 128 characters long and include Unicode characters. Can be changed later. Optional.|-|id|String|Identifier for the attribute set that is unique within a tenant. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case insensitive. Required.| +|id|String|Identifier for the attribute set that is unique within a tenant. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case sensitive. Required.| |maxAttributesPerSet|Int32|Maximum number of custom security attributes that can be defined in this attribute set. Default value is `null`. If not specified, the administrator can add up to the maximum of 500 active attributes per tenant. Can be changed later. Optional.| ## Response |
v1.0 | Directory Post Customsecurityattributedefinitions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directory-post-customsecurityattributedefinitions.md | The following table shows the properties that you can configure when you create |Property|Type|Description| |:|:|:|-|attributeSet|String|Name of the attribute set. Case insensitive. Required.| +|attributeSet|String|Name of the attribute set. Case sensitive. Required.| |description|String|Description of the custom security attribute. Can be up to 128 characters long and include Unicode characters. Cannot contain spaces or special characters. Can be changed later. Optional.| |isCollection|Boolean|Indicates whether multiple values can be assigned to the custom security attribute. Cannot be changed later. If **type** is set to `Boolean`, **isCollection** cannot be set to `true`. Required.| |isSearchable|Boolean|Indicates whether custom security attribute values are indexed for searching on objects that are assigned attribute values. Cannot be changed later. Required.|-|name|String|Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case insensitive. Required.| +|name|String|Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case sensitive. Required.| |status|String|Specifies whether the custom security attribute is active or deactivated. Acceptable values are `Available` and `Deprecated`. Can be changed later. Required.| |type|String|Data type for the custom security attribute values. Supported types are: `Boolean`, `Integer`, and `String`. Cannot be changed later. Required.| |usePreDefinedValuesOnly|Boolean|Indicates whether only predefined values can be assigned to the custom security attribute. If set to `false`, free-form values are allowed. Can later be changed from `true` to `false`, but cannot be changed from `false` to `true`. If **type** is set to `Boolean`, **usePreDefinedValuesOnly** cannot be set to `true`. Required.| |
v1.0 | Directoryobject Checkmemberobjects | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directoryobject-checkmemberobjects.md | description: "Check for membership in a list of groups, administrative units, or ms.localizationpriority: medium + doc_type: "apiPageType" |
v1.0 | Domain Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-delete.md | Title: "Delete domain" -description: "Deletes a domain from a tenant." -+description: "Delete a domain from a tenant." + ms.localizationpriority: medium doc_type: apiPageType doc_type: apiPageType Namespace: microsoft.graph -Deletes a domain from a tenant. +Delete a domain from a tenant. > **Important:** > - Deleted domains are not recoverable.<br /> 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 one of the following roles: --* Global Administrator -* Domain Name Administrator +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 | Title: "Force domain deletion" -description: "Deletes a domain using an asynchronous long-running operation." -+ Title: "domain: forceDelete" +description: "Delete a domain using an asynchronous long-running operation." + ms.localizationpriority: medium doc_type: apiPageType -# Force domain deletion +# domain: forceDelete Namespace: microsoft.graph -Deletes a domain using an asynchronous long-running operation. +Delete a domain using an asynchronous long-running operation. -Prior to calling [forceDelete](domain-forcedelete.md), you must update or remove any references to **Exchange** as the provisioning service. +Before performing this operation, you must update or remove any references to **Exchange** as the provisioning service. The following actions are performed as part of this operation: The following actions are performed as part of this operation: * If one of the `applications` to be renamed is a multitenant app, an error is returned. -After the domain deletion completes, API operations for the deleted domain will return an HTTP 404 status code. To verify deletion of a domain, you can perform a [get domain](domain-get.md) operation. +After the domain deletion completes, API operations for the deleted domain return an HTTP 404 status code. To verify deletion of a domain, you can perform a [get domain](domain-get.md) operation. [!INCLUDE [national-cloud-support](../../includes/all-clouds.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 one of the following roles: --* Global Administrator -* Domain Name Administrator +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 In the request body, provide a JSON object with the following parameters. | Parameter | Type | Description | |:|:--|:-|-|`disableUserAccounts`|`Boolean`| Option to disable user accounts that are renamed. If a user account is disabled, the user won't be allowed to sign in. If set to **true** the `users` updated as part of this operation will be disabled. Default value is **true**. | +|`disableUserAccounts`|`Boolean`| Option to disable user accounts that are renamed. If a user account is disabled, the user isn't allowed to sign in. If set to `true` the users updated as part of this operation are disabled. Default value is `true`. | ## Response body |
v1.0 | Domain Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-get.md | Title: "Get domain" description: "Retrieve the properties and relationships of domain object."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: +The work or school account needs to belong to atleast one of the following Microsoft Entra roles: -* Global Administrator * User Administrator * Helpdesk Administrator * Service Support Administrator |
v1.0 | Domain List Domainnamereferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-list-domainnamereferences.md | Title: "List domainNameReferences" description: "Retrieve a list of directoryObject with a reference to the domain."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: --* Global Administrator -* Domain Name Administrator -* Global Reader +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)] |
v1.0 | Domain List Serviceconfigurationrecords | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-list-serviceconfigurationrecords.md | Title: "List serviceConfigurationRecords" description: "Retrieves a list of domainDnsRecord objects needed to enable services for the domain."-+ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Domain List Verificationdnsrecords | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-list-verificationdnsrecords.md | Title: "List verificationDnsRecords" description: "Retrieve a list of domainDnsRecord objects."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: --* Global Administrator -* Domain Name Administrator -* Global Reader +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). ## 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 | Title: "List domains" description: "Retrieve a list of domain objects."-+ ms.localizationpriority: medium doc_type: apiPageType 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 roles: +The work or school account needs to belong to one of the following Microsoft Entra roles: -* Global Administrator * User Administrator * Helpdesk Administrator * Service Support Administrator |
v1.0 | Domain Post Domains | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-post-domains.md | Title: "Create domain" description: "Adds a domain to the tenant."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: --* Global Administrator -* Domain Name Administrator +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 | Title: "Create internalDomainFederation" description: "Create a new internalDomainFederation object." ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_post_federationconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-post-federationconfiguration-permissions.md)] +> [!IMPORTANT] +> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios. + [!INCLUDE [rbac-domainfederation-apis-write](../includes/rbac-for-apis/rbac-domainfederation-apis-write.md)] ## HTTP request You can specify the following properties when creating an **internalDomainFedera |displayName|String|The display name of the federated identity provider.| |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 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.| +|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`.| |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`.|-|isSignedAuthenticationRequestRequired|Boolean|If true, when SAML authentication requests are sent to the federated SAML IDP, Microsoft Entra ID will sign those requests using the OrgID signing key. If false (default), the SAML authentication requests sent to the federated IDP are not signed.| -|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens 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 is not present in the federation properties after the federation service certificate has been updated.| +|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.| |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).| + ### federatedIdpMfaBehavior values | Member | Description | Content-Type: application/json "federatedIdpMfaBehavior": "rejectMfaByFederatedIdp" } ```++<!-- +{ + "type": "#page.annotation", + "description": "", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: /api/domain-post-federationconfiguration.md: + Exception processing links. + Link Definition was null. Link text: !INCLUDE Azure AD PowerShell deprecation note (Parameter 'Definition')" + ] +} +--> |
v1.0 | Domain Promote | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-promote.md | Title: "domain: promote" description: "Promote a verified subdomain to the root domain."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: --* Global Administrator -* Domain Name Administrator +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 | Title: "Update domain" description: "Update the properties of domain object."-+ ms.localizationpriority: medium doc_type: apiPageType doc_type: apiPageType Namespace: microsoft.graph -Update the properties of domain object. --> **Important:** -> Only verified domains can be updated. +Update the properties of [domain](../resources/domain.md) object. Only verified domains can be updated. [!INCLUDE [national-cloud-support](../../includes/all-clouds.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 one of the following roles: +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): -* Global Administrator * Domain Name Administrator * Security Administrator * External Identity Provider Administrator |
v1.0 | Domain Verify | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-verify.md | Title: "domain: verify" description: "Validates the ownership of the domain."-+ ms.localizationpriority: medium doc_type: apiPageType 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 one of the following roles: --* Global Administrator -* Domain Name Administrator +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 Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/driveitem-delta.md | This method supports the `$select`, `$expand`, and `$top` [OData query parameter |Name|Description| |:|:| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|+|deltaExcludeParent| String. If this request header is included, the response includes the items that have changed, and not the parent items in the hierarchy.| ## Request body |
v1.0 | Driveitem Get Content Format | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/driveitem-get-content-format.md | The following values are valid for the **format** parameter: | Format value | Description | Supported source extensions |:-|:--|- | pdf | Converts the item into PDF format. | csv, doc, docx, odp, ods, odt, pot, potm, potx, pps, ppsx, ppsxm, ppt, pptm, pptx, rtf, xls, xlsx+| html | Converts the item into HTML format.| loop, fluid, wbtx ## Request headers |
v1.0 | Educationassignment Activate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationassignment-activate.md | Namespace: microsoft.graph Activate an `inactive` [educationAssignment](../resources/educationassignment.md) to signal that the assignment has further action items for teachers or students. This action can only be performed by a teacher on currently inactive assignments. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 an [educationAss ### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "sampleKeys": ["37d99af7-cfc5-4e3b-8566-f7d40e4a2070", "c0f133b9-615c-4119-876c-c1848fd0a99a"], The following example shows a request. POST https://graph.microsoft.com/v1.0/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/assignments/c0f133b9-615c-4119-876c-c1848fd0a99a/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 | Educationassignment Deactivate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationassignment-deactivate.md | Namespace: microsoft.graph Mark an `assigned` [educationAssignment](../resources/educationassignment.md) as `inactive` to signal that the assignment has no further action items for teachers and students. This action can only be performed by a teacher on assigned assignments. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 example shows how to mark an assignment `inactive` without the opt #### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "sampleKeys": ["37d99af7-cfc5-4e3b-8566-f7d40e4a2070", "c0f133b9-615c-4119-876c-c1848fd0a99a"], The following example shows a request. POST https://graph.microsoft.com/v1.0/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/assignments/c0f133b9-615c-4119-876c-c1848fd0a99a/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 when `Prefer: include-unknown-enum-members` isn't provided in the request header. The following example shows how to mark an assignment `inactive` using the optio #### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "sampleKeys": ["37d99af7-cfc5-4e3b-8566-f7d40e4a2070", "2cb9ce0c-a4a1-40b8-b386-b43e0f05e7ed"], POST https://graph.microsoft.com/v1.0/education/classes/37d99af7-cfc5-4e3b-8566- Prefer: include-unknown-enum-members ``` +# [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 when `Prefer: include-unknown-enum-members` is provided in the request header. |
v1.0 | Educationassignment Post Resource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationassignment-post-resource.md | Content-type: application/json ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) * [Upload files for education assignments and submissions](/graph/education-upload-resource-overview) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Educationassignment Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationassignment-publish.md | Title: "educationAssignment: publish" -description: "Change the state of an educationAssignment from its original draft status to the published status." +description: "Change the status of an educationAssignment from its original draft status to the published status." ms.localizationpriority: medium Namespace: microsoft.graph Publish an education assignment. -Change the state of an [educationAssignment](../resources/educationassignment.md) from its original `draft` status to the `published` status. +Change the status of an [educationAssignment](../resources/educationassignment.md) from its original `draft` status to the `published` status. -You can change the state from `draft` to `scheduled` if the **assignment** is scheduled for a future date. +You can change the status from `draft` to `scheduled` if the **assignment** is scheduled for a future date. Only a teacher in the class can make this call. When an assignment is in draft status, students will not see the assignment, nor will there be any submission objects. Calling this API creates [educationSubmission](../resources/educationsubmission.md) objects and displays the assignment in each student's list. -The state of the assignment goes back to `draft` if there is any backend failure during publish process. +The status of the assignment goes back to `draft` if there is any backend failure during publish process. To update the properties of a published **assignment**, see [update an assignment](../api/educationassignment-update.md). HTTP/1.1 200 Ok ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationassignment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationassignment-update.md | Existing properties that aren't included in the request body maintains their pre |addToCalendarAction|educationAddToCalendarOptions|Optional field to control the **assignment** behavior for adding **assignments** to students' and teachers' calendars when the **assignment** is published. The possible values are: `none`, `studentsAndPublisher`, `studentsAndTeamOwners`, `unknownFutureValue`, `studentsOnly`. 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): `studentsOnly`. Optional.| |allowLateSubmissions|Boolean| Whether students can send submission after the due date.| |allowStudentsToAddResourcesToSubmission|Boolean| Whether a student can add resources to a submission or not. Also, indicates whether all resources in the submission correspond to the assignment resource list. |-|assignDateTime|DateTimeOffset| Indicates the date to publish the assignment to students. Can't be edited after the assignment has been published.| +|assignDateTime|DateTimeOffset| Indicates the date to publish the assignment to students. Can't be edited when the assignment is published.| |assignTo|[educationAssignmentRecipient](../resources/educationassignmentrecipient.md)| Students who get the assignment.| |closeDateTime|DateTimeOffset| Date when the assignment is closed for submissions. This is an optional field that can be null if the assignment doesn't allowLateSubmissions or the closeDateTime is the same as the dueDateTime but if specified, it must be greater than or equal to the dueDateTime.| |displayName|String| Name of assignment. | Content-type: application/json ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) * [Specify the default channel for education assignment notifications](/graph/education-build-notificationchannelurl) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Educationclass Delete Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationclass-delete-members.md | The following example shows a request. "name": "create_educationclass_from_educationschool_1" }--> ```http-DELETE https://graph.microsoft.com/v1.0/education/classes/{class-id}/members/{member-id} +DELETE https://graph.microsoft.com/v1.0/education/classes/{class-id}/members/{member-id}/$ref ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/create-educationclass-from-educationschool-1-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 | Educationclass List Modules | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationclass-list-modules.md | A teacher or an application with application permissions can see all module obje Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_list_modules" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationclass-list-modules-permissions.md)] ## HTTP request |
v1.0 | Educationclass Post Assignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationclass-post-assignment.md | Namespace: microsoft.graph Create a new assignment. -Only teachers in a class can create an assignment. Assignments start in the Draft state, which means that students will not see the assignment until publication. +Only teachers in a class can create an assignment. Assignments start in draft status, which means that students can't see the assignment until it's published. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] Content-type: application/json ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationclass Post Module | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationclass-post-module.md | Only teachers in a class can create a module. Modules start in the `draft` state Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_post_module" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationclass-post-module-permissions.md)] ## HTTP request |
v1.0 | Educationmodule Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmodule-delete.md | Delete an existing [module](../resources/educationmodule.md) in a [class](../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": "educationmodule_delete" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmodule-delete-permissions.md)] ## HTTP request |
v1.0 | Educationmodule Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmodule-get.md | Students can only see published modules; teachers and applications with applicat Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationmodule_get" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmodule-get-permissions.md)] ## HTTP request |
v1.0 | Educationmodule List Resources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmodule-list-resources.md | Get all the [educationModuleResource](../resources/educationmoduleresource.md) o Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationmodule_list_resources" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmodule-list-resources-permissions.md)] ## HTTP request |
v1.0 | Educationmodule Pin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmodule-pin.md | Only teachers can perform this action and only one module at a time can be pinne Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationmodule_pin" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmodule-pin-permissions.md)] ## HTTP request |
v1.0 | Educationmodule Post Resources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmodule-post-resources.md | Every resource has an **@odata.type** property to indicate which type of resourc Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationmodule_post_resources" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmodule-post-resources-permissions.md)] ## HTTP request |
v1.0 | Educationmodule Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmodule-publish.md | Only teachers in the class can perform this operation. When a module is in draft Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationmodule_publish" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmodule-publish-permissions.md)] ## HTTP request |
v1.0 | Educationmodule Setupresourcesfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmodule-setupresourcesfolder.md | The teacher determines what resources to upload to the SharePoint folder for the Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationmodule_setupresourcesfolder" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmodule-setupresourcesfolder-permissions.md)] ## HTTP request |
v1.0 | Educationmodule Unpin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmodule-unpin.md | Only teachers in the class can perform this operation. Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationmodule_unpin" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmodule-unpin-permissions.md)] ## HTTP request |
v1.0 | Educationmodule Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmodule-update.md | Only teachers in the class can perform this operation. You can't use a PATCH req Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationmodule_update" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmodule-update-permissions.md)] ## HTTP request |
v1.0 | Educationmoduleresource Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmoduleresource-delete.md | Delete a specific [educationModuleResource](../resources/educationmoduleresource Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationmoduleresource_delete" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmoduleresource-delete-permissions.md)] ## HTTP request |
v1.0 | Educationmoduleresource Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmoduleresource-get.md | Get the properties of a [resource](../resources/educationmoduleresource.md) asso Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationmoduleresource_get" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmoduleresource-get-permissions.md)] ## HTTP request |
v1.0 | Educationmoduleresource Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationmoduleresource-update.md | The only one property that can be updated is **displayName**, for all resource 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). <!-- { "blockType": "permissions", "name": "educationmoduleresource_update" } -->- [!INCLUDE [permissions-table](../includes/permissions/educationmoduleresource-update-permissions.md)] ## HTTP request |
v1.0 | Educationsubmission Excuse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationsubmission-excuse.md | + + Title: "educationSubmission: excuse" +description: "Excuse an educationSubmission object." ++ms.localizationpriority: medium ++++# educationSubmission: excuse ++Namespace: microsoft.graph ++Excuse a [submission](../resources/educationsubmission.md). Excused submissions aren't included in average grade calculations. Grading rubrics and feedback are deleted. Only teachers can perform this action. ++If the `Prefer: include-unknown-enum-members` request header is provided, the excused submission shows the **excused** status. Otherwise, the submission status retains the **returned** status. For more information about how to use this header, see the [Examples](#examples) section. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "educationsubmission_excuse" } --> ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +POST /education/classes/{classId}/assignments/{assignmentId}/submissions/{submissionId}/excuse +``` ++## Request headers +| Header | Value | +|:|:--| +| Authorization | Bearer {token}. Required. | +| Prefer | `include-unknown-enum-members`. Optional. | ++## Request body +Don't supply a request body for this method. ++## Response +If successful, this method returns a `200 OK` response code and an [educationSubmission](../resources/educationsubmission.md) object in the response body. ++## Examples ++### Example 1: Request with optional Prefer header ++#### Request +The following example shows a request that uses the `Prefer: include-unknown-enum-members` header to retain the excused status. ++<!-- { + "blockType": "request", + "name": "educationsubmission_excuse" +}--> ++```http +POST https://graph.microsoft.com/v1.0/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/assignments/28992cce-fac0-4950-a836-5a524ded8599/submissions/02859156-c3c7-876d-7a5c-915bf4f61380/excuse +Prefer: include-unknown-enum-members +``` ++#### Response +The following example shows the response when the `Prefer: include-unknown-enum-members` header is provided in the request. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.educationSubmission" +} --> ++```http +HTTP/1.1 200 Ok ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.educationSubmission", + "status": "excused", + "submittedDateTime": "2023-07-19T15:17:37.9961504Z", + "unsubmittedDateTime": null, + "returnedDateTime": "2023-07-19T15:17:08.7988272Z", + "reassignedDateTime": null, + "excusedDateTime": "2024-04-25T11:50:36.7972162Z", + "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%2228992cce-fac0-4950-a836-5a524ded8599%5C%22%5D,%5C%22submissionId%5C%22%3A%5C%2202859156-c3c7-876d-7a5c-915bf4f61380%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": "02859156-c3c7-876d-7a5c-915bf4f61380", + "recipient": { + "@odata.type": "#microsoft.graph.educationSubmissionIndividualRecipient", + "userId": "61243ddb-6f39-499d-b232-9fa8cef26b3a" + }, + "submittedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + }, + "unsubmittedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "returnedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + }, + "reassignedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "excusedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + } +} +``` ++### Example 2: Request without the Prefer request header ++#### Request +The following example shows a request. ++<!-- { + "blockType": "request", + "name": "educationsubmission_excuse_header" +}--> ++```html +POST https://graph.microsoft.com/v1.0/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/assignments/28992cce-fac0-4950-a836-5a524ded8599/submissions/02859156-c3c7-876d-7a5c-915bf4f61380/excuse +``` ++#### Response +The following example shows the response when the `Prefer: include-unknown-enum-members` header isn't included in the request, and the submission hasn't been excused before. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.educationSubmission" +} --> ++```http +HTTP/1.1 200 Ok ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.educationSubmission", + "status": "returned", + "submittedDateTime": "2023-07-19T15:17:37.9961504Z", + "unsubmittedDateTime": null, + "returnedDateTime": "2024-04-19T12:52:57.4362614Z", + "reassignedDateTime": null, + "excusedDateTime": "2024-04-19T12:52:57.4362614Z", + "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%2228992cce-fac0-4950-a836-5a524ded8599%5C%22%5D,%5C%22submissionId%5C%22%3A%5C%2202859156-c3c7-876d-7a5c-915bf4f61380%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": "02859156-c3c7-876d-7a5c-915bf4f61380", + "recipient": { + "@odata.type": "#microsoft.graph.educationSubmissionIndividualRecipient", + "userId": "61243ddb-6f39-499d-b232-9fa8cef26b3a" + }, + "submittedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + }, + "unsubmittedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "returnedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + }, + "reassignedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "excusedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + } +} +``` +## See also ++* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "educationSubmission: excuse", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + ] +} +--> |
v1.0 | Educationsubmission Post Resources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationsubmission-post-resources.md | Content-type: application/json ## Related content -* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition) +* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition) * [Upload files for education assignments and submissions](/graph/education-upload-resource-overview) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Educationsubmission Reassign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationsubmission-reassign.md | HTTP/1.1 200 OK ## Related content -[States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition). +[Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition). <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationsubmission Return | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationsubmission-return.md | HTTP/1.1 200 OK ## Related content -[States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition). +[Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition). <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationsubmission Submit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationsubmission-submit.md | HTTP/1.1 200 OK ## Related content -[States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition). +[Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition). <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationsubmission Unsubmit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationsubmission-unsubmit.md | HTTP/1.1 200 OK ## Related content -[States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition). +[Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition). <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Entitlementmanagement Post Assignmentrequests | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/entitlementmanagement-post-assignmentrequests.md | 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. - [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions If this is an `adminAdd` request, then subsequently an [accessPackageAssignment] ## Examples ### Example 1: Admin requests a direct assignment for a user already in the directory-#### Request --The following example shows a request for a direct assignment, in which the administrator is requesting the creation of an assignment for the user. Because the [accessPackageSubject](../resources/accesspackagesubject.md) might not yet exist, the value of the **targetID** is the object ID of the user being assigned, the value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package. +#### Request +The following example shows a request for a direct assignment, in which the administrator requests the creation of an assignment for a user. Because the [accessPackageSubject](../resources/accesspackagesubject.md) might not yet exist, the value of the **targetID** is the object ID of the user being assigned, the value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package. # [HTTP](#tab/http) <!-- { HTTP/1.1 201 Created Content-type: application/json {-- "id": "7e382d02-4454-436b-b700-59c7dd77f466", + "id": "46184453-e63b-4f20-86c2-c557ed5d5df9", "requestType": "adminAdd", "requestState": "Submitted", "requestStatus": "Accepted" Content-type: application/json ### Example 2: Remove an assignment -To remove assignments, create a new accessPackageAssignmentRequest object with the following settings: +To remove assignments, create a new **accessPackageAssignmentRequest** object with the following settings: -+ The value of the **requestType** property set to `adminRemove`. -+ In the assignment property, include an object with the identifier of the accessPackageAssignment object to delete. +* The value of the **requestType** property set to `adminRemove`. +* In the **assignment** property, include an object with the identifier of the **accessPackageAssignment** object to delete. #### Request The following example shows how to remove an assignment. - # [HTTP](#tab/http) <!-- { "blockType": "request", Content-type: application/json The following example shows the response. -> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. <!-- { "blockType": "response", Content-type: application/json { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#accessPackageAssignmentRequests/$entity",- "id": "78eaee8c-e6cf-48c9-8f99-aae44c35e379", "requestType": "adminRemove", "requestState": "Submitted", Content-type: application/json } ``` -### Example 3: Request an assignment +### Example 3: Request an assignment by providing answers to questions -The following example shows how a user can request an access package assignment for themselves. +The following example shows how a user can request an access package assignment for themselves by answering questions required by the policy during the request process. #### Request +The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_packageID" + "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_approver" }-->+ ```http POST https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/assignmentRequests Content-type: application/json {+ "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest", "requestType": "userAdd",+ "answers": [ + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "displayValue": "This is the answer to a multiple choice question", + "value": "MultipleChoiceAnswerValue", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion", + "id": "8fe745e7-80b2-490d-bd22-4e708c77288c" + } + }, + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "This is my answer to a text input question.", + "displayValue": "This is my answer.", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", + "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6" + } + } + ], "assignment": {- "accessPackageId": "d7be3253-b9c6-4fab-adef-30d30de8da2b" + "accessPackageId": "977c7ff4-ef8f-4910-9d31-49048ddf3120" } } ``` # [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 the response. -> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. <!-- { "blockType": "response", HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/entitlementManagement/assignmentRequests/$entity", - "id": "724bc62d-90ff-48f3-903f-b59ec8453343", + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#accessPackageAssignmentRequests/$entity", + "id": "7a6ab703-0780-4b37-8445-81f679b2d75c", "requestType": "userAdd",- "state": "submitted" + "state": "submitted", + "status": "Accepted", + "createdDateTime": null, + "completedDateTime": null, + "schedule": { + "startDateTime": null, + "recurrence": null, + "expiration": { + "endDateTime": null, + "duration": null, + "type": "notSpecified" + } + }, + "answers": [ + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "MultipleChoiceAnswerValue", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion", + "id": "8fe745e7-80b2-490d-bd22-4e708c77288c" + }, + "displayValue": "This is the answer to a multiple choice question" + }, + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "This is my answer to a text input question.", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", + "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6" + }, + "displayValue": "This is my answer." + } + ] } ``` +### Example 4: Request a package and provide a justification -### Example 4: Request an assignment by providing answers to questions --The following example shows how a user can request an access package assignment for themselves by answering questions required by the policy while making the request. +The following example shows how to request an access package and provide justification to the approver. #### Request +The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_to_approver" + "name": "create_assignmentrequests_from_assignmentrequests_justification_provided" }--> ```http POST https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/a Content-type: application/json {- "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest", - "requestType": "userAdd", - "answers": [ - { - "@odata.type": "#microsoft.graph.accessPackageAnswerString", - "displayValue": "This is the answer to a multiple choice question", - "value": "MultipleChoiceAnswerValue", - "answeredQuestion": { - "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion", - "id": "8fe745e7-80b2-490d-bd22-4e708c77288c" - } - }, - { - "@odata.type": "#microsoft.graph.accessPackageAnswerString", - "value": "This is my answer to a text input question.", - "displayValue": "This is my answer.", - "answeredQuestion": { - "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", - "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6" - } - } - ], - "assignment": { - "accessPackageId": "977c7ff4-ef8f-4910-9d31-49048ddf3120" - } + "requestType": "UserAdd", + "accessPackageAssignment": { + "accessPackageId": "a914b616-e04e-476b-aa37-91038f0b165b" + }, + "justification":"Need access to New Hire access package" } ``` # [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 the response. -> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. <!-- { "blockType": "response", HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#accessPackageAssignmentRequests/$entity", - "id": "7a6ab703-0780-4b37-8445-81f679b2d75c", - "requestType": "userAdd", - "state": "submitted", - "status": "Accepted", + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/entitlementManagement/assignmentRequests/$entity", + "id": "9c1e258d-7723-43b1-ae21-e6eeeb324fe5", + "requestType": "UserAdd", + "requestState": "Submitted", + "requestStatus": "Accepted", "createdDateTime": null,- "completedDateTime": null, + "completedDate": null, + "justification": "Need access to New Hire access package", + "isValidationOnly": false, "schedule": { "startDateTime": null, "recurrence": null, Content-type: application/json "type": "notSpecified" } },- "answers": [ - { - "@odata.type": "#microsoft.graph.accessPackageAnswerString", - "value": "MultipleChoiceAnswerValue", - "answeredQuestion": { - "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion", - "id": "8fe745e7-80b2-490d-bd22-4e708c77288c" - }, - "displayValue": "This is the answer to a multiple choice question" - }, - { - "@odata.type": "#microsoft.graph.accessPackageAnswerString", - "value": "This is my answer to a text input question.", - "answeredQuestion": { - "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", - "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6" - }, - "displayValue": "This is my answer." - } - ] + "answers": [], + "verifiedCredentialsData": [] } ``` +### Example 5: Admin requests a direct assignment for a user not yet in the directory -### Example 5: Request an update to answers for an assignment +#### Request ++The following example shows a request for a direct assignment, in which the administrator requests the creation of an assignment for a user who doesn't exist in the directory. The value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package. -The following example shows how an admin can request updates to an assignment to edit their responses to questions that were answered while requesting the assignment. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_assignmentrequest_from_assignmentrequests_direct_assignment" +}--> ++```http +POST https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/assignmentRequests +Content-type: application/json ++{ + "requestType": "AdminAdd", + "accessPackageAssignment":{ + "target": { + "email": "user@contoso.com" + }, + "assignmentPolicyId":"2264bf65-76ba-417b-a27d-54d291f0cbc8", + "accessPackageId":"a914b616-e04e-476b-aa37-91038f0b165b" + } +} +``` ++# [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.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": "cb32aef9-2976-496d-9804-eb432fd894a7", + "requestType": "AdminAdd", + "requestState": "Submitted", + "requestStatus": "Accepted", + "createdDateTime": null, + "completedDate": null, + "justification": null, + "isValidationOnly": false, + "schedule": { + "startDateTime": null, + "recurrence": null, + "expiration": { + "endDateTime": null, + "duration": null, + "type": "notSpecified" + } + }, + "answers": [], + "verifiedCredentialsData": [], + "customExtensionHandlerInstances": [], + "customExtensionCalloutInstances": [] +} +``` ++### Example 6: 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. #### Request +The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "update_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_to_approver" + "name": "update_accesspackageassignmentrequest_from_assignmentrequests_requestor_answer_to_approver" }--> ```http POST https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/assignmentRequests 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 the response. -> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. <!-- { "blockType": "response", Content-type: application/json ] } ```++<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 +2019-02-04 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "Create accessPackageAssignmentRequest", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> |
v1.0 | Extensionproperty Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/extensionproperty-delete.md | Title: "Delete extensionProperty (directory extension)" description: "Delete a directory extension definition." ms.localizationpriority: medium + doc_type: "apiPageType" |
v1.0 | Extensionproperty Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/extensionproperty-get.md | Title: "Get extensionProperty (directory extension)" description: "Read a directory extension definition." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Federatedidentitycredential Upsert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/federatedidentitycredential-upsert.md | + + Title: "Upsert federatedIdentityCredential" +description: "Create a new federatedIdentityCredential object if it doesn't exist, or update the properties of an existing federatedIdentityCredential object." ++ms.localizationpriority: medium ++++# Upsert federatedIdentityCredential +Namespace: microsoft.graph ++Create a new [federatedIdentityCredential](../resources/federatedidentitycredential.md) object for an application if it does exist, or update the properties of an existing [federatedIdentityCredential](../resources/federatedidentitycredential.md) object. By [configuring a trust relationship](/azure/active-directory/develop/workload-identity-federation-create-trust) between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to 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). ++<!-- { "blockType": "permissions", "name": "application_post_federatedidentitycredentials" } --> ++## 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. +<!-- { "blockType": "ignored" } --> +```http +PATCH /applications/{id}/federatedIdentityCredentials(name='{name}') +PATCH /applications(appId='{appId}')/federatedIdentityCredentials(name='{name}') +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Content-Type|application/json. Required.| +| Prefer | `create-if-missing`. Required for upsert behavior, otherwise the request is treated as an update operation. | ++## Request body ++In the request body, supply a JSON representation of the [federatedIdentityCredential](../resources/federatedidentitycredential.md) object. +The following table lists the properties that are required when you create the [federatedIdentityCredential](../resources/federatedidentitycredential.md). Note that the **name** property is required as part of the request URL. ++|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.| +|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.| ++## Response ++If successful, if an application object with **name** doesn't exist, this method returns a `201 Created` response code and a new [federatedIdentityCredential](../resources/federatedidentitycredential.md) object in the response body. ++If an application object with **name** already exists, this method updates the [federatedIdentityCredential](../resources/federatedidentitycredential.md) object and returns a `204 No Content` response code. ++## Examples ++### Example 1: Create a new federatedIdentityCredential if it doesn't exist ++The following example creates a federatedIdentityCredential because a federatedIdentityCredential with the specified **name** value doesn't exist. ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "upsert_federatedidentitycredential_create" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/applications(uniqueName='app-65278')/federatedIdentityCredentials(name='fic01-app-65278') +Content-Type: application/json ++{ + "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0", + "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a", + "audiences": [ + "api://AzureADTokenExchange" + ] +} +``` ++### 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.federatedIdentityCredential" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#applications('bcd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials/$entity", + "id": "d9b7bf1e-429e-4678-8132-9b00c9846cc4", + "name": "testing02fic01-app-65278", + "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0", + "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a", + "description": null, + "audiences": [ + "api://AzureADTokenExchange" + ] +} +``` ++### Example 2: Update an existing federatedIdentityCredential ++The following example updates the federatedIdentityCredential because a federatedIdentityCredential with the specified **name** value exists. ++#### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "federatedIdentityCredential_upsert_update" +} +--> ++``` http +PATCH https://graph.microsoft.com/v1.0/applications(uniqueName='app-65278')/federatedIdentityCredentials(name='fic01-app-65278') +Content-Type: application/json +Prefer: create-if-missing ++{ + "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0", + "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a", + "audiences": [ + "api://AzureADTokenExchange" + ] +} +``` ++#### Response ++The following example shows the response. +<!-- { + "blockType": "response" +} +--> ++``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Group Assignlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/group-assignlicense.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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +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 - Groups Administrator - License Administrator - User Administrator-- Global Administrator ## HTTP request |
v1.0 | Group Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/group-delete.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/group-delete-permissions.md)] The following conditions apply for apps to delete role-assignable groups:-+ For delegated scenarios, the app must be assigned the _RoleManagement.ReadWrite.Directory_ delegated permission, and the calling user must be the creator of the group or a global administrator or a privileged role administrator. -+ For app-only scenarios, the calling app must be the owner of the group or be assigned the _RoleManagement.ReadWrite.Directory_ application permission or be assigned the Global Administrator or Privileged Role Administrator Microsoft Entra role. ++ For delegated scenarios, the app must be assigned the _RoleManagement.ReadWrite.Directory_ delegated permission, and the calling user must be the creator of the group or be assigned at least the Privileged Role Administrator Microsoft Entra role.++ For app-only scenarios, the calling app must be the owner of the group or be assigned the _RoleManagement.ReadWrite.Directory_ application permission or be assigned at least the Privileged Role Administrator Microsoft Entra role. ## HTTP request |
v1.0 | Group List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/group-list-members.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] +> **Note:** To list the members of a hidden membership group, the *Member.Read.Hidden* permission is also required. + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Group List Transitivemembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/group-list-transitivemembers.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "group_list_transitivemembers" } --> [!INCLUDE [permissions-table](../includes/permissions/group-list-transitivemembers-permissions.md)] -> **Note:** To list the members of a hidden membership group, the _Member.Read.Hidden_ permission is required. - [!INCLUDE [limited-info](../../includes/limited-info.md)] +> **Note:** To list the members of a hidden membership group, the _Member.Read.Hidden_ permission is required. + ## HTTP request <!-- { "blockType": "ignored" } --> |
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. | 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. | | mailNickname | String | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : . <> , SPACE`. |-| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. To update this property, the calling user must be assigned one of the following Microsoft Entra roles: <br><ul><li> Global Administrator <li> User Account Administrator <li> Directory Writer <li> Exchange Administrator <li> SharePoint Administrator </ul> <br/>For more information about this property, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction). | +| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. To update this property, the calling user must be assigned at least one of the following Microsoft Entra roles: <br><ul><li> User Account Administrator <li> Directory Writer <li> Exchange Administrator <li> SharePoint Administrator </ul> <br/>For more information about this property, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction). | | securityEnabled | Boolean | Specifies whether the group is a security group. |+| uniqueName | String | The unique identifier that can be assigned to a group and used as an alternate key. Can updated only if `null` and is immutable once set. | | visibility | String | Specifies the visibility of a Microsoft 365 group. The possible values are: **Private**, **Public**, or empty (which is interpreted as **Public**). | > [!IMPORTANT] |
v1.0 | Group Upsert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/group-upsert.md | + + Title: "Upsert group" +description: "Create a new Microsoft 365 group or security group if it doesn't exist, or update the properties of an existing group object." ++ms.localizationpriority: medium ++++# Upsert group ++Namespace: microsoft.graph ++Create a new [group](../resources/group.md) object if it doesn't exist, or update the properties of an existing [group](../resources/group.md) object. +You can create or update the following types of group: ++- Microsoft 365 group (unified group) +- Security group ++ By default, this operation returns only a subset of the properties for each group. For a list of properties that are returned by default, see the [Properties](../resources/group.md#properties) section of the [group](../resources/group.md) resource. To get properties that are _not_ returned by default, do a [GET operation](group-get.md) and specify the properties in a `$select` OData query option. ++>**Note**: To create a [team](../resources/team.md), first create a group then add a team to it. For more information, see [Create team](../api/team-put-teams.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": "group_post_groups" } --> ++In order for an app with Group.Create permission to create a group with owners or members, it must have the privileges to read the object type that it wants to assign as the group owner or member. Therefore: ++- The app can assign itself as the group's owner or member. +- To create the group with users as owners or members, the app must have at least the *User.Read.All* permission. +- To create the group with other service principals as owners or members, the app must have at least the *Application.Read.All* permission. +- To create the group with either users or service principals as owners or members, the app must have at least the *Directory.Read.All* permission. ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++``` http +PATCH /groups/(uniqueName='uniqueName') +``` ++## Request headers ++| Name | Description | +|:--|:| +| Authorization | Bearer {token}. Required.| +| Content-Type | application/json. Required.| +| Prefer | `create-if-missing`. Required for upsert behavior, otherwise the request is treated as an update operation. | ++## Request body ++In the request body, supply a JSON representation of the [group](../resources/group.md) object. ++The following table lists the properties that are required when you create the [group](../resources/group.md). Specify other writable properties as necessary for your group on creation or update. ++| Property | Type | Description | +| :-- | : | :-- | +| displayName | String | The name to display in the address book for the group. Maximum length is 256 characters. Required. | +| mailEnabled | Boolean | Set to `true` for mail-enabled groups. Required. | +| mailNickname | String | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : <> , SPACE`. Required. | +| securityEnabled | Boolean | Set to `true` for security-enabled groups, including Microsoft 365 groups. Required. **Note:** Groups created using the Microsoft Entra admin center or the Azure portal always have **securityEnabled** initially set to `true`. | ++> [!IMPORTANT] +> +> - Creating a group using the **Group.Create** application permission without specifying owners will create the group anonymously and the group will not be modifiable. Add owners to the group while creating it to specify owners who can modify the group. +> - Creating a Microsoft 365 group programmatically with an app-only context and without specifying owners will create the group anonymously. Doing so can result in the associated SharePoint Online site not being created automatically until further manual action is taken. +> - 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. ++### groupTypes options ++Use the **groupTypes** property to control the type of group and its membership, as shown. ++| Type of group | Assigned membership | Dynamic membership | +| :-- | : | :-- | +| Microsoft 365 (aka unified group) | `["Unified"]` | `["Unified","DynamicMembership"]` | +| Dynamic | `[]` (_null_) | `["DynamicMembership"]` | ++## Response ++If successful, if the object with the **uniqueName** doesn't exist, this method returns a `201 Created` response code and a new [group](../resources/group.md) object in the response body. ++If the object with the **uniqueName** already exists, this method updates the [group](../resources/group.md) object and returns a `204 No Content` response code. ++## Examples ++### Example 1: Create a Microsoft 365 group if it doesn't exist ++The following example creates a Microsoft 365 group because a group with the specified **uniqueName** value does not exist. Because the owners have not been specified, the calling user is automatically added as the owner of the group. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "upsert_group_create" +}--> ++```http +PATCH https://graph.microsoft.com/v1.0/groups(uniqueName='uniqueName') +Content-type: application/json +Prefer: create-if-missing ++{ + "description": "Self help community for golf", + "displayName": "Golf Assist", + "groupTypes": [ + "Unified" + ], + "mailEnabled": true, + "mailNickname": "golfassist", + "securityEnabled": 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. The value of the **preferredDataLocation** property is inherited from the group creator's preferred data location. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.group" +} --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity", + "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4", + "deletedDateTime": null, + "classification": null, + "createdDateTime": "2018-12-22T02:21:05Z", + "description": "Self help community for golf", + "displayName": "Golf Assist", + "expirationDateTime": null, + "groupTypes": [ + "Unified" + ], + "isAssignableToRole": null, + "mail": "golfassist@contoso.com", + "mailEnabled": true, + "mailNickname": "golfassist", + "membershipRule": null, + "membershipRuleProcessingState": null, + "onPremisesLastSyncDateTime": null, + "onPremisesSecurityIdentifier": null, + "onPremisesSyncEnabled": null, + "preferredDataLocation": "CAN", + "preferredLanguage": null, + "proxyAddresses": [ + "SMTP:golfassist@contoso.onmicrosoft.com" + ], + "renewedDateTime": "2018-12-22T02:21:05Z", + "resourceBehaviorOptions": [], + "resourceProvisioningOptions": [], + "securityEnabled": false, + "securityIdentifier": "S-1-12-1-1753967289-1089268234-832641959-555555555", + "theme": null, + "visibility": "Public", + "uniqueName": "uniqueName", + "onPremisesProvisioningErrors": [] +} +``` ++### Example 2: Create a security group with an owner and members if it doesn't exist ++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. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "upsert_create_prepopulated_group" +}--> ++```http +PATCH https://graph.microsoft.com/v1.0/groups(uniqueName='uniqueName') +Content-Type: application/json ++{ + "description": "Group with designated owner and members", + "displayName": "Operations group", + "groupTypes": [ + ], + "mailEnabled": false, + "mailNickname": "operations2019", + "securityEnabled": true, + "owners@odata.bind": [ + "https://graph.microsoft.com/v1.0/users/26be1845-4119-4801-a799-aea79d09f1a2" + ], + "members@odata.bind": [ + "https://graph.microsoft.com/v1.0/users/ff7cb387-6688-423c-8188-3da9532a73cc", + "https://graph.microsoft.com/v1.0/users/69456242-0067-49d3-ba96-9de6f2728e14" + ] +} +``` ++# [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 is an example of a successful response. It includes only default properties. You can subsequently get the **owners** or **members** navigation properties of the group to verify the owner or members. The value of the **preferredDataLocation** property is inherited from the group creator's preferred data location. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.group" +} --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity", + "@odata.id": "https://graph.microsoft.com/v2/84841066-274d-4ec0-a5c1-276be684bdd3/directoryObjects/1226170d-83d5-49b8-99ab-d1ab3d91333e/Microsoft.DirectoryServices.Group", + "id": "1226170d-83d5-49b8-99ab-d1ab3d91333e", + "deletedDateTime": null, + "classification": null, + "createdDateTime": "2021-09-21T07:14:44Z", + "createdByAppId": "de8bc8b5-d9f9-48b1-a8ad-b748da725064", + "organizationId": "84841066-274d-4ec0-a5c1-276be684bdd3", + "description": "Group with designated owner and members", + "displayName": "Operations group", + "expirationDateTime": null, + "groupTypes": [], + "infoCatalogs": [], + "isAssignableToRole": null, + "isManagementRestricted": null, + "mail": null, + "mailEnabled": false, + "mailNickname": "operations2019", + "membershipRule": null, + "membershipRuleProcessingState": null, + "onPremisesDomainName": null, + "onPremisesLastSyncDateTime": null, + "onPremisesNetBiosName": null, + "onPremisesSamAccountName": null, + "onPremisesSecurityIdentifier": null, + "onPremisesSyncEnabled": null, + "preferredDataLocation": null, + "preferredLanguage": null, + "proxyAddresses": [], + "renewedDateTime": "2021-09-21T07:14:44Z", + "resourceBehaviorOptions": [], + "resourceProvisioningOptions": [], + "securityEnabled": true, + "securityIdentifier": "S-1-12-1-304486157-1236829141-2882644889-1043566909", + "theme": null, + "uniqueName": "uniqueName", + "visibility": null, + "writebackConfiguration": { + "isEnabled": null, + "onPremisesGroupType": null + }, + "onPremisesProvisioningErrors": [] +} +``` ++### Example 3: Update an existing group ++In this example, the specified group already exists, so the operation is treated as an update. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "upsert_update_prepopulated_group" +}--> ++```http +POST https://graph.microsoft.com/v1.0/groups +Content-Type: application/json ++{ + "description": "Group assignable to a role", + "displayName": "Role assignable group", + "groupTypes": [ + "Unified" + ], + "isAssignableToRole": true, + "mailEnabled": true, + "securityEnabled": true, + "mailNickname": "contosohelpdeskadministrators", + "owners@odata.bind": [ + "https://graph.microsoft.com/v1.0/users/99e44b05-c10b-4e95-a523-e2732bbaba1e" + ], + "members@odata.bind": [ + "https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0", + "https://graph.microsoft.com/v1.0/users/4562bcc8-c436-4f95-b7c0-4f8ce89dca5e" + ] +} +``` ++# [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 value of the **preferredDataLocation** property is inherited from the group creator's preferred data location. ++<!-- { + "blockType": "response" +} --> ++``` http +HTTP/1.1 204 No Content +``` ++## Related content ++- [Add custom data to resources using extensions](/graph/extensibility-overview) +- [Add custom data to users using open extensions (preview)](/graph/extensibility-open-users) +- [Add custom data to groups using schema extensions (preview)](/graph/extensibility-schema-groups) |
v1.0 | Horizontalsection Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/horizontalsection-delete.md | + + Title: 'Delete horizontalSection' +description: 'Delete a horizontal section from a page.' ++ms.localizationpriority: medium +++# Delete horizontalSection ++Namespace: microsoft.graph ++Remove a [horizontalSection](../resources/horizontalSection.md) from a [sitePage](../resources/sitepage.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). ++> **Note:** To delete an item, the user must have granted the application write access to the item to be deleted. ++<!-- { "blockType": "permissions", "name": "horizontalsection_delete" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +DELETE /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id} +``` ++## Request headers ++| Name |Description| +|:-|:-| +| Authorization | Bearer \{token\}. Required. | ++## Request body ++Don't supply a request body with this method. ++## Response ++If successful, this call returns a `204 No Content` response to indicate that the resource was deleted and there was nothing to return. ++If the target horizontal section is not found, this method returns `404 Not Found`. ++## Example ++### Request ++The following example shows a request. ++<!-- { "blockType": "ignored" } --> ++``` http +DELETE https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1 +``` ++### Response ++The following example shows the response. ++<!-- { "blockType": "response" } --> ++```http +HTTP/1.1 204 No Content +``` |
v1.0 | Horizontalsection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/horizontalsection-get.md | + + Title: 'Get horizontalSection' +description: 'Read the properties and relationships of a horizontalSection object.' ++ms.localizationpriority: medium +++# Get horizontalSection ++Namespace: microsoft.graph ++Read the properties and relationships of a [horizontalSection](../resources/horizontalsection.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": "horizontalsection_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id} +``` ++## 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 [horizontalSection](../resources/horizontalsection.md) object in the response body. ++## Examples ++### Example 1: Get a horizontalSection object ++#### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++``` http +GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1 +``` ++#### 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.horizontalSection" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "layout": "twoColumns", + "id": "1", + "emphasis": "soft" +} +``` ++### Example 2: Get a horizontalSection object using select and expand +#### Request ++With `$select` and `$expand` statements, you can retrieve horizontalSection metadata and column information in a single request. ++<!-- { "blockType": "ignored" } --> ++``` http +GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1?$select=id&$expand=columns +``` ++#### Response ++The following is an example of a request. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.horizontalSection" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "layout": "twoColumns", + "id": "1", + "columns":[{ + "id": "1", + "width": 6 + },{ + "id": "2", + "width": 6 + }] +} +``` |
v1.0 | Horizontalsection List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/horizontalsection-list.md | + + Title: "List horizontalSections" +description: "Get a list of the horizontalSection objects and their properties." ++ms.localizationpriority: medium +++# List horizontalSections ++Namespace: microsoft.graph ++Get a list of the [horizontalSection](../resources/horizontalsection.md) objects and their properties. Sort by `id` 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": "horizontalsection_list" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections +``` ++## 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).| +| Content-Type | application/json. Required. | ++## 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 [horizontalSection](../resources/horizontalsection.md) objects in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++``` http +GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections +``` ++### 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.horizontalSection)" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.horizontalSection", + "layout": "twoColumns", + "id": "1", + "emphasis": "soft" + }, + { + "@odata.type": "#microsoft.graph.horizontalSection", + "layout": "oneThirdRightColumn", + "id": "2", + "emphasis": "none" + } + ] +} +``` |
v1.0 | Horizontalsection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/horizontalsection-update.md | + + Title: 'Update horizontalSection' +description: "Update the properties of a horizontalSection object." ++ms.localizationpriority: medium ++# Update horizontalSection ++Namespace: microsoft.graph ++Update the properties of a [horizontalSection](../resources/horizontalSection.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": "horizontalsection_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id} +``` ++## 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 [horizontalSection](../resources/horizontalSection.md) resource to update. ++## Response ++If successful, this method returns a `200 OK` response code and an updated [horizontalSection](../resources/horizontalSection.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++``` http +PATCH https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1 ++Content-Type: application/json ++{ + "emphasis": "strong", + "layout": "twoColumns", +} +``` ++### Response ++The following example shows the response. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.horizontalSection", + "truncated": true +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "emphasis": "strong", + "layout": "twoColumns", + "id": "3", + "columns": [ + { + "id": "1", + "width": 6 + }, + { + "id": "2", + "width": 6 + } + ] +} +``` |
v1.0 | Horizontalsectioncolumn Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/horizontalsectioncolumn-get.md | + + Title: 'Get horizontalSectionColumn' +description: 'Read the properties and relationships of a horizontalSectionColumn object.' ++ms.localizationpriority: medium +++# Get horizontalSectionColumn ++Namespace: microsoft.graph ++++Read the properties and relationships of a [horizontalSectionColumn](../resources/horizontalsectioncolumn.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": "horizontalsectioncolumn_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns/{horizontal-section-column-id} +``` ++## 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 [horizontalSectionColumn](../resources/horizontalsectioncolumn.md) object in the response body. ++## Examples ++### Example 1: Get a horizontalSectionColumn +#### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++```http +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1/columns/1 +``` ++#### 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.horizontalSectionColumn" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.horizontalSectionColumn", + "id": "1", + "width": 6 + } +} +``` +### Example 2: Get a horizontalSectionColumn using select and expand +#### Request ++With `$select` and `$expand` statements, you can retrieve horizontalSectionColumn metadata and associated webParts in a single request. ++<!-- { "blockType": "ignored" } --> ++```http +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1/columns/1?$select=id&$expand=webparts +``` ++#### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.horizontalSectionColumn" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.horizontalSectionColumn", + "id": "1", + "webparts":[{ + "@odata.type": "#microsoft.graph.textWebPart", + "id": "1212fc8d-dd6b-408a-8d5d-9f1cc787efbb", + "innerHtml": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vel.</p>" + }] + } +} +``` |
v1.0 | Horizontalsectioncolumn List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/horizontalsectioncolumn-list.md | + + Title: 'List horizontalSectionColumns' +description: 'Get a list of the horizontalSectionColumn objects and their properties.' ++ms.localizationpriority: medium +++# List horizontalSectionColumns ++Namespace: microsoft.graph ++++Get a list of the [horizontalSectionColumn](../resources/horizontalsectioncolumn.md) objects and their properties. Sort by `id` 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": "horizontalsectioncolumn_list" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns +``` ++## 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 [horizontalSectionColumn](../resources/horizontalsectioncolumn.md) objects in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++```http +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202//microsoft.graph.sitePage/canvasLayout/horizontalSections/1/columns +``` ++### 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.horizontalSectionColumn)" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.horizontalSectionColumn", + "id": "1", + "width": 6 + }, + { + "@odata.type": "#microsoft.graph.horizontalSectionColumn", + "id": "2", + "width": 6 + } + ] +} +``` |
v1.0 | Icon Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/icon-get.md | Title: "Get Icon" + Title: "Get workbookIcon" description: "Retrieve the properties and relationships of icon object." ms.localizationpriority: medium -# Get Icon +# Get workbookIcon Namespace: microsoft.graph -Retrieve the properties and relationships of icon object. +Retrieve the properties and relationships of a workbook icon. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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/items/{id}/workbook/worksheets/{id|name}/tables/{id|name}/sort/fie GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/sort/fields/icon ``` ## Optional query parameters-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData query parameters](/graph/query-parameters) to help customize the response. ## Request headers | Name |Description| Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [Icon](../resources/icon.md) object in the response body. -## Example -##### Request +If successful, this method returns a `200 OK` response code and a [workbookIcon](../resources/workbookicon.md) object in the response body. +## Examples +### Request The following example shows a request. <!-- { The following example shows a request. ```http GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/tables/{id|name}/sort/fields/icon ```-##### Response +### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Icon Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/icon-update.md | Title: "Update icon" + Title: "Update workbookIcon" description: "Update the properties of icon object." ms.localizationpriority: medium -# Update icon +# Update workbookIcon Namespace: microsoft.graph -Update the properties of icon object. +Update the properties of an icon object in a workbook. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name ## Request body-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. | Property | Type |Description| |:|:--|:-| In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [Icon](../resources/icon.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookIcon](../resources/workbookicon.md) object in the response body. ## Example-##### Request +### Request The following example shows a request. <!-- { "blockType": "request", Content-type: application/json "index": 99 } ```-##### Response +### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Identityapiconnector Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityapiconnector-create.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_create" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-create-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identityapiconnector Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityapiconnector-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identityapiconnector Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityapiconnector-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identityapiconnector List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityapiconnector-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_list" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-list-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identityapiconnector Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityapiconnector-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-update-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identityapiconnector Uploadclientcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityapiconnector-uploadclientcertificate.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityapiconnector_uploadclientcertificate" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-uploadclientcertificate-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identitycontainer List Authenticationeventlisteners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-list-authenticationeventlisteners.md | + + Title: "List authenticationEventListeners" +description: "Get a list of the authenticationEventListener objects and their properties." ++ms.localizationpriority: medium ++++# List authenticationEventListeners +Namespace: microsoft.graph ++Get a list of the [authenticationEventListener](../resources/authenticationeventlistener.md) objects and their properties. The following derived types are supported: ++- [onTokenIssuanceStartListener](../resources/ontokenissuancestartlistener.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": "identitycontainer_list_authenticationeventlisteners" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identity/authenticationEventListeners +``` ++## Optional query parameters +This method supports the `$filter` 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 collection of [authenticationEventListener](../resources/authenticationeventlistener.md) objects in the response body. The **@odata.type** property in the response object indicates the type of the authenticationEventListener object. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_authenticationeventlistener" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/authenticationEventListeners +``` ++# [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.authenticationEventListener)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners", + "value": [ + { + "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener", + "id": "990d94e5-cc8f-4c4b-97b4-27e2678aac28", + "conditions": { + "applications": { + "includeApplications@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners('990d94e5-cc8f-4c4b-97b4-27e2678aac28')/microsoft.graph.onTokenIssuanceStartListener/conditions/applications/includeApplications", + "includeApplications": [ + { + "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4" + } + ] + } + }, + "handler": { + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler", + "configuration": null, + "customExtension": { + "id": "6fc5012e-7665-43d6-9708-4370863f4e6e", + "displayName": "onTokenIssuanceStartCustomExtension", + "description": "Fetch additional claims from custom user store", + "clientConfiguration": null, + "authenticationConfiguration": { + "@odata.type": "#microsoft.graph.azureAdTokenAuthentication", + "resourceId": "api://authenticationeventsAPI.contoso.net/a13d0fc1-04ab-4ede-b215-63de0174cbb4" + }, + "endpointConfiguration": { + "@odata.type": "#microsoft.graph.httpRequestEndpoint", + "targetUrl": "https://authenticationeventsAPI.contoso.net" + }, + "claimsForTokenConfiguration": [ + { + "claimIdInApiResponse": "DateOfBirth" + }, + { + "claimIdInApiResponse": "CustomRoles" + } + ] + } + } + } + ] +} +``` + |
v1.0 | Identitycontainer List Authenticationeventsflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-list-authenticationeventsflows.md | + + Title: "List authenticationEventsFlows" +description: "Get a list of the authenticationEventsFlow objects and their properties." ++ms.localizationpriority: medium ++++# List authenticationEventsFlows +Namespace: microsoft.graph ++Get a collection of authentication events policies that are derived from [authenticationEventsFlow](../resources/authenticationeventsflow.md). The following derived subtypes are supported: +- [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.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": "identitycontainer_list_authenticationeventsflows" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identity/authenticationEventsFlows +``` ++## Optional query parameters ++This method supports the `$filter`, `$expand`, `$orderby`, 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 [authenticationEventsFlow](../resources/authenticationeventsflow.md) objects in the response body. ++## Examples ++### Example 1: List all user flows ++#### Request +The following example shows a request. +<!-- { + "blockType": "request", + "name": "list_authenticationeventsflow" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows +``` +++#### Response ++The following is an example of a response that returns two user flows: "Test User Flow 1" and "Woodgrove Drive User Flow" with the following configurations: ++- "Test User Flow 1" is set up to allow email+password accounts, collect email address and country, and create a "Member" user type. +- "Woodgrove Drive User Flow" is set up to allow email+password accounts or social (Google or Facebook) sign in, collect email address, display name, and favorite color, and create "Member" user type. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.authenticationEventsFlow)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "79a67c51-c86d-4a48-8313-1e14ac821e16", + "displayName": "TestUserFlow1", + "description": null, + "onAttributeCollectionStart": null, + "onAttributeCollectionSubmit": null, + "conditions": { + "applications": { + "includeAllApplications": false, + "includeApplications@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows('79a67c51-c86d-4a48-8313-1e14ac821e16')/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications", + "includeApplications": [] + } + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp", + "identityProviders": [ + { + "@odata.type": "#microsoft.graph.builtInIdentityProvider", + "id": "EmailPassword-OAUTH", + "displayName": "Email with password", + "identityProviderType": "EmailPassword" } + ] + }, + "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": "country", + "label": "Country/Region", + "inputType": "text", + "defaultValue": null, + "hidden": false, + "editable": true, + "writeToDirectory": true, + "required": false, + "validationRegEx": "^.*", + "options": [] + } + ] + } + ] + }, + "attributes": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "country", + "displayName": "Country/Region", + "description": "The country/region in which the user is located.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + } + ] + }, + "onUserCreateStart": { + "@odata.type": "#microsoft.graph.onUserCreateStartExternalUsersSelfServiceSignUp", + "userTypeToCreate": "member" + } + }, + { + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "0313cc37-d421-421d-857b-87804d61e33e", + "displayName": "Woodgrove Drive User Flow", + "description": "For onboarding consumers to the Woodgrove Drive application", + "onAttributeCollectionStart": null, + "onAttributeCollectionSubmit": null, + "conditions": { + "applications": { + "includeAllApplications": false, + "includeApplications@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows('0313cc37-d421-421d-857b-87804d61e33e')/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications", + "includeApplications": [] + } + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp", + "identityProviders": [ + { + "@odata.type": "#microsoft.graph.builtInIdentityProvider", + "id": "EmailPassword-OAUTH", + "displayName": "Email with password", + "identityProviderType": "EmailPassword" + }, + { + "@odata.type": "#microsoft.graph.socialIdentityProvider", + "id": "Google-OAUTH", + "displayName": "Google", + "identityProviderType": "Google", + "clientId": "137004260525-q8j2cp9hqceqa6hpvaa346e04g92tn8m.apps.googleusercontent.com", + "clientSecret": "******" + }, + { + "@odata.type": "#microsoft.graph.socialIdentityProvider", + "id": "Facebook-OAUTH", + "displayName": "Facebook", + "identityProviderType": "Facebook", + "clientId": "236028191057849", + "clientSecret": "******" + } + ] + }, + "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": [] + } + ] + } + ] + }, + "attributes": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "displayName", + "displayName": "Display Name", + "description": "Display Name of the User.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor", + "displayName": "Favorite color", + "description": "what is your favorite color", + "userFlowAttributeType": "custom", + "dataType": "string" + } + ] + }, + "onUserCreateStart": { + "@odata.type": "#microsoft.graph.onUserCreateStartExternalUsersSelfServiceSignUp", + "userTypeToCreate": "member" + } + } + ] +} +``` ++### Example 2: List all user flows that include Google as an identity provider ++#### Request ++The following example shows a request. ++<!-- { + "blockType": "request", + "name": "list_authenticationeventsflow_selfservicesignup_identityproviders" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/any(idp:idp/id eq 'Google-OAUTH') +``` ++#### 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.authenticationEventsFlow)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows", + "value": [ + { + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "0313cc37-d421-421d-857b-87804d61e33e", + "displayName": "Woodgrove Drive User Flow", + "description": "For onboarding consumers to the Woodgrove Drive application", + "onAttributeCollectionStart": null, + "onAttributeCollectionSubmit": null, + "conditions": { + "applications": { + "includeAllApplications": false, + "includeApplications@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows('0313cc37-d421-421d-857b-87804d61e33e')/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications", + "includeApplications": [] + } + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp", + "identityProviders": [ + { + "@odata.type": "#microsoft.graph.builtInIdentityProvider", + "id": "EmailPassword-OAUTH", + "displayName": "Email with password", + "identityProviderType": "EmailPassword" + }, + { + "@odata.type": "#microsoft.graph.socialIdentityProvider", + "id": "Google-OAUTH", + "displayName": "Google", + "identityProviderType": "Google", + "clientId": "############-q8j2cp9hqceqa6hpvaa346e04g92tn8m.apps.googleusercontent.com", + "clientSecret": "******" + }, + { + "@odata.type": "#microsoft.graph.socialIdentityProvider", + "id": "Facebook-OAUTH", + "displayName": "Facebook", + "identityProviderType": "Facebook", + "clientId": "###############", + "clientSecret": "******" + } + ] + }, + "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": [] + } + ] + } + ] + }, + "attributes": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "displayName", + "displayName": "Display Name", + "description": "Display Name of the User.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor", + "displayName": "Favorite color", + "description": "what is your favorite color", + "userFlowAttributeType": "custom", + "dataType": "string" + } + ] + }, + "onUserCreateStart": { + "@odata.type": "#microsoft.graph.onUserCreateStartExternalUsersSelfServiceSignUp", + "userTypeToCreate": "member" + } + } + ] +} +``` ++### Example 3: List all user flows that collect 'city' during attribute collection at account creation ++#### Request ++The following example shows a request. ++<!-- { + "blockType": "request", + "name": "list_authenticationeventsflow_filter_selfservicesignup_attributes" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/any(attribute:attribute/id eq 'city') +``` ++#### 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.authenticationEventsFlow)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows", + "value": [ + { + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "0313cc37-d421-421d-857b-87804d61e33e", + "displayName": "TestUserFlow3", + "description": "my user flow description newestXXX", + "onAttributeCollectionStart": null, + "onAttributeCollectionSubmit": null, + "conditions": { + "applications": { + "includeAllApplications": false, + "includeApplications@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows('0313cc37-d421-421d-857b-87804d61e33e')/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications", + "includeApplications": [] + } + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp", + "identityProviders": [ + { + "@odata.type": "#microsoft.graph.builtInIdentityProvider", + "id": "AADSignup-OAUTH", + "displayName": "Azure Active Directory Sign up", + "identityProviderType": "AADSignup" + }, + { + "@odata.type": "#microsoft.graph.builtInIdentityProvider", + "id": "EmailPassword-OAUTH", + "displayName": "Email with password", + "identityProviderType": "EmailPassword" + }, + { + "@odata.type": "#microsoft.graph.socialIdentityProvider", + "id": "Google-OAUTH", + "displayName": "Google", + "identityProviderType": "Google", + "clientId": "137004260525-q8j2cp9hqceqa6hpvaa346e04g92tn8m.apps.googleusercontent.com", + "clientSecret": "******" + }, + { + "@odata.type": "#microsoft.graph.socialIdentityProvider", + "id": "Facebook-OAUTH", + "displayName": "Facebook", + "identityProviderType": "Facebook", + "clientId": "236028191057849", + "clientSecret": "******" + } + ] + }, + "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": "city", + "label": "City", + "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": "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": [] + } + ] + } + ] + }, + "attributes": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "city", + "displayName": "City", + "description": "The city in which the user is located.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "displayName", + "displayName": "Display Name", + "description": "Display Name of the User.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + } + ] + }, + "onUserCreateStart": { + "@odata.type": "#microsoft.graph.onUserCreateStartExternalUsersSelfServiceSignUp", + "userTypeToCreate": "member" + } + }, + { + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "f5b9b311-cb87-445b-a655-e6e6a4d3e582", + "displayName": "TestUserFlow4", + "description": null, + "onAttributeCollectionStart": null, + "onAttributeCollectionSubmit": null, + "conditions": { + "applications": { + "includeAllApplications": false, + "includeApplications@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows('f5b9b311-cb87-445b-a655-e6e6a4d3e582')/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications", + "includeApplications": [] + } + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp", + "identityProviders": [ + { + "@odata.type": "#microsoft.graph.builtInIdentityProvider", + "id": "EmailPassword-OAUTH", + "displayName": "Email with password", + "identityProviderType": "EmailPassword" + } + ] + }, + "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": "city", + "label": "City", + "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": "country", + "label": "Country/Region", + "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": "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": [] + } + ] + } + ] + }, + "attributes": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "city", + "displayName": "City", + "description": "The city in which the user is located.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "country", + "displayName": "Country/Region", + "description": "The country/region in which the user is located.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "displayName", + "displayName": "Display Name", + "description": "Display Name of the User.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + } + ] + }, + "onUserCreateStart": { + "@odata.type": "#microsoft.graph.onUserCreateStartExternalUsersSelfServiceSignUp", + "userTypeToCreate": "member" + } + } + ] +} +``` ++### Example 4: List user flow associated with specific application ID ++#### Request +The following example shows a request. +<!-- { + "blockType": "request", + "name": "list_authenticationeventsflow_filter_includeapplications" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/any(appId:appId/appId eq '63856651-13d9-4784-9abf-20758d509e19') +``` ++#### 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.authenticationEventsFlow)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows", + "value": [ + { + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "b5ca7ddb-f5e4-4dea-8ee5-282116ddc71d", + "displayName": "Test User Flow", + "description": null, + "onAttributeCollectionStart": null, + "onAttributeCollectionSubmit": null, + "conditions": { + "applications": { + "includeAllApplications": false, + "includeApplications@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows('b5ca7ddb-f5e4-4dea-8ee5-282116ddc71d')/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications", + "includeApplications": [ + { + "appId": "63856651-13d9-4784-9abf-20758d509e19" + } + ] + } + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp", + "identityProviders": [ + { + "@odata.type": "#microsoft.graph.builtInIdentityProvider", + "id": "EmailPassword-OAUTH", + "displayName": "Email with password", + "identityProviderType": "EmailPassword" + } + ] + }, + "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": "extension_6ea3bc85aec24b1c92ff4a117afb6621_RewardsNumber", + "label": "Rewards number", + "inputType": "text", + "defaultValue": null, + "hidden": false, + "editable": true, + "writeToDirectory": true, + "required": false, + "validationRegEx": "^.*", + "options": [] + }, + { + "attribute": "displayName", + "label": "Display Name", + "inputType": "text", + "defaultValue": null, + "hidden": false, + "editable": true, + "writeToDirectory": true, + "required": false, + "validationRegEx": "^.*", + "options": [] + } + ] + } + ] + }, + "attributes": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "extension_6ea3bc85aec24b1c92ff4a117afb6621_RewardsNumber", + "displayName": "RewardsNumber", + "description": null, + "userFlowAttributeType": "custom", + "dataType": "string" + }, + { + "id": "displayName", + "displayName": "Display Name", + "description": "Display Name of the User.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + } + ] + }, + "onUserCreateStart": { + "@odata.type": "#microsoft.graph.onUserCreateStartExternalUsersSelfServiceSignUp", + "userTypeToCreate": "member" + } + } + ] +} +``` |
v1.0 | Identitycontainer List B2xuserflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-list-b2xuserflows.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_list_b2xuserflows" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-b2xuserflows-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identitycontainer List Customauthenticationextensions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-list-customauthenticationextensions.md | + + Title: "List customAuthenticationExtensions" +description: "Get a list of the customAuthenticationExtension objects and their properties." ++ms.localizationpriority: medium ++++# List customAuthenticationExtensions +Namespace: microsoft.graph ++Get a list of the [customAuthenticationExtension](../resources/customauthenticationextension.md) objects and their properties. The following derived types are supported. ++- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "identitycontainer_list_customauthenticationextensions" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identity/customAuthenticationExtensions +``` ++## Optional query parameters +This method supports the `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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 [customAuthenticationExtension](../resources/customauthenticationextension.md) objects in the response body. An **@odata.type** property is returned for each object to specify the type of customAuthenticationExtension. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_customauthenticationextension" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/customAuthenticationExtensions?$filter=isOf('microsoft.graph.onTokenIssuanceStartCustomExtension') +``` ++# [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.customAuthenticationExtension)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/customAuthenticationExtensions", + "value": [ + { + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension", + "id": "6fc5012e-7665-43d6-9708-4370863f4e6e", + "displayName": "onTokenIssuanceStartCustomExtension", + "description": "Fetch additional claims from custom user store", + "clientConfiguration": null, + "authenticationConfiguration": { + "@odata.type": "#microsoft.graph.azureAdTokenAuthentication", + "resourceId": "api://authenticationeventsAPI.contoso.net/a13d0fc1-04ab-4ede-b215-63de0174cbb4" + }, + "endpointConfiguration": { + "@odata.type": "#microsoft.graph.httpRequestEndpoint", + "targetUrl": "https://authenticationeventsAPI.contoso.net" + }, + "claimsForTokenConfiguration": [ + { + "claimIdInApiResponse": "DateOfBirth" + }, + { + "claimIdInApiResponse": "CustomRoles" + } + ] + } + ] +} +``` + |
v1.0 | Identitycontainer List Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-list-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_list_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator -* External ID user flow administrator ## HTTP request |
v1.0 | Identitycontainer Post Authenticationeventlisteners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-post-authenticationeventlisteners.md | + + Title: "Create authenticationEventListener" +description: "Create a new authenticationEventListener object." ++ms.localizationpriority: medium ++++# Create authenticationEventListener +Namespace: microsoft.graph ++Create a new [authenticationEventListener](../resources/authenticationeventlistener.md) object. You can create one of the following subtypes that are derived from **authenticationEventListener**. ++- [onTokenIssuanceStartListener resource type](../resources/ontokenissuancestartlistener.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": "identitycontainer_post_authenticationeventlisteners" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /identity/authenticationEventListeners +``` ++## 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 [authenticationEventListener](../resources/authenticationeventlistener.md) object. ++You can specify the following properties when creating an **authenticationEventListener**. You must specify the **@odata.type** property to specify the type of authenticationEventListener to create; for example, `@odata.type": "microsoft.graph.onTokenIssuanceStartListener"`. ++|Property|Type|Description| +|:|:|:| +|conditions|[authenticationConditions](../resources/authenticationconditions.md)|The conditions on which this authenticationEventListener should trigger. Optional.| +|handler|[onTokenIssuanceStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be set for the **onTokenIssuanceStartListener** listener type.| ++## Response ++If successful, this method returns a `201 Created` response code and an [authenticationEventListener](../resources/authenticationeventlistener.md) object in the response body. The **@odata.type** property specifies the type of the created object. ++## Examples +++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_authenticationeventlistener_onTokenIssuanceStartListener" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners +Content-Type: application/json +Content-length: 312 ++{ + "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener", + "conditions": { + "applications": { + "includeApplications": [ + { + "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4" + } + ] + } + }, + "handler": { + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler", + "customExtension": { + "id": "6fc5012e-7665-43d6-9708-4370863f4e6e" + } + } +} +``` ++# [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.authenticationEventListener" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity", + "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener", + "id": "990d94e5-cc8f-4c4b-97b4-27e2678aac28", + "conditions": { + "applications": { + "includeApplications": [ + { + "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4" + } + ] + } + }, + "handler": { + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler", + "customExtension": { + "id": "6fc5012e-7665-43d6-9708-4370863f4e6e" + } + } +} +``` + |
v1.0 | Identitycontainer Post Authenticationeventsflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-post-authenticationeventsflows.md | + + Title: "Create authenticationEventsFlow" +description: "Create a new authenticationEventsFlow object." ++ms.localizationpriority: medium ++++# Create authenticationEventsFlow +Namespace: microsoft.graph ++Create a new [authenticationEventsFlow](../resources/authenticationeventsflow.md) object that is of the type specified in the request body. The following derived subtypes are supported: +- [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object type. ++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "identitycontainer_post_authenticationeventsflows" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /identity/authenticationEventsFlows +``` ++## 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 [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. ++You can specify the following properties when creating an **authenticationEventsFlow**. You must include the **@odata.type** property with a value of the specific user flow type in the body. For example, `"@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow"`. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Required. The display name for the events policy. Must be unique.| +|description|String|Optional. The description of the events policy.| +|conditions|[authenticationConditions](../resources/authenticationconditions.md)|Optional. The conditions representing the context of the authentication request which is used to decide whether the events policy is invoked.| ++## Response ++If successful, this method returns a `201 Created` response code and a JSON representation of an [authenticationEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object in the response body. An **@odata.type** property with the value of the specific user flow type created is included in the response body. For example, `"@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow"`. ++## Examples ++### Example 1: Create a basic External Identities sign-up and sign-in user flow in an external tenant ++#### Request +The following example shows a request. In this example, you create a user flow named "Woodgrove User Flow" with the following configuration. ++- Allow sign up and sign in. +- Allow users to create a local email with password account. +- Collect the **Display Name** built-in attribute from the user. +- Defines how the attributes to be collected will be displayed to the user. ++<!-- { + "blockType": "request", + "name": "create_authenticationeventsflow_selfservicesignup" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "displayName": "Woodgrove Drive User Flow", + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp", + "identityProviders": [ + { + "id": "EmailPassword-OAUTH" + } + ] + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAttributeCollection": { + "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp", + "attributes": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "displayName", + "displayName": "Display Name", + "description": "Display Name of the User.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + } + ], + "attributeCollectionPage": { + "views": [ + { + "inputs": [ + { + "attribute": "email", + "label": "Email Address", + "inputType": "Text", + "hidden": true, + "editable": false, + "writeToDirectory": true, + "required": true, + "validationRegEx": "^[a-zA-Z0-9.!#$%&’'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$" + }, + { + "attribute": "displayName", + "label": "Display Name", + "inputType": "text", + "hidden": false, + "editable": true, + "writeToDirectory": true, + "required": false, + "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$" + } + ] + } + ] + } + } +} +``` ++#### 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.authenticationEventsFlow" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows/$entity", + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "0313cc37-d421-421d-857b-87804d61e33e", + "displayName": "Woodgrove Drive User Flow", + "conditions": { + "applications": { + "includeAllApplications": false + } + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp" + }, + "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": [] + } + ] + } + ] + } + } +} +``` ++### Example 2: Create a basic external identities sign-up and sign-in user flow with an attached application in an external tenant ++#### Request +The following example shows a request. In this example, you create a user flow named "Woodgrove User Flow" with the following configuration. ++- Allow sign up and sign in. +- Allow users to create a local email with password account. +- Collect the **Display Name** built-in attribute from the user. +- Defines how the attributes to be collected will be displayed to the user. ++<!-- { + "blockType": "request", + "name": "create_authenticationeventsflow_selfservicesignup_includeapplications" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "displayName": "Woodgrove Drive User Flow", + "conditions": { + "applications": { + "includeApplications": [ + { + "appId": "63856651-13d9-4784-9abf-20758d509e19" + } + ] + } + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp", + "identityProviders": [ + { + "id": "EmailPassword-OAUTH" + } + ] + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAttributeCollection": { + "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp", + "attributes": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "displayName", + "displayName": "Display Name", + "description": "Display Name of the User.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + } + ], + "attributeCollectionPage": { + "views": [ + { + "inputs": [ + { + "attribute": "email", + "label": "Email Address", + "inputType": "Text", + "hidden": true, + "editable": false, + "writeToDirectory": true, + "required": true, + "validationRegEx": "^[a-zA-Z0-9.!#$%&’'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$" + }, + { + "attribute": "displayName", + "label": "Display Name", + "inputType": "text", + "hidden": false, + "editable": true, + "writeToDirectory": true, + "required": false, + "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$" + } + ] + } + ] + } + } +} +``` ++#### 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.authenticationEventsFlow" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows/$entity", + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "1d51b447-eb52-4ec8-ae4e-0a35ebc148ea", + "displayName": "Woodgrove Drive User Flow", + "description": null, + "onUserCreateStart": null, + "conditions": { + "applications": { + "includeAllApplications": false + } + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp" + }, + "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": [] + } + ] + } + ] + } + } +} +``` ++### Example 3: Create an External Identities sign-up and sign-in user flow with social providers and a custom attribute ++#### Request ++The following example shows a request. In this example, you create a user flow named "Woodgrove Drive User Flow" with the following configuration ++- Allow sign up and sign in. +- Allow users to create a local email with password account, or authenticate with Google or Facebook +- Collect the **Display Name** built-in attribute and a **Favorite Color** custom attribute. ++<!-- { + "blockType": "request", + "name": "create_authenticationeventsflow__selfservicesignup_socialproviders_customattribute" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "displayName": "Woodgrove User Flow 2", + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp", + "identityProviders": [ + { + "id": "EmailPassword-OAUTH" + }, + { + "id": "Google-OAUTH" + }, + { + "id": "Facebook-OAUTH" + } + ] + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAttributeCollection": { + "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp", + "attributes": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "displayName", + "displayName": "Display Name", + "description": "Display Name of the User.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor", + "displayName": "Favorite color", + "description": "what is your favorite color", + "userFlowAttributeType": "custom", + "dataType": "string" + } + ], + "attributeCollectionPage": { + "views": [ + { + "inputs": [ + { + "attribute": "email", + "label": "Email Address", + "inputType": "Text", + "hidden": true, + "editable": false, + "writeToDirectory": true, + "required": true, + "validationRegEx": "^[a-zA-Z0-9.!#$%&’'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$" + }, + { + "attribute": "displayName", + "label": "Display Name", + "inputType": "text", + "hidden": false, + "editable": true, + "writeToDirectory": true, + "required": false, + "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$" + }, + { + "attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor", + "label": "Favorite color", + "inputType": "text", + "hidden": false, + "editable": true, + "writeToDirectory": true, + "required": false, + "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$" + } + ] + } + ] + } + } +} +``` +++#### 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.authenticationEventsFlow" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventsFlows/$entity", + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "{authentictionEventsFlow-id}", + "displayName": "Woodgrove User Flow 2", + "description": null, + "onUserCreateStart": null, + "conditions": { + "applications": { + "includeAllApplications": false + } + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": true + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp" + }, + "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": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$", + "options": [] + } + ] + } + ] + } + } +} +``` |
v1.0 | Identitycontainer Post B2xuserflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-post-b2xuserflows.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_post_b2xuserflows" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-b2xuserflows-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Identitycontainer Post Customauthenticationextensions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-post-customauthenticationextensions.md | + + Title: "Create customAuthenticationExtension" +description: "Create a new customAuthenticationExtension object." ++ms.localizationpriority: medium ++++# Create customAuthenticationExtension +Namespace: microsoft.graph ++Create a new [customAuthenticationExtension](../resources/customauthenticationextension.md) object. The following derived types are currently supported. ++- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "identitycontainer_post_customauthenticationextensions" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /identity/customAuthenticationExtensions +``` ++## 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 [customAuthenticationExtension](../resources/customauthenticationextension.md) object. ++You can specify the following properties when creating a **customAuthenticationExtension**. You must specify the **@odata.type** property with a value of the customAuthenticationExtension object type that you want to create. For example, to create an **onTokenIssuanceStartCustomExtension** object, set **@odata.type** to `#microsoft.graph.onTokenIssuanceStartCustomExtension`. ++|Property|Type|Description| +|:|:|:| +|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|The authentication configuration for this custom extension. Required.| +|claimsForTokenConfiguration|[onTokenIssuanceStartReturnClaim](../resources/ontokenissuancestartreturnclaim.md) collection|Collection of claims to be returned by the API called by this custom authentication extension. Can be set for **onTokenIssuanceStartCustomExtension** object only. Used to populate claims mapping experience in Microsoft Entra admin center. Optional. | +|clientConfiguration|[customExtensionClientConfiguration](../resources/customextensionclientconfiguration.md)|The connection settings for the custom extension. Optional.| +|description|String|Description for the custom extension. Optional.| +|displayName|String|Display name for the custom extension. Required.| +|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|Configuration for the API endpoint that the custom extension will call. Required.| ++## Response ++If successful, this method returns a `201 Created` response code and a [customAuthenticationExtension](../resources/customauthenticationextension.md) object in the response body. ++## Examples +++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_customauthenticationextension_onTokenIssuanceStartCustomExtension" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/identity/customAuthenticationExtensions +Content-Type: application/json +Content-length: 468 ++{ + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension", + "displayName": "onTokenIssuanceStartCustomExtension", + "description": "Fetch additional claims from custom user store", + "endpointConfiguration": { + "@odata.type": "#microsoft.graph.httpRequestEndpoint", + "targetUrl": "https://authenticationeventsAPI.contoso.com" + }, + "authenticationConfiguration": { + "@odata.type": "#microsoft.graph.azureAdTokenAuthentication", + "resourceId": "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4" + }, + "clientConfiguration": { + "timeoutInMilliseconds": 2000, + "maximumRetries": 1 + }, + "claimsForTokenConfiguration": [ + { + "claimIdInApiResponse": "DateOfBirth" + }, + { + "claimIdInApiResponse": "CustomRoles" + } + ] +} +``` ++# [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.customAuthenticationExtension" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/customAuthenticationExtensions/$entity", + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension", + "id": "6fc5012e-7665-43d6-9708-4370863f4e6e", + "displayName": "onTokenIssuanceStartCustomExtension", + "description": "Fetch additional claims from custom user store", + "clientConfiguration": null, + "authenticationConfiguration": { + "@odata.type": "#microsoft.graph.azureAdTokenAuthentication", + "resourceId": "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4" + }, + "clientConfiguration": { + "timeoutInMilliseconds": 2000, + "maximumRetries": 1 + }, + "endpointConfiguration": { + "@odata.type": "#microsoft.graph.httpRequestEndpoint", + "targetUrl": "https://authenticationeventsAPI.contoso.com" + }, + "claimsForTokenConfiguration": [ + { + "claimIdInApiResponse": "DateOfBirth" + }, + { + "claimIdInApiResponse": "CustomRoles" + } + ] +} +``` + |
v1.0 | Identitycontainer Post Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-post-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-identityproviders-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identitygovernance Lifecycleworkflowscontainer Post Workflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitygovernance-lifecycleworkflowscontainer-post-workflows.md | Title: "Create workflow" -description: "Create a new workflow object. You can create up to 50 workflows in a tenant." +description: "Create a new workflow object. You can create up to 100 workflows in a tenant." ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph.identityGovernance -Create a new [workflow](../resources/identitygovernance-workflow.md) object. You can create up to 50 workflows in a tenant. +Create a new [workflow](../resources/identitygovernance-workflow.md) object. You can create up to 100 workflows in a tenant. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Identityprovider Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityprovider-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-delete-permissions.md)] -The work or school account must be a global administrator of the tenant. ## HTTP request |
v1.0 | Identityprovider Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityprovider-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-get-permissions.md)] -The work or school account must be a global administrator of the tenant. ## HTTP request |
v1.0 | Identityprovider List Availableprovidertypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityprovider-list-availableprovidertypes.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_list_availableprovidertypes" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-list-availableprovidertypes-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identityprovider List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityprovider-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_list" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-list-permissions.md)] -The work or school account must be a global administrator of the tenant. ## HTTP request |
v1.0 | Identityprovider Post Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityprovider-post-identityproviders.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-post-identityproviders-permissions.md)] -The work or school account must be a global administrator of the tenant. ## HTTP request |
v1.0 | Identityprovider Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityprovider-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprovider_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-update-permissions.md)] -The work or school account must be a global administrator of the tenant. ## HTTP request |
v1.0 | Identityproviderbase Availableprovidertypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityproviderbase-availableprovidertypes.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityproviderbase_availableprovidertypes" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-availableprovidertypes-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identityproviderbase Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityproviderbase-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityproviderbase_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Identityproviderbase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityproviderbase-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityproviderbase_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator -* External ID user flow administrator ## HTTP request |
v1.0 | Identityproviderbase Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityproviderbase-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityproviderbase_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-update-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Internaldomainfederation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/internaldomainfederation-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "internaldomainfederation_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/internaldomainfederation-delete-permissions.md)] +> [!IMPORTANT] +> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios. ++<!-- Domain Name Administrator and Hybrid Identity Administrator can't delete federated domains --> The calling user must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): - Security Administrator |
v1.0 | Internaldomainfederation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/internaldomainfederation-update.md | Title: "Update internalDomainFederation" description: "Update the properties of an internalDomainFederation object." ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "internaldomainfederation_update" } --> [!INCLUDE [permissions-table](../includes/permissions/internaldomainfederation-update-permissions.md)] +> [!IMPORTANT] +> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios. + [!INCLUDE [rbac-domainfederation-apis-write](../includes/rbac-for-apis/rbac-domainfederation-apis-write.md)] ## HTTP request PATCH /domains/{domainsId}/federationConfiguration/{internalDomainFederationId} |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 (IdP). | |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 will sign those requests using the OrgID signing key. If `false` (default), the SAML authentication requests sent to the federated IdP are not signed.| +|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.|-|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens 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 is not present in the federation properties after the federation service certificate has been updated.| +|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`. | |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).| +|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.| |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).| + ### federatedIdpMfaBehavior values | Member | Description | Content-Type: application/json "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp" } ```++<!-- +{ + "type": "#page.annotation", + "description": "", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: /api/internaldomainfederation-update.md: + Exception processing links. + Link Definition was null. Link text: !INCLUDE Azure AD PowerShell deprecation note (Parameter 'Definition')" + ] +} +--> |
v1.0 | Intune Apps Mobileappcontentfile Commit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-apps-mobileappcontentfile-commit.md | Namespace: microsoft.graph Commits a file of a given app. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). Here is an example of the request. <!-- { "blockType": "ignored" , "name" : "intune_apps_mobileappcontentfile_commit_commit_action" }--> ``` http POST https://graph.microsoft.com/v1.0/deviceAppManagement/mobileApps/{mobileAppId}/contentVersions/{mobileAppContentId}/files/{mobileAppContentFileId}/commit+ Content-type: application/json Content-length: 399 |
v1.0 | Intune Apps Mobileappcontentfile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-apps-mobileappcontentfile-create.md | Namespace: microsoft.graph Create a new [mobileAppContentFile](../resources/intune-apps-mobileappcontentfile.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). The following table shows the properties that are required when you create the m |Property|Type|Description| |:|:|:|-|azureStorageUri|String|The Azure Storage URI.| -|isCommitted|Boolean|A value indicating whether the file is committed.| -|id|String|The File Id.| -|createdDateTime|DateTimeOffset|The time the file was created.| -|name|String|the file name.| -|size|Int64|The size of the file prior to encryption.| -|sizeEncrypted|Int64|The size of the file after encryption.| -|azureStorageUriExpirationDateTime|DateTimeOffset|The time the Azure storage Uri expires.| -|manifest|Binary|The manifest information.| -|uploadState|[mobileAppContentFileUploadState](../resources/intune-apps-mobileappcontentfileuploadstate.md)|The state of the current upload request. Possible values are: `success`, `transientError`, `error`, `unknown`, `azureStorageUriRequestSuccess`, `azureStorageUriRequestPending`, `azureStorageUriRequestFailed`, `azureStorageUriRequestTimedOut`, `azureStorageUriRenewalSuccess`, `azureStorageUriRenewalPending`, `azureStorageUriRenewalFailed`, `azureStorageUriRenewalTimedOut`, `commitFileSuccess`, `commitFilePending`, `commitFileFailed`, `commitFileTimedOut`.| +|azureStorageUri|String|Indicates the Azure Storage URI that the file is uploaded to. Created by the service upon receiving a valid mobileAppContentFile. Read-only. This property is read-only.| +|isCommitted|Boolean|A value indicating whether the file is committed. A committed app content file has been fully uploaded and validated by the Intune service. TRUE means that app content file is committed, FALSE means that app content file is not committed. Defaults to FALSE. Read-only. This property is read-only.| +|id|String|The unique identifier for this mobileAppContentFile. This id is assigned during creation of the mobileAppContentFile. Read-only. This property is read-only.| +|createdDateTime|DateTimeOffset|Indicates created date and time associated with app content file, in ISO 8601 format. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Read-only. This property is read-only.| +|name|String|Indicates the name of the file.| +|size|Int64|The size of the file prior to encryption. To be deprecated, please use sizeInBytes property instead.| +|sizeEncrypted|Int64|The size of the file after encryption. To be deprecated, please use sizeEncryptedInBytes property instead.| +|sizeInBytes|Int64|Indicates the original size of the file, in bytes. Valid values 0 to 9.22337203685478E+18| +|sizeEncryptedInBytes|Int64|Indicates the size of the file after encryption, in bytes. Valid values 0 to 9.22337203685478E+18| +|azureStorageUriExpirationDateTime|DateTimeOffset|Indicates the date and time when the Azure storage URI expires, in ISO 8601 format. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Read-only. This property is read-only.| +|manifest|Binary|Indicates the manifest information, containing file metadata.| +|uploadState|[mobileAppContentFileUploadState](../resources/intune-apps-mobileappcontentfileuploadstate.md)|Indicates the state of the current upload request. Possible values are: success, transientError, error, unknown, azureStorageUriRequestSuccess, azureStorageUriRequestPending, azureStorageUriRequestFailed, azureStorageUriRequestTimedOut, azureStorageUriRenewalSuccess, azureStorageUriRenewalPending, azureStorageUriRenewalFailed, azureStorageUriRenewalTimedOut, commitFileSuccess, commitFilePending, commitFileFailed, commitFileTimedOut. Default value is success. This property is read-only. Possible values are: `success`, `transientError`, `error`, `unknown`, `azureStorageUriRequestSuccess`, `azureStorageUriRequestPending`, `azureStorageUriRequestFailed`, `azureStorageUriRequestTimedOut`, `azureStorageUriRenewalSuccess`, `azureStorageUriRenewalPending`, `azureStorageUriRenewalFailed`, `azureStorageUriRenewalTimedOut`, `commitFileSuccess`, `commitFilePending`, `commitFileFailed`, `commitFileTimedOut`.| +|isDependency|Boolean|Indicates whether this content file is a dependency for the main content file. TRUE means that the content file is a dependency, FALSE means that the content file is not a dependency and is the main content file. Defaults to FALSE.| If successful, this method returns a `201 Created` response code and a [mobileAp ### Request Here is an example of the request.--<!-- { "blockType": "ignored" , "name" : "intune_apps_mobileappcontentfile_create_create_mobileappcontentfile" }--> ``` http POST https://graph.microsoft.com/v1.0/deviceAppManagement/mobileApps/{mobileAppId}/contentVersions/{mobileAppContentId}/files Content-type: application/json-Content-length: 342 +Content-length: 419 { "@odata.type": "#microsoft.graph.mobileAppContentFile", Content-length: 342 "name": "Name value", "size": 4, "sizeEncrypted": 13,+ "sizeInBytes": 11, + "sizeEncryptedInBytes": 4, "azureStorageUriExpirationDateTime": "2017-01-01T00:00:08.4940464-08:00", "manifest": "bWFuaWZlc3Q=",- "uploadState": "transientError" + "uploadState": "transientError", + "isDependency": true } ``` ### 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.--<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.mobileAppContentFile" }--> ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 450 +Content-Length: 527 { "@odata.type": "#microsoft.graph.mobileAppContentFile", Content-Length: 450 "name": "Name value", "size": 4, "sizeEncrypted": 13,+ "sizeInBytes": 11, + "sizeEncryptedInBytes": 4, "azureStorageUriExpirationDateTime": "2017-01-01T00:00:08.4940464-08:00", "manifest": "bWFuaWZlc3Q=",- "uploadState": "transientError" + "uploadState": "transientError", + "isDependency": true } ``` |
v1.0 | Intune Apps Mobileappcontentfile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-apps-mobileappcontentfile-get.md | Namespace: microsoft.graph Read properties and relationships of the [mobileAppContentFile](../resources/intune-apps-mobileappcontentfile.md) object. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). If successful, this method returns a `200 OK` response code and [mobileAppConten ### Request Here is an example of the request.--<!-- { "blockType": "ignored" , "name" : "intune_apps_mobileappcontentfile_get_get_mobileappcontentfile" }--> ``` http GET https://graph.microsoft.com/v1.0/deviceAppManagement/mobileApps/{mobileAppId}/contentVersions/{mobileAppContentId}/files/{mobileAppContentFileId} ``` ### 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.--<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.mobileAppContentFile" }--> ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 491 +Content-Length: 574 { "value": { Content-Length: 491 "name": "Name value", "size": 4, "sizeEncrypted": 13,+ "sizeInBytes": 11, + "sizeEncryptedInBytes": 4, "azureStorageUriExpirationDateTime": "2017-01-01T00:00:08.4940464-08:00", "manifest": "bWFuaWZlc3Q=",- "uploadState": "transientError" + "uploadState": "transientError", + "isDependency": true } } ``` |
v1.0 | Intune Apps Mobileappcontentfile List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-apps-mobileappcontentfile-list.md | Namespace: microsoft.graph List properties and relationships of the [mobileAppContentFile](../resources/intune-apps-mobileappcontentfile.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). If successful, this method returns a `200 OK` response code and a collection of ### Request Here is an example of the request.--<!-- { "blockType": "ignored" , "name" : "intune_apps_mobileappcontentfile_list_list_mobileappcontentfiles" }--> ``` http GET https://graph.microsoft.com/v1.0/deviceAppManagement/mobileApps/{mobileAppId}/contentVersions/{mobileAppContentId}/files ``` ### 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.--<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.mobileAppContentFile" }--> ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 527 +Content-Length: 616 { "value": [ Content-Length: 527 "sizeEncrypted": 13, "azureStorageUriExpirationDateTime": "2017-01-01T00:00:08.4940464-08:00", "manifest": "bWFuaWZlc3Q=",- "uploadState": "transientError" + "uploadState": "transientError", + "isDependency": true } ] } |
v1.0 | Intune Apps Mobileappcontentfile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-apps-mobileappcontentfile-update.md | Namespace: microsoft.graph Update the properties of a [mobileAppContentFile](../resources/intune-apps-mobileappcontentfile.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). The following table shows the properties that are required when you create the [ |Property|Type|Description| |:|:|:|-|azureStorageUri|String|The Azure Storage URI.| -|isCommitted|Boolean|A value indicating whether the file is committed.| -|id|String|The File Id.| -|createdDateTime|DateTimeOffset|The time the file was created.| -|name|String|the file name.| -|size|Int64|The size of the file prior to encryption.| -|sizeEncrypted|Int64|The size of the file after encryption.| -|azureStorageUriExpirationDateTime|DateTimeOffset|The time the Azure storage Uri expires.| -|manifest|Binary|The manifest information.| -|uploadState|[mobileAppContentFileUploadState](../resources/intune-apps-mobileappcontentfileuploadstate.md)|The state of the current upload request. Possible values are: `success`, `transientError`, `error`, `unknown`, `azureStorageUriRequestSuccess`, `azureStorageUriRequestPending`, `azureStorageUriRequestFailed`, `azureStorageUriRequestTimedOut`, `azureStorageUriRenewalSuccess`, `azureStorageUriRenewalPending`, `azureStorageUriRenewalFailed`, `azureStorageUriRenewalTimedOut`, `commitFileSuccess`, `commitFilePending`, `commitFileFailed`, `commitFileTimedOut`.| +|azureStorageUri|String|Indicates the Azure Storage URI that the file is uploaded to. Created by the service upon receiving a valid mobileAppContentFile. Read-only. This property is read-only.| +|isCommitted|Boolean|A value indicating whether the file is committed. A committed app content file has been fully uploaded and validated by the Intune service. TRUE means that app content file is committed, FALSE means that app content file is not committed. Defaults to FALSE. Read-only. This property is read-only.| +|id|String|The unique identifier for this mobileAppContentFile. This id is assigned during creation of the mobileAppContentFile. Read-only. This property is read-only.| +|createdDateTime|DateTimeOffset|Indicates created date and time associated with app content file, in ISO 8601 format. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Read-only. This property is read-only.| +|name|String|Indicates the name of the file.| +|size|Int64|The size of the file prior to encryption. To be deprecated, please use sizeInBytes property instead.| +|sizeEncrypted|Int64|The size of the file after encryption. To be deprecated, please use sizeEncryptedInBytes property instead.| +|sizeInBytes|Int64|Indicates the original size of the file, in bytes. Valid values 0 to 9.22337203685478E+18| +|sizeEncryptedInBytes|Int64|Indicates the size of the file after encryption, in bytes. Valid values 0 to 9.22337203685478E+18| +|azureStorageUriExpirationDateTime|DateTimeOffset|Indicates the date and time when the Azure storage URI expires, in ISO 8601 format. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Read-only. This property is read-only.| +|manifest|Binary|Indicates the manifest information, containing file metadata.| +|uploadState|[mobileAppContentFileUploadState](../resources/intune-apps-mobileappcontentfileuploadstate.md)|Indicates the state of the current upload request. Possible values are: success, transientError, error, unknown, azureStorageUriRequestSuccess, azureStorageUriRequestPending, azureStorageUriRequestFailed, azureStorageUriRequestTimedOut, azureStorageUriRenewalSuccess, azureStorageUriRenewalPending, azureStorageUriRenewalFailed, azureStorageUriRenewalTimedOut, commitFileSuccess, commitFilePending, commitFileFailed, commitFileTimedOut. Default value is success. This property is read-only. Possible values are: `success`, `transientError`, `error`, `unknown`, `azureStorageUriRequestSuccess`, `azureStorageUriRequestPending`, `azureStorageUriRequestFailed`, `azureStorageUriRequestTimedOut`, `azureStorageUriRenewalSuccess`, `azureStorageUriRenewalPending`, `azureStorageUriRenewalFailed`, `azureStorageUriRenewalTimedOut`, `commitFileSuccess`, `commitFilePending`, `commitFileFailed`, `commitFileTimedOut`.| +|isDependency|Boolean|Indicates whether this content file is a dependency for the main content file. TRUE means that the content file is a dependency, FALSE means that the content file is not a dependency and is the main content file. Defaults to FALSE.| If successful, this method returns a `200 OK` response code and an updated [mobi ### Request Here is an example of the request.--<!-- { "blockType": "ignored" , "name" : "intune_apps_mobileappcontentfile_update_update_mobileappcontentfile" }--> ``` http PATCH https://graph.microsoft.com/v1.0/deviceAppManagement/mobileApps/{mobileAppId}/contentVersions/{mobileAppContentId}/files/{mobileAppContentFileId} Content-type: application/json-Content-length: 342 +Content-length: 419 { "@odata.type": "#microsoft.graph.mobileAppContentFile", Content-length: 342 "sizeEncrypted": 13, "azureStorageUriExpirationDateTime": "2017-01-01T00:00:08.4940464-08:00", "manifest": "bWFuaWZlc3Q=",- "uploadState": "transientError" + "uploadState": "transientError", + "isDependency": true } ``` ### 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.--<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.mobileAppContentFile" }--> ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 450 +Content-Length: 527 { "@odata.type": "#microsoft.graph.mobileAppContentFile", Content-Length: 450 "name": "Name value", "size": 4, "sizeEncrypted": 13,+ "sizeInBytes": 11, + "sizeEncryptedInBytes": 4, "azureStorageUriExpirationDateTime": "2017-01-01T00:00:08.4940464-08:00", "manifest": "bWFuaWZlc3Q=",- "uploadState": "transientError" + "uploadState": "transientError", + "isDependency": true } ``` |
v1.0 | Intune Devices Manageddevice Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-devices-manageddevice-create.md | The following table shows the properties that are required when you create the m |notes|String|Notes on the device created by IT Admin. Default is null. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported.| |ethernetMacAddress|String|Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only.| |physicalMemoryInBytes|Int64|Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only.|+|enrollmentProfileName|String|Name of the enrollment profile assigned to the device. Default value is empty string, indicating no enrollment profile was assgined. This property is read-only.| Here is an example of the request. ``` http POST https://graph.microsoft.com/v1.0/deviceManagement/managedDevices Content-type: application/json-Content-length: 4942 +Content-length: 5058 { "@odata.type": "#microsoft.graph.managedDevice", Content-length: 4942 "udid": "Udid value", "notes": "Notes value", "ethernetMacAddress": "Ethernet Mac Address value",- "physicalMemoryInBytes": 5 + "physicalMemoryInBytes": 5, + "enrollmentProfileName": "Enrollment Profile Name value" } ``` Content-length: 4942 ### 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. +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. <!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.managedDevice" }--> ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 4991 +Content-Length: 5107 { "@odata.type": "#microsoft.graph.managedDevice", Content-Length: 4991 "udid": "Udid value", "notes": "Notes value", "ethernetMacAddress": "Ethernet Mac Address value",- "physicalMemoryInBytes": 5 + "physicalMemoryInBytes": 5, + "enrollmentProfileName": "Enrollment Profile Name value" } ``` |
v1.0 | Intune Devices Manageddevice Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-devices-manageddevice-get.md | GET /deviceManagement/detectedApps/{detectedAppId}/managedDevices/{managedDevice GET /deviceManagement/detectedApps/{detectedAppId}/managedDevices/{managedDeviceId}/users/{userId}/managedDevices/{managedDeviceId} ``` +## Optional query parameters +This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. + ## Request headers |Header|Value| |:|:| If successful, this method returns a `200 OK` response code and [managedDevice]( ### Request Here is an example of the request.--# [HTTP](#tab/http) -<!-- { "blockType": "request" , "name" : "intune_devices_manageddevice_get_get_manageddevice" }--> ``` http GET https://graph.microsoft.com/v1.0/deviceManagement/managedDevices/{managedDeviceId} ``` -# [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 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.--<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.managedDevice" }--> ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 5220 +Content-Length: 5340 { "value": { Content-Length: 5220 "udid": "Udid value", "notes": "Notes value", "ethernetMacAddress": "Ethernet Mac Address value",- "physicalMemoryInBytes": 5 + "physicalMemoryInBytes": 5, + "enrollmentProfileName": "Enrollment Profile Name value" } } ``` |
v1.0 | Intune Devices Manageddevice List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-devices-manageddevice-list.md | If successful, this method returns a `200 OK` response code and a collection of ### Request Here is an example of the request.--# [HTTP](#tab/http) -<!-- { "blockType": "request" , "name" : "intune_devices_manageddevice_list_list_manageddevices" }--> ``` http GET https://graph.microsoft.com/v1.0/deviceManagement/managedDevices ``` -# [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 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.--<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.managedDevice" }--> ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 5444 +Content-Length: 5568 { "value": [ Content-Length: 5444 "udid": "Udid value", "notes": "Notes value", "ethernetMacAddress": "Ethernet Mac Address value",- "physicalMemoryInBytes": 5 + "physicalMemoryInBytes": 5, + "enrollmentProfileName": "Enrollment Profile Name value" } ] } |
v1.0 | Intune Devices Manageddevice Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-devices-manageddevice-update.md | The following table shows the properties that are required when you create the [ |notes|String|Notes on the device created by IT Admin. Default is null. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported.| |ethernetMacAddress|String|Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only.| |physicalMemoryInBytes|Int64|Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only.|+|enrollmentProfileName|String|Name of the enrollment profile assigned to the device. Default value is empty string, indicating no enrollment profile was assgined. This property is read-only.| If successful, this method returns a `200 OK` response code and an updated [mana ### Request Here is an example of the request.--# [HTTP](#tab/http) -<!-- { "blockType": "request" , "name" : "intune_devices_manageddevice_update_update_manageddevice" }--> ``` http PATCH https://graph.microsoft.com/v1.0/deviceManagement/managedDevices/{managedDeviceId} Content-type: application/json-Content-length: 4942 +Content-length: 5058 { "@odata.type": "#microsoft.graph.managedDevice", Content-length: 4942 "udid": "Udid value", "notes": "Notes value", "ethernetMacAddress": "Ethernet Mac Address value",- "physicalMemoryInBytes": 5 + "physicalMemoryInBytes": 5, + "enrollmentProfileName": "Enrollment Profile Name value" } ``` -# [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 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.--<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.managedDevice" }--> ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 4991 +Content-Length: 5107 { "@odata.type": "#microsoft.graph.managedDevice", Content-Length: 4991 "udid": "Udid value", "notes": "Notes value", "ethernetMacAddress": "Ethernet Mac Address value",- "physicalMemoryInBytes": 5 + "physicalMemoryInBytes": 5, + "enrollmentProfileName": "Enrollment Profile Name value" } ``` |
v1.0 | Intune Devices Manageddeviceoverview Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-devices-manageddeviceoverview-get.md | If successful, this method returns a `200 OK` response code and [managedDeviceOv ### Request Here is an example of the request.--# [HTTP](#tab/http) -<!-- { "blockType": "request" , "name" : "intune_devices_manageddeviceoverview_get_get_manageddeviceoverview" }--> ``` http GET https://graph.microsoft.com/v1.0/deviceManagement/managedDeviceOverview ``` -# [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 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.--<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.managedDeviceOverview" }--> ``` http HTTP/1.1 200 OK Content-Type: application/json |
v1.0 | Intune Devices Manageddeviceoverview Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-devices-manageddeviceoverview-update.md | Namespace: microsoft.graph Update the properties of a [managedDeviceOverview](../resources/intune-devices-manageddeviceoverview.md) object. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). If successful, this method returns a `200 OK` response code and an updated [mana ### Request Here is an example of the request.--# [HTTP](#tab/http) -<!-- { "blockType": "request" , "name" : "intune_devices_manageddeviceoverview_update_update_manageddeviceoverview" }--> ``` http PATCH https://graph.microsoft.com/v1.0/deviceManagement/managedDeviceOverview Content-type: application/json Content-length: 900 } ``` -# [JavaScript](#tab/javascript) --- ### 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.--<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.managedDeviceOverview" }--> ``` http HTTP/1.1 200 OK Content-Type: application/json |
v1.0 | Intune Mstunnel Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-devicemanagement-get.md | - Title: "Get deviceManagement" -description: "Read properties and relationships of the deviceManagement object." --localization_priority: Normal --doc_type: apiPageType ---# Get deviceManagement --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-mstunnel-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-mstunnel-devicemanagement.md) object in the response body. --## Example --### Request -Here is an example of the request. --# [HTTP](#tab/http) -<!-- { "blockType": "request" , "name" : "intune_mstunnel_devicemanagement_get_get_devicemanagement" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement -``` --# [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 -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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.deviceManagement" }--> -``` 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 Mstunnel Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-devicemanagement-update.md | - Title: "Update deviceManagement" -description: "Update the properties of a deviceManagement object." --localization_priority: Normal --doc_type: apiPageType ---# Update deviceManagement --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-mstunnel-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-mstunnel-devicemanagement.md) object. --The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-mstunnel-devicemanagement.md). --|Property|Type|Description| -|:|:|:| -|id|String|Not yet documented| ----## Response -If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-mstunnel-devicemanagement.md) object in the response body. --## Example --### Request -Here is an example of the request. --# [HTTP](#tab/http) -<!-- { "blockType": "request" , "name" : "intune_mstunnel_devicemanagement_update_update_devicemanagement" }--> -``` http -PATCH https://graph.microsoft.com/v1.0/deviceManagement -Content-type: application/json -Content-length: 58 --{ - "@odata.type": "#microsoft.graph.deviceManagement" -} -``` --# [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 -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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.deviceManagement" }--> -``` 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 Mstunnel Microsofttunnelconfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelconfiguration-create.md | - Title: "Create microsoftTunnelConfiguration" -description: "Create a new microsoftTunnelConfiguration object." --localization_priority: Normal --doc_type: apiPageType ---# Create microsoftTunnelConfiguration --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 [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). --|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/microsoftTunnelConfigurations -``` --## 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 microsoftTunnelConfiguration object. --The following table shows the properties that are required when you create the microsoftTunnelConfiguration. --|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the configuration id. Supports: $delete, $update. $Insert, $skip, $top is not supported. Read-only.| -|displayName|String|The display name for the server configuration. This property is required when a server is created.| -|description|String|The configuration's description (optional)| -|network|String|The subnet that will be used to allocate virtual address for the clients| -|dnsServers|String collection|The DNS servers that will be used by the clients| -|defaultDomainSuffix|String|The Default Domain appendix that will be used by the clients| -|routeIncludes|String collection|The routes that will be routed by the server| -|routeExcludes|String collection|Subsets of the routes that will not be routed by the server| -|splitDNS|String collection|The domains that will be resolved using the provided dns servers| -|listenPort|Int32|The port that both TCP and UPD will listen over on the server| -|advancedSettings|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|Additional settings that may be applied to the server| -|lastUpdateDateTime|DateTimeOffset|When the configuration was last updated| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance| -|disableUdpConnections|Boolean|When DisableUdpConnections is set, the clients and VPN server will not use DTLS connections to transfer data.| ----## Response -If successful, this method returns a `201 Created` response code and a [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelconfiguration_create_create_microsofttunnelconfiguration" }--> -``` http -POST https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelConfigurations -Content-type: application/json -Content-length: 782 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelConfiguration", - "displayName": "Display Name value", - "description": "Description value", - "network": "Network value", - "dnsServers": [ - "Dns Servers value" - ], - "defaultDomainSuffix": "Default Domain Suffix value", - "routeIncludes": [ - "Route Includes value" - ], - "routeExcludes": [ - "Route Excludes value" - ], - "splitDNS": [ - "Split DNS value" - ], - "listenPort": 10, - "advancedSettings": [ - { - "@odata.type": "microsoft.graph.keyValuePair", - "name": "Name value", - "value": "Value value" - } - ], - "lastUpdateDateTime": "2016-12-31T23:58:21.6459442-08:00", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "disableUdpConnections": true -} -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelConfiguration" }--> -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 831 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelConfiguration", - "id": "b8bdb469-b469-b8bd-69b4-bdb869b4bdb8", - "displayName": "Display Name value", - "description": "Description value", - "network": "Network value", - "dnsServers": [ - "Dns Servers value" - ], - "defaultDomainSuffix": "Default Domain Suffix value", - "routeIncludes": [ - "Route Includes value" - ], - "routeExcludes": [ - "Route Excludes value" - ], - "splitDNS": [ - "Split DNS value" - ], - "listenPort": 10, - "advancedSettings": [ - { - "@odata.type": "microsoft.graph.keyValuePair", - "name": "Name value", - "value": "Value value" - } - ], - "lastUpdateDateTime": "2016-12-31T23:58:21.6459442-08:00", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "disableUdpConnections": true -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelconfiguration-delete.md | - Title: "Delete microsoftTunnelConfiguration" -description: "Deletes a microsoftTunnelConfiguration." --localization_priority: Normal --doc_type: apiPageType ---# Delete microsoftTunnelConfiguration --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 [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). --|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/microsoftTunnelConfigurations/{microsoftTunnelConfigurationId} -DELETE /deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelConfiguration -``` --## 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. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelconfiguration_delete_delete_microsofttunnelconfiguration" }--> -``` http -DELETE https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelConfigurations/{microsoftTunnelConfigurationId} -``` --### 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. --<!-- { "blockType": "response"}--> -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelconfiguration-get.md | - Title: "Get microsoftTunnelConfiguration" -description: "Read properties and relationships of the microsoftTunnelConfiguration object." --localization_priority: Normal --doc_type: apiPageType ---# Get microsoftTunnelConfiguration --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 [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). --|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/microsoftTunnelConfigurations/{microsoftTunnelConfigurationId} -GET /deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelConfiguration -``` --## 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 [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelconfiguration_get_get_microsofttunnelconfiguration" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelConfigurations/{microsoftTunnelConfigurationId} -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelConfiguration" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 912 --{ - "value": { - "@odata.type": "#microsoft.graph.microsoftTunnelConfiguration", - "id": "b8bdb469-b469-b8bd-69b4-bdb869b4bdb8", - "displayName": "Display Name value", - "description": "Description value", - "network": "Network value", - "dnsServers": [ - "Dns Servers value" - ], - "defaultDomainSuffix": "Default Domain Suffix value", - "routeIncludes": [ - "Route Includes value" - ], - "routeExcludes": [ - "Route Excludes value" - ], - "splitDNS": [ - "Split DNS value" - ], - "listenPort": 10, - "advancedSettings": [ - { - "@odata.type": "microsoft.graph.keyValuePair", - "name": "Name value", - "value": "Value value" - } - ], - "lastUpdateDateTime": "2016-12-31T23:58:21.6459442-08:00", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "disableUdpConnections": true - } -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelconfiguration-list.md | - Title: "List microsoftTunnelConfigurations" -description: "List properties and relationships of the microsoftTunnelConfiguration objects." --localization_priority: Normal --doc_type: apiPageType ---# List microsoftTunnelConfigurations --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 [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). --|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/microsoftTunnelConfigurations -``` --## 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 [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) objects in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelconfiguration_list_list_microsofttunnelconfigurations" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelConfigurations -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelConfiguration" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 988 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.microsoftTunnelConfiguration", - "id": "b8bdb469-b469-b8bd-69b4-bdb869b4bdb8", - "displayName": "Display Name value", - "description": "Description value", - "network": "Network value", - "dnsServers": [ - "Dns Servers value" - ], - "defaultDomainSuffix": "Default Domain Suffix value", - "routeIncludes": [ - "Route Includes value" - ], - "routeExcludes": [ - "Route Excludes value" - ], - "splitDNS": [ - "Split DNS value" - ], - "listenPort": 10, - "advancedSettings": [ - { - "@odata.type": "microsoft.graph.keyValuePair", - "name": "Name value", - "value": "Value value" - } - ], - "lastUpdateDateTime": "2016-12-31T23:58:21.6459442-08:00", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "disableUdpConnections": true - } - ] -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelconfiguration-update.md | - Title: "Update microsoftTunnelConfiguration" -description: "Update the properties of a microsoftTunnelConfiguration object." --localization_priority: Normal --doc_type: apiPageType ---# Update microsoftTunnelConfiguration --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 [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). --|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/microsoftTunnelConfigurations/{microsoftTunnelConfigurationId} -PATCH /deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelConfiguration -``` --## 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 [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) object. --The following table shows the properties that are required when you create the [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md). --|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the configuration id. Supports: $delete, $update. $Insert, $skip, $top is not supported. Read-only.| -|displayName|String|The display name for the server configuration. This property is required when a server is created.| -|description|String|The configuration's description (optional)| -|network|String|The subnet that will be used to allocate virtual address for the clients| -|dnsServers|String collection|The DNS servers that will be used by the clients| -|defaultDomainSuffix|String|The Default Domain appendix that will be used by the clients| -|routeIncludes|String collection|The routes that will be routed by the server| -|routeExcludes|String collection|Subsets of the routes that will not be routed by the server| -|splitDNS|String collection|The domains that will be resolved using the provided dns servers| -|listenPort|Int32|The port that both TCP and UPD will listen over on the server| -|advancedSettings|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|Additional settings that may be applied to the server| -|lastUpdateDateTime|DateTimeOffset|When the configuration was last updated| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance| -|disableUdpConnections|Boolean|When DisableUdpConnections is set, the clients and VPN server will not use DTLS connections to transfer data.| ----## Response -If successful, this method returns a `200 OK` response code and an updated [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelconfiguration_update_update_microsofttunnelconfiguration" }--> -``` http -PATCH https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelConfigurations/{microsoftTunnelConfigurationId} -Content-type: application/json -Content-length: 782 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelConfiguration", - "displayName": "Display Name value", - "description": "Description value", - "network": "Network value", - "dnsServers": [ - "Dns Servers value" - ], - "defaultDomainSuffix": "Default Domain Suffix value", - "routeIncludes": [ - "Route Includes value" - ], - "routeExcludes": [ - "Route Excludes value" - ], - "splitDNS": [ - "Split DNS value" - ], - "listenPort": 10, - "advancedSettings": [ - { - "@odata.type": "microsoft.graph.keyValuePair", - "name": "Name value", - "value": "Value value" - } - ], - "lastUpdateDateTime": "2016-12-31T23:58:21.6459442-08:00", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "disableUdpConnections": true -} -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelConfiguration" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 831 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelConfiguration", - "id": "b8bdb469-b469-b8bd-69b4-bdb869b4bdb8", - "displayName": "Display Name value", - "description": "Description value", - "network": "Network value", - "dnsServers": [ - "Dns Servers value" - ], - "defaultDomainSuffix": "Default Domain Suffix value", - "routeIncludes": [ - "Route Includes value" - ], - "routeExcludes": [ - "Route Excludes value" - ], - "splitDNS": [ - "Split DNS value" - ], - "listenPort": 10, - "advancedSettings": [ - { - "@odata.type": "microsoft.graph.keyValuePair", - "name": "Name value", - "value": "Value value" - } - ], - "lastUpdateDateTime": "2016-12-31T23:58:21.6459442-08:00", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "disableUdpConnections": true -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelhealththreshold-create.md | - Title: "Create microsoftTunnelHealthThreshold" -description: "Create a new microsoftTunnelHealthThreshold object." --localization_priority: Normal --doc_type: apiPageType ---# Create microsoftTunnelHealthThreshold --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 [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). --|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/microsoftTunnelHealthThresholds -``` --## 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 microsoftTunnelHealthThreshold object. --The following table shows the properties that are required when you create the microsoftTunnelHealthThreshold. --|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the metric name. Supports: $delete, $update. $Insert, $skip, $top is not supported. Read-only.| -|healthyThreshold|Int64|The threshold for being healthy based on default health status metrics: CPU usage healthy < 50%, Memory usage healthy < 50%, Disk space healthy > 5GB, Latency healthy < 10ms, health metrics can be customized.| -|unhealthyThreshold|Int64|The threshold for being unhealthy based on default health status metrics: CPU usage unhealthy > 75%, Memory usage unhealthy > 75%, Disk space < 3GB, Latency Unhealthy > 20ms, health metrics can be customized.| -|defaultHealthyThreshold|Int64|The threshold for being healthy based on default health status metrics: CPU usage healthy < 50%, Memory usage healthy < 50%, Disk space healthy > 5GB, Latency healthy < 10ms, health metrics can be customized. Read-only.| -|defaultUnhealthyThreshold|Int64|The threshold for being unhealthy based on default health status metrics: CPU usage unhealthy > 75%, Memory usage unhealthy > 75%, Disk space < 3GB, Latency unhealthy > 20ms, health metrics can be customized. Read-only.| ----## Response -If successful, this method returns a `201 Created` response code and a [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelhealththreshold_create_create_microsofttunnelhealththreshold" }--> -``` http -POST https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelHealthThresholds -Content-type: application/json -Content-length: 194 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelHealthThreshold", - "healthyThreshold": 0, - "unhealthyThreshold": 2, - "defaultHealthyThreshold": 7, - "defaultUnhealthyThreshold": 9 -} -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelHealthThreshold" }--> -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 243 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelHealthThreshold", - "id": "419c526e-526e-419c-6e52-9c416e529c41", - "healthyThreshold": 0, - "unhealthyThreshold": 2, - "defaultHealthyThreshold": 7, - "defaultUnhealthyThreshold": 9 -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelhealththreshold-delete.md | - Title: "Delete microsoftTunnelHealthThreshold" -description: "Deletes a microsoftTunnelHealthThreshold." --localization_priority: Normal --doc_type: apiPageType ---# Delete microsoftTunnelHealthThreshold --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 [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). --|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/microsoftTunnelHealthThresholds/{microsoftTunnelHealthThresholdId} -``` --## 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. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelhealththreshold_delete_delete_microsofttunnelhealththreshold" }--> -``` http -DELETE https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelHealthThresholds/{microsoftTunnelHealthThresholdId} -``` --### 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. --<!-- { "blockType": "response"}--> -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelhealththreshold-get.md | - Title: "Get microsoftTunnelHealthThreshold" -description: "Read properties and relationships of the microsoftTunnelHealthThreshold object." --localization_priority: Normal --doc_type: apiPageType ---# Get microsoftTunnelHealthThreshold --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 [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). --|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/microsoftTunnelHealthThresholds/{microsoftTunnelHealthThresholdId} -``` --## 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 [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelhealththreshold_get_get_microsofttunnelhealththreshold" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelHealthThresholds/{microsoftTunnelHealthThresholdId} -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelHealthThreshold" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 274 --{ - "value": { - "@odata.type": "#microsoft.graph.microsoftTunnelHealthThreshold", - "id": "419c526e-526e-419c-6e52-9c416e529c41", - "healthyThreshold": 0, - "unhealthyThreshold": 2, - "defaultHealthyThreshold": 7, - "defaultUnhealthyThreshold": 9 - } -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelhealththreshold-list.md | - Title: "List microsoftTunnelHealthThresholds" -description: "List properties and relationships of the microsoftTunnelHealthThreshold objects." --localization_priority: Normal --doc_type: apiPageType ---# List microsoftTunnelHealthThresholds --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 [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). --|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/microsoftTunnelHealthThresholds -``` --## 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 [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) objects in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelhealththreshold_list_list_microsofttunnelhealththresholds" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelHealthThresholds -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelHealthThreshold" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 300 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.microsoftTunnelHealthThreshold", - "id": "419c526e-526e-419c-6e52-9c416e529c41", - "healthyThreshold": 0, - "unhealthyThreshold": 2, - "defaultHealthyThreshold": 7, - "defaultUnhealthyThreshold": 9 - } - ] -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelhealththreshold-update.md | - Title: "Update microsoftTunnelHealthThreshold" -description: "Update the properties of a microsoftTunnelHealthThreshold object." --localization_priority: Normal --doc_type: apiPageType ---# Update microsoftTunnelHealthThreshold --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 [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). --|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/microsoftTunnelHealthThresholds/{microsoftTunnelHealthThresholdId} -``` --## 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 [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) object. --The following table shows the properties that are required when you create the [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md). --|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the metric name. Supports: $delete, $update. $Insert, $skip, $top is not supported. Read-only.| -|healthyThreshold|Int64|The threshold for being healthy based on default health status metrics: CPU usage healthy < 50%, Memory usage healthy < 50%, Disk space healthy > 5GB, Latency healthy < 10ms, health metrics can be customized.| -|unhealthyThreshold|Int64|The threshold for being unhealthy based on default health status metrics: CPU usage unhealthy > 75%, Memory usage unhealthy > 75%, Disk space < 3GB, Latency Unhealthy > 20ms, health metrics can be customized.| -|defaultHealthyThreshold|Int64|The threshold for being healthy based on default health status metrics: CPU usage healthy < 50%, Memory usage healthy < 50%, Disk space healthy > 5GB, Latency healthy < 10ms, health metrics can be customized. Read-only.| -|defaultUnhealthyThreshold|Int64|The threshold for being unhealthy based on default health status metrics: CPU usage unhealthy > 75%, Memory usage unhealthy > 75%, Disk space < 3GB, Latency unhealthy > 20ms, health metrics can be customized. Read-only.| ----## Response -If successful, this method returns a `200 OK` response code and an updated [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelhealththreshold_update_update_microsofttunnelhealththreshold" }--> -``` http -PATCH https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelHealthThresholds/{microsoftTunnelHealthThresholdId} -Content-type: application/json -Content-length: 194 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelHealthThreshold", - "healthyThreshold": 0, - "unhealthyThreshold": 2, - "defaultHealthyThreshold": 7, - "defaultUnhealthyThreshold": 9 -} -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelHealthThreshold" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 243 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelHealthThreshold", - "id": "419c526e-526e-419c-6e52-9c416e529c41", - "healthyThreshold": 0, - "unhealthyThreshold": 2, - "defaultHealthyThreshold": 7, - "defaultUnhealthyThreshold": 9 -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserver Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserver-create.md | - Title: "Create microsoftTunnelServer" -description: "Create a new microsoftTunnelServer object." --localization_priority: Normal --doc_type: apiPageType ---# Create microsoftTunnelServer --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 [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). --|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/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers -``` --## 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 microsoftTunnelServer object. --The following table shows the properties that are required when you create the microsoftTunnelServer. --|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the managed server. This id is assigned at enrollment time. Supports: $delete. $Update, $insert, $skip, $top is not supported. Read-only.| -|displayName|String|The display name for the server. This property is required when a server is created and cannot be cleared during updates.| -|tunnelServerHealthStatus|[microsoftTunnelServerHealthStatus](../resources/intune-mstunnel-microsofttunnelserverhealthstatus.md)|Indicates the server's health Status as of the last evaluation time. Health is evaluated every 60 seconds, and the possible values are: unknown, healthy, unhealthy, warning, offline, upgradeInProgress, upgradeFailed. Possible values are: `unknown`, `healthy`, `unhealthy`, `warning`, `offline`, `upgradeInProgress`, `upgradeFailed`, `unknownFutureValue`.| -|lastCheckinDateTime|DateTimeOffset|Indicates when the server last checked in| -|agentImageDigest|String|The digest of the current agent image running on this server| -|serverImageDigest|String|The digest of the current server image running on this server| ----## Response -If successful, this method returns a `201 Created` response code and a [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserver_create_create_microsofttunnelserver" }--> -``` http -POST https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers -Content-type: application/json -Content-length: 312 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelServer", - "displayName": "Display Name value", - "tunnelServerHealthStatus": "healthy", - "lastCheckinDateTime": "2017-01-01T00:02:46.0431416-08:00", - "agentImageDigest": "Agent Image Digest value", - "serverImageDigest": "Server Image Digest 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelServer" }--> -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 361 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelServer", - "id": "b5cf0aee-0aee-b5cf-ee0a-cfb5ee0acfb5", - "displayName": "Display Name value", - "tunnelServerHealthStatus": "healthy", - "lastCheckinDateTime": "2017-01-01T00:02:46.0431416-08:00", - "agentImageDigest": "Agent Image Digest value", - "serverImageDigest": "Server Image Digest value" -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserver Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserver-delete.md | - Title: "Delete microsoftTunnelServer" -description: "Deletes a microsoftTunnelServer." --localization_priority: Normal --doc_type: apiPageType ---# Delete microsoftTunnelServer --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 [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). --|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/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers/{microsoftTunnelServerId} -``` --## 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. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserver_delete_delete_microsofttunnelserver" }--> -``` http -DELETE https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers/{microsoftTunnelServerId} -``` --### 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. --<!-- { "blockType": "response"}--> -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Mstunnel Microsofttunnelserver Generateserverlogcollectionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserver-generateserverlogcollectionrequest.md | - Title: "generateServerLogCollectionRequest action" -description: "Not yet documented" --localization_priority: Normal --doc_type: apiPageType ---# generateServerLogCollectionRequest action --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. --Not yet documented --## Permissions -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/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers/{microsoftTunnelServerId}/generateServerLogCollectionRequest -``` --## 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| -|:|:|:| -|startDateTime|DateTimeOffset|Not yet documented| -|endDateTime|DateTimeOffset|Not yet documented| ----## Response -If successful, this action returns a `200 OK` response code and a [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserver_generateserverlogcollectionrequest_generateserverlogcollectionrequest_action" }--> -``` http -POST https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers/{microsoftTunnelServerId}/generateServerLogCollectionRequest -Content-type: application/json -Content-length: 115 --{ - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelServerLogCollectionResponse" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 481 --{ - "value": { - "@odata.type": "#microsoft.graph.microsoftTunnelServerLogCollectionResponse", - "id": "05dcc2e9-c2e9-05dc-e9c2-dc05e9c2dc05", - "status": "completed", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "sizeInBytes": 11, - "serverId": "Server Id value", - "requestDateTime": "2017-01-01T00:03:07.1589002-08:00", - "expiryDateTime": "2017-01-01T00:03:32.5199332-08:00" - } -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserver Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserver-get.md | - Title: "Get microsoftTunnelServer" -description: "Read properties and relationships of the microsoftTunnelServer object." --localization_priority: Normal --doc_type: apiPageType ---# Get microsoftTunnelServer --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 [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). --|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/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers/{microsoftTunnelServerId} -``` --## 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 [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserver_get_get_microsofttunnelserver" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers/{microsoftTunnelServerId} -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelServer" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 394 --{ - "value": { - "@odata.type": "#microsoft.graph.microsoftTunnelServer", - "id": "b5cf0aee-0aee-b5cf-ee0a-cfb5ee0acfb5", - "displayName": "Display Name value", - "tunnelServerHealthStatus": "healthy", - "lastCheckinDateTime": "2017-01-01T00:02:46.0431416-08:00", - "agentImageDigest": "Agent Image Digest value", - "serverImageDigest": "Server Image Digest value" - } -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserver List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserver-list.md | - Title: "List microsoftTunnelServers" -description: "List properties and relationships of the microsoftTunnelServer objects." --localization_priority: Normal --doc_type: apiPageType ---# List microsoftTunnelServers --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 [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). --|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/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers -``` --## 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 [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) objects in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserver_list_list_microsofttunnelservers" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelServer" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 422 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.microsoftTunnelServer", - "id": "b5cf0aee-0aee-b5cf-ee0a-cfb5ee0acfb5", - "displayName": "Display Name value", - "tunnelServerHealthStatus": "healthy", - "lastCheckinDateTime": "2017-01-01T00:02:46.0431416-08:00", - "agentImageDigest": "Agent Image Digest value", - "serverImageDigest": "Server Image Digest value" - } - ] -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserver Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserver-update.md | - Title: "Update microsoftTunnelServer" -description: "Update the properties of a microsoftTunnelServer object." --localization_priority: Normal --doc_type: apiPageType ---# Update microsoftTunnelServer --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 [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). --|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/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers/{microsoftTunnelServerId} -``` --## 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 [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) object. --The following table shows the properties that are required when you create the [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md). --|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the managed server. This id is assigned at enrollment time. Supports: $delete. $Update, $insert, $skip, $top is not supported. Read-only.| -|displayName|String|The display name for the server. This property is required when a server is created and cannot be cleared during updates.| -|tunnelServerHealthStatus|[microsoftTunnelServerHealthStatus](../resources/intune-mstunnel-microsofttunnelserverhealthstatus.md)|Indicates the server's health Status as of the last evaluation time. Health is evaluated every 60 seconds, and the possible values are: unknown, healthy, unhealthy, warning, offline, upgradeInProgress, upgradeFailed. Possible values are: `unknown`, `healthy`, `unhealthy`, `warning`, `offline`, `upgradeInProgress`, `upgradeFailed`, `unknownFutureValue`.| -|lastCheckinDateTime|DateTimeOffset|Indicates when the server last checked in| -|agentImageDigest|String|The digest of the current agent image running on this server| -|serverImageDigest|String|The digest of the current server image running on this server| ----## Response -If successful, this method returns a `200 OK` response code and an updated [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserver_update_update_microsofttunnelserver" }--> -``` http -PATCH https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers/{microsoftTunnelServerId} -Content-type: application/json -Content-length: 312 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelServer", - "displayName": "Display Name value", - "tunnelServerHealthStatus": "healthy", - "lastCheckinDateTime": "2017-01-01T00:02:46.0431416-08:00", - "agentImageDigest": "Agent Image Digest value", - "serverImageDigest": "Server Image Digest 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelServer" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 361 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelServer", - "id": "b5cf0aee-0aee-b5cf-ee0a-cfb5ee0acfb5", - "displayName": "Display Name value", - "tunnelServerHealthStatus": "healthy", - "lastCheckinDateTime": "2017-01-01T00:02:46.0431416-08:00", - "agentImageDigest": "Agent Image Digest value", - "serverImageDigest": "Server Image Digest value" -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-create.md | - Title: "Create microsoftTunnelServerLogCollectionResponse" -description: "Create a new microsoftTunnelServerLogCollectionResponse object." --localization_priority: Normal --doc_type: apiPageType ---# Create microsoftTunnelServerLogCollectionResponse --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 [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). --|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/microsoftTunnelServerLogCollectionResponses -``` --## 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 microsoftTunnelServerLogCollectionResponse object. --The following table shows the properties that are required when you create the microsoftTunnelServerLogCollectionResponse. --|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for server log collection response. Read-only.| -|status|[microsoftTunnelLogCollectionStatus](../resources/intune-mstunnel-microsofttunnellogcollectionstatus.md)|The status of log collection. Possible values are: pending, completed, failed. Possible values are: `pending`, `completed`, `failed`, `unknownFutureValue`.| -|startDateTime|DateTimeOffset|The start time of the logs collected| -|endDateTime|DateTimeOffset|The end time of the logs collected| -|sizeInBytes|Int64|The size of the logs in bytes| -|serverId|String|ID of the server the log collection is requested upon| -|requestDateTime|DateTimeOffset|The time when the log collection was requested| -|expiryDateTime|DateTimeOffset|The time when the log collection is expired| ----## Response -If successful, this method returns a `201 Created` response code and a [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserverlogcollectionresponse_create_create_microsofttunnelserverlogcollectionresponse" }--> -``` http -POST https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelServerLogCollectionResponses -Content-type: application/json -Content-length: 395 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelServerLogCollectionResponse", - "status": "completed", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "sizeInBytes": 11, - "serverId": "Server Id value", - "requestDateTime": "2017-01-01T00:03:07.1589002-08:00", - "expiryDateTime": "2017-01-01T00:03:32.5199332-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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelServerLogCollectionResponse" }--> -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 444 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelServerLogCollectionResponse", - "id": "05dcc2e9-c2e9-05dc-e9c2-dc05e9c2dc05", - "status": "completed", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "sizeInBytes": 11, - "serverId": "Server Id value", - "requestDateTime": "2017-01-01T00:03:07.1589002-08:00", - "expiryDateTime": "2017-01-01T00:03:32.5199332-08:00" -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-delete.md | - Title: "Delete microsoftTunnelServerLogCollectionResponse" -description: "Deletes a microsoftTunnelServerLogCollectionResponse." --localization_priority: Normal --doc_type: apiPageType ---# Delete microsoftTunnelServerLogCollectionResponse --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 [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). --|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/microsoftTunnelServerLogCollectionResponses/{microsoftTunnelServerLogCollectionResponseId} -``` --## 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. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserverlogcollectionresponse_delete_delete_microsofttunnelserverlogcollectionresponse" }--> -``` http -DELETE https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelServerLogCollectionResponses/{microsoftTunnelServerLogCollectionResponseId} -``` --### 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. --<!-- { "blockType": "response"}--> -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Generatedownloadurl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-generatedownloadurl.md | - Title: "generateDownloadUrl action" -description: "Not yet documented" --localization_priority: Normal --doc_type: apiPageType ---# generateDownloadUrl action --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. --Not yet documented --## Permissions -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/microsoftTunnelServerLogCollectionResponses/{microsoftTunnelServerLogCollectionResponseId}/generateDownloadUrl -``` --## 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 String in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserverlogcollectionresponse_generatedownloadurl_generatedownloadurl_action" }--> -``` http -POST https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelServerLogCollectionResponses/{microsoftTunnelServerLogCollectionResponseId}/generateDownloadUrl -``` --### 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. --<!-- { "blockType": "response" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 59 --{ - "value": "https://example.com/generateDownloadUrl/" -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-get.md | - Title: "Get microsoftTunnelServerLogCollectionResponse" -description: "Read properties and relationships of the microsoftTunnelServerLogCollectionResponse object." --localization_priority: Normal --doc_type: apiPageType ---# Get microsoftTunnelServerLogCollectionResponse --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 [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). --|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/microsoftTunnelServerLogCollectionResponses/{microsoftTunnelServerLogCollectionResponseId} -``` --## 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 [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserverlogcollectionresponse_get_get_microsofttunnelserverlogcollectionresponse" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelServerLogCollectionResponses/{microsoftTunnelServerLogCollectionResponseId} -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelServerLogCollectionResponse" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 481 --{ - "value": { - "@odata.type": "#microsoft.graph.microsoftTunnelServerLogCollectionResponse", - "id": "05dcc2e9-c2e9-05dc-e9c2-dc05e9c2dc05", - "status": "completed", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "sizeInBytes": 11, - "serverId": "Server Id value", - "requestDateTime": "2017-01-01T00:03:07.1589002-08:00", - "expiryDateTime": "2017-01-01T00:03:32.5199332-08:00" - } -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-list.md | - Title: "List microsoftTunnelServerLogCollectionResponses" -description: "List properties and relationships of the microsoftTunnelServerLogCollectionResponse objects." --localization_priority: Normal --doc_type: apiPageType ---# List microsoftTunnelServerLogCollectionResponses --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 [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). --|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/microsoftTunnelServerLogCollectionResponses -``` --## 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 [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) objects in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserverlogcollectionresponse_list_list_microsofttunnelserverlogcollectionresponses" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelServerLogCollectionResponses -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelServerLogCollectionResponse" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 513 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.microsoftTunnelServerLogCollectionResponse", - "id": "05dcc2e9-c2e9-05dc-e9c2-dc05e9c2dc05", - "status": "completed", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "sizeInBytes": 11, - "serverId": "Server Id value", - "requestDateTime": "2017-01-01T00:03:07.1589002-08:00", - "expiryDateTime": "2017-01-01T00:03:32.5199332-08:00" - } - ] -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-update.md | - Title: "Update microsoftTunnelServerLogCollectionResponse" -description: "Update the properties of a microsoftTunnelServerLogCollectionResponse object." --localization_priority: Normal --doc_type: apiPageType ---# Update microsoftTunnelServerLogCollectionResponse --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 [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). --|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/microsoftTunnelServerLogCollectionResponses/{microsoftTunnelServerLogCollectionResponseId} -``` --## 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 [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) object. --The following table shows the properties that are required when you create the [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md). --|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for server log collection response. Read-only.| -|status|[microsoftTunnelLogCollectionStatus](../resources/intune-mstunnel-microsofttunnellogcollectionstatus.md)|The status of log collection. Possible values are: pending, completed, failed. Possible values are: `pending`, `completed`, `failed`, `unknownFutureValue`.| -|startDateTime|DateTimeOffset|The start time of the logs collected| -|endDateTime|DateTimeOffset|The end time of the logs collected| -|sizeInBytes|Int64|The size of the logs in bytes| -|serverId|String|ID of the server the log collection is requested upon| -|requestDateTime|DateTimeOffset|The time when the log collection was requested| -|expiryDateTime|DateTimeOffset|The time when the log collection is expired| ----## Response -If successful, this method returns a `200 OK` response code and an updated [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelserverlogcollectionresponse_update_update_microsofttunnelserverlogcollectionresponse" }--> -``` http -PATCH https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelServerLogCollectionResponses/{microsoftTunnelServerLogCollectionResponseId} -Content-type: application/json -Content-length: 395 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelServerLogCollectionResponse", - "status": "completed", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "sizeInBytes": 11, - "serverId": "Server Id value", - "requestDateTime": "2017-01-01T00:03:07.1589002-08:00", - "expiryDateTime": "2017-01-01T00:03:32.5199332-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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelServerLogCollectionResponse" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 444 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelServerLogCollectionResponse", - "id": "05dcc2e9-c2e9-05dc-e9c2-dc05e9c2dc05", - "status": "completed", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "sizeInBytes": 11, - "serverId": "Server Id value", - "requestDateTime": "2017-01-01T00:03:07.1589002-08:00", - "expiryDateTime": "2017-01-01T00:03:32.5199332-08:00" -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelsite Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelsite-create.md | - Title: "Create microsoftTunnelSite" -description: "Create a new microsoftTunnelSite object." --localization_priority: Normal --doc_type: apiPageType ---# Create microsoftTunnelSite --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 [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). --|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/microsoftTunnelSites -``` --## 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 microsoftTunnelSite object. --The following table shows the properties that are required when you create the microsoftTunnelSite. --|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the site id. $Insert, $skip, $top is not supported. Read-only.| -|displayName|String|The display name for the site. This property is required when a site is created.| -|description|String|The site's description (optional)| -|publicAddress|String|The site's public domain name or IP address| -|upgradeWindowUtcOffsetInMinutes|Int32|The site's timezone represented as a minute offset from UTC| -|upgradeWindowStartTime|TimeOfDay|The site's upgrade window start time of day| -|upgradeWindowEndTime|TimeOfDay|The site's upgrade window end time of day| -|upgradeAutomatically|Boolean|The site's automatic upgrade setting. True for automatic upgrades, false for manual control| -|upgradeAvailable|Boolean|The site provides the state of when an upgrade is available| -|internalNetworkProbeUrl|String|The site's Internal Network Access Probe URL| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance| ----## Response -If successful, this method returns a `201 Created` response code and a [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelsite_create_create_microsofttunnelsite" }--> -``` http -POST https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites -Content-type: application/json -Content-length: 524 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelSite", - "displayName": "Display Name value", - "description": "Description value", - "publicAddress": "Public Address value", - "upgradeWindowUtcOffsetInMinutes": 15, - "upgradeWindowStartTime": "12:01:27.3030000", - "upgradeWindowEndTime": "11:57:17.9830000", - "upgradeAutomatically": true, - "upgradeAvailable": true, - "internalNetworkProbeUrl": "https://example.com/internalNetworkProbeUrl/", - "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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelSite" }--> -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 573 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelSite", - "id": "b2f7dc3e-dc3e-b2f7-3edc-f7b23edcf7b2", - "displayName": "Display Name value", - "description": "Description value", - "publicAddress": "Public Address value", - "upgradeWindowUtcOffsetInMinutes": 15, - "upgradeWindowStartTime": "12:01:27.3030000", - "upgradeWindowEndTime": "11:57:17.9830000", - "upgradeAutomatically": true, - "upgradeAvailable": true, - "internalNetworkProbeUrl": "https://example.com/internalNetworkProbeUrl/", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ] -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelsite Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelsite-delete.md | - Title: "Delete microsoftTunnelSite" -description: "Deletes a microsoftTunnelSite." --localization_priority: Normal --doc_type: apiPageType ---# Delete microsoftTunnelSite --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 [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). --|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/microsoftTunnelSites/{microsoftTunnelSiteId} -``` --## 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. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelsite_delete_delete_microsofttunnelsite" }--> -``` http -DELETE https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId} -``` --### 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. --<!-- { "blockType": "response"}--> -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Mstunnel Microsofttunnelsite Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelsite-get.md | - Title: "Get microsoftTunnelSite" -description: "Read properties and relationships of the microsoftTunnelSite object." --localization_priority: Normal --doc_type: apiPageType ---# Get microsoftTunnelSite --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 [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). --|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/microsoftTunnelSites/{microsoftTunnelSiteId} -``` --## 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 [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelsite_get_get_microsofttunnelsite" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId} -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelSite" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 620 --{ - "value": { - "@odata.type": "#microsoft.graph.microsoftTunnelSite", - "id": "b2f7dc3e-dc3e-b2f7-3edc-f7b23edcf7b2", - "displayName": "Display Name value", - "description": "Description value", - "publicAddress": "Public Address value", - "upgradeWindowUtcOffsetInMinutes": 15, - "upgradeWindowStartTime": "12:01:27.3030000", - "upgradeWindowEndTime": "11:57:17.9830000", - "upgradeAutomatically": true, - "upgradeAvailable": true, - "internalNetworkProbeUrl": "https://example.com/internalNetworkProbeUrl/", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ] - } -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelsite List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelsite-list.md | - Title: "List microsoftTunnelSites" -description: "List properties and relationships of the microsoftTunnelSite objects." --localization_priority: Normal --doc_type: apiPageType ---# List microsoftTunnelSites --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 [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). --|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/microsoftTunnelSites -``` --## 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 [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) objects in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelsite_list_list_microsofttunnelsites" }--> -``` http -GET https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites -``` --### 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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelSite" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 662 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.microsoftTunnelSite", - "id": "b2f7dc3e-dc3e-b2f7-3edc-f7b23edcf7b2", - "displayName": "Display Name value", - "description": "Description value", - "publicAddress": "Public Address value", - "upgradeWindowUtcOffsetInMinutes": 15, - "upgradeWindowStartTime": "12:01:27.3030000", - "upgradeWindowEndTime": "11:57:17.9830000", - "upgradeAutomatically": true, - "upgradeAvailable": true, - "internalNetworkProbeUrl": "https://example.com/internalNetworkProbeUrl/", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ] - } - ] -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelsite Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/intune-mstunnel-microsofttunnelsite-update.md | - Title: "Update microsoftTunnelSite" -description: "Update the properties of a microsoftTunnelSite object." --localization_priority: Normal --doc_type: apiPageType ---# Update microsoftTunnelSite --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 [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). --|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/microsoftTunnelSites/{microsoftTunnelSiteId} -``` --## 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 [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) object. --The following table shows the properties that are required when you create the [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md). --|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the site id. $Insert, $skip, $top is not supported. Read-only.| -|displayName|String|The display name for the site. This property is required when a site is created.| -|description|String|The site's description (optional)| -|publicAddress|String|The site's public domain name or IP address| -|upgradeWindowUtcOffsetInMinutes|Int32|The site's timezone represented as a minute offset from UTC| -|upgradeWindowStartTime|TimeOfDay|The site's upgrade window start time of day| -|upgradeWindowEndTime|TimeOfDay|The site's upgrade window end time of day| -|upgradeAutomatically|Boolean|The site's automatic upgrade setting. True for automatic upgrades, false for manual control| -|upgradeAvailable|Boolean|The site provides the state of when an upgrade is available| -|internalNetworkProbeUrl|String|The site's Internal Network Access Probe URL| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance| ----## Response -If successful, this method returns a `200 OK` response code and an updated [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) object in the response body. --## Example --### Request -Here is an example of the request. --<!-- { "blockType": "request" , "name" : "intune_mstunnel_microsofttunnelsite_update_update_microsofttunnelsite" }--> -``` http -PATCH https://graph.microsoft.com/v1.0/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId} -Content-type: application/json -Content-length: 524 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelSite", - "displayName": "Display Name value", - "description": "Description value", - "publicAddress": "Public Address value", - "upgradeWindowUtcOffsetInMinutes": 15, - "upgradeWindowStartTime": "12:01:27.3030000", - "upgradeWindowEndTime": "11:57:17.9830000", - "upgradeAutomatically": true, - "upgradeAvailable": true, - "internalNetworkProbeUrl": "https://example.com/internalNetworkProbeUrl/", - "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. --<!-- { "blockType": "response" , "@odata.type" : "microsoft.graph.microsoftTunnelSite" }--> -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 573 --{ - "@odata.type": "#microsoft.graph.microsoftTunnelSite", - "id": "b2f7dc3e-dc3e-b2f7-3edc-f7b23edcf7b2", - "displayName": "Display Name value", - "description": "Description value", - "publicAddress": "Public Address value", - "upgradeWindowUtcOffsetInMinutes": 15, - "upgradeWindowStartTime": "12:01:27.3030000", - "upgradeWindowEndTime": "11:57:17.9830000", - "upgradeAutomatically": true, - "upgradeAvailable": true, - "internalNetworkProbeUrl": "https://example.com/internalNetworkProbeUrl/", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ] -} -``` |
v1.0 | Itemanalytics Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/itemanalytics-get.md | GET /drives/{drive-id}/items/{item-id}/analytics/lastSevenDays GET /sites/{site-id}/analytics/lastSevenDays GET /sites/{site-id}/lists/{list-id}/items/{item-id}/analytics/lastSevenDays ```++> [!NOTE] +> The value for `{item-id}` in the `/sites/{site-id}/lists/{list-id}/items/{item-id}` request is the `listItemUniqueId`. To get the `listItemUniqueId` of an item, call the `/sites/{site-id}/lists/{list-id}/items/{item-id}?$select=sharepointIds` endpoint. For details, see [sharePointIds](/graph/api/resources/sharepointids). + ## Optional query parameters This method supports the [OData query parameters](/graph/query-parameters) to help customize the response. |
v1.0 | Learningcontent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/learningcontent-get.md | Content-type: application/json "numberOfPages": 10, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": [ Content-type: application/json "numberOfPages": 10, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": [ |
v1.0 | Learningcontent Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/learningcontent-update.md | PATCH /employeeExperience/learningProviders/{learningProviderId}/learningContent |duration|Duration|The duration of the learning content in seconds. The value is represented in ISO 8601 format for durations. Optional.| |externalId|String|Unique external content ID for the learning content. Required.| |format|String|The format of the learning content. For example, `Course`, `Video`, `Book`, `Book Summary`, `Audiobook Summary`. Optional.|+|level|Level|The difficulty level of the learning content. Possible values are: `Beginner`, `Intermediate`, `Advanced`. Optional.| |isActive|Boolean|Indicates whether the content is active or not. Inactive content doesn't show up in the UI. The default value is `true`. Optional.| |isPremium|Boolean|Indicates whether the learning content requires the user to sign-in on the learning provider platform or not. The default value is `false`. Optional.| |isSearchable|Boolean|Indicates whether the learning content is searchable or not. The default value is `true`. Optional.| Content-Type: application/json "numberOfPages": 9, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00Z", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": [ Content-Type: application/json "numberOfPages": 9, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": [ Content-Type: application/json "numberOfPages": 9, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": [ Content-Type: application/json "numberOfPages": 9, "duration": "PT20M", "format": "Book",+ "level": "Beginner", "createdDateTime": "2018-01-01T00:00:00", "lastModifiedDateTime": "2021-04-01T04:26:06.1995367Z", "contributors": [ |
v1.0 | Learningprovider List Learningcontents | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/learningprovider-list-learningcontents.md | HTTP/1.1 200 OK Content-Type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#learningProviders('13727311-e7bb-470d-8b20-6a23d9030d70')/learningContents", + "@odata.context": "https://graph.microsoft.com/beta/$metadata#learningProviders('13727311-e7bb-470d-8b20-6a23d9030d70')/learningContents", + "@odata.nextLink": "https://graph.microsoft.com/beta/$metadata#learningProviders('13727311-e7bb-470d-8b20-6a23d9030d70')/learningContents?skip=2&top=2", + "@odata.count": 10, "value": [ { "id": "99029577-a660-46b6-ba58-3ce4d21d5f50", |
v1.0 | Licensedetails Getteamslicensingdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/licensedetails-getteamslicensingdetails.md | + + Title: "licenseDetails: getTeamsLicensingDetails" +description: "Get the license status of a user in Microsoft Teams." ++ms.localizationpriority: high ++++# licenseDetails: getTeamsLicensingDetails ++Namespace: microsoft.graph ++Get the license status of a [user](../resources/user.md) in Microsoft Teams. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "licensedetails_getteamslicensingdetails" } --> ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +GET /users/{user-id}/licenseDetails/getTeamsLicensingDetails +``` ++## 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 along with a [teamsLicensingDetails](../resources/teamslicensingdetails.md) object. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "user_get_teams_licensing_details", + "sampleKeys": ["2f39ffba-51ca-4d2d-a66f-a020a83ce208"] +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/users/2f39ffba-51ca-4d2d-a66f-a020a83ce208/licenseDetails/getTeamsLicensingDetails +``` ++# [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.teamsLicensingDetails" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.teamsLicensingDetails", + "hasTeamsLicense": true +} +``` ++## Related content ++- [Get userTeamwork](userteamwork-get.md) +- [Get teamwork](teamwork-get.md) |
v1.0 | Listitem Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/listitem-delta.md | ++ +description: "Get newly created, updated, or deleted list items without having to perform a full read of the entire items collection." + Title: "listItem: delta" +ms.localizationpriority: "medium" +++# listItem: delta ++Namespace: microsoft.graph ++Get newly created, updated, or deleted [list items](../resources/listitem.md) without having to perform a full read of the entire items collection. ++Your app begins by calling `delta` without any parameters. +The service starts enumerating the hierarchy of the list, returning pages of items, and either an **@odata.nextLink** or an **@odata.deltaLink**. +Your app should continue calling with the **@odata.nextLink** until you see an **@odata.deltaLink** returned. ++After you received all the changes, you can apply them to your local state. +To check for changes in the future, call `delta` again with the **@odata.deltaLink** from the previous response. ++The delta feed shows the latest state for each item, not each change. If an item was renamed twice, it only shows up once, with its latest name. +The same item might appear more than once in a delta feed, for various reasons. You should use the last occurrence you see. ++Items with this property should be removed from your local state. ++> **Note:** You should only delete a folder locally if it's empty after syncing all the changes. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "listitem_delta" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +GET /sites/{siteId}/lists/{listId}/items/delta +``` ++## Query parameters ++In the request URL, you can include the following optional query parameter. ++| Parameter | Type | Description | +|:-|:-|:-| +| token | String | If unspecified, enumerates the current state of the hierarchy. If `latest`, returns an empty response with the latest delta token. If a previous delta token, returns a new state since that token.| ++This method also supports the `$select`, `$expand`, and `$top` [OData query parameters](/graph/query-parameters) to customize the response. ++## 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 [listItem](../resources/listitem.md) objects in the response body. ++In addition to a collection of **listItem** objects, the response also includes one of the following properties. ++| Name | Value | Description | +|:--|:-|:| +| @odata.nextLink | URL | A URL to retrieve the next available page of changes if there are more changes in the current set. | +| @odata.deltaLink | URL | A URL returned instead of **@odata.nextLink** after all current changes have been returned. Use this property to read the next set of changes in the future. | ++In some cases, the service returns a `410 Gone` response code with an error response that contains one of the following error codes, and a `Location` header that contains a new `nextLink` that starts a fresh delta enumeration. This occurs when the service can't provide a list of changes for a given token; for example, if a client tries to reuse an old token after being disconnected for a long time, or if the server state has changed and a new token is required. ++After the full enumeration is completed, compare the returned items with your local state and follow the instructions based on the error type. ++| Error type | Instructions | +|:-|:-| +| resyncChangesApplyDifferences | Replace any local items with the versions from the server (including deletes) if you're sure that the service was up-to-date with your local changes when you last synchronized. Upload any local changes that the server doesn't know about. | +| resyncChangesUploadDifferences | Upload any local items that the service didn't return and upload any items that differ from the versions from the server. Keep both copies if you're not sure which one is more up-to-date. | ++In addition to the resync errors and for more details about how errors are returned, see [Microsoft Graph error responses and resource types](/graph/errors). ++## Examples ++### Example 1: Initial request ++The following example shows an initial request and how to call this API to establish your local state. ++#### Request ++The following example shows an initial request. ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "get_listItem_delta_first", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE", "22e03ef3-6ef4-424d-a1d3-92a337807c30"] } --> ++```msgraph-interactive +GET https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta +``` ++# [C#](#tab/csharp) ++# [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 that includes the first page of changes and the **@odata.nextLink** property that indicates that no more items are available in the current set of items. Your app should continue to request the URL value of **@odata.nextLink** until all pages of items have been retrieved. ++<!-- { "blockType": "response", "name": "get_listItem_delta_first", "@odata.type": "Collection(microsoft.graph.listItem)", "truncated": true, "scope": "site.read" } --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "value": [ + { + "createdDateTime": "2020-06-02T22:46:58Z", + "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"", + "id": "1", + "lastModifiedDateTime": "2021-10-14T23:27:27Z", + "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder", + "createdBy": { + "user": { + "displayName": "John doe" + } + }, + "parentReference": { + "id": "1", + "path": "Shared%20Documents", + "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" + }, + "contentType": { + "id": "0x00123456789abc", + "name": "Folder" + } + }, + { + "createdDateTime": "2020-06-02T22:46:58Z", + "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC067},756\"", + "id": "2", + "lastModifiedDateTime": "2021-10-14T23:27:27Z", + "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemA.txt", + "createdBy": { + "user": { + "displayName": "John doe" + } + }, + "parentReference": { + "id": "2", + "path": "Shared%20Documents", + "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" + }, + "contentType": { + "id": "0x00123456789abc", + "name": "Document" + } + }, + { + "createdDateTime": "2020-06-02T22:46:58Z", + "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC068},756\"", + "id": "3", + "lastModifiedDateTime": "2021-10-14T23:27:27Z", + "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemB.txt", + "createdBy": { + "user": { + "displayName": "John doe" + } + }, + "parentReference": { + "id": "3", + "path": "Shared%20Documents", + "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" + }, + "contentType": { + "id": "0x00123456789abc", + "name": "Document" + } + } + ], + "@odata.nextLink": "https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka" +} +``` ++### Example 2: Last page request ++The following example shows a request that gets the last page in a set and how to call this API to update your local state. ++#### Request ++The following example shows a request after the initial request. ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "get-listItem-delta-last", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE","22e03ef3-6ef4-424d-a1d3-92a337807c30"] }--> ++```msgraph-interactive +GET https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka +``` ++# [C#](#tab/csharp) ++# [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 that indicates that the item named `TestItemB.txt` was deleted and the item `TestFolder` was either added or modified between the initial request and this request to update the local state. ++The final page of items includes the **@odata.deltaLink** property that provides the URL that can be used later to retrieve changes since the current set of items. ++<!-- { "blockType": "response", "name": "get-listItem-delta-last", "truncated": true, "@odata.type": "Collection(microsoft.graph.listItem)", "scope": "site.read" } --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "value": [ + { + "createdDateTime": "2020-06-02T22:46:58Z", + "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"", + "id": "1", + "lastModifiedDateTime": "2016-03-21T20:01:37Z", + "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder", + "createdBy": { + "user": { + "displayName": "John doe" + } + }, + "parentReference": { + "id": "1", + "path": "Shared%20Documents", + "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" + }, + "contentType": { + "id": "0x00123456789abc", + "name": "Folder" + } + }, + { + "id": "3", + "parentReference": { + "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066" + }, + "contentType": { + "id": "0x00123456789abc", + "name": "Document" + }, + "deleted": { + "state": "deleted" + } + } + ], + "@odata.deltaLink": "https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka" +} +``` ++### Example 3: Delta link request ++In some scenarios, you might want to request the current `deltaLink` value without first enumerating all of the items in the list already. This can be useful if your app only wants to know about changes and doesn't need to know about existing items. +To retrieve the latest `deltaLink`, call `delta` with the query string parameter `?token=latest`. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "get-delta-latest_datalink_tokenislatest", "scope": "sites.read", "target": "action", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE","22e03ef3-6ef4-424d-a1d3-92a337807c30"] } --> ++```msgraph-interactive +GET https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=latest +``` ++# [C#](#tab/csharp) ++# [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", "name": "get-delta-latest_datalink_tokenislatest", "isEmpty": true, "@odata.type": "Collection(microsoft.graph.listItem)" } --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "value": [ ], + "@odata.deltaLink": "https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka" +} +``` ++## Related content +- [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) +- [Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance) ++<!-- { + "type": "#page.annotation", + "description": "Sync changes from the service to your client state.", + "keywords": "sync,delta,changes,$delta", + "section": "documentation", + "tocPath": "ListItem/Get delta" +} --> |
v1.0 | M365appsinstallationoptions Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/m365appsinstallationoptions-get.md | Namespace: microsoft.graph Read the properties and relationships of an [m365AppsInstallationOptions](../resources/m365appsInstallationoptions.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). GET https://graph.microsoft.com/v1.0/admin/microsoft365Apps/installationOptions - ### Response The following example shows a response. >**Note:** The response object shown here might be shortened for readability. |
v1.0 | M365appsinstallationoptions Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/m365appsinstallationoptions-update.md | Namespace: microsoft.graph Update the properties of an [m365AppsInstallationOptions](../resources/m365appsInstallationoptions.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). |
v1.0 | Mailfolder Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/mailfolder-get.md | GET /users/{id | userPrincipalName}/mailFolders/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.+ ## Request headers-| Name | Type | Description| -|:--|:|:-| -| Authorization | string | Bearer {token}. Required. | ++|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. |
v1.0 | Meetingattendancereport Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/meetingattendancereport-get.md | GET /me/onlineMeetings/{meetingId}/attendanceReports/{reportId} GET /users/{userId}/onlineMeetings/{meetingId}/attendanceReports/{reportId} ``` -To get an attendance report for a webinar session by ID: +To get an attendance report for a webinar session by ID with delegated and app permission: <!-- { "blockType": "ignored" }--> ``` http GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports/{reportId} |
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 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] > GET /me/onlineMeetings/{meetingId}/attendanceReports GET /users/{userId}/onlineMeetings/{meetingId}/attendanceReports ``` -To get all attendance reports for a webinar session: +To get all attendance reports for a webinar session with delegated and app permission: <!-- { "blockType": "ignored" } --> ``` http GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports |
v1.0 | Multitenantorganization Delete Tenants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganization-delete-tenants.md | + + Title: "Remove multiTenantOrganizationMember" +description: "Remove a tenant from a multitenant organization." ++ms.localizationpriority: medium ++++# Remove multiTenantOrganizationMember +Namespace: microsoft.graph ++Remove a tenant from a multitenant organization. A tenant can be removed in the following scenarios: ++* An active member tenant can remove itself. +* An active owner tenant can remove any other tenant. +* An active owner tenant can remove itself as long as there is another active owner tenant remaining. +* An active owner tenant can remove itself as long as there is no other active tenant remaining, thereby deleting the entire multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganization_delete_tenants" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /tenantRelationships/multiTenantOrganization/tenants/{tenantId} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++The following example removes a tenant from a multitenant organization. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_multitenantorganizationmember" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/tenants/5036a0a0-a7a4-4933-9086-5dd54535dd6e +``` ++# [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 | Multitenantorganization Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganization-get.md | + + Title: "Get multiTenantOrganization" +description: "Get properties of the multitenant organization." ++ms.localizationpriority: medium ++++# Get multiTenantOrganization +Namespace: microsoft.graph ++Get properties of the multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganization_get" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /tenantRelationships/multiTenantOrganization +``` ++## Optional query parameters +This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [multiTenantOrganization](../resources/multitenantorganization.md) object in the response body. ++## Examples ++The following example gets properties of the multitenant organization. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_multitenantorganization" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization +``` ++# [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, + "@odata.type": "microsoft.graph.multiTenantOrganization" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/$entity", + "id": "6d8b39e5-039a-4034-bf3a-e0b4f8cd60b6", + "createdDateTime": "2023-05-26T22:05:23Z", + "displayName": "Contoso organization", + "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank", + "state": "active" +} +``` ++The following response shows when the requesting tenant is not part of any multitenant organization. ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "createdDateTime": null, + "displayName": null, + "description": null, + "state": "inactive" +} +``` + |
v1.0 | Multitenantorganization List Tenants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganization-list-tenants.md | + + Title: "List multiTenantOrganizationMembers" +description: "List the tenants and their properties in the multitenant organization." ++ms.localizationpriority: medium ++++# List multiTenantOrganizationMembers +Namespace: microsoft.graph ++List the tenants and their properties in the multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganization_list_tenants" } --> ++If called with MultiTenantOrganization.Read.All or MultiTenantOrganization.ReadWrite.All permissions, this API returns both active and pending tenants. If called with MultiTenantOrganization.ReadBasic.All permission, the caller can only read the **displayName** and **tenantId** properties. +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /tenantRelationships/multiTenantOrganization/tenants +``` ++## 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). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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 [multiTenantOrganizationMember](../resources/multitenantorganizationmember.md) objects in the response body. ++## Examples ++The following example lists the tenants and their properties in the multitenant organization. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_multitenantorganizationmember" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/tenants +``` ++# [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, + "@odata.type": "Collection(microsoft.graph.multiTenantOrganizationMember)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/tenants", + "value": [ + { + "tenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "displayName": "Contoso", + "addedDateTime": "2023-05-26T22:05:23Z", + "joinedDateTime": null, + "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "role": "owner", + "state": "active", + "transitionDetails": null + }, + { + "tenantId": "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad", + "displayName": "Fabrikam", + "addedDateTime": "2023-05-27T19:24:29Z", + "joinedDateTime": null, + "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "role": "member", + "state": "pending", + "transitionDetails": null + }, + { + "tenantId": "5036a0a0-a7a4-4933-9086-5dd54535dd6e", + "displayName": "Woodgrove Bank", + "addedDateTime": "2023-05-27T20:41:56Z", + "joinedDateTime": null, + "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "role": "member", + "state": "pending", + "transitionDetails": null + } + ] +} +``` + |
v1.0 | Multitenantorganization Post Tenants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganization-post-tenants.md | + + Title: "Add multiTenantOrganizationMember" +description: "Add a tenant to a multitenant organization." ++ms.localizationpriority: medium ++++# Add multiTenantOrganizationMember +Namespace: microsoft.graph ++Add a tenant to a multitenant organization. The administrator of an owner tenant has the permissions to add tenants to the multitenant organization. The added tenant is in the pending state until the administrator of the added tenant joins the multitenant organization by submitting a join request. A tenant can be part of only one multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganization_post_tenants" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /tenantRelationships/multiTenantOrganization/tenants +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [multiTenantOrganizationMember](../resources/multitenantorganizationmember.md) object. ++You can specify the following properties when creating a **multiTenantOrganizationMember**. ++|Property|Type|Description| +|:|:|:| +|tenantId|String|Tenant ID of the Microsoft Entra tenant to add to the multitenant organization. Required.| +|displayName|String|Display name of the tenant added to the multitenant organization. Currently, can't be changed once set. Required.| +|role|multiTenantOrganizationMemberRole|Role of the tenant in the multitenant organization. The possible values are: `owner`, `member` (default), `unknownFutureValue`. Optional.| +++## Response ++If successful, this method returns a `201 Created` response code and a [multiTenantOrganizationMember](../resources/multitenantorganizationmember.md) object in the response body. If the tenant is already pending or active in this multitenant organization, you get a 'Request_BadRequest' error. ++## Examples ++The following example adds the Fabrikam tenant to the multitenant organization. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_multitenantorganizationmember_from_" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/tenants +Content-Type: application/json ++{ + "tenantId": "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad", + "displayName": "Fabrikam" +} +``` ++# [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, + "@odata.type": "microsoft.graph.multiTenantOrganizationMember" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/tenants/$entity", + "tenantId": "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad", + "displayName": "Fabrikam", + "addedDateTime": "2023-05-27T19:24:29Z", + "joinedDateTime": null, + "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "role": "member", + "state": "pending", + "transitionDetails": null +} +``` ++If tenant is already pending or active in this multitenant organization, you get a 'Request_BadRequest' error. ++```http +HTTP/1.1 400 Bad Request +Content-Type: application/json ++{ + "error": { + "code": "Request_BadRequest", + "message": "Tenant is already being added in Multi-Tenant Organization.", + "innerError": { + "date": "2023-05-27T20:56:14", + "request-id": "a1e5973c-66f1-4853-9e3d-39e6b4f606d1", + "client-request-id": "651548c3-e864-4509-837b-4f5d4cf546a5" + } + } +} +``` |
v1.0 | Multitenantorganization Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganization-update.md | + + Title: "Update multiTenantOrganization" +description: "Update the properties of a multitenant organization." ++ms.localizationpriority: medium ++++# Update multiTenantOrganization +Namespace: microsoft.graph ++Update the properties of a multitenant organization. ++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganization_update" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /tenantRelationships/multiTenantOrganization +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|displayName|String|Display name of the multitenant organization. Optional.| +|description|String|Description of the multitenant organization. Optional.| ++++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++The following example updates the description and display name for a multitenant organization. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_multitenantorganization" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization +Content-Type: application/json ++{ + "displayName": "Contoso organization", + "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank" +} +``` ++# [JavaScript](#tab/javascript) ++++### Response ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Multitenantorganizationidentitysyncpolicytemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganizationidentitysyncpolicytemplate-get.md | + + Title: "Get multiTenantOrganizationIdentitySyncPolicyTemplate" +description: "Get the cross-tenant access policy template with user synchronization settings for a multitenant organization." ++ms.localizationpriority: medium ++++# Get multiTenantOrganizationIdentitySyncPolicyTemplate +Namespace: microsoft.graph ++Get the cross-tenant access policy template with user synchronization settings for a multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganizationidentitysyncpolicytemplate_get" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization +``` ++## Optional query parameters +This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [multiTenantOrganizationIdentitySyncPolicyTemplate](../resources/multitenantorganizationidentitysyncpolicytemplate.md) object in the response body. ++## Examples ++The following example gets the user synchronization settings of the template. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_multitenantorganizationidentitysyncpolicytemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization +``` ++# [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 response shows the unconfigured (or reset) state of the cross-tenant access policy template for user synchronization settings for multitenant organization tenants. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization/$entity", + "templateApplicationLevel": "newPartners,existingPartners", + "id": "0e7aad84-cb46-4b8e-a881-522ef25939f1", + "userSyncInbound": { + "isSyncAllowed": null + } +} +``` ++The following example response shows a configured state of the cross-tenant access policy template for user synchronization settings, after inbound user synchronization has been configured. ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization/$entity", + "id": "e1a11ff3-01f1-4c48-9784-b9d931571474", + "templateApplicationLevel": "newPartners,existingPartners", + "userSyncInbound": { + "isSyncAllowed": true + } +} +``` |
v1.0 | Multitenantorganizationidentitysyncpolicytemplate Resettodefaultsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganizationidentitysyncpolicytemplate-resettodefaultsettings.md | + + Title: "multiTenantOrganizationIdentitySyncPolicyTemplate: resetToDefaultSettings" +description: "Reset the cross-tenant access policy template with user synchronization settings for a multitenant organization to the default values." ++ms.localizationpriority: medium ++++# multiTenantOrganizationIdentitySyncPolicyTemplate: resetToDefaultSettings +Namespace: microsoft.graph ++Reset the cross-tenant access policy template with user synchronization settings for a multitenant organization to the default values. ++In its reset state, the template has no impact on user synchronization settings, other than that unconfigured user synchronization settings are created if needed, for every multitenant organization 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": "multitenantorganizationidentitysyncpolicytemplate_resettodefaultsettings" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization/resetToDefaultSettings +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this action returns a `204 No Content` response code. ++## Examples ++The following example resets the user synchronization settings of the template to the default values. ++### Request ++<!-- { + "blockType": "request", + "name": "multitenantorganizationidentitysyncpolicytemplatethis.resettodefaultsettings" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization/resetToDefaultSettings +``` ++### Response ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Multitenantorganizationidentitysyncpolicytemplate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganizationidentitysyncpolicytemplate-update.md | + + Title: "Update multiTenantOrganizationIdentitySyncPolicyTemplate" +description: "Update the cross-tenant access policy template with user synchronization settings for a multitenant organization." ++ms.localizationpriority: medium ++++# Update multiTenantOrganizationIdentitySyncPolicyTemplate +Namespace: microsoft.graph ++Update the cross-tenant access policy template with user synchronization settings for a multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganizationidentitysyncpolicytemplate_update" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|userSyncInbound|[crossTenantUserSyncInbound](../resources/crosstenantusersyncinbound.md)|Determines whether users can be synchronized from the partner tenant. `false` causes any current user synchronization from the source tenant to the target tenant to stop. This property has no impact on existing users who have already been synchronized.| +|templateApplicationLevel|templateApplicationLevel|Specifies whether the template will be applied to user synchronization settings of certain tenants. The possible values are: `none`, `newPartners`, `existingPartners`, `unknownFutureValue`. You can also specify multiple values like `newPartners,existingPartners` (default). `none` indicates the template is not applied to any new or existing partner tenants. `newPartners` indicates the template is applied to new partner tenants. `existingPartners` indicates the template is applied to existing partner tenants, those who already had partner-specific user synchronization settings in place. Optional.| +++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++The following example updates the user synchronization settings of the template. It configures that the template is applied for new and existing partners. For more information, see [crossTenantIdentitySyncPolicyPartner resource type](../resources/crosstenantidentitysyncpolicypartner.md). ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_multitenantorganizationidentitysyncpolicytemplate" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization +Content-Type: application/json ++{ + "templateApplicationLevel": "newPartners,existingPartners", + "userSyncInbound": { + "isSyncAllowed": 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 ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Multitenantorganizationjoinrequestrecord Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganizationjoinrequestrecord-get.md | + + Title: "Get multiTenantOrganizationJoinRequestRecord" +description: "Get the status of a tenant joining a multitenant organization." ++ms.localizationpriority: medium ++++# Get multiTenantOrganizationJoinRequestRecord +Namespace: microsoft.graph ++Get the status of a tenant joining a multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganizationjoinrequestrecord_get" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /tenantRelationships/multiTenantOrganization/joinRequest +``` ++## Optional query parameters +This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [multiTenantOrganizationJoinRequestRecord](../resources/multitenantorganizationjoinrequestrecord.md) object in the response body. ++## Examples ++The following example gets the status of a tenant joining a multitenant organization. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_multitenantorganizationjoinrequestrecord" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/joinRequest +``` ++# [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 before an added tenant joins a multitenant organization. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.multiTenantOrganizationJoinRequestRecord" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity", + "id": "7149c406-fac5-4be9-ad4b-f46fac7fe60c", + "addedByTenantId": "00000000-0000-0000-0000-000000000000", + "memberState": null, + "role": null, + "transitionDetails": null +} +``` ++The following example shows the response after an added tenant [requests to join a multitenant organization](multitenantorganizationjoinrequestrecord-update.md) and the state is still `pending`. ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity", + "id": "3e536776-7489-43e9-9637-742d62ec3fc5", + "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "memberState": "pending", + "role": null, + "transitionDetails": { + "desiredMemberState": "active", + "status": "notStarted", + "details": "" + } +} +``` ++The following example shows the response after an added tenant successfully joins a multitenant organization and the state is changed to `active`. ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity", + "id": "3e536776-7489-43e9-9637-742d62ec3fc5", + "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "memberState": "active", + "role": member, + "transitionDetails": null +} +``` ++The following example shows the response when an added tenant fails to join a multitenant organization. To reset a failed join request, see [Update multiTenantOrganizationJoinRequestRecord](multitenantorganizationjoinrequestrecord-update.md). ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity", + "id": "3e536776-7489-43e9-9637-742d62ec3fc5", + "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "memberState": "pending", + "role": null, + "transitionDetails": { + "desiredMemberState": "active", + "status": "failed", + "details": "DirectoryService Exception" + } +} +``` |
v1.0 | Multitenantorganizationjoinrequestrecord Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganizationjoinrequestrecord-update.md | + + Title: "Update multiTenantOrganizationJoinRequestRecord" +description: "Join a multitenant organization." ++ms.localizationpriority: medium ++++# Update multiTenantOrganizationJoinRequestRecord +Namespace: microsoft.graph ++Join a multitenant organization, after the owner of the multitenant organization has added your tenant to the multitenant organization as pending. ++Before a tenant added to a multitenant organization can participate in the multitenant organization, the administrator of the joining tenant must submit a join request. ++To allow for asynchronous processing, you must wait **up to 2 hours** before joining a multitenant organization is completed. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganizationjoinrequestrecord_update" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /tenantRelationships/multiTenantOrganization/joinRequest +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|addedByTenantId|String|Tenant ID of the Microsoft Entra tenant that added the current tenant to the multitenant organization. To reset a failed join request, set `addedByTenantId` to `00000000-0000-0000-0000-000000000000`. Required.| +++## Response ++If successful, this method returns a `204 No Content` response code. ++A join request might be unsuccessful. The following are some scenarios: ++* The joining tenant has not been added to the multitenant organization by its owner. +* The owner or joiner tenant exceeds the maximum number of internal users per tenant. +* The multitenant organization would exceed the maximum number of tenants. +* The joining tenant is already part of a different multitenant organization. ++## Examples ++### Example 1: Join a multitenant organization ++The following example shows a request by the current tenant to join a multitenant organization. It can take a few minutes for the join to complete. If the join succeeds, the state of the tenant is changed to `active`. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_multitenantorganizationjoinrequestrecord" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/joinRequest +Content-Type: application/json ++{ + "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325" +} +``` ++# [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 +``` ++### Example 2: Reset a failed join request ++The following example shows a request by the current tenant to reset a failed join request. To reset a failed join request, set `addedByTenantId` to `00000000-0000-0000-0000-000000000000`. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_multitenantorganizationjoinrequestrecord_joinfailed" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/joinRequest +Content-Type: application/json ++{ + "addedByTenantId": "00000000-0000-0000-0000-000000000000" +} +``` ++# [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 | Multitenantorganizationmember Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganizationmember-get.md | + + Title: "Get multiTenantOrganizationMember" +description: "Get a tenant and its properties in the multitenant organization." ++ms.localizationpriority: medium ++++# Get multiTenantOrganizationMember +Namespace: microsoft.graph ++Get a tenant and its properties in the multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganizationmember_get" } --> ++If called with MultiTenantOrganization.ReadBasic.All permission, the caller can only read the **displayName** and **tenantId** properties. +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /tenantRelationships/multiTenantOrganization/tenants/{tenantId} +``` ++## Optional query parameters +This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [multiTenantOrganizationMember](../resources/multitenantorganizationmember.md) object in the response body. ++## Examples ++The following example gets a tenant and its properties in the multitenant organization. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_multitenantorganizationmember" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/tenants/1fd6544e-e994-4de2-9f1b-787b51c7d325 +``` ++# [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, + "@odata.type": "microsoft.graph.multiTenantOrganizationMember" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/tenants/$entity", + "tenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "displayName": "Contoso", + "addedDateTime": "2023-05-26T22:05:23Z", + "joinedDateTime": null, + "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "role": "owner", + "state": "active", + "transitionDetails": null +} +``` ++If an update is in progress, `transitionDetails` lists information about the update. The following response indicates the role is being changed from member to owner. ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/tenants/$entity", + "tenantId": "5036a0a0-a7a4-4933-9086-5dd54535dd6e", + "displayName": "Woodgrove Bank", + "addedDateTime": "2023-05-27T21:52:40Z", + "joinedDateTime": null, + "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325", + "role": "member", + "state": "pending", + "transitionDetails": { + "desiredState": "active", + "desiredRole": "owner", + "status": "notStarted", + "details": null + } +} +``` + |
v1.0 | Multitenantorganizationmember Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganizationmember-update.md | + + Title: "Update multiTenantOrganizationMember" +description: "Update the properties of a tenant in a multitenant organization." ++ms.localizationpriority: medium ++++# Update multiTenantOrganizationMember +Namespace: microsoft.graph ++Update the properties of a tenant in a multitenant organization. Only owner tenants can call this API. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganizationmember_update" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /tenantRelationships/multiTenantOrganization/tenants/{tenantId} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|role|multiTenantOrganizationMemberRole|Role of the tenant in the multitenant organization. The possible values are: `owner`, `member` (default), `unknownFutureValue`. Optional.| +++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++The following example changes the role of a tenant in a multitenant organization from member to owner. ++### Request ++<!-- { + "blockType": "request", + "name": "update_multitenantorganizationmember" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/tenant/5036a0a0-a7a4-4933-9086-5dd54535dd6e +Content-Type: application/json ++{ + "role": "owner" +} +``` +++### Response ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Multitenantorganizationpartnerconfigurationtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganizationpartnerconfigurationtemplate-get.md | + + Title: "Get multiTenantOrganizationPartnerConfigurationTemplate" +description: "Get the cross-tenant access policy template with inbound and outbound partner configuration settings for a multitenant organization." ++ms.localizationpriority: medium ++++# Get multiTenantOrganizationPartnerConfigurationTemplate +Namespace: microsoft.graph ++Get the cross-tenant access policy template with inbound and outbound partner configuration settings for a multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganizationpartnerconfigurationtemplate_get" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration +``` ++## Optional query parameters +This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [multiTenantOrganizationPartnerConfigurationTemplate](../resources/multitenantorganizationpartnerconfigurationtemplate.md) object in the response body. ++## Examples ++The following example gets the partner configuration settings of the template. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_multitenantorganizationpartnerconfigurationtemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration +``` ++# [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 response shows the unconfigured (or reset) state of the cross-tenant access policy template for partner configuration settings for multitenant organization tenants. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.multiTenantOrganizationPartnerConfigurationTemplate" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration/$entity", + "id": "75b1889b-6f42-4cc5-8e62-e774b8db243c", + "templateApplicationLevel": "newPartners,existingPartners", + "inboundTrust": null, + "b2bCollaborationOutbound": null, + "b2bCollaborationInbound": null, + "b2bDirectConnectOutbound": null, + "b2bDirectConnectInbound": null, + "automaticUserConsentSettings": { + "inboundAllowed": null, + "outboundAllowed": null + } +} +``` ++The following example response shows a configured state of the cross-tenant access policy template for partner configuration settings, after inbound trust and automatic redemption have been configured. ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration/$entity", + "id": "8d253b1b-1798-434a-8e77-bec3774d1512", + "templateApplicationLevel": "newPartners,existingPartners", + "b2bCollaborationOutbound": null, + "b2bCollaborationInbound": null, + "b2bDirectConnectOutbound": null, + "b2bDirectConnectInbound": null, + "inboundTrust": { + "isMfaAccepted": true, + "isCompliantDeviceAccepted": true, + "isHybridAzureADJoinedDeviceAccepted": true + }, + "automaticUserConsentSettings": { + "inboundAllowed": true, + "outboundAllowed": true + } +} +``` + |
v1.0 | Multitenantorganizationpartnerconfigurationtemplate Resettodefaultsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganizationpartnerconfigurationtemplate-resettodefaultsettings.md | + + Title: "multiTenantOrganizationPartnerConfigurationTemplate: resetToDefaultSettings" +description: "Reset the cross-tenant access policy template with inbound and outbound partner configuration settings for a multitenant organization to the default values." ++ms.localizationpriority: medium ++++# multiTenantOrganizationPartnerConfigurationTemplate: resetToDefaultSettings +Namespace: microsoft.graph ++Reset the cross-tenant access policy template with inbound and outbound partner configuration settings for a multitenant organization to the default values. ++In its reset state, the template has no impact on partner configuration settings, other than that an unconfigured partner configuration is created if needed, for every multitenant organization 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": "multitenantorganizationpartnerconfigurationtemplate_resettodefaultsettings" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration/resetToDefaultSettings +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this action returns a `204 No Content` response code. ++## Examples ++The following example resets the inbound and outbound partner configuration settings of the template to the default values. ++### Request ++<!-- { + "blockType": "request", + "name": "multitenantorganizationpartnerconfigurationtemplatethis.resettodefaultsettings" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration/resetToDefaultSettings +``` ++### Response ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Multitenantorganizationpartnerconfigurationtemplate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganizationpartnerconfigurationtemplate-update.md | + + Title: "Update multiTenantOrganizationPartnerConfigurationTemplate" +description: "Update the cross-tenant access policy template with inbound and outbound partner configuration settings for a multitenant organization." ++ms.localizationpriority: medium ++++# Update multiTenantOrganizationPartnerConfigurationTemplate +Namespace: microsoft.graph ++Update the cross-tenant access policy template with inbound and outbound partner configuration settings for a multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "multitenantorganizationpartnerconfigurationtemplate_update" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|inboundTrust|[crossTenantAccessPolicyInboundTrust](../resources/crosstenantaccesspolicyinboundtrust.md)|Determines the partner-specific configuration for trusting other Conditional Access claims from external Microsoft Entra organizations. Optional.| +|b2bCollaborationOutbound|[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md)|Defines your partner-specific configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B collaboration. Optional.| +|b2bCollaborationInbound|[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md)|Defines your partner-specific configuration for users from other organizations accessing your resources via Microsoft Entra B2B collaboration. Optional.| +|b2bDirectConnectOutbound|[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md)|Defines your partner-specific configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B direct connect. Optional.| +|b2bDirectConnectInbound|[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md)|Defines your partner-specific configuration for users from other organizations accessing your resources via Microsoft Entra B2B direct connect. Optional.| +|automaticUserConsentSettings|[inboundOutboundPolicyConfiguration](../resources/inboundoutboundpolicyconfiguration.md)|Determines the partner-specific configuration for automatic user consent settings. Optional.| +|templateApplicationLevel|templateApplicationLevel|Specifies whether the template will be applied to partner configuration settings of certain tenants. The possible values are: `none`, `newPartners`, `existingPartners`, `unknownFutureValue`. You can also specify multiple values like `newPartners,existingPartners` (default). `none` indicates the template isn't applied to any new or existing partner tenants. `newPartners` indicates the template is applied to new partner tenants. `existingPartners` indicates the template is applied to existing partner tenants, those who already had partner-specific partner configurations in place. Optional.| +++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++The following example configures the inbound trust settings to accept MFA, compliant, and Microsoft Entra hybrid joined devices from the partner tenant. It configures automatic redemption on behalf of your users and accepts admin consent for the users of the partner. It configures that the template is applied for new and existing partners. For more information, see [crossTenantAccessPolicyConfigurationPartner resource type](../resources/crosstenantaccesspolicyconfigurationpartner.md). ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_multitenantorganizationpartnerconfigurationtemplate" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration +Content-Type: application/json ++{ + "inboundTrust": { + "isMfaAccepted": true, + "isCompliantDeviceAccepted": true, + "isHybridAzureADJoinedDeviceAccepted": true + }, + "automaticUserConsentSettings": { + "inboundAllowed": true, + "outboundAllowed": true + }, + "templateApplicationLevel": "newPartners,existingPartners" +} ++``` ++# [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 | Nameditem Add | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/nameditem-add.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `200 OK` response code and [WorkbookNamedItem](../resources/nameditem.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookNamedItem](../resources/workbooknameditem.md) object in the response body. ## Example |
v1.0 | Nameditem Addformulalocal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/nameditem-addformulalocal.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `200 OK` response code and [WorkbookNamedItem](../resources/nameditem.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookNamedItem](../resources/workbooknameditem.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Nameditem Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/nameditem-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookNamedItem](../resources/nameditem.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookNamedItem](../resources/workbooknameditem.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Nameditem List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/nameditem-list.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookNamedItem](../resources/nameditem.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookNamedItem](../resources/workbooknameditem.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Nameditem Range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/nameditem-range.md | GET /me/drive/root:/{item-path}:/workbook/names/{name}/range ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Nameditem Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/nameditem-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookNamedItem](../resources/nameditem.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookNamedItem](../resources/workbooknameditem.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Onattributecollectionexternalusersselfservicesignup Delete Attributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onattributecollectionexternalusersselfservicesignup-delete-attributes.md | + + Title: "Remove attribute (from user flow)" +description: "Remove an attribute from an externalUsersSelfServiceSignupEventsFlow." ++ms.localizationpriority: medium ++++# 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. ++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "onattributecollectionexternalusersselfservicesignup_delete_attributes" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref +``` ++## 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 `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details. ++## 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). +<!-- { + "blockType": "request", + "name": "delete_onAttributeCollectionExternalUsersSelfServiceSignUp" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/city/$ref +``` +++#### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Onattributecollectionexternalusersselfservicesignup List Attributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onattributecollectionexternalusersselfservicesignup-list-attributes.md | + + Title: "List attributes (of a user flow)" +description: "List attributes for an externalusersselfservicesignupeventsflow." ++ms.localizationpriority: medium ++++# List attributes (of a user flow) +Namespace: microsoft.graph +++Get an [identityUserFlowAttribute](../resources/identityuserflowattribute.md) collection associated with an external identities self-service user flow represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. These attributes are collected from the user during the authentication experience defined by 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). ++<!-- { "blockType": "permissions", "name": "onattributecollectionexternalusersselfservicesignup_list_attributes" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/ +``` ++## Optional query parameters ++This method supports the `$filter`, `$expand`, `$orderby` 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).| +|Content-Type|application/json. Required.| ++## Request body +Don't supply a request body for this method. +++## Response ++If successful, this method returns a `200 OK` response code and a new [identityUserFlowAttribute](../resources/identityuserflowattribute.md) object in the response body. ++If no user flow attributes are assigned to the user flow, this method returns a `400 Bad Request` error code. ++## Examples ++#### Request +The following example shows a request to retrieve the attributes associated with a user flow. +<!-- { + "blockType": "request", + "name": "get_onAttributeCollectionExternalUsersSelfServiceSignUp" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/ +``` +++#### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.authenticationAttributeCollectionPage" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.identityUserFlowAttribute)", + "value": [ + { + "id": "email", + "displayName": "Email Address", + "description": "Email address of the user", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "displayName", + "displayName": "Display Name", + "description": "Display Name of the User.", + "userFlowAttributeType": "builtIn", + "dataType": "string" + }, + { + "id": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor", + "displayName": "Favorite color", + "description": "what is your favorite color", + "userFlowAttributeType": "custom", + "dataType": "string" + } + ] +} +``` |
v1.0 | Onattributecollectionexternalusersselfservicesignup Post Attributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onattributecollectionexternalusersselfservicesignup-post-attributes.md | + + Title: "Add attribute (to user flow)" +description: "Add attribute to an externalUsersSelfServiceSignupEventsFlow." ++ms.localizationpriority: medium ++++# 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. ++Prerequisite: [PATCH the user flow](../api/authenticationeventsflow-update.md) with the updated onAttributeCollection event that includes the new attribute. ++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "onattributecollectionexternalusersselfservicesignup_post_attributes" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref +``` ++## 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 an **odata.id** property with the ID of the [identityUserFlowAttribute](../resources/identityuserflowattribute.md) object to add to the user flow. ++## Response +If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details. ++## Examples ++#### 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). ++<!-- { + "blockType": "request", + "name": "onAttributeCollectionExternalUsersSelfServiceSignUp_post_attributes" +} +--> ++``` http +POST https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref ++{ + "@odata.id":"https://graph.microsoft.com/v1.0/identity/userFlowAttributes/city" +} ++``` ++#### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Onauthenticationmethodloadstartexternalusersselfservicesignup Delete Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onauthenticationmethodloadstartexternalusersselfservicesignup-delete-identityproviders.md | + + Title: "Remove identityProvider (from a user flow)" +description: "Remove an identity provider from an externalUsersSelfServiceSignupEventsFlow." ++ms.localizationpriority: medium ++++# Remove identityProvider (from a user flow) +Namespace: microsoft.graph ++Remove an identity provider from an external identities self-service sign up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object type. ++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "onauthenticationmethodloadstartexternalusersselfservicesignup_delete_identityproviders" } --> +++## HTTP request +<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/{identityProviders-id}/$ref +``` ++## 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 `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details. ++## Examples ++#### Request +The following example shows a request to remove Facebook as an identity provider option for account creation. +<!-- { + "blockType": "request", + "name": "delete_onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp_identityProviders" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/Facebook-OAUTH/$ref +``` ++#### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Onauthenticationmethodloadstartexternalusersselfservicesignup List Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders.md | + + Title: "List identityProviders (in a user flow)" +description: "List identity provider for an externalusersselfservicesignupeventsflow." ++ms.localizationpriority: medium ++++# List identityProviders (in a user flow) +Namespace: microsoft.graph ++Get the identity providers that are defined for an external identities self-service sign up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object type. ++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "onauthenticationmethodloadstartexternalusersselfservicesignup_list_identityproviders" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/ +``` ++## 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).| +|Content-Type|application/json. Required.| ++## 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 [identityProviderBase](../resources/identityproviderbase.md) objects in the response body. ++## Examples ++#### Request +The following example shows a request. +<!-- { + "blockType": "request", + "name": "list_onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp_identityProviders" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/ +``` ++#### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.identityProviderBase)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.identityProviderBase)", + "value": [ + { + "@odata.type": "#microsoft.graph.builtInIdentityProvider", + "id": "EmailPassword-OAUTH", + "displayName": "Email with password", + "identityProviderType": "EmailPassword", + }, + { + "@odata.type": "#microsoft.graph.socialIdentityProvider", + "id": "Google-OAUTH", + "displayName": "Google", + "identityProviderType": "Google", + "clientId": "{googleClientId}", + "clientSecret": "******" + } + ] +} +``` |
v1.0 | Onauthenticationmethodloadstartexternalusersselfservicesignup Post Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onauthenticationmethodloadstartexternalusersselfservicesignup-post-identityproviders.md | + + Title: "Add identityProvider (to a user flow)" +description: "Add an identity provider to an externalUsersSelfServiceSignupEventsFlow." ++ms.localizationpriority: medium ++++# Add identityProvider (to a user flow) +Namespace: microsoft.graph ++Add an identity provider to an external identities self-service user flow represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object type. The [identity provider must first be configured in the tenant](../api/identitycontainer-list-identityproviders.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": "onauthenticationmethodloadstartexternalusersselfservicesignup_post_identityproviders" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$ref +``` ++## 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, provide a JSON representation of the ID of the [identityProvider](../resources/identityproviderbase.md) you want to add. For self-service user flows, the values can be `EmailPassword-OAUTH`, `EmailOtpSignup-OAUTH`, `Google-OAUTH`, or `Facebook-OAUTH`. ++## Response ++If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details. ++## Examples ++#### Request +The following example shows a request that adds Google as identity provider option for account creation. +<!-- { + "blockType": "request", + "name": "update_authenticationeventsflow" +} +--> +``` http +POST https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$ref ++{ + "@odata.id": "https://graph.microsoft.com/beta/identityProviders/Google-OAUTH" +} +``` ++#### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Onlinemeeting List Recordings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onlinemeeting-list-recordings.md | Get the list of [callRecording](../resources/callrecording.md) objects associate > * This API doesn't support meetings created using the [create onlineMeeting API](/graph/api/application-post-onlinemeetings) that are not associated with an event on the user's calendar. > * This API works differently in one or more national clouds. For details, see [Microsoft Teams API implementation differences in national clouds](/graph/teamwork-national-cloud-differences). ## Permissions |
v1.0 | Onlinemeeting List Transcripts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onlinemeeting-list-transcripts.md | Retrieve the list of [callTranscript](../resources/calltranscript.md) objects as > * This API doesn't support meetings created using the [create onlineMeeting API](/graph/api/application-post-onlinemeetings) that are not associated with an event on the user's calendar. > * This API works differently in one or more national clouds. For details, see [Microsoft Teams API implementation differences in national clouds](/graph/teamwork-national-cloud-differences). ## Permissions |
v1.0 | Opentypeextension Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/opentypeextension-delete.md | Title: "Delete open extension" description: "Delete an open extension (openTypeExtension object) from the specified instance of a resource." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | Opentypeextension Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/opentypeextension-get.md | Title: "Get open extension" description: "Get an open extension (openTypeExtension object) identified by name or fully qualified name." ms.localizationpriority: high + doc_type: apiPageType |
v1.0 | Opentypeextension Post Opentypeextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/opentypeextension-post-opentypeextension.md | Title: "Create open extension" description: "Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource." ms.localizationpriority: high + doc_type: apiPageType |
v1.0 | Opentypeextension Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/opentypeextension-update.md | Title: "Update open extension" description: "Update an open extension (openTypeExtension object) with the properties in the request body:" ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | Outlookcategory Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/outlookcategory-update.md | Title: "Update Outlook category" -description: "Update the writable property, **color**, of the specified outlookCategory object. You can't modify the **displayName** property " + Title: "Update outlookCategory" +description: "Update the writable property, **color**, of the specified outlookCategory object." ms.localizationpriority: medium doc_type: apiPageType -# Update Outlook category +# Update outlookCategory Namespace: microsoft.graph -Update the writable property, **color**, of the specified [outlookCategory](../resources/outlookcategory.md) object. You can't modify the **displayName** property -once you have created the category. +Update the writable property, **color**, of the specified [outlookCategory](../resources/outlookcategory.md) object. You can't modify the **displayName** property once you have created the category. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] maintains their previous values or are recalculated based on changes to other pr ## Response -If successful, this method returns a `200 OK` response code and updated [outlookCategory](../resources/outlookcategory.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [outlookCategory](../resources/outlookcategory.md) object in the response body. ## Example-##### Request +### Request The following example shows a request. # [HTTP](#tab/http) Content-type: application/json -##### 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. +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, |
v1.0 | Outlookuser List Mastercategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/outlookuser-list-mastercategories.md | Title: "List Outlook categories" -description: "Get all the categories that have been defined for the user." + Title: "List masterCategories" +description: "Get all the categories that have been defined for a user." ms.localizationpriority: medium doc_type: apiPageType -# List Outlook categories +# List masterCategories Namespace: microsoft.graph -Get all the categories that have been defined for the user. +Get all the categories that have been defined for a user. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Partners Billing Billedreconciliation Export | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/partners-billing-billedreconciliation-export.md | Namespace: microsoft.graph.partners.billing Export the billed invoice reconciliation data. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/billedreconciliationthisexport-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/billedreconciliationthisexport-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Planner Post Plans | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/planner-post-plans.md | Title: "Create plannerPlan" -description: "Use this API to create a new **plannerPlan**." +description: "Create a new plannerPlan object." ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph -Use this API to create a new **plannerPlan**. +Create a new [plannerPlan](../resources/plannerplan.md) object. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] The following table shows the properties that are required when you create a [pl |Property|Type|Description| |:|:|:|-|container|[plannerPlanContainer](../resources/plannerplancontainer.md)|Identifies the container of the plan. Specify only the **url**, the **containerId** and **type**, or all properties. After it is set, this property canΓÇÖt be updated.| +|container|[plannerPlanContainer](../resources/plannerplancontainer.md)|Identifies the container of the plan. Specify only the **url**, the **containerId** and **type**, or all properties. After it's set, this property can't be updated.| |title|String|The title of the plan.| ->**Note:** If the container is a Microsoft 365 group, the user who is creating the plan must be a member of the group that will contain the plan. When you create a new group by using [Create group](../api/group-post-groups.md), you are not added to the group as a member. After the group is created, add yourself as a member by using [group post members](../api/group-post-members.md). +>**Note:** If the container is a Microsoft 365 group, the user who creates the plan must be a member of the group that contains the plan. When you create a new group by using [Create group](../api/group-post-groups.md), you aren't added to the group as a member. After the group is created, add yourself as a member by using [group post members](../api/group-post-members.md). ## Response This method can return any of the [HTTP status codes](/graph/errors). The most c The following example shows a request. - # [HTTP](#tab/http) <!-- { "blockType": "request", Content-type: application/json { "container": {- "url": "https://graph.microsoft.com/beta/groups/ebf3b108-5234-4e22-b93d-656d7dae5874" + "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874" }, "title": "title-value" } Content-type: application/json "createdDateTime": "2015-03-30T18:36:49.2407981Z", "container": { "@odata.type": "microsoft.graph.plannerPlanContainer",- "url": "https://graph.microsoft.com/beta/groups/ebf3b108-5234-4e22-b93d-656d7dae5874", + "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874", "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874", "type": "group" }, |
v1.0 | Plannertask Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/plannertask-update.md | PATCH /planner/tasks/{id} | Property | Type |Description| |:|:--|:-|-|appliedCategories|[plannerAppliedCategories](../resources/plannerappliedcategories.md)|The categories to which the task has been applied. See [applied Categories](../resources/plannerappliedcategories.md) for possible values.| +|appliedCategories|[plannerAppliedCategories](../resources/plannerappliedcategories.md)|The categories to which the task has been applied. For possible values, see [appliedCategories](../resources/plannerappliedcategories.md).| |assigneePriority|String|Hint used to order items of this type in a list view. The format is defined in [Using order hints in Planner](../resources/planner-order-hint-format.md).| |assignments|[plannerAssignments](../resources/plannerassignments.md)|The set of users the task is assigned to.|-|bucketId|String|Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. [Format validation](../resources/planner-identifiers-disclaimer.md) is done on the service. | +|bucketId|String|Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. The value is 28 characters long and case-sensitive. [Format validation](../resources/planner-identifiers-disclaimer.md) is done on the service. | |conversationThreadId|String|Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.| |dueDateTime|DateTimeOffset|Date and time at which the task is due. 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|Hint used to order items of this type in a list view. The format is defined in [Using order hints in Planner](../resources/planner-order-hint-format.md).| PATCH /planner/tasks/{id} |startDateTime|DateTimeOffset|Date and time at which the task starts. 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`.| |title|String|Title of the task.| +> [!NOTE] +> For Project tasks that are replicated to Planner, only the **percentComplete** property can be updated. + ## Response If successful, this method returns a `204 No Content` response code and an empty content. If the request specifies the `Prefer` header with a `return=representation` preference, then this method returns a `200 OK` response code and an updated [plannerTask](../resources/plannertask.md) object in the response body. |
v1.0 | Printershare Delete Allowedgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/printershare-delete-allowedgroup.md | DELETE https://graph.microsoft.com/v1.0/print/shares/{printerShareId}/allowedGro [!INCLUDE [sample-code](../includes/snippets/php/delete-allowedgroup-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-allowedgroup-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Printershare Delete Alloweduser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/printershare-delete-alloweduser.md | DELETE https://graph.microsoft.com/v1.0/print/shares/{printerShareId}/allowedUse [!INCLUDE [sample-code](../includes/snippets/php/delete-alloweduser-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-alloweduser-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Profilephoto Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/profilephoto-delete.md | Delete the photo for the signed-in user or the specified group. > > The delete operation supports only user or group photos, but _not Outlook contact nor Teams photos_. + ## 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). The following example shows a request. DELETE https://graph.microsoft.com/v1.0/me/photo/$value ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/delete-profilephoto-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [Python](#tab/python) + ### Response |
v1.0 | Projectrome Delete Historyitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/projectrome-delete-historyitem.md | Title: "Delete a historyItem" + Title: "Delete an activityHistoryItem" description: "Delete an existing history item for an existing user activity." ms.localizationpriority: medium -# Delete a historyItem +# Delete an activityHistoryItem Namespace: microsoft.graph |
v1.0 | Projectrome Get Activities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/projectrome-get-activities.md | This method supports some [OData Query Parameters](/graph/query-parameters) to h - $expand for the **historyItems** navigation property. - $top to limit the maximum number of items across pages.-- $filter on the **lastModifiedDateTime** property for either activities or **historyItems**, if expanded.+- $filter on the **lastModifiedDateTime** property for either activities or **activityHistoryItems**, if expanded. The following are some examples of supported queries with URL encoding: |
v1.0 | Projectrome Get Recent Activities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/projectrome-get-recent-activities.md | Title: "Get recent user activities" -description: " API. The service queries for the most recent historyItems, and then pull those related activities. Activities are sorted according to the most recent **lastModified** on the **historyItem**. This means that activities without **historyItems** won't be included in the response. The UserActivity.ReadWrite.CreatedByApp permission will also apply extra filtering to the response, so that only activities created by your application are returned. This server-side filtering might result in empty pages if the user is active and other applications have created more recent activities. To get your application's activities, use the **nextLink** property to paginate." +description: "Get recent activities for a given user." ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph -Get recent activities for a given user. This OData function has some default behaviors included to make it operate like a "most recently used" API. The service queries for the most recent [historyItems](../resources/projectrome-historyitem.md), and then pull those related activities. Activities are sorted according to the most recent **lastModified** on the **historyItem**. This means that activities without **historyItems** won't be included in the response. The UserActivity.ReadWrite.CreatedByApp permission will also apply extra filtering to the response, so that only activities created by your application are returned. This server-side filtering might result in empty pages if the user is active and other applications have created more recent activities. To get your application's activities, use the **nextLink** property to paginate. +Get recent activities for a given user. This OData function has some default behaviors included to make it operate like a "most recently used" API. The service queries for the most recent [activityHistoryItems](../resources/projectrome-historyitem.md), and then pull those related activities. Activities are sorted according to the most recent **lastModified** on the **activityHistoryItem**. This means that activities without **activityHistoryItems** won't be included in the response. The UserActivity.ReadWrite.CreatedByApp permission will also apply extra filtering to the response, so that only activities created by your application are returned. This server-side filtering might result in empty pages if the user is active and other applications have created more recent activities. To get your application's activities, use the **nextLink** property to paginate. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] This method supports some [OData Query Parameters](/graph/query-parameters) to h - $expand for the **historyItems** navigation property. - $top to limit the maximum number of items across pages.-- $filter on the **lastModifiedDateTime** property for either **activities** or **historyItems**, if expanded.+- $filter on the **lastModifiedDateTime** property for either **activities** or **activityHistoryItems**, if expanded. The following are some examples of supported queries with URL encoding. |
v1.0 | Projectrome Put Activity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/projectrome-put-activity.md | Title: "Create or replace an activity" -description: "Create a new or replace an existing user activity for your app. If you'd like to create a user activity and its related **historyItems** in one request, you can use deep insert." +description: "Create a new or replace an existing user activity for your app. If you'd like to create a user activity and its related **activityHistoryItems** in one request, you can use deep insert." ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph -Create a new or replace an existing [user activity](../resources/projectrome-activity.md) for your app. If you'd like to create a user activity and its related **historyItems** in one request, you can use [deep insert](#example-2-deep-insert). +Create a new or replace an existing [user activity](../resources/projectrome-activity.md) for your app. If you'd like to create a user activity and its related **activityHistoryItems** in one request, you can use [deep insert](#example-2-deep-insert). ## Permissions |
v1.0 | Projectrome Put Historyitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/projectrome-put-historyitem.md | Title: "Create or replace a historyItem" + Title: "Create or replace an activityHistoryItem" description: "Create a new or replace an existing history item for an existing user activity." ms.localizationpriority: medium -# Create or replace a historyItem +# Create or replace an activityHistoryItem Namespace: microsoft.graph PUT /me/activities/{id}/historyItems/{id} ## Request body -In the request body, supply a JSON representation of a [historyItem](../resources/projectrome-historyitem.md) object. +In the request body, supply a JSON representation of an [activityHistoryItem](../resources/projectrome-historyitem.md) object. ## Response -If successful, this method returns a `201 Created` response code if the **historyItem** was created or `200 OK` if the **historyItem** was replaced. +If successful, this method returns a `201 Created` response code if the **activityHistoryItem** was created or `200 OK` if the **activityHistoryItem** was replaced. ## Example |
v1.0 | Range Boundingrect | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-boundingrect.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here's an example of how to call this API. |
v1.0 | Range Cell | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-cell.md | In the path, provide the following parameters. ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Range Column | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-column.md | In the request path, provide the following parameters. ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Range Entirecolumn | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-entirecolumn.md | GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Range Entirerow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-entirerow.md | GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Range Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns a `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Range Insert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-insert.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Range Intersection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-intersection.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here's an example of how to call this API. |
v1.0 | Range Lastcell | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-lastcell.md | GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here's an example of how to call this API. |
v1.0 | Range Lastcolumn | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-lastcolumn.md | GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here's an example of how to call this API. |
v1.0 | Range Lastrow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-lastrow.md | GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here's an example of how to call this API. |
v1.0 | Range Offsetrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-offsetrange.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here's an example of how to call this API. |
v1.0 | Range Row | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-row.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Range Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [Range](../resources/range.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [Range](../resources/workbookrange.md) object in the response body. ## Example ##### Request The following example shows a request. It updates a range - values, number-format and formula. The `null` input is to instruct the API to ignore the cell for that particular input. The values, number-format and formulas can be independently updated or combined together in the same API call. |
v1.0 | Range Usedrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-usedrange.md | GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Rangeborder Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeborder-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookRangeBorder](../resources/rangeborder.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookRangeBorder](../resources/workbookrangeborder.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Rangeborder List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeborder-list.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookRangeBorder](../resources/rangeborder.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookRangeBorder](../resources/workbookrangeborder.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Rangeborder Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeborder-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookRangeBorder](../resources/rangeborder.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookRangeBorder](../resources/workbookrangeborder.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Rangebordercollection Itemat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangebordercollection-itemat.md | Don't supply a request body for this method. ## Response -If successful, this method returns `200 OK` response code and [WorkbookRangeBorder](../resources/rangeborder.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookRangeBorder](../resources/workbookrangeborder.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Rangefill Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangefill-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookRangeFill](../resources/rangefill.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookRangeFill](../resources/workbookrangefill.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Rangefill Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangefill-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookRangeFill](../resources/rangefill.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookRangeFill](../resources/workbookrangefill.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Rangefont Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangefont-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookRangeFont](../resources/rangefont.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookRangeFont](../resources/workbookrangefont.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Rangefont Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangefont-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookRangeFont](../resources/rangefont.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookRangeFont](../resources/workbookrangefont.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Rangeformat Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeformat-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookRangeFormat](../resources/rangeformat.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookRangeFormat](../resources/workbookrangeformat.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Rangeformat List Borders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeformat-list-borders.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookRangeBorder](../resources/rangeborder.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookRangeBorder](../resources/workbookrangeborder.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Rangeformat Post Borders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeformat-post-borders.md | POST /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ra | Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body-In the request body, supply a JSON representation of [WorkbookRangeBorder](../resources/rangeborder.md) object. +In the request body, supply a JSON representation of [workbookRangeBorder](../resources/workbookrangeborder.md) object. ## Response -If successful, this method returns `201 Created` response code and [WorkbookRangeBorder](../resources/rangeborder.md) object in the response body. +If successful, this method returns `201 Created` response code and [workbookRangeBorder](../resources/workbookrangeborder.md) object in the response body. ## Example ##### Request Content-type: application/json } ``` -In the request body, supply a JSON representation of [WorkbookRangeBorder](../resources/rangeborder.md) object. +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 | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookRangeFormat](../resources/rangeformat.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookRangeFormat](../resources/workbookrangeformat.md) object in the response body. ## Example ### Update the format, fill, and font properties in three table cells -The following examples demonstrate how to update properties of the [WorkbookRangeFormat](../resources/rangeformat.md), [WorkbookRangeFill](../resources/rangefill.md), and [WorkbookRangeFont](../resources/rangefont.md) properties of a specified range. +The following examples demonstrate how to update properties of the [workbookRangeFormat](../resources/workbookrangeformat.md), [workbookRangeFill](../resources/workbookrangefill.md), and [workbookRangeFont](../resources/workbookrangefont.md) properties of a specified range. The result of this set of requests is a table with three cells formatted like the top three cells in the image below. |
v1.0 | Rbacapplication List Roleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rbacapplication-list-roleassignments.md | One of the following permissions is required to call this API. To learn more, in <!-- { "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) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | +|Delegated (work or school account) | RoleManagement.Read.Directory, RoleManagement.Read.All, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | +|Application | RoleManagement.Read.Directory, RoleManagement.Read.All, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | ### For the entitlement management provider <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> |
v1.0 | Remotedesktopsecurityconfiguration List Targetdevicegroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/remotedesktopsecurityconfiguration-list-targetdevicegroups.md | Get a list of the [targetDeviceGroup](../resources/targetdevicegroup.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": "remotedesktopsecurityconfiguration_list_targetdevicegroups" } --> +<!-- { "blockType": "ignored", "name": "remotedesktopsecurityconfiguration_list_targetdevicegroups" } --> [!INCLUDE [permissions-table](../includes/permissions/remotedesktopsecurityconfiguration-list-targetdevicegroups-permissions.md)] [!INCLUDE [rbac-remote-desktop-security-config-apis](../includes/rbac-for-apis/rbac-remote-desktop-security-config-apis.md)] |
v1.0 | Reportroot Getrelyingpartydetailedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/reportroot-getrelyingpartydetailedsummary.md | + + Title: "reportRoot: getRelyingPartyDetailedSummary" +description: "Get a summary of AD FS relying parties information." ++ms.localizationpriority: medium ++++# reportRoot: getRelyingPartyDetailedSummary ++Namespace: microsoft.graph +++Get a summary of AD FS relying parties information. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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-getrelyingpartydetailedsummary-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/getRelyingPartyDetailedSummary(period='parameterValue') +``` ++## 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. ++## Optional query parameters ++This method supports the `$filter` and `$orderby` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++|Parameter|Type|Description| +|:|:|:| +|period|String|Specifies the length of time over which the report is aggregated. The supported values are: D1, D7, D30. These values follow the format `Dn` where n represents the number of days over which the report is aggregated.| +++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this function returns a `200 OK` response code and a [relyingPartyDetailedSummary](../resources/relyingpartydetailedsummary.md) collection in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "reportrootthis.getrelyingpartydetailedsummary" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/reports/getRelyingPartyDetailedSummary(period='D7') +``` ++# [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.relyingPartyDetailedSummary)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.relyingPartyDetailedSummary", + "id": "31b45f83-0f5c-40be-80af-02e918f3b55b", + "relyingPartyId": "https://customer.contoso.com/mgmt", + "serviceId": "4cce6fff-4ccc-41fe-8521-bce16ea521e9", + "relyingPartyName": "Contoso", + "successfulSignInCount": 0, + "failedSignInCount": 225, + "totalSignInCount": 225, + "signInSuccessRate": 0, + "uniqueUserCount": 1, + "migrationStatus": "ready", + "replyUrls": [ + "https://adfshelp.microsoft.com/Contoso/tokenresponse" + ], + "migrationValidationDetails": [ + { + "name": "AdditionalWSFedEndpointCheckResult", + "value": "{\"result\": 0, \"message\": \"No additional WS-Federation endpoints were found.\"}" + }, + { + "name": "AllowedAuthenticationClassReferencesCheckResult", + "value": "{\"result\": 0, \"message\": \"AllowedAuthenticationClassReferences is not set up.\"}" + } + ] + } + ] +} +``` ++<!-- { + "type": "#page.annotation", + "description": "reportRoot: getRelyingPartyDetailedSummary", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: reportrootthis.getrelyingpartydetailedsummary/container/signInSuccessRate: + Expected type Double but actual was Int64. Property: signInSuccessRate, actual value: '0'" + ] +}--> + |
v1.0 | Samlorwsfedexternaldomainfederation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/samlorwsfedexternaldomainfederation-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-delete-permissions.md)] -The work or school account needs to belong to one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/samlorwsfedexternaldomainfederation-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_get" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-get-permissions.md)] -The work or school account needs to belong to one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation List Domains | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/samlorwsfedexternaldomainfederation-list-domains.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_list_domains" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-list-domains-permissions.md)] -The work or school account needs to belong to one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/samlorwsfedexternaldomainfederation-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_list" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-list-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation Post Domains | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/samlorwsfedexternaldomainfederation-post-domains.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_post_domains" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-post-domains-permissions.md)] -The work or school account needs to belong to one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/samlorwsfedexternaldomainfederation-post.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_post" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-post-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Samlorwsfedexternaldomainfederation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/samlorwsfedexternaldomainfederation-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "samlorwsfedexternaldomainfederation_update" } --> [!INCLUDE [permissions-table](../includes/permissions/samlorwsfedexternaldomainfederation-update-permissions.md)] -The work or school account needs to belong to one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Global Administrator -* External Identity Provider Administrator ## HTTP request |
v1.0 | Schemaextension Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/schemaextension-delete.md | Title: "Delete schemaExtension" description: "Delete the definition of a schema extension." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | Schemaextension Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/schemaextension-get.md | Title: "Get schemaExtension" description: "Get the properties of the specified schemaExtension definition." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | Schemaextension List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/schemaextension-list.md | Title: "List schemaExtensions" description: "Get a list of schemaExtension objects created by any apps you own in the current tenant (that can be " ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | Schemaextension Post Schemaextensions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/schemaextension-post-schemaextensions.md | Title: "Create schemaExtension" description: "Create a new schemaExtension definition to extend a supporting resource type." ms.localizationpriority: high + doc_type: apiPageType |
v1.0 | Schemaextension Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/schemaextension-update.md | Title: "Update schemaExtension" description: "Update properties in the definition of the specified schemaExtension." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | Search Acronym Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-acronym-delete.md | Namespace: microsoft.graph.search Delete an [acronym](../resources/search-acronym.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). DELETE https://graph.microsoft.com/v1.0/search/acronyms/733b26d5-af76-4eea-ac69- [!INCLUDE [sample-code](../includes/snippets/php/delete-acronym-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-acronym-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Acronym Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-acronym-get.md | Namespace: microsoft.graph.search Read the properties and relationships of an [acronym](../resources/search-acronym.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). GET https://graph.microsoft.com/v1.0/search/acronyms/733b26d5-af76-4eea-ac69-1a0 [!INCLUDE [sample-code](../includes/snippets/php/get-acronym-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-acronym-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Acronym Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-acronym-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-acronym-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-acronym-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Bookmark Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-bookmark-delete.md | Namespace: microsoft.graph.search Delete a [bookmark](../resources/search-bookmark.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). DELETE https://graph.microsoft.com/v1.0/search/bookmarks/733b26d5-af76-4eea-ac69 [!INCLUDE [sample-code](../includes/snippets/php/delete-bookmark-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-bookmark-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Bookmark Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-bookmark-get.md | Namespace: microsoft.graph.search Read the properties and relationships of a [bookmark](../resources/search-bookmark.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). GET https://graph.microsoft.com/v1.0/search/bookmarks/733b26d5-af76-4eea-ac69-1a [!INCLUDE [sample-code](../includes/snippets/php/get-bookmark-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-bookmark-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Bookmark Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-bookmark-update.md | Namespace: microsoft.graph.search Update the properties of a [bookmark](../resources/search-bookmark.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). Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-bookmark-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-bookmark-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Qna Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-qna-delete.md | Namespace: microsoft.graph.search Delete a [qna](../resources/search-qna.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). DELETE https://graph.microsoft.com/v1.0/search/qnas/733b26d5-af76-4eea-ac69-1a0c [!INCLUDE [sample-code](../includes/snippets/php/delete-qna-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-qna-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Qna Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-qna-get.md | GET https://graph.microsoft.com/v1.0/search/qnas/733b26d5-af76-4eea-ac69-1a0ce87 [!INCLUDE [sample-code](../includes/snippets/php/get-qna-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-qna-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Qna Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-qna-update.md | Namespace: microsoft.graph.search Update the properties of a [qna](../resources/search-qna.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). Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-qna-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-qna-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Searchentity List Acronyms | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-list-acronyms.md | Namespace: microsoft.graph.search Get a list of the [acronym](../resources/search-acronym.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). GET https://graph.microsoft.com/v1.0/search/acronyms [!INCLUDE [sample-code](../includes/snippets/php/list-acronym-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-acronym-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Searchentity List Bookmarks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-list-bookmarks.md | Namespace: microsoft.graph.search Get a list of [bookmark](../resources/search-bookmark.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). GET https://graph.microsoft.com/v1.0/search/bookmarks [!INCLUDE [sample-code](../includes/snippets/php/list-bookmark-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-bookmark-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Searchentity List Qnas | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-list-qnas.md | Namespace: microsoft.graph.search Get a list of the [qna](../resources/search-qna.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). GET https://graph.microsoft.com/v1.0/search/qnas [!INCLUDE [sample-code](../includes/snippets/php/list-qna-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-qna-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Searchentity Post Acronyms | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-post-acronyms.md | Namespace: microsoft.graph.search Create a new [acronym](../resources/search-acronym.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). Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-acronym-from-acronyms-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/create-acronym-from-acronyms-e1-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Searchentity Post Bookmarks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-post-bookmarks.md | Namespace: microsoft.graph.search Create a new [bookmark](../resources/search-bookmark.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). Content-Type: application/json "description": "Try or buy Contoso for Home or Business and view product information", "keywords": { "keywords": ["Contoso", "install"],- "reservedKeywords": ["Contoso"], + "reservedKeywords": ["Unique keyword"], "matchSimilarKeywords": true }, "availabilityStartDateTime": null, Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-bookmark-from-bookmarks-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/create-bookmark-from-bookmarks-e1-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Search Searchentity Post Qnas | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-post-qnas.md | Namespace: microsoft.graph.search Create a new [qna](../resources/search-qna.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). Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-qna-from-qnas-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-qna-from-qnas-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Security Authoritytemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-authoritytemplate-get.md | + + Title: "Get authorityTemplate" +description: "Read the properties and relationships of an authorityTemplate." ++ms.localizationpriority: medium +++# Get authorityTemplate +Namespace: microsoft.graph.security ++Read the properties and relationships of a [authorityTemplate](../resources/security-authoritytemplate.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_authoritytemplate_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/authorities/{authorityTemplateId} +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/authorityTemplate +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.authorityTemplate](../resources/security-authoritytemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_authoritytemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/authorities/a94af2e3-853b-6fcc-c898-d61d3a6d9efc +``` ++# [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 +Here's an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.authorityTemplate" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", + "displayName": "String", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} +} +``` + |
v1.0 | Security Categorytemplate Delete Subcategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md | + + Title: "Delete subcategoryTemplate" +description: "Delete a subcategoryTemplate object." ++ms.localizationpriority: medium +++# Delete subcategoryTemplate +Namespace: microsoft.graph.security ++Delete a [subcategoryTemplate](../resources/security-subcategorytemplate.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_categorytemplate_delete_subcategories" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/labels/categories/{categoryTemplateId}/subcategories/{subcategoryTemplateId}/$ref +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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 +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_subcategorytemplate" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/categories/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5/subcategories/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 +``` ++# [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 +Here's an example of the response. +> +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Security Categorytemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-categorytemplate-get.md | + + Title: "Get categoryTemplate" +description: "Read the properties and relationships of a categoryTemplate object." ++ms.localizationpriority: medium +++# Get categoryTemplate +Namespace: microsoft.graph.security ++Read the properties and relationships of a [categoryTemplate](../resources/security-categorytemplate.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_categorytemplate_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/categories/{categoryTemplateId} +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For example, to retrieve the **subategories** property associated with this particular category, you can use the `expand` parameter:`$expand=subcategories`. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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.categoryTemplate](../resources/security-categorytemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_categorytemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/categories/e2c79762-34a9-75ba-b6f0-a7c9a57978ef +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.categoryTemplate" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", + "displayName": "Accounts payable", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} +} +``` + |
v1.0 | Security Categorytemplate List Subcategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md | + + Title: "List subcategories" +description: "Get the subcategoryTemplate resources from the subcategories navigation property." ++ms.localizationpriority: medium +++# List subcategories +Namespace: microsoft.graph.security ++Get a list of subcategories [subcategoryTemplate](../resources/security-subcategorytemplate.md) associated with a category template. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_categorytemplate_list_subcategories" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/categories/{categoryTemplateId}/subcategories +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.subcategoryTemplate](../resources/security-subcategorytemplate.md) objects in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_subcategorytemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/categories/{categoryTemplateId}/subcategories +``` ++# [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 +Here's an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.security.subcategoryTemplate)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.subcategoryTemplate", + "id": "2ac39915-dbeb-e933-82e2-92b981835fa0", + "displayName": "Vendor Invoice", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } + ] +} +``` + |
v1.0 | Security Categorytemplate Post Subcategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md | + + Title: "Create subcategoryTemplate" +description: "Create a new subcategoryTemplate object." ++ms.localizationpriority: medium +++# Create subcategoryTemplate +Namespace: microsoft.graph.security ++Create a new [subcategoryTemplate](../resources/security-subcategorytemplate.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_categorytemplate_post_subcategories" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/labels/categories/{categoryTemplateId}/subcategories +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object. ++You can specify the following properties when creating a **subcategoryTemplate**. ++|Property|Type|Description| +|:|:|:| +|displayName|String| Unique string that defines a sub-category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md). Optional.| +++++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_subcategorytemplate_from_" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/labels/categories/{categoryTemplateId}/subcategories +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.subcategoryTemplate", + "displayName": "Vendor Invoice", +} +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.subcategoryTemplate" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.subcategoryTemplate", + "id": "2ac39915-dbeb-e933-82e2-92b981835fa0", + "displayName": "Vendor Invoice", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } +``` + |
v1.0 | Security Citationtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-citationtemplate-get.md | + + Title: "Get citationTemplate" +description: "Read the properties and relationships of a citationTemplate object." ++ms.localizationpriority: medium +++# Get citationTemplate +Namespace: microsoft.graph.security ++Read the properties and relationships of a [citationTemplate](../resources/security-citationtemplate.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_citationtemplate_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/citations/{citationTemplateId} +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/citationTemplate +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.citationTemplate](../resources/security-citationtemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_citationtemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/citations/c0475d01-d532-8a53-6e26-14ea58c640bf +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.citationTemplate" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.security.citationTemplate", + "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", + "displayName": "Contoso Company Policy", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" + } +} +``` + |
v1.0 | Security Departmenttemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-departmenttemplate-get.md | + + Title: "Get departmentTemplate" +description: "Read the properties and relationships of a departmentTemplate object." ++ms.localizationpriority: medium +++# Get departmentTemplate +Namespace: microsoft.graph.security ++Read the properties and relationships of a [departmentTemplate](../resources/security-departmenttemplate.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_departmenttemplate_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/departments/{departmentTemplateId} +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/departmentTemplate +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.departmentTemplate](../resources/security-departmenttemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_departmenttemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/departments/11b44677-9f06-c85a-4a0b-766b66904bf8 +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.departmentTemplate" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.security.departmentTemplate", + "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", + "displayName": "Finance", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} +} +``` + |
v1.0 | Security Fileplanreferencetemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-fileplanreferencetemplate-get.md | + + Title: "Get filePlanReferenceTemplate" +description: "Read the properties and relationships of a filePlanReferenceTemplate object." ++ms.localizationpriority: medium +++# Get filePlanReferenceTemplate +Namespace: microsoft.graph.security ++Read the properties and relationships of a [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.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_fileplanreferencetemplate_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/filePlanReferences/{filePlanReferenceTemplateId} +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/filePlanReferenceTemplate +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_fileplanreferencetemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/filePlanReferences/b1f7b518-a44f-1d4b-c6f1-ab8771d3907c +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.filePlanReferenceTemplate" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", + "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", + "displayName": "String", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} +} +``` + |
v1.0 | Security Labelsroot Delete Authorities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-delete-authorities.md | + + Title: "Delete authorityTemplate" +description: "Delete an authorityTemplate object." ++ms.localizationpriority: medium +++# Delete authorityTemplate +Namespace: microsoft.graph.security ++Delete a [authorityTemplate](../resources/security-authoritytemplate.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_labelsroot_delete_authorities" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/labels/authorities/{authorityTemplateId}/$ref +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/authorityTemplate/$ref +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_authoritytemplate" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/authorities/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 +``` ++# [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 +Here's an example of the response. +> +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Security Labelsroot Delete Categories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-delete-categories.md | + + Title: "Delete categoryTemplate" +description: "Delete a categoryTemplate object." ++ms.localizationpriority: medium +++# Delete categoryTemplate +Namespace: microsoft.graph.security ++Delete a [categoryTemplate](../resources/security-categorytemplate.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_labelsroot_delete_categories" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/labels/categories/{categoryTemplateId}/$ref +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/$ref +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_categorytemplate" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/categories/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 +``` ++# [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 +Here's an example of the response. +> +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Security Labelsroot Delete Citations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-delete-citations.md | + + Title: "Delete citationTemplate" +description: "Delete a citationTemplate object." ++ms.localizationpriority: medium +++# Delete citationTemplate +Namespace: microsoft.graph.security ++Delete a [citationTemplate](../resources/security-citationtemplate.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_labelsroot_delete_citations" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/labels/citations/{citationTemplateId}/$ref +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/citationTemplate/$ref +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_citationtemplate" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/citations/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 +``` ++# [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 +Here's an example of the response. +> +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Security Labelsroot Delete Departments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-delete-departments.md | + + Title: "Delete departmentTemplate" +description: "Delete a departmentTemplate object." ++ms.localizationpriority: medium +++# Delete departmentTemplate +Namespace: microsoft.graph.security ++Delete a [departmentTemplate](../resources/security-departmenttemplate.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_labelsroot_delete_departments" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/labels/departments/{departmentTemplateId}/$ref +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/departmentTemplate/$ref +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_departmenttemplate" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/departments/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 +``` ++# [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 +Here's an example of the response. +> +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Security Labelsroot Delete Fileplanreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-delete-fileplanreferences.md | + + Title: "Delete filePlanReferenceTemplate" +description: "Delete a filePlanReferenceTemplate object." ++ms.localizationpriority: medium +++# Delete filePlanReferenceTemplate +Namespace: microsoft.graph.security ++Delete a [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.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_labelsroot_delete_fileplanreferences" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/labels/filePlanReferences/{filePlanReferenceTemplateId}/$ref +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/filePlanReferenceTemplate/$ref +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Don't supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_fileplanreferencetemplate" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/filePlanReferences/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 +``` ++# [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 +Here's an example of the response. +> +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Security Labelsroot List Authorities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-authorities.md | + + Title: "List authorityTemplates" +description: "Get a list of the authorityTemplate objects and their properties." ++ms.localizationpriority: medium +++# List authorityTemplates +Namespace: microsoft.graph.security +++Get a list of the [authorityTemplate](../resources/security-authoritytemplate.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_labelsroot_list_authorities" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/authorities +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.authorityTemplate](../resources/security-authoritytemplate.md) objects in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_authoritytemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/authorities +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.security.authorityTemplate)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", + "displayName": "Business", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + }, + { + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5", + "displayName": "Legal", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } + ] +} +``` |
v1.0 | Security Labelsroot List Categories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-categories.md | + + Title: "List categoryTemplates" +description: "Get a list of the categoryTemplate objects and their properties." ++ms.localizationpriority: medium +++# List categoryTemplates +Namespace: microsoft.graph.security ++Get a list of the [categoryTemplate](../resources/security-categorytemplate.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_labelsroot_list_categories" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/categories +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.categoryTemplate](../resources/security-categorytemplate.md) objects in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_categorytemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/categories +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.security.categoryTemplate)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", + "displayName": "Accounts Payable", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + }, + { + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5", + "displayName": "Accounts", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } + ] +} +``` |
v1.0 | Security Labelsroot List Citations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-citations.md | + + Title: "List citationTemplates" +description: "Get a list of the citationTemplate objects and their properties." ++ms.localizationpriority: medium +++# List citationTemplates +Namespace: microsoft.graph.security ++Get a list of the [citationTemplate](../resources/security-citationtemplate.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_labelsroot_list_citations" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/citations +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.citationTemplate](../resources/security-citationtemplate.md) objects in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_citationtemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/citations +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.security.citationTemplate)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.citationTemplate", + "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", + "displayName": "Contoso Company Policy", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" + } + ] +} +``` + |
v1.0 | Security Labelsroot List Departments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-departments.md | + + Title: "List departmentTemplates" +description: "Get a list of the departmentTemplate objects and their properties." ++ms.localizationpriority: medium +++# List departmentTemplates +Namespace: microsoft.graph.security ++Get a list of the [departmentTemplate](../resources/security-departmenttemplate.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_labelsroot_list_departments" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/departments +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.departmentTemplate](../resources/security-departmenttemplate.md) objects in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_departmenttemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/departments +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.security.departmentTemplate)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.departmentTemplate", + "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", + "displayName": "Finance", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } + ] +} +``` + |
v1.0 | Security Labelsroot List Fileplanreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-fileplanreferences.md | + + Title: "List filePlanReferenceTemplates" +description: "Get a list of the filePlanReferenceTemplate objects and their properties." ++ms.localizationpriority: medium +++# List filePlanReferenceTemplates +Namespace: microsoft.graph.security ++Get a list of the [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.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_labelsroot_list_fileplanreferences" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/filePlanReferences +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) objects in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_fileplanreferencetemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/filePlanReferences +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.security.filePlanReferenceTemplate)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", + "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", + "displayName": "FIN 01-02-001", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } + ] +} +``` + |
v1.0 | Security Labelsroot List Retentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md | + + Title: "List retentionLabels" +description: "Get a list of the retentionLabel objects and their properties." ++ms.localizationpriority: medium +++# List retentionLabels +Namespace: microsoft.graph.security ++Get a list of the [retentionLabel](../resources/security-retentionlabel.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_labelsroot_list_retentionlabel" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/retentionLabels +``` ++## Optional query parameters +This method supports the `expand` OData query parameter to help customize the response. ++For example: +- To retrieve the **retentionEventType** property, use `$expand=retentionEventType`. +- To retrieve the **descriptors** property, use `$expand=descriptors`. ++For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.retentionLabel](../resources/security-retentionlabel.md) objects in the response body. ++## Examples ++### Request +Here's an example of a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_retentionlabel" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.security.retentionLabel)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", + "displayName": "Retention Schedule 10004", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "relabel", + "retentionTrigger": "dateCreated", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": "730" + }, + "isInUse": true, + "descriptionForAdmins": "creation based retention label for schedule 10004", + "descriptionForUsers": "retains for 2 years then relabeled", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2017-11-27T02:10:12Z", + "lastModifiedBy": { + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Records Manager" + } + }, + "lastModifiedDateTime": "2020-08-28T22:13:09Z", + "labelToBeApplied": "Retention schedule 10005", + "defaultRecordBehavior": "startLocked" + } + ] +} +``` ++ |
v1.0 | Security Labelsroot Post Authorities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-authorities.md | + + Title: "Create authorityTemplate" +description: "Create a new authorityTemplate object." ++ms.localizationpriority: medium +++# Create authorityTemplate +Namespace: microsoft.graph.security ++Create a new [authorityTemplate](../resources/security-authoritytemplate.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_labelsroot_post_authorities" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/labels/authorities +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object. ++You can specify the following properties when creating a **authorityTemplate**. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| +++++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_authoritytemplate_from_" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/labels/authorities +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "displayName": "Business", +} +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.authorityTemplate" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", + "displayName": "Business", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} +``` + |
v1.0 | Security Labelsroot Post Categories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-categories.md | + + Title: "Create categoryTemplate" +description: "Create a new categoryTemplate object." ++ms.localizationpriority: medium +++# Create categoryTemplate +Namespace: microsoft.graph.security ++Create a new [categoryTemplate](../resources/security-categorytemplate.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_labelsroot_post_categories" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/labels/categories +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object. ++You can specify the following properties when creating a **categoryTemplate**. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| +++++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_categorytemplate_from_" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/labels/categories +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "displayName": "Accounts Payable", +} +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.categoryTemplate" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", + "displayName": "Accounts Payable", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} +``` |
v1.0 | Security Labelsroot Post Citations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-citations.md | + + Title: "Create citationTemplate" +description: "Create a new citationTemplate object." ++ms.localizationpriority: medium +++# Create citationTemplate +Namespace: microsoft.graph.security ++Create a new [citationTemplate](../resources/security-citationtemplate.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_labelsroot_post_citations" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/labels/citations +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object. ++You can specify the following properties when creating a **citationTemplate**. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| +|citationUrl|String|Represents the URL to the published citation. Optional.| +|citationJurisdiction|String|Represents the jurisdiction or agency that published the citation. Optional.| +++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_citationtemplate_from_" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/labels/citations +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.citationTemplate", + "displayName": "Contoso Company Policy", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" +} +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.citationTemplate" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.citationTemplate", + "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", + "displayName": "Contoso Company Policy", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z", + "createdDateTime": "String (timestamp)", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "String" +} +``` + |
v1.0 | Security Labelsroot Post Departments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-departments.md | + + Title: "Create departmentTemplate" +description: "Create a new departmentTemplate object." ++ms.localizationpriority: medium +++# Create departmentTemplate +Namespace: microsoft.graph.security ++Create a new [departmentTemplate](../resources/security-departmenttemplate.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_labelsroot_post_departments" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/labels/departments +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object. ++You can specify the following properties when creating a **departmentTemplate**. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| +++++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_departmenttemplate_from_" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/labels/departments +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.departmentTemplate", + "displayName": "Finance", +} +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.departmentTemplate" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.departmentTemplate", + "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", + "displayName": "Finance", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} +``` + |
v1.0 | Security Labelsroot Post Fileplanreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-fileplanreferences.md | + + Title: "Create filePlanReferenceTemplate" +description: "Create a new filePlanReferenceTemplate object." ++ms.localizationpriority: medium +++# Create filePlanReferenceTemplate +Namespace: microsoft.graph.security ++Create a new [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.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_labelsroot_post_fileplanreferences" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/labels/filePlanReferences +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object. ++You can specify the following properties when creating a **filePlanReferenceTemplate**. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a file plan reference name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| +++++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_fileplanreferencetemplate_from_" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/labels/filePlanReferences +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", + "displayName": "FIN 01-02-001", +} +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.filePlanReferenceTemplate" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", + "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", + "displayName": "FIN 01-02-001", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} +``` + |
v1.0 | Security Labelsroot Post Retentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md | + + Title: "Create retentionLabel" +description: "Create a new retentionLabel object." ++ms.localizationpriority: medium +++# Create retentionLabel +Namespace: microsoft.graph.security ++Create a new [retentionLabel](../resources/security-retentionlabel.md) object. ++To create a [disposition review stage](../resources/security-dispositionreviewstage.md), include the **actionAfterRetentionPeriod** property in the request body with one of the possible values specified. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_labelsroot_post_retentionlabel" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/labels/retentionLabels +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [retentionLabel](../resources/security-retentionlabel.md) object. ++Specify the following properties when you create a **retentionLabel**. ++|Property|Type|Description| +|:|:|:| +|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to take on a document with this label applied during the retention period. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`. | +|behaviorDuringRetentionPeriod|microsoft.graph.security.behaviorDuringRetentionPeriod|Specifies how the behavior of a document with this label should be during the retention period. The possible values are: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`, `unknownFutureValue`. | +|descriptionForAdmins|String|Provides label information for the admin. Optional. | +|descriptionForUsers|String|Provides the label information for the user. Optional. | +|displayName|String|Unique string that defines a label name. | +|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained. | +|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content. | +|retentionTrigger|microsoft.graph.security.retentionTrigger|Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`, `unknownFutureValue`. | +|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it's created. The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`. | +|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. | ++++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_retentionlabel_from_" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/labels/retentionLabels +Content-Type: application/json +Content-length: 555 ++{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "displayName": "Retention Schedule 10005", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "startDispositionReview", + "retentionTrigger": "dateOfEvent", + "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": 2555 + }, + "dispositionReviewStages": [ + { + "stageNumber" : 1, + "name": "Stage1", + "reviewersEmailAddresses ": [ + "Admin@contoso.onmicrosoft.com" + ] + } + ], + "descriptionForAdmins": "retain for 7 years", + "descriptionForUsers": "retain for 7 years", + "descriptors": { + "authorityTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/authorities('fie3f4fc-b966-4c40-94de-fb8a383658e4')", + "categoryTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/categories('0bjk8-b966-4c40-94de-fb8a383658e4')", + "citationTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/citations('0e23f4fc-b966-4c40-94de-fb8a383658e4')", + "departmentTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/departments('p99ef4fc-b966-4c40-94de-fb8a383658e4')", + "filePlanReferenceTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/filePlanReferences('e095f4fc-b966-4c40-94de-fb8a383658e4')" + }, + "defaultRecordBehavior":"startLocked", +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++### Response +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.retentionLabel" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", + "displayName": "Retention Schedule 10005", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "startDispositionReview", + "retentionTrigger": "dateOfEvent", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": 2555 + }, + "dispositionReviewStages": [ + { + "stageNumber" : 1, + "name": "Stage1", + "reviewersEmailAddresses ": [ + "Admin@contoso.onmicrosoft.com" + ] + } + ], + "isInUse": true, + "descriptionForAdmins": "retain for 7 years", + "descriptionForUsers": "retain for 7 years", + "defaultRecordBehavior":"startLocked", + "createdBy": { + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-08-23T16:43:55Z", + "labelToBeApplied": " ", + "defaultRecordBehavior": "startLocked", + "descriptors": { + "authority": { + "displayName": "Business" + }, + "category": { + "displayName": "Accounts Payable", + }, + "citation": { + "displayName" : "Contoso Company Policy", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" + }, + "department": { + "displayName" : "Finance" + }, + "filePlanReference": { + "displayName" : "FIN 01-02-001" + } + } +} +``` + |
v1.0 | Security Retentionlabel Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-retentionlabel-delete.md | + + Title: "Delete retentionLabel" +description: "Deletes a retentionLabel object." ++ms.localizationpriority: medium +++# Delete retentionLabel +Namespace: microsoft.graph.security ++Delete a [retentionLabel](../resources/security-retentionlabel.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_retentionlabel_delete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/labels/retentionLabels/{retentionLabelId} ++``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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 +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_retentionlabel" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50 +``` ++# [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 +Here's an example of the response. +> +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Security Retentionlabel Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-retentionlabel-get.md | + + Title: "Get retentionLabel" +description: "Read the properties and relationships of a retentionLabel object." ++ms.localizationpriority: medium +++# Get retentionLabel +Namespace: microsoft.graph.security ++Read the properties and relationships of a [retentionLabel](../resources/security-retentionlabel.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_retentionlabel_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/retentionLabels/{retentionLabelId} +GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabelId} +``` ++## Optional query parameters +This method supports the expand OData query parameters to help customize the response. For example, to retrieve the **retentionEventType** property, you can use the `expand` parameter:`$expand=retentionEventType` or `$expand=descriptors`. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## 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.retentionLabel](../resources/security-retentionlabel.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_retentionlabel" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId} +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.retentionLabel" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", + "displayName": "Retention Schedule 10004", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "relabel", + "retentionTrigger": "dateCreated", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": 730 + }, + "isInUse": true, + "descriptionForAdmins": "creation based retention label for schedule 10004", + "descriptionForUsers": "retains for 2 years then relabeled", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2017-11-27T02:10:12Z", + "lastModifiedBy": { + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Records Manager" + } + }, + "lastModifiedDateTime": "2020-08-28T22:13:09Z", + "labelToBeApplied": "Retention schedule 10005", + "defaultRecordBehavior": "startLocked" + } +} +``` + |
v1.0 | Security Retentionlabel Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-retentionlabel-update.md | + + Title: "Update retentionLabel" +description: "Update the properties of a retentionLabel object." ++ms.localizationpriority: medium +++# Update retentionLabel +Namespace: microsoft.graph.security ++Update the properties of a [retentionLabel](../resources/security-retentionlabel.md) object. ++To update a [disposition review stage](../resources/security-dispositionreviewstage.md), include the **actionAfterRetentionPeriod** property in the request body with one of the possible values specified. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_retentionlabel_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /security/labels/retentionLabels/{retentionLabelId} ++``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|descriptionForAdmins|String|This is an optional property that provides the label information for the admin.| +|descriptionForUsers|String|This is an optional property that provides the label information for the user.| +|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained.| +|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content.| +|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created. The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`.| +|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. | ++++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_retentionlabel" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50 +Content-Type: application/json +Content-length: 555 ++{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": 2555 + }, +} +``` ++# [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 +Here's an example of the response. ++<!-- { + "blockType": "response" +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Security Security Runhuntingquery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-security-runhuntingquery.md | POST https://graph.microsoft.com/v1.0/security/runHuntingQuery >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",- "@odata.type": "microsoft.graph.security.huntingQueryResults" + "@odata.type": "microsoft.graph.security.huntingQueryResults", + "truncated": true } --> Content-type: application/json { "schema": [ {- "Name": "Timestamp", - "Type": "DateTime" + "name": "Timestamp", + "type": "DateTime" }, {- "Name": "FileName", - "Type": "String" + "name": "FileName", + "type": "String" }, {- "Name": "InitiatingProcessFileName", - "Type": "String" + "name": "InitiatingProcessFileName", + "type": "String" } ], "results": [ {- "Timestamp": "2020-08-30T06:38:35.7664356Z", - "FileName": "conhost.exe", - "InitiatingProcessFileName": "powershell.exe" + "timestamp": "2020-08-30T06:38:35.7664356Z", + "fileName": "conhost.exe", + "initiatingProcessFileName": "powershell.exe" }, {- "Timestamp": "2020-08-30T06:38:30.5163363Z", - "FileName": "conhost.exe", - "InitiatingProcessFileName": "powershell.exe" + "timestamp": "2020-08-30T06:38:30.5163363Z", + "fileName": "conhost.exe", + "initiatingProcessFileName": "powershell.exe" } ] } |
v1.0 | Security Subcategorytemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-subcategorytemplate-get.md | + + Title: "Get subcategoryTemplate" +description: "Read the properties and relationships of a subcategoryTemplate object." ++ms.localizationpriority: medium +++# Get subcategoryTemplate +Namespace: microsoft.graph.security ++Read the properties and relationships of a [subcategoryTemplate](../resources/security-subcategorytemplate.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_subcategorytemplate_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/categories/{categoryTemplateId}/subcategories/{subcategoryTemplateId} +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +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.subcategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body. ++## Examples ++### Request +Here's an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_subcategorytemplate" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/labels/categories/82d00422-1f60-46cd-9809-33ca0b4d2286/subcategories/2ac39915-dbeb-e933-82e2-92b981835fa0 +``` ++# [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 +Here's an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.subcategoryTemplate" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.security.subcategoryTemplate", + "id": "2ac39915-dbeb-e933-82e2-92b981835fa0", + "displayName": "Vendor Invoice", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} +} +``` + |
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: ## Permissions -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). <!-- { "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) | AppRoleAssignment.ReadWrite.All and Application.Read.All, AppRoleAssignment.ReadWrite.All and Directory.Read.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | AppRoleAssignment.ReadWrite.All and Application.Read.All, AppRoleAssignment.ReadWrite.All and Directory.Read.All | [!INCLUDE [rbac-approleassignments-apis-write](../includes/rbac-for-apis/rbac-approleassignments-apis-write.md)] |
v1.0 | Serviceprincipal Post Serviceprincipals | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceprincipal-post-serviceprincipals.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipal_post_serviceprincipals" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-post-serviceprincipals-permissions.md)] -For multi-tenant apps, 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): +For multi-tenant apps, 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): -+ Global Administrator + Application Administrator-+ Cloud Application Administrator roles ++ Cloud Application Administrator For single-tenant apps where the calling user is a non-admin user but is the owner of the backing application, the user must have the *Application Developer* role. |
v1.0 | Serviceprincipal Upsert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceprincipal-upsert.md | + + Title: "Upsert servicePrincipal" +description: "Create a new servicePrincipal object if it doesn't exist, or update the properties of an existing servicePrincipal object." ++ms.localizationpriority: medium ++++# Upsert servicePrincipal ++Namespace: microsoft.graph ++Create a new [servicePrincipal](../resources/serviceprincipal.md) object if it doesn't exist, or update the properties of an existing [servicePrincipal](../resources/serviceprincipal.md) object. ++> [!IMPORTANT] +> Adding [**passwordCredential**](../resources/passwordcredential.md) when creating servicePrincipals is not supported. Use the [addPassword](serviceprincipal-addpassword.md) method to add passwords or secrets for a servicePrincipal. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_upsert" } --> ++For multitenant apps, 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): +++ Application Administrator++ Cloud Application Administrator++For single-tenant apps where the calling user is a nonadmin user but is the owner of the backing application, the user must have the *Application Developer* role. ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +PATCH /servicePrincipals(appId='appId') +``` ++## Request headers +| Name | Description| +|:--|:-| +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required. | +| Prefer | `create-if-missing`. Required for upsert behavior, otherwise the request is treated as an update operation. | ++## Request body ++In the request body, supply a JSON representation of a [servicePrincipal](../resources/serviceprincipal.md) object. ++## Response ++If successful, if a servicePrincipal with **appId** doesn't exist, this method returns a `201 Created` response code and a new [servicePrincipal](../resources/servicePrincipal.md) object in the response body. ++If a servicePrincipal with **appId** already exists, this method updates the [servicePrincipal](../resources/servicePrincipal.md) object and returns a `204 No Content` response code. ++## Examples ++### Example 1: Create a new servicePrincipal if it doesn't exist ++The following example creates a servicePrincipal because a servicePrincipal with the specified **appId** value doesn't exist. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "upsert_create_serviceprincipal" +}--> +```http +PATCH https://graph.microsoft.com/v1.0/servicePrincipals(appId='65415bb1-9267-4313-bbf5-ae259732ee12') +Content-type: application/json +Prefer: create-if-missing ++{ + "displayName": "My app instance" +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [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.servicePrincipal" +} --> +```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#servicePrincipals/$entity", + "id": "59e617e5-e447-4adc-8b88-00af644d7c92", + "deletedDateTime": null, + "accountEnabled": true, + "appDisplayName": "My App", + "appId": "65415bb1-9267-4313-bbf5-ae259732ee12", + "applicationTemplateId": null, + "appOwnerOrganizationId": "1bc1c026-2f7b-48a5-98da-afa2fd8bc7bc", + "appRoleAssignmentRequired": false, + "displayName": "My app instance", + "errorUrl": null, + "homepage": null, + "loginUrl": null, + "logoutUrl": null, + "notificationEmailAddresses": [], + "preferredSingleSignOnMode": null, + "preferredTokenSigningKeyEndDateTime": null, + "preferredTokenSigningKeyThumbprint": null, + "publisherName": "Contoso", + "replyUrls": [], + "samlMetadataUrl": null, + "samlSingleSignOnSettings": null, + "servicePrincipalNames": [ + "f1bd758f-4a1a-4b71-aa20-a248a22a8928" + ], + "signInAudience": "AzureADandPersonalMicrosoftAccount", + "tags": [], + "addIns": [], + "api": { + "resourceSpecificApplicationPermissions": [] + }, + "appRoles": [], + "info": { + "termsOfServiceUrl": null, + "supportUrl": null, + "privacyStatementUrl": null, + "marketingUrl": null, + "logoUrl": null + }, + "keyCredentials": [], + "publishedPermissionScopes": [], + "passwordCredentials": [] +} +``` ++### Example 2: Update an existing servicePrincipal ++The following example updates the servicePrincipal because a servicePrincipal with the specified **appId** value exists. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "upsert_update_serviceprincipal" +} +--> ++```http +PATCH https://graph.microsoft.com/v1.0/servicePrincipals(appId='65415bb1-9267-4313-bbf5-ae259732ee12') +Content-type: application/json +Prefer: create-if-missing ++{ + "displayName": "My app instance" +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [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 +``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "Create serviceprincipal", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + ] +} +--> |
v1.0 | Signin Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/signin-get.md | One of the following permissions is required to call this API. To learn more, in 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 one of the following directory roles that allow them to read sign-in reports. To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference): -+ Global Administrator +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 |
v1.0 | Signin List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/signin-list.md | One of the following permissions is required to call this API. To learn more, in 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 one of the following directory roles that allow them to read sign-in reports. To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): -+ Global Administrator +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 |
v1.0 | Site Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/site-delta.md | Your application should continue making calls using the **@odata.nextLink** unti After you receive all the changes, you can apply them to your local state. To monitor future changes, call the **delta** API by using the **@odata.deltaLink** in the previous response. -Deleted sites are returned with the @removed annotation with the reason for removal. Any resources marked as deleted should be removed from your local state. +Any resources marked as deleted should be removed from your local state. + ## Permissions The following example shows the initial request and how to call this API to esta The following example shows the initial request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_sites_delta_first", "tags": "service.graph" } --> -```http +```msgraph-interactive GET https://graph.microsoft.com/v1.0/sites/delta ``` +# [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 that includes the first page of changes and the **@odata.nextLink** property that indicates that no more sites are available in the current set of sites. Your app should continue to request the URL value of **@odata.nextLink** until all pages of sites are retrieved. The following example shows a request that accesses the last page in a set and h The following example shows a request after the initial request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-sites-delta-last", "tags": "service.graph" }--> -```http +```msgraph-interactive GET https://graph.microsoft.com/v1.0/sites/delta?token=1230919asd190410jlka ``` +# [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 that indicates that the site named `All Company` was deleted between the initial request and this request to update the local state. Content-type: application/json "displayName": "All Company", "isPersonalSite": false, "id": "bd565af7-7963-4658-9a77-26e11ac73186",- "@removed": { - "reason": "deleted" - }, "root": {} } ] To retrieve the latest `deltaLink`, call `delta` with the query string parameter The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-sites-delta-latest", "scopes": "sites.read", "tags": "service.graph", "target": "action" } --> -```http +```msgraph-interactive GET https://graph.microsoft.com/v1.0/sites/delta?token=latest ``` +# [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 | Site Follow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/site-follow.md | Namespace: microsoft.graph Follow a user's [site](../resources/site.md) or multiple sites. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 [!INCLUDE [sample-code](../includes/snippets/php/follow-site-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/follow-site-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Site Unfollow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/site-unfollow.md | Namespace: microsoft.graph Unfollow a user's [site](../resources/site.md) or multiple sites. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 [!INCLUDE [sample-code](../includes/snippets/php/unfollow-site-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/unfollow-site-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Sitepage Create Webpart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sitepage-create-webpart.md | + + Title: 'Create webPart' +description: 'Create a new webPart at a specified position in the sitePage' ++ms.localizationpriority: medium +++# Create webPart ++Namespace: microsoft.graph ++Create a new [webPart] at a specified position in the [sitePage]. ++[sitePage]: ../resources/sitepage.md +[webPart]: ../resources/webPart.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_create_webpart" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +POST /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts +POST /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns/{horizontal-section-column-id}/webparts +``` ++## Optional query parameters ++| Name | Description | +| :- | :-- | +| index | The position at which the web part should be inserted in the collection of web parts | ++## 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 [textWebPart](../resources/textWebPart.md) or [standardWebPart](../resources/standardWebPart.md). ++To ensure successful parsing of the request body, the `@odata.type=#microsoft.graph.textwebpart` or `@odata.type=#microsoft.graph.standardwebpart` must be included in the request body. ++### Supported web parts ++There are two kinds of web parts that can be added to a [sitePage](../resources/sitepage.md): [standardWebPart](../resources/standardWebPart.md) and [textWebPart](../resources/textWebPart.md). ++For [standardWebPart](../resources/standardWebPart.md), only the following are supported when updating using the Microsoft Graph API. Attempting to add unsupported web parts will result in a failure or exception. ++| # | Web Part | Type | +| | -- | -- | +| 1 | Bing Maps | `e377ea37-9047-43b9-8cdb-a761be2f8e09` | +| 2 | Button | `0f087d7f-520e-42b7-89c0-496aaf979d58` | +| 3 | Call To Action | `df8e44e7-edd5-46d5-90da-aca1539313b8` | +| 4 | Divider | `2161a1c6-db61-4731-b97c-3cdb303f7cbb` | +| 5 | Document Embed | `b7dd04e1-19ce-4b24-9132-b60a1c2b910d` | +| 6 | Image | `d1d91016-032f-456d-98a4-721247c305e8` | +| 7 | Image Gallery | `af8be689-990e-492a-81f7-ba3e4cd3ed9c` | +| 8 | Link Preview | `6410b3b6-d440-4663-8744-378976dc041e` | +| 9 | Org Chart | `e84a8ca2-f63c-4fb9-bc0b-d8eef5ccb22b` | +| 10 | People | `7f718435-ee4d-431c-bdbf-9c4ff326f46e` | +| 11 | Quick Links | `c70391ea-0b10-4ee9-b2b4-006d3fcad0cd` | +| 12 | Spacer | `8654b779-4886-46d4-8ffb-b5ed960ee986` | +| 13 | Youtube Embed | `544dd15b-cf3c-441b-96da-004d5a8cea1d` | ++## Response ++If successful, this method returns a `201` and the created [webPart](../resources/webPart.md) object in the response body. ++## Example ++### Request ++The following example shows how to create a new webpart. ++<!-- { "blockType": "ignored" } --> ++```http +POST /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202//microsoft.graph.sitePage/canvasLayout/verticalSection/webparts +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.textWebPart", + "innerHtml": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus blandit pellentesque ipsum tempor porta. Phasellus tincidunt et ipsum nec iaculis. Sed eu arcu tristique, congue erat a, consequat lorem. Suspendisse ac ullamcorper elit. Sed ultricies, risus sed hendrerit dictum, nunc massa ornare velit, a pharetra dolor urna quis lorem. Maecenas eget pellentesque purus, nec ultricies risus. Donec rhoncus lorem at euismod varius. Donec auctor sed mi vitae pharetra. Aenean id tempor mauris. Donec dui nulla, semper ut elit id, mattis commodo arcu. Aliquam erat volutpat." +} +``` ++++### Response ++If successful, this method returns a [webPart][] in the response body for the created webPart. ++<!-- { "blockType": "response", "@odata.type": "microsoft.graph.webPart", "truncated": true } --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.textWebPart", + "id": "51053496-e6f3-4161-94ac-07bdf4d92226", + "innerHtml": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus blandit pellentesque ipsum tempor porta. Phasellus tincidunt et ipsum nec iaculis. Sed eu arcu tristique, congue erat a, consequat lorem. Suspendisse ac ullamcorper elit. Sed ultricies, risus sed hendrerit dictum, nunc massa ornare velit, a pharetra dolor urna quis lorem. Maecenas eget pellentesque purus, nec ultricies risus. Donec rhoncus lorem at euismod varius. Donec auctor sed mi vitae pharetra. Aenean id tempor mauris. Donec dui nulla, semper ut elit id, mattis commodo arcu. Aliquam erat volutpat." +} +``` ++[webPart]: ../resources/webPart.md ++<!-- +{ + "type": "#webpart.annotation", + "description": "Create a WebPart.", + "keywords": "", + "section": "documentation", + "tocPath": "WebParts/Create", + "suppressions": [] +} +--> |
v1.0 | Sitepage Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sitepage-create.md | ++ +description: "Create a new sitePage in the site pages list in a site." Last updated : 05/07/2018+ Title: Create a new page in a SharePoint site +ms.localizationpriority: medium +++# Create a page in the site pages list of a site ++Namespace: microsoft.graph ++Create a new [sitePage][] in the site pages [list][] in a [site][]. ++[sitePage]: ../resources/sitepage.md +[list]: ../resources/list.md +[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_create" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +POST /sites/{site-id}/pages +``` +## 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 [sitePage](../resources/sitepage.md) resource to create. ++> **Notes:** : +> 1. To ensure successful parsing of the request body, the `@odata.type=#microsoft.graph.sitePage` must be included in the request body. +> 2. If you're using the response from the [Get sitepage](../api/sitepage-get.md) operation to create a **sitePage**, we recommend that you add the HTTP header `Accept: application/json;odata.metadata=none`. This will remove all OData metadata from the response. You can also manually remove all OData metadata. +> 3. Only the web part listed in the [Supported web parts](#supported-web-parts) section are supported when creating a [sitePage](../resources/sitepage.md) using the Microsoft Graph API. Attempting to add unsupported web parts will result in a failure or exception. ++### Supported web parts ++There are two kinds of web parts that can be added to a [sitePage](../resources/sitepage.md): [standardWebParts](../resources/standardwebpart.md) and [textWebPart](../resources/textwebpart.md). The following table lists the supported web parts for standard web parts. ++| # | Web Part | Type | +| | -- | -- | +| 1 | Bing Maps | `e377ea37-9047-43b9-8cdb-a761be2f8e09` | +| 2 | Button | `0f087d7f-520e-42b7-89c0-496aaf979d58` | +| 3 | Call To Action | `df8e44e7-edd5-46d5-90da-aca1539313b8` | +| 4 | Divider | `2161a1c6-db61-4731-b97c-3cdb303f7cbb` | +| 5 | Document Embed | `b7dd04e1-19ce-4b24-9132-b60a1c2b910d` | +| 6 | Image | `d1d91016-032f-456d-98a4-721247c305e8` | +| 7 | Image Gallery | `af8be689-990e-492a-81f7-ba3e4cd3ed9c` | +| 8 | Link Preview | `6410b3b6-d440-4663-8744-378976dc041e` | +| 9 | Org Chart | `e84a8ca2-f63c-4fb9-bc0b-d8eef5ccb22b` | +| 10 | People | `7f718435-ee4d-431c-bdbf-9c4ff326f46e` | +| 11 | Quick Links | `c70391ea-0b10-4ee9-b2b4-006d3fcad0cd` | +| 12 | Spacer | `8654b779-4886-46d4-8ffb-b5ed960ee986` | +| 13 | Youtube Embed | `544dd15b-cf3c-441b-96da-004d5a8cea1d` | ++## Response ++If successful, this method returns a `201` and the created [sitePage](../resources/basesitepage.md) object. ++## Example ++The following example shows how to create a new page. ++### Request ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "create-page", "scopes": "sites.readwrite.all" } --> ++```http +POST /sites/{site-id}/pages +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.sitePage", + "name": "test.aspx", + "title": "test", + "pageLayout": "article", + "showComments": true, + "showRecommendedPages": false, + "titleArea": { + "enableGradientEffect": true, + "imageWebUrl": "https://cdn.hubblecontent.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, + "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" + } + } + ] + } + } + } + ] + } + ] + } + ] + } +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++++### Response ++If successful, this method returns a [sitePage][] in the response body for the created page. ++<!-- { "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": "test.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/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.hubblecontent.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 + } +} +``` ++**Note:** The response object is truncated for clarity. Default properties will be returned from the actual call. ++[list]: ../resources/list.md +[listitem]: ../resources/listitem.md +[site]: ../resources/site.md +[sitePage]: ../resources/sitepage.md ++<!-- +{ + "type": "#page.annotation", + "description": "Create a sitePage in the SitePages list in a site.", + "keywords": "", + "section": "documentation", + "tocPath": "Pages/Create", + "suppressions": [] +} +--> |
v1.0 | Sitepage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sitepage-get.md | ++ +description: "Returns the metadata for a sitePage in the site pages list in a site." Last updated : 03/15/2018+ Title: Get sitePage +ms.localizationpriority: medium +++# Get SitePage ++Namespace: microsoft.graph ++Returns the metadata for a [sitePage][] in the site pages [list][] in a [site][]. ++[sitePage]: ../resources/sitepage.md +[list]: ../resources/list.md +[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_get" } --> +++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage +``` ++## 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 string parameter to include the content of an item when retrieving the metadata of an item 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 will be used in another request. | ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200` and a [sitePage](../resources/sitepage.md) object in the response body. +++## Examples ++### Example 1: Get a page in the site pages list of a site +#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "get-page", "scopes": "sites.read.all", "tags": "service.sharepoint" } --> ++```msgraph-interactive +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage +``` ++# [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": "microsoft.graph.sitePage", "truncated": true } --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.type": "microsoft.graph.sitePage", + "description": "Here's the page description", + "id": "65e59907-59d5-44ff-a038-7c0bf3098c01", + "name": "Home.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Home.aspx", + "title": "Organization Home", + "thumbnailWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/00210d24-bba0-42e6-9a31-1d452a95dd75/thumbnails/large.jpg?file=163352059.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 using select and expand ++#### Request ++With `$select` and `$expand` statements, you can retrieve sitePage metadata and page content in a single request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_sitePage" +} +--> ++```msgraph-interactive +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage?$select=id,name +``` ++# [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": "microsoft.graph.sitePage", "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 with page content ++#### Request ++You can expand references in your URL with the _$expand_ query parameter. To access the page with page content, append the `?$expand=canvasLayout` query string. ++```http +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage?$expand=canvasLayout +``` ++#### Response ++The following example shows the response. +```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/autotest Electronic Convertible.aspx", + "title": "autotest Electronic Convertible", + "pageLayout": "article", + "thumbnailWebUrl": "https://media.akamai.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": "#page.annotation", + "description": "Get a page in a site", + "keywords": "", + "section": "documentation", + "tocPath": "Pages/Get", + "suppressions": [ + ] +} +--> |
v1.0 | Sitepage Getwebpartsbyposition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sitepage-getwebpartsbyposition.md | + + Title: "sitePage getWebPartsByPosition" +description: "Get a collection of webParts by position." ++ms.localizationpriority: medium +++# sitePage: getWebPartsByPosition ++Namespace: microsoft.graph ++Get a collection of [webPart](../resources/webpart.md) by providing [webPartPosition](../resources/webpartposition.md) information. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_getwebpartsbyposition" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitepage/getWebPartsByPosition +``` ++## Function parameters ++In the request URL, provide one or more following parameters with a valid value. ++| Parameter | Type | Description | +| : | : | :- | +| columnId | Double | Indicates the identifier of the column where the WebPart located. Only works if `horizontalSectionId` is provided. | +| horizontalSectionId | Double | Indicates the horizontal section where the WebPart located. | +| isInVerticalSection | boolean | Indicate whether the WebPart is contained in the current vertical section. | +| webPartIndex | Double | The index of the current WebPart. Represents the order of WebPart in the current column or section. Only works if either `columnId` or `isInVerticalSection` is provided. | ++## Optional query parameters ++This method supports the `$expand`, `$filter`, and `$select` [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 OK` response code and a collection of [webPart](../resources/webpart.md) objects in the response body. ++## Examples ++### Request ++The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_webparts_by_position" +} +--> ++```msgraph-interactive +GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/getWebPartsByPosition?isInVerticalSection=true +``` ++# [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.webPart)" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.textWebPart", + "id": "d79d70af-27ea-4208-8dce-23c3bf678664", + "innerHtml": "<h2>How do you get started?</h2>" + } + ] +} +``` |
v1.0 | Sitepage List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sitepage-list.md | ++ +description: "Get the collection of sitePage objects from the site pages [list] in a site. All pages in the site are returned (with pagination)." Last updated : 03/15/2018+ Title: List SitePage +ms.localizationpriority: medium +++# List SitePage ++Namespace: microsoft.graph ++Get the collection of [sitePage][] objects from the site pages [list][] in a site [site][]. All pages in the site are returned (with pagination). Sort alphabetically by `name` in ascending order. ++[sitePage]: ../resources/sitepage.md +[list]: ../resources/list.md +[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_list" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +GET /sites/{site-id}/pages/microsoft.graph.sitePage +``` ++## 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 [sitePage](../resources/sitepage.md) object in the response body. ++## Example ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!--{ + "blockType": "request", + "name": "get-pages", + "scopes": "sites.read.all", + "tags": "service.sharepoint" +} +--> ++```msgraph-interactive +GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/microsoft.graph.sitePage +``` ++# [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": "microsoft.graph.sitePage", + "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/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.hubblecontent.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/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.hubblecontent.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": "#page.annotation", + "description": "Enumerate the list of pages in a site", + "keywords": "", + "section": "documentation", + "tocPath": "Pages/Enumerate", + "suppressions": [ + ] +} +--> |
v1.0 | Sitepage Post Horizontalsection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sitepage-post-horizontalsection.md | + + Title: 'Create horizontalSection' +description: "Create a horizontalSection in a page" ++ms.localizationpriority: medium ++# Create horizontalSection ++Namespace: microsoft.graph ++Create a [horizontalSection](../resources/horizontalSection.md) object in a given [sitePage](../resources/sitepage.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_post_horizontalsection" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +POST /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections +``` ++## 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 [horizontalSection](../resources/horizontalSection.md) resource to create. ++## Response ++If successful, this method returns a `201 Created` response code and a created [horizontalSection](../resources/horizontalSection.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++```http +POST https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections +Content-Type: application/json ++{ + "emphasis": "soft", + "layout": "oneColumn", + "id": "3", + "columns": [ + { + "id": "1", + "width": 12, + "webparts":[ + { + "id":"20a69b85-529c-41f3-850e-c93458aa74eb", + "innerHtml":"<p>sample text in text web part</p>" + } + ] + } + ] +} +``` ++### Response ++The following example shows the response. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.horizontalSection", + "truncated": true +} +--> ++```http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "emphasis": "soft", + "layout": "oneColumn", + "id": "3", + "columns": [ + { + "id": "1", + "width": 12, + "webparts":[ + { + "id":"20a69b85-529c-41f3-850e-c93458aa74eb", + "innerHtml":"<p>sample text in text web part</p>" + } + ] + } + ] +} +``` |
v1.0 | Sitepage Post Verticalsection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sitepage-post-verticalsection.md | + + Title: 'Create verticalSection' +description: "Create a verticalSection in a page" ++ms.localizationpriority: medium ++# Create verticalSection ++Namespace: microsoft.graph ++Create a [verticalSection](../resources/verticalSection.md) object in a given [sitePage](../resources/sitepage.md). ++A [sitePage](../resources/sitepage.md) can only have one vertical section. If a vertical section already exists, this method returns a `409 Conflict` response code. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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_post_verticalsection" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PUT /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection +``` ++## 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 [verticalSection](../resources/verticalSection.md) resource to create. ++## Response ++If successful, this method returns a `201 Created` response code and a created [verticalSection](../resources/verticalSection.md) object in the response body. ++If the vertical section already exists, this method returns a `409 Conflict` response code. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++```http +PUT https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/verticalSection +Content-Type: application/json ++{ + "emphasis": "soft", + "webparts":[ + { + "id":"20a69b85-529c-41f3-850e-c93458aa74eb", + "innerHtml":"<p>sample text in text web part</p>" + } + ] +} +``` ++++### Response ++The following example shows the response. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.verticalSection", + "truncated": true +} +--> ++```http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "emphasis": "soft", + "webparts":[ + { + "id":"20a69b85-529c-41f3-850e-c93458aa74eb", + "innerHtml":"<p>sample text in text web part</p>" + } + ] +} +``` |
v1.0 | Sitepage Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sitepage-publish.md | ++ +description: "Publish the latest version of a sitePage resource, which makes the version of the page available to all users." + Title: "sitePage: publish" +ms.localizationpriority: medium ++# sitePage: publish ++Namespace: microsoft.graph ++Publish the latest version of a [sitePage][] resource, which makes the version of the page available to all users. If the page is checked out, check in the page and publish it. If the page is checked out to the caller of this API, the page is automatically checked in and then published. ++> If a page approval flow has been activated in the page library, the page is not published until the approval flow is completed. ++[sitePage]: ../resources/sitepage.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_publish" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +POST /sites/{siteId}/pages/{pageId}/microsoft.graph.sitePage/publish +``` ++## 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`. It does not return anything in the response body. ++<!-- { "blockType": "response" } --> ++```http +HTTP/1.1 204 No Content +``` +++<!-- +{ + "type": "#page.annotation", + "description": "Publish a page.", + "keywords": "publish page", + "section": "documentation", + "tocPath": "Pages/Publish", + "suppressions": [] +} +--> ++ |
v1.0 | Sitepage Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sitepage-update.md | + + Title: "Update sitePage" +description: "Update the properties of a sitePage object." ++ms.localizationpriority: medium +++# Update sitePage ++Namespace: microsoft.graph ++Update the properties of a [sitePage](../resources/sitepage.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": "sitepage_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage +``` ++## 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 +++These fields and be used in update requests. ++| Property | Type | Description | +| :- | :- | :-- | +| description | String | Description of the site page. Optional. | +| thumbnailWebUrl | String | Url of the site page's thumbnail image. Optional. | +| title | String | Title of the site page. Optional. | +| showComments | Boolean | Boolean to determine whether or not to show comments at the bottom of the page. Optional. | +| showRecommendedPages | Boolean | Boolean to determine whether or not to show recommended pages at the bottom of the page. Optional. | +| promotionKind | [PagePromotionType](../resources/sitepage.md#pagepromotiontype-values) | Promotion kind of the SharePoint page. Optional. Only support promote a page (e.g from `page` to `newsPost`). Demote is not supported. | +| titleArea | [titleArea](../resources/titlearea.md) | Title area on the site page. Optional. | +| canvasLayout | [canvasLayout](../resources/canvaslayout.md) | The layout of the content in a page, including horizontal sections and vertical section. A content of the entire page layout needs to be provided, the update function does not support partial updates. Optional. | ++> **Notes:** : +> 1. To ensure successful parsing of the request body, the `@odata.type=#microsoft.graph.sitePage` must be included in the request body. +> 2. If you're using the response from the [Get sitepage](../api/sitepage-get.md) operation to update a **sitePage**, we recommend that you add the HTTP header `Accept: application/json;odata.metadata=none`. This will remove all OData metadata from the response. You can also manually remove all OData metadata. +> 3. Only the web part listed in the [Supported web parts](#supported-web-parts) section are supported when updating a [sitePage](../resources/sitepage.md) using the Microsoft Graph API. Attempting to add unsupported web parts will result in a failure or exception. ++### Supported web parts ++There are two kinds of web parts that can be added to a [sitePage](../resources/sitepage.md): [standardWebParts](../resources/standardwebpart.md) and [textWebPart](../resources/textwebpart.md). The following table lists the supported web parts for standard web parts. ++| # | Web Part | Type | +| | -- | -- | +| 1 | Bing Maps | `e377ea37-9047-43b9-8cdb-a761be2f8e09` | +| 2 | Button | `0f087d7f-520e-42b7-89c0-496aaf979d58` | +| 3 | Call To Action | `df8e44e7-edd5-46d5-90da-aca1539313b8` | +| 4 | Divider | `2161a1c6-db61-4731-b97c-3cdb303f7cbb` | +| 5 | Document Embed | `b7dd04e1-19ce-4b24-9132-b60a1c2b910d` | +| 6 | Image | `d1d91016-032f-456d-98a4-721247c305e8` | +| 7 | Image Gallery | `af8be689-990e-492a-81f7-ba3e4cd3ed9c` | +| 8 | Link Preview | `6410b3b6-d440-4663-8744-378976dc041e` | +| 9 | Org Chart | `e84a8ca2-f63c-4fb9-bc0b-d8eef5ccb22b` | +| 10 | People | `7f718435-ee4d-431c-bdbf-9c4ff326f46e` | +| 11 | Quick Links | `c70391ea-0b10-4ee9-b2b4-006d3fcad0cd` | +| 12 | Spacer | `8654b779-4886-46d4-8ffb-b5ed960ee986` | +| 13 | Youtube Embed | `544dd15b-cf3c-441b-96da-004d5a8cea1d` | ++## Response ++If successful, this method returns a `200 OK` response code and an updated [sitePage](../resources/sitepage.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_sitepage" +} +--> ++```http +PATCH https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.sitePage", + "title": "sample", + "showComments": true, + "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.sitePage", + "truncated": true +} +--> ++```http +HTTP/1.1 200 OK +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": "draft", + "versionId": "0.1" + }, + "titleArea": { + "enableGradientEffect": true, + "imageWebUrl": "https://cdn.hubblecontent.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 | Subscription Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/subscription-delete.md | description: "Delete a subscription." ms.localizationpriority: medium doc_type: apiPageType+ # Delete subscription |
v1.0 | Subscription Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/subscription-get.md | Title: "Get subscription" description: "Retrieve the properties and relationships of a subscription." ms.localizationpriority: high + doc_type: apiPageType |
v1.0 | Subscription List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/subscription-list.md | Title: "List subscriptions" description: "Retrieve the properties and relationships of webhook subscriptions, based on the app ID, the user, and the user's role with a tenant." ms.localizationpriority: high + doc_type: apiPageType |
v1.0 | Subscription Post Subscriptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/subscription-post-subscriptions.md | Title: "Create subscription" description: "Subscribes a listener application to receive change notifications when data on the Microsoft Graph changes." ms.localizationpriority: high + doc_type: apiPageType |
v1.0 | Subscription Reauthorize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/subscription-reauthorize.md | Title: "subscription: reauthorize" description: "Reauthorize a subscription when you receive a reauthorizationRequired challenge." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Subscription Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/subscription-update.md | Title: "Update subscription" description: "Renew a subscription by extending its expiry time." ms.localizationpriority: medium + doc_type: apiPageType PATCH /subscriptions/{id} [!INCLUDE [table-intro](../../includes/update-property-table-intro.md)] +The request body must include at least one of the properties listed. + | Name | Type | Description| |:--|:|:-| | expirationDateTime | DateTimeOffset | Specifies the date and time in UTC when the subscription expires. For the maximum supported subscription length of time varies depending on the resource. |+| notificationUrl | String | This URL must make use of the HTTPS protocol. Any query string parameter included in the notificationUrl property is included in the HTTP POST request when Microsoft Graph sends the change notifications.| ## Response |
v1.0 | Table Converttorange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-converttorange.md | POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name} ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Table Databodyrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-databodyrange.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/ ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Table Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookTable](../resources/table.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookTable](../resources/workbooktable.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Table Headerrowrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-headerrowrange.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/ ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Table List Columns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-list-columns.md | Don't supply a request body for this method. ## Response -If successful, the method returns a `200 OK` response code and collection of [WorkbookTableColumn](../resources/workbooktablecolumn.md) objects in the response body. +If successful, the method returns a `200 OK` response code and collection of [workbookTableColumn](../resources/workbooktablecolumn.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Table List Rows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-list-rows.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookTableRow](../resources/workbooktablerow.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookTableRow](../resources/workbooktablerow.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Table List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-list.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookTable](../resources/table.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookTable](../resources/workbooktable.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Table Post Columns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-post-columns.md | POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name} | Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body-In the request body, supply a JSON representation of [WorkbookTableColumn](../resources/workbooktablecolumn.md) object. +In the request body, supply a JSON representation of [workbookTableColumn](../resources/workbooktablecolumn.md) object. ## Response -If successful, this method returns `201 Created` response code and [WorkbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. +If successful, this method returns `201 Created` response code and [workbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. ## Example ##### Request Content-type: application/json -In the request body, supply a JSON representation of [WorkbookTableColumn](../resources/workbooktablecolumn.md) object. +In the request body, supply a JSON representation of [workbookTableColumn](../resources/workbooktablecolumn.md) object. ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Table Range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-range.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/ ## Response -If successful, this method returns a `200 OK` response code and a [workbookRange](../resources/range.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [workbookRange](../resources/workbookrange.md) object in the response body. ## Example |
v1.0 | Table Totalrowrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-totalrowrange.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/ ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Table Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/table-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and an updated [workbookTable](../resources/table.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [workbookTable](../resources/workbooktable.md) object in the response body. ## Example ### Request |
v1.0 | Tablecollection Add | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablecollection-add.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `200 OK` response code and [WorkbookTable](../resources/table.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookTable](../resources/workbooktable.md) object in the response body. ## Example Here's an example of how to call this API. |
v1.0 | Tablecolumn Databodyrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablecolumn-databodyrange.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/ ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Tablecolumn Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablecolumn-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Tablecolumn Headerrowrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablecolumn-headerrowrange.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/ ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Tablecolumn List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablecolumn-list.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookTableColumn](../resources/workbooktablecolumn.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookTableColumn](../resources/workbooktablecolumn.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Tablecolumn Range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablecolumn-range.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/ ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Tablecolumn Totalrowrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablecolumn-totalrowrange.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/ ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Tablecolumn Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablecolumn-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Tablecolumncollection Add | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablecolumncollection-add.md | In the request body, provide a JSON object with the following parameters. |name|string|name ## Response -If successful, this method returns `200 OK` response code and [WorkbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. ## Example Here's an example of how to call this API. |
v1.0 | Tablecolumncollection Itemat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablecolumncollection-itemat.md | Don't supply a request body for this method. ## Response -If successful, this method returns `200 OK` response code and [WorkbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Tablerow Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablerow-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookTableRow](../resources/workbooktablerow.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookTableRow](../resources/workbooktablerow.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Tablerow List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablerow-list.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookTableRow](../resources/workbooktablerow.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookTableRow](../resources/workbooktablerow.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Tablerow Range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablerow-range.md | Don't supply a request body for this method. ## Response -If successful, this method returns `200 OK` response code and a [range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and a [range](../resources/workbookrange.md) object in the response body. ## Examples |
v1.0 | Tablerow Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablerow-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookTableRow](../resources/workbooktablerow.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookTableRow](../resources/workbooktablerow.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Tablerowcollection Add | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablerowcollection-add.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `200 OK` response code and [WorkbookTableRow](../resources/workbooktablerow.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookTableRow](../resources/workbooktablerow.md) object in the response body. ## Example In this example two rows of data are inserted at the end of the table. |
v1.0 | Tablerowcollection Itemat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablerowcollection-itemat.md | Don't supply a request body for this method.| ## Response -If successful, this method returns `200 OK` response code and [WorkbookTableRow](../resources/workbooktablerow.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookTableRow](../resources/workbooktablerow.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Tablesort Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tablesort-get.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookTableSort](../resources/tablesort.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookTableSort](../resources/workbooktablesort.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Team Clone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-clone.md | You can specify which parts of the team to clone: - **settings** ΓÇô Copies all settings within the team, along with key group settings. - **tabs** ΓÇô Copies the tabs within channels. -> **Note:** This method isn't supported for organization-wide teams. +> [!NOTE] +> This method isn't supported for organization-wide teams. > [!NOTE] > A known issue related to owners of cloned teams is associated with this method. For details, see [Known issues](https://developer.microsoft.com/graph/known-issues). When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. -If the user who opens the tab doesn't have permission to configure apps, they'll see a message that says that the tab isn't configured. +If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation. After the POST clone returns, you need to GET the [operation](../resources/teamsasyncoperation.md) returned by the `Location:` header to see if it's `running`, `succeeded`, or `failed`. You should continue to GET until the status isn't `running`. The recommended delay between GETs is 5 seconds. Cloning is a long-running operation. After the POST clone returns, you need to G ## Permissions -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) | Team.Create, Group.ReadWrite.All**, Directory.ReadWrite.All** | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Team.Create, Group.ReadWrite.All**, Directory.ReadWrite.All** | +<!-- { "blockType": "permissions", "name": "team_clone" } --> -> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All and Directory.ReadWrite.All 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" } --> POST /teams/{id}/clone | Property | Type |Description| |:|:--|:-|-|classification|String (optional)|Describes a classification for the group (such as low, medium or high business impact). If classification isn't specified, the classification is copied from the original team/group.| -|description|String (optional)|An optional description for the group. If this property isn't specified, it is left blank.| +|classification|String (optional)|Describes a classification for the group (such as low, medium, or high business impact). If classification isn't specified, the classification is copied from the original team/group.| +|description|String (optional)|An optional description for the group. If this property isn't specified, it's left blank.| |displayName|String|The display name for the group. This property is required when a group is created and it can't be cleared during updates. Supports $filter and $orderby.|-|mailNickname|String|The mail alias for the group, unique in the organization. This property must be specified when a group is created. Supports $filter. If this property isn't specified, it is computed from the displayName. Known issue: this property is currently ignored.| +|mailNickname|String|The mail alias for the group, unique in the organization. This property must be specified when a group is created. Supports `filter`. If this property isn't specified, it's computed from the displayName. This property is currently ignored.| |partsToClone| [clonableTeamParts](../resources/clonableteamparts.md) |A comma-separated list of the parts to clone. Legal parts are "apps, tabs, settings, channels, members".| |visibility|[teamVisibilityType](../resources/teamvisibilitytype.md) (optional)| Specifies the visibility of the group. Possible values are: **Private**, **Public**. If visibility isn't specified, the visibility is copied from the original team/group. If the team being cloned is an **educationClass** team, the visibility parameter is ignored, and the new group's visibility will be set to HiddenMembership.| |
v1.0 | Team Delete Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-delete-installedapps.md | Uninstalls an [app](../resources/teamsappinstallation.md) from the specified [te ## Permissions -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) | TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam, Group.ReadWrite.All**, Directory.ReadWrite.All** | -|Delegated (personal Microsoft account) | Not supported. | -|Application | TeamsAppInstallation.ReadWriteSelfForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, Group.ReadWrite.All**, Directory.ReadWrite.All** | +<!-- { "blockType": "permissions", "name": "team_delete_installedapps" } --> -> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Team Get Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-get-installedapps.md | Retrieve the [app](../resources/teamsappinstallation.md) installed in the specif ## Permissions -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) | TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadForUser, TeamsAppInstallation.ReadForTeam, TeamsAppInstallation.ReadWriteForTeam, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam, TeamsAppInstallation.ReadWriteAndConsentForTeam, Group.Read.All<sup>1</sup>, Group.ReadWrite.All<sup>1</sup>, Directory.Read.All<sup>1</sup>, Directory.ReadWrite.All<sup>1</sup> | -|Delegated (personal Microsoft account) | Not supported. | -|Application | TeamsAppInstallation.Read.Group<sup>2</sup>, TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, TeamsAppInstallation.ReadWriteAndConsentForTeam.All, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam.All, Group.Read.All<sup>1</sup>, Group.ReadWrite.All<sup>1</sup>, Directory.Read.All<sup>1</sup>, Directory.ReadWrite.All<sup>1</sup> | +<!-- { "blockType": "permissions", "name": "team_get_installedapps" } --> +> [!NOTE] +> - The Group.Read.All, Group.ReadWrite.All, Directory.Read.All, and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. +> - The TeamsAppInstallation.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request |
v1.0 | Team Get Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-get-members.md | Get a [conversationMember](../resources/conversationmember.md) from a [team](../ ## Permissions -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)| TeamMember.Read.All, TeamMember.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application| TeamMember.Read.Group*, TeamMember.Read.All, TeamMember.ReadWrite.All | +<!-- { "blockType": "permissions", "name": "team_get_members" } --> ++> [!NOTE] +> The TeamMember.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). -> **Note**: Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored"} --> ```http GET /teams/{team-id}/members/{membership-id} ## Optional query parameters -This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers |
v1.0 | Team Get Primarychannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-get-primarychannel.md | Get the default [channel](../resources/channel.md), **General**, of a [team](../ [!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) | Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | ChannelSettings.Read.Group*, ChannelSettings.ReadWrite.Group*, Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All | +This API supports admin permissions. Global admins can access groups that they aren't a member of. -> **Note**: Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +<!-- { "blockType": "permissions", "name": "team_get_primarychannel" } --> -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> [!NOTE] +> The ChannelSettings.Read.Group and ChannelSettings.ReadWrite.Group permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Team List Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-list-installedapps.md | Retrieve a list of [apps installed](../resources/teamsappinstallation.md) in the ## Permissions -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) | TeamsAppInstallation.ReadForTeam, TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam, TeamsAppInstallation.ReadWriteAndConsentForTeam, Group.Read.All<sup>1</sup>, Group.ReadWrite.All<sup>1</sup>, Directory.Read.All<sup>1</sup>, Directory.ReadWrite.All<sup>1</sup> | -|Delegated (personal Microsoft account) | Not supported. | -|Delegated (work or school account) | TeamsAppInstallation.ReadForTeam, TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam, TeamsAppInstallation.ReadWriteAndConsentForTeam, Group.Read.All<sup>1</sup>, Group.ReadWrite.All<sup>1</sup>, Directory.Read.All<sup>1</sup>, Directory.ReadWrite.All<sup>1</sup> | +<!-- { "blockType": "permissions", "name": "team_list_installedapps" } --> +> [!NOTE] +> The Group.Read.All, Group.ReadWrite.All, Directory.Read.All, and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. ## HTTP request |
v1.0 | Team List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-list-members.md | Namespace: microsoft.graph Get the [conversationMember](../resources/conversationmember.md) collection of a [team](../resources/team.md). -The membership IDs returned by the server must be treated as opaque strings. The client should not try to parse or make assumptions about these resource IDs. +The membership IDs returned by the server must be treated as opaque strings. The client shouldn't try to parse or make assumptions about these resource IDs. -In the future, membership results may include users from various tenants, as indicated in the response. Clients should avoid assuming that all members exclusively belong to the current tenant. +In the future, membership results can include users from various tenants, as indicated in the response. Clients should avoid assuming that all members exclusively belong to the current tenant. > [!NOTE]-> This API results in a 401 error when a newly created tenant calls this method. For more information, see [Known issues](https://developer.microsoft.com/en-us/graph/known-issues/?search=19164). +> This API returns a 401 error when a newly created tenant calls this method. For more information, see [Known issues](https://developer.microsoft.com/en-us/graph/known-issues/?search=19164). [!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)| TeamMember.Read.All, TeamMember.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application| TeamMember.Read.Group*, TeamMember.Read.All, TeamMember.ReadWrite.All | +<!-- { "blockType": "permissions", "name": "team_list_members" } --> -> **Note**: Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamMember.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP 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 | If successful, this method returns a `201 Created` response code and a [conversa For best results, stagger calls with a 2 second buffer. +> [!NOTE] +> The response code `404 Not Found` is returned when you attempt to add a disabled/blocked user. + ## Examples ### Example 1: Add a member to a team |
v1.0 | Team Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-post.md | Create a new [team](../resources/team.md). ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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) | Team.Create, Group.ReadWrite.All**, Directory.ReadWrite.All** | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Team.Create, Teamwork.Migrate.All, Group.ReadWrite.All**, Directory.ReadWrite.All** | +<!-- { "blockType": "permissions", "name": "team_post" } --> -> **Note**: The Teamwork.Migrate.All permission is *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. --> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> - The Teamwork.Migrate.All permission is only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> - The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ## HTTP request To create a team from a non-standard base template, you want to change the `temp To learn more about supported base template types, see [Get started with Teams templates](/MicrosoftTeams/get-started-with-teams-templates). -> [!Note] +> [!NOTE] > It can take up to 24 hours for Teams users to see a custom template change in the gallery. #### Request |
v1.0 | Team Sendactivitynotification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-sendactivitynotification.md | Send an activity feed notification in the scope of a team. For more information [!INCLUDE [national-cloud-support](../../includes/global-us.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)|TeamsActivity.Send| -|Delegated (personal Microsoft account)|Not Supported.| -|Application|TeamsActivity.Send.Group*, TeamsActivity.Send| +<!-- { "blockType": "permissions", "name": "team_sendactivitynotification" } --> ->**Note:** Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsActivity.Send.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request The following table shows the parameters that can be used with this action. |Parameter|Type|Description| |:|:|:| |topic|[teamworkActivityTopic](../resources/teamworkactivitytopic.md)|The topic of the notification. Specifies the resource being talked about.|-|activityType|String|The activity type. Activity types must be declared in the [Teams app manifest](/microsoftteams/platform/overview).| +|activityType|String|The activity type must be declared in the [Teams app manifest](/microsoftteams/platform/overview), except for the `systemDefault` [Reserved activity type](/graph/teams-send-activityfeednotifications/#reserved-activity-types), which provides free-form text in the `Actor+Reason` line of the notification.| |chainId|Int64|Optional. The chain ID for the notification. Used to override a previous notification. Use the same `chainId` in subsequent requests to override the previous notification.| |previewText|[itemBody](../resources/itembody.md)|The preview text for the notification. Microsoft Teams shows the first 150 characters.| |templateParameters|[keyValuePair](../resources/keyvaluepair.md) collection|The values for the template variables defined in the activity feed entry corresponding to `activityType` in the [Teams app manifest](/microsoftteams/platform/overview).| |
v1.0 | Team Teamsappinstallation Upgrade | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-teamsappinstallation-upgrade.md | Title: "teamsAppInstallation in a team: upgrade" -description: "Upgrade an app installation in a team" +description: "Upgrade an app installation in a team." ms.localizationpriority: medium Upgrade an [app installation](../resources/teamsappinstallation.md) in a [team]( ## Permissions -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) | TeamsAppInstallation.ReadWriteSelfForTeam<sup>1</sup>, TeamsAppInstallation.ReadWriteForTeam<sup>1</sup>, TeamsAppInstallation.ReadWriteAndConsentForTeam, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam, Group.ReadWrite.All<sup>2</sup>, Directory.ReadWrite.All<sup>2</sup> | -|Delegated (personal Microsoft account) | Not supported. | -|Application | TeamsAppInstallation.ReadWriteSelfForTeam.All<sup>1</sup>, TeamsAppInstallation.ReadWriteForTeam.All<sup>1</sup>, TeamsAppInstallation.ReadWriteAndConsentForTeam.All, TeamsAppInstallation.ReadWriteAndConsentSelfForTeam.All, Group.ReadWrite.All<sup>2</sup>, Directory.ReadWrite.All<sup>2</sup> | +<!-- { "blockType": "permissions", "name": "team_teamsappinstallation_upgrade" } --> -> **Note**: -<br><sup>1</sup> These permissions cannot be used to install apps that require consent to [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent) permissions. -<br><sup>2</sup> These permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. +> [!NOTE] +> - The TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeampermissions, TeamsAppInstallation.ReadWriteSelfForTeam.All, and TeamsAppInstallation.ReadWriteForTeam.All permissions cannot be used to install apps that require consent to [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent) permissions. +> - The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Teamsapp Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/teamsapp-delete.md | You can also use this API to remove a submitted app from the review process. ## Permissions -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). ->**Note:** Only global administrators can call this API. +Only global administrators can call this API. -| Permission Type | Permissions (from least to most privileged)| -|:- |:-| -| Delegated (work or school account) | AppCatalog.Submit, AppCatalog.ReadWrite.All, Directory.ReadWrite.All** | -| Delegated (personal Microsoft account) | Not supported.| -| Application | Not supported. | +<!-- { "blockType": "permissions", "name": "teamsapp_delete" } --> -> **Note:** -> -> * Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. -> * You can only use the `AppCatalog.Submit` permission to delete app definitions in review. +> [!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. ## HTTP request To delete an app from the app catalog: DELETE /appCatalogs/teamsApps/{id} ``` -To delete an app that has been submitted but has not been approved: +To delete an app that is submitted but isn't yet approved: ```http DELETE appCatalogs/teamsApps/{appId}/appDefinitions/{appDefinitionId} |
v1.0 | Teamsapp Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/teamsapp-publish.md | The **requiresReview** property allows any user to submit an app for review by 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). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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) | AppCatalog.Submit, AppCatalog.ReadWrite.All, Directory.ReadWrite.All** | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Not supported. | +<!-- { "blockType": "permissions", "name": "teamsapp_publish" } --> -> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!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. ## HTTP request <!-- { "blockType": "ignored" } --> POST /appCatalogs/teamsApps?requiresReview={Boolean} |Property|Type|Description| |-|-|-|-|requiresReview| Boolean | This optional query parameter triggers the app review process. Users with admin privileges can submit apps without triggering a review. If users want to request a review before publishing, they must set **requiresReview** to `true`. A user who has admin privileges can opt not to set **requiresReview** or set the value to `false` and the app will be considered approved and will publish instantly.| +|requiresReview| Boolean | This optional query parameter triggers the app review process. Users with admin privileges can submit apps without triggering a review. If users want to request a review before publishing, they must set **requiresReview** to `true`. A user who has admin privileges can opt not to set **requiresReview** or set the value to `false` and the app is approved and immediately published.| ## Request headers |
v1.0 | Teamsapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/teamsapp-update.md | This API specifically updates an app published to your organization's app catalo ## Permissions -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) | AppCatalog.Submit, AppCatalog.ReadWrite.All, Directory.ReadWrite.All** | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Not supported. | +Only Global Administrators can call this API. -> **Note:** -> * Only Global Administrators can call this API. -> * Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +<!-- { "blockType": "permissions", "name": "teamsapp_update" } --> +++> [!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. ## HTTP request POST /appCatalogs/teamsApps/{id}/appDefinitions |Property|Type|Description| |-|-|-|-|requiresReview| Boolean | This optional query parameter triggers the app review process. Users with admin privileges can submit apps without triggering a review. If users want to request a review before publishing, they must set **requiresReview** to `true`. A user who has admin privileges can opt not to set **requiresReview** or set the value to `false` and the app will be considered approved and will publish instantly.| +|requiresReview| Boolean | This optional query parameter triggers the app review process. Users with admin privileges can submit apps without triggering a review. If users want to request a review before publishing, they must set **requiresReview** to `true`. A user who has admin privileges can opt not to set **requiresReview** or set the value to `false` and the app is approved and immediately published.| ## Request headers POST /appCatalogs/teamsApps/{id}/appDefinitions ## Request body -In the request body, include a Teams zip manifest payload. For details, see [Create an app package](/microsoftteams/platform/concepts/apps/apps-package) +In the request body, include a Teams zip manifest payload. For details, see [Create an app package](/microsoftteams/platform/concepts/apps/apps-package). >**Note:** Use the ID returned from the [List published apps](./appcatalogs-list-teamsapps.md) call to reference the app you'd like to update. Do not use the ID from the manifest of the zip app package. The following example shows the response. HTTP/1.1 204 No Content ``` -### Example 2: Update a new version of an existing app for admin review prior to publication in the current tenant catalog +### Example 2: Update a new version of an existing app for admin review before publication in the current tenant catalog #### Request |
v1.0 | Teamwork Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/teamwork-get.md | + + Title: "Get teamwork." +description: "Get organization settings for teamwork, such as the region of the organization and the Microsoft Teams enablement status." ++ms.localizationpriority: high ++++# Get teamwork ++Namespace: microsoft.graph ++Get the properties and relationships of a [teamwork](../resources/teamwork.md) object, such as the region of the organization and whether Microsoft Teams is enabled. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "teamwork_get" } --> ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +GET /teamwork +``` ++## 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 along with a [teamwork](../resources/teamwork.md) object in the response body. +++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_teamworkSettings_for_organization", +}--> ++```msgraph-interactive +GET https://graph.microsoft.com/v1.0/teamwork +``` ++# [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.teamwork" +} --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#teamwork", + "id": "teamwork", + "isTeamsEnabled": true, + "region": "Americas" +} +``` ++## Related content ++- [licenseDetails: getTeamsLicensingDetails](licenseDetails-getteamslicensingdetails.md) +- [Get userTeamwork](userteamwork-get.md) |
v1.0 | Teamwork Sendactivitynotificationtorecipients | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/teamwork-sendactivitynotificationtorecipients.md | The following table shows the parameters that can be used with this action. | Parameter | Type | Description | | :-- | :-- | :-- | | topic | [teamworkActivityTopic](../resources/teamworkactivitytopic.md) | The topic of the notification. Specifies the resource being talked about. |-| activityType | String | The activity type. Activity types must be declared in the [Teams app manifest](/microsoftteams/platform/overview). | +| activityType | String | The activity type must be declared in the [Teams app manifest](/microsoftteams/platform/overview), except for the `systemDefault` [Reserved activity type](/graph/teams-send-activityfeednotifications/#reserved-activity-types), which provides free-form text in the `Actor+Reason` line of the notification. | | chainId | Int64 | Optional. The chain ID of the notification. Used to override a previous notification. Use the same `chainId` in subsequent requests to override the previous notification. | | previewText | [itemBody](../resources/itembody.md) | The preview text for the notification. Microsoft Teams only shows the first 150 characters. | | templateParameters | [keyValuePair](../resources/keyvaluepair.md) collection | The values for the template variables defined in the activity feed entry corresponding to `activityType` in the [Teams app manifest](/microsoftteams/platform/overview). | |
v1.0 | Tenantrelationship Put Multitenantorganization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tenantrelationship-put-multitenantorganization.md | + + Title: "Create multiTenantOrganization" +description: "Create a new multitenant organization." ++ms.localizationpriority: medium ++++# Create multiTenantOrganization +Namespace: microsoft.graph ++Create a new multitenant organization. By default, the creator tenant becomes an owner tenant upon successful creation. Only owner tenants can manage a multitenant organization. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "tenantrelationship_put_multitenantorganization" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PUT /tenantRelationships/multiTenantOrganization +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [multiTenantOrganization](../resources/multitenantorganization.md) object. ++You can specify the following properties when creating a **multiTenantOrganization**. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Display name of the multitenant organization. Required.| +|description|String|Description of the multitenant organization. Optional.| ++++## Response ++If successful, this method returns a `201 Created` response code and a [multiTenantOrganization](../resources/multitenantorganization.md) object in the response body. ++## Examples ++The following example creates a new multitenant organization. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_multitenantorganization_from_" +} +--> +``` http +PUT https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization +Content-Type: application/json ++{ + "displayName": "Contoso organization", + "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank" +} +``` ++# [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, + "@odata.type": "microsoft.graph.multiTenantOrganization" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/$entity", + "id": "6d8b39e5-039a-4034-bf3a-e0b4f8cd60b6", + "createdDateTime": "2023-05-26T22:05:23Z", + "displayName": "Contoso organization", + "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank", + "state": "active" +} +``` + |
v1.0 | Unifiedroleassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/unifiedroleassignment-get.md | One of the following permissions is required to call this API. To learn more, in <!-- { "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) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | +|Delegated (work or school account) | RoleManagement.Read.Directory, RoleManagement.Read.All, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | +|Application | RoleManagement.Read.Directory, RoleManagement.Read.All, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All | ### For the entitlement management provider <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> |
v1.0 | User Assignlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-assignlicense.md | Title: "user: assignLicense" description: "Add or remove subscriptions for the user. You can also enable and disable specific plans associated with a subscription." ms.localizationpriority: high+ doc_type: apiPageType 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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +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-- Global Administrator ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User Changepassword | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-changepassword.md | description: "Update your own password." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User Delete Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-delete-approleassignments.md | Title: "Delete appRoleAssignment" description: "Delete an appRoleAssignment that has been granted to a user." ms.localizationpriority: medium doc_type: apiPageType+ |
v1.0 | User Delete Manager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-delete-manager.md | description: "Remove a user's manager." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User Delete Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-delete-sponsors.md | + + Title: "Remove sponsor" +description: "Remove a user's sponsor." ++ms.localizationpriority: medium ++++# Remove sponsor ++Namespace: microsoft.graph ++Remove a user's sponsor. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "user_delete_sponsors" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /users/{id}/sponsors/{id}/$ref +``` ++> [!CAUTION] +> If `/$ref` is not appended to the request and the calling app has permissions to manage the sponsor object type, the sponsor object is also deleted from Microsoft Entra ID; otherwise, a `403 Forbidden` error is returned. For example, an app with `User.ReadWrite.All` permissions deletes a user who is a sponsor. You can restore specific objects through the [Restore deleted items API](directory-deleteditems-restore.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 `204 No Content` response code. It doesn't return anything in the response body. ++## Examples ++### Request ++The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_sponsors_from_user" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/users/{user-id}/sponsors/{directory-object-id}/$ref +``` ++# [JavaScript](#tab/javascript) ++++### Response ++The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | User Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-delete.md | description: "Describes the delete method of the user resource (entity) of the M ms.localizationpriority: high+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored", "name": "user_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/user-delete-permissions.md)] -The calling user must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): +The calling user must be assigned at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): - User Administrator - Privileged Authentication Administrator-- Global Administrator To delete users with privileged administrator roles in delegated scenarios, the app must be assigned the *Directory.AccessAsUser.All* delegated permission, and the calling user must have a higher privileged administrator role as indicated in [Who can perform sensitive actions](../resources/users.md#who-can-perform-sensitive-actions). |
v1.0 | User Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-delta.md | description: "Get newly created, updated, or deleted users without having to per ms.localizationpriority: high + doc_type: apiPageType |
v1.0 | User Exportpersonaldata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-exportpersonaldata.md | description: "Submits a data policy operation request, made by a Company Adminis ms.localizationpriority: medium + doc_type: apiPageType doc_type: apiPageType Namespace: microsoft.graph -Submit a data policy operation request from a company administrator or an application to export an organizational user's data. This data includes the user's data stored in OneDrive and their activity reports. For more guidance about exporting data while complying with regulations, see [Data Subject Requests and the GDPR and CCPA](/compliance/regulatory/gdpr-data-subject-requests). +Submit a data policy operation request from a company administrator or an application to export an organizational user's data. This data includes the user's data stored in OneDrive and their activity reports. For more information about exporting data while complying with regulations, see [Data Subject Requests and the GDPR and CCPA](/compliance/regulatory/gdpr-data-subject-requests). [!INCLUDE [national-cloud-support](../../includes/global-only.md)] POST /users/{id}/exportPersonalData ## Request body In the request body, provide a JSON object with the following parameters. -| Parameter | Type |Description| +| Parameter | Type |Description| |:|:--|:-|-|storageLocation|String|This is a shared access signature (SAS) URL to an Azure Storage account, to where data should be exported.| +|storageLocation|String|A shared access signature (SAS) URL to an Azure Storage account, to where data should be exported.| ## Response If successful, this method returns a `202 Accepted` response code. It doesn't return anything in the response body. The response contains the following response headers. |
v1.0 | User Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-get.md | description: "Retrieve the properties and relationships of user object." ms.localizationpriority: high+ doc_type: apiPageType |
v1.0 | User List Agreementacceptances | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-agreementacceptances.md | Title: "List agreementAcceptances" description: "Retrieve a list of a user's agreementAcceptance objects." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User List Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-approleassignments.md | Title: "List appRoleAssignments granted to a user" description: "Retrieve the list of app role assignments granted to a user." ms.localizationpriority: high doc_type: apiPageType+ |
v1.0 | User List Createdobjects | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-createdobjects.md | description: "Get a list of directory objects that were created by the user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Directreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-directreports.md | description: "Get a user's direct reports." ms.localizationpriority: high + doc_type: apiPageType |
v1.0 | User List Events | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-events.md | GET /me/calendarGroups/{id}/calendars/{id}/events GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events ``` ## Optional query parameters-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData query parameters](/graph/query-parameters) to help customize the response. ++> [!NOTE] +> You can't use the `$filter` parameter to filter on the **recurrence** property. + ## Request headers | Name | Type | Description | |:|:--|:--| Don't supply a request body for this method. ## Response If successful, this method returns a `200 OK` response code and collection of [event](../resources/event.md) objects in the response body.-## Example -##### Request +## Examples +### Request The following example shows a request. It specifies the following: - A `Prefer: outlook.timezone` header to get date time values returned in Pacific Standard Time. Prefer: outlook.timezone="Pacific Standard Time" -##### Response +### Response The following example shows the response. The **body** property is returned in the default HTML format. <!-- { "blockType": "response", |
v1.0 | User List Joinedteams | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-joinedteams.md | Get the [teams](../resources/team.md) in Microsoft Teams that the user is a dire [!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) | Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All, User.Read.All, User.ReadWrite.All, Directory.Read.All**, Directory.ReadWrite.All** | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All, User.Read.All, User.ReadWrite.All, Directory.Read.All**, Directory.ReadWrite.All** | +<!-- { "blockType": "permissions", "name": "user_list_joinedteams" } --> -> **Note:** Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ## HTTP request <!-- { "blockType": "ignored" } --> GET /users/{id | user-principal-name}/joinedTeams ``` ## Optional query parameters-This method does not currently support the [OData query parameters](/graph/query-parameters) to customize the response. +This method doesn't currently support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers | Header | Value | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [team](../resources/team.md) objects in the response body. -> [!Note] +> [!NOTE] > This API has a [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=13633) where it returns only the **id**, **displayName**, and **description** properties of a [team](../resources/team.md).To get all properties, use the [Get team](../api/team-get.md) operation. ## Example |
v1.0 | User List Licensedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-licensedetails.md | Title: "List licenseDetails" description: "Retrieve a list of licenseDetails objects." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Manager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-manager.md | description: "Get user's manager. Returns the user or contact assigned as the us ms.localizationpriority: high + doc_type: apiPageType |
v1.0 | User List Memberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-memberof.md | description: "Get groups, directory roles, and administrative units that the use ms.localizationpriority: high+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_list_memberof" } --> [!INCLUDE [permissions-table](../includes/permissions/user-list-memberof-permissions.md)] -> **Note:** To list the members of a group with hidden membership, the Member.Read.Hidden permission is required. - [!INCLUDE [limited-info](../../includes/limited-info.md)] +> [!TIP] +> - Calling the `/me/memberOf` endpoint requires a signed-in user and therefore a delegated permission. Application permissions are not supported when you use the `/me/memberOf` endpoint. +> - To list the members of a group with hidden membership, the `Member.Read.Hidden` permission is required. + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User List Owneddevices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-owneddevices.md | description: "Get the list of devices that are owned by the user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Ownedobjects | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-ownedobjects.md | description: "Get the list of directory objects that are owned by the user." ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List Registereddevices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-registereddevices.md | description: "Get the list of user's registered devices." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User List Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-sponsors.md | + + Title: "List sponsors" +description: "Get a user's sponsors." +ms.localizationpriority: medium +++++# List sponsors ++Namespace: microsoft.graph ++Get a user's sponsors. Sponsors are users and groups that are responsible for this guest's privileges in the tenant and for keeping the guest's information and access up to date. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "user_list_sponsors" } --> +++## HTTP request ++Get sponsors. +<!-- { "blockType": "ignored" } --> +```http +GET /users/{id | userPrincipalName}/sponsors +``` ++## Optional query parameters ++This method supports the `$select` and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. You can specify `$select` inside `$expand` to select the individual sponsor's properties: `$expand=sponsors($select=id,displayName)`. ++## 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 [user](../resources/user.md) and [group](../resources/group.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_sponsors" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/users/025e5e3e-e5b7-4eb4-ba1f-4e5b0579f1a2/sponsors +``` ++# [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.directoryObject", + "isCollection": true +} +--> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ +"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects", + "value": [ + { + "@odata.type": "#microsoft.graph.user", + "id": "263a1289-8282-4bf7-91f7-550d9bba8c02", + "displayName": "Sara Davis", + "jobTitle": "Finance VP", + "mail": "SaraD@contoso.com", + "userPrincipalName": "SaraD@contoso.com" + }, + { + "@odata.type": "#microsoft.graph.group", + "id": "08143e93-989e-4771-ac78-803bcdac52d2", + "mail": "groupforsponsors@contoso.com", + "mailEnabled": true, + "mailNickname": "groupforsponsors", + "securityEnabled": true + } + ] +} +``` |
v1.0 | User List Transitivememberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-transitivememberof.md | description: "Get groups, directory roles, and administrative units that the use ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | User List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list.md | description: "Retrieve a list of user objects." ms.localizationpriority: high+ doc_type: apiPageType |
v1.0 | User Post Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-post-approleassignments.md | Title: "Grant an appRoleAssignment to a user" description: "Grant an app role assignment to a user." ms.localizationpriority: high doc_type: apiPageType+ |
v1.0 | User Post Manager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-post-manager.md | description: "Assign a user's manager." ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User Post Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-post-sponsors.md | + + Title: "Add sponsor" +description: "Assign a user a sponsor." ++ms.localizationpriority: medium ++++# Add sponsor ++Namespace: microsoft.graph ++Assign a user a sponsor. Sponsors are users and groups that are responsible for this guest user's privileges in the tenant and for keeping the guest user's information and access up to date. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "user_post_sponsors" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{id}/sponsors/$ref +``` ++## 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 object and pass an `@odata.id` parameter with the read URL of the [user](../resources/user.md) or [group](../resources/group.md) object to be added. ++## Response ++If successful, this method returns `204 No Content` response code. It doesn't return anything in the response body. ++## Examples ++### Example 1: Assign a user as a sponsor ++#### Request ++The following example shows a request. The request body is a JSON object with an `@odata.id` parameter and the read URL for the [user](../resources/user.md) object to be assigned as a sponsor. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_userSponsors" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/users/d8ab5060-f636-4cff-ae97-d4687f5c83f3/sponsors/$ref +Content-Type: application/json ++{ + "@odata.id": "https://graph.microsoft.com/v1.0/users/{user-id}" +} +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. +<!-- { + "blockType": "response" +} --> +```http +HTTP/1.1 204 No Content +``` ++### Example 2: Assign a group as a sponsor ++#### Request ++The following example shows a request. The request body is a JSON object with an `@odata.id` parameter and the read URL for the [group](../resources/group.md) object to be assigned as a sponsor. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_groupSponsors" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/users/d8ab5060-f636-4cff-ae97-d4687f5c83f3/sponsors/$ref +Content-Type: application/json ++{ + "@odata.id": "https://graph.microsoft.com/v1.0/groups/{group-id}" +} +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. +<!-- { + "blockType": "response" +} --> +```http +HTTP/1.1 204 No Content +``` |
v1.0 | User Post Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-post-users.md | description: "Use this API to create a new User." ms.localizationpriority: high+ doc_type: apiPageType |
v1.0 | User Reprocesslicenseassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-reprocesslicenseassignment.md | description: "Reprocess all group-based license assignments for the user." ms.localizationpriority: medium + doc_type: "apiPageType" 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 one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +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-- Global Administrator ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User Retryserviceprovisioning | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-retryserviceprovisioning.md | Title: "user: retryServiceProvisioning" description: "Retries user service provisioning." ms.localizationpriority: medium + doc_type: "apiPageType" |
v1.0 | User Revokesigninsessions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-revokesigninsessions.md | description: "Invalidates all the user's refresh tokens issued to applications ( ms.localizationpriority: medium + doc_type: apiPageType |
v1.0 | User Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-update.md | description: "Update the properties of a user object." ms.localizationpriority: high+ doc_type: apiPageType 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. A global 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. 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.| | 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.| |
v1.0 | Userflowlanguageconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/userflowlanguageconfiguration-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguageconfiguration_get" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguageconfiguration-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Userflowlanguageconfiguration List Defaultpages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/userflowlanguageconfiguration-list-defaultpages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguageconfiguration_list_defaultpages" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguageconfiguration-list-defaultpages-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Userflowlanguageconfiguration List Overridespages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/userflowlanguageconfiguration-list-overridespages.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguageconfiguration_list_overridespages" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguageconfiguration-list-overridespages-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Userflowlanguagepage Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/userflowlanguagepage-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguagepage_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguagepage-delete-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request The following example shows a request. DELETE https://graph.microsoft.com/beta/identity/b2xUserFlows/B2X_1_Partner/languages/en/overridesPages/selfasserted1_1/$value ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/delete-userflowlanguagepage-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [Python](#tab/python) + ### Response |
v1.0 | Userflowlanguagepage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/userflowlanguagepage-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguagepage_get" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguagepage-get-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Userflowlanguagepage Put | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/userflowlanguagepage-put.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "userflowlanguagepage_put" } --> [!INCLUDE [permissions-table](../includes/permissions/userflowlanguagepage-put-permissions.md)] -The work or school account needs to belong to one of the following roles: --* Global administrator -* External Identity User Flow administrator ## HTTP request |
v1.0 | Usersettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/usersettings-get.md | description: "Read the user and organization settings object." ms.localizationpriority: high+ doc_type: apiPageType |
v1.0 | Usersettings List Windows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/usersettings-list-windows.md | Namespace: microsoft.graph Get a list of [windowsSetting](../resources/windowssetting.md) objects and their properties for the signed in 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). GET https://graph.microsoft.com/v1.0/me/settings/windows [!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting1-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-windowssetting1-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/v1.0/me/settings/windows?$filter=settingType eq [!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting2-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-windowssetting2-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/v1.0/me/settings/windows?$filter=settingType eq [!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting3-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-windowssetting3-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/v1.0/me/settings/windows?$filter=windowsDeviceId [!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting4-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-windowssetting4-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Usersettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/usersettings-update.md | description: "Update the properties of the settings object. " ms.localizationpriority: medium+ doc_type: apiPageType |
v1.0 | Userteamwork Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/userteamwork-get.md | + + Title: "Get userTeamwork" +description: "Get user teamwork settings for a user such as user locale and user region." ++ms.localizationpriority: high ++++# Get userTeamwork ++Namespace: microsoft.graph ++Get the [userTeamwork](../resources/userteamwork.md) settings for a specified [user](../resources/user.md), which includes the Microsoft Teams region and the locale chosen by the 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": "userteamwork_get" } --> ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +GET /users/{user-id}/teamwork +``` ++## 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 with a [userTeamwork](../resources/userteamwork.md) object in the response body. +++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_userTeamworkSettings_for_user", + "sampleKeys": ["2f39ffba-51ca-4d2d-a66f-a020a83ce208"] +}--> +```msgraph-interactive +GET https://graph.microsoft.com/v1.0/users/2f39ffba-51ca-4d2d-a66f-a020a83ce208/teamwork +``` ++# [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.userTeamwork" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('2f39ffba-51ca-4d2d-a66f-a020a83ce208')/teamwork/$entity", + "id": "userTeamwork", + "locale": "en-us", + "region": "Americas" +} +``` ++## Related content ++- [licenseDetails: getTeamsLicensingDetails](licenseDetails-getteamslicensingdetails.md) +- [Get teamwork](teamwork-get.md) |
v1.0 | Userteamwork Sendactivitynotification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/userteamwork-sendactivitynotification.md | The following table shows the parameters that can be used with this action. |Parameter|Type|Description| |:|:|:| |topic|[teamworkActivityTopic](../resources/teamworkactivitytopic.md)|The topic of the notification. Specifies the resource being talked about.|-|activityType|String|The activity type. Activity types must be declared in the [Teams app manifest](/microsoftteams/platform/overview).| +|activityType|String|The activity type must be declared in the [Teams app manifest](/microsoftteams/platform/overview), except for the `systemDefault` [Reserved activity type](/graph/teams-send-activityfeednotifications/#reserved-activity-types), which provides free-form text in the `Actor+Reason` line of the notification.| |chainId|Int64|Optional. The chain ID of the notification. Used to override a previous notification. Use the same `chainId` in subsequent requests to override the previous notification.| |previewText|[itemBody](../resources/itembody.md)|The preview text for the notification. Microsoft Teams shows the first 150 characters.| |templateParameters|[keyValuePair](../resources/keyvaluepair.md) collection|The values for the template variables defined in the activity feed entry corresponding to `activityType` in the [Teams app manifest](/microsoftteams/platform/overview).| |
v1.0 | Verticalsection Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/verticalsection-delete.md | + + Title: 'Delete verticalSection' +description: 'Delete a vertical section from a page.' ++ms.localizationpriority: medium +++# Delete verticalSection ++Namespace: microsoft.graph ++Remove a [verticalSection](../resources/verticalSection.md) from a [sitePage](../resources/sitepage.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). ++>**Note:** To delete an item, the user must have granted the application write access to the item to be deleted. ++<!-- { "blockType": "permissions", "name": "verticalsection_delete" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +DELETE /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection +``` ++## Request headers ++| Name |Description| +|:-|:-| +| Authorization | Bearer \{token\}. Required. | ++## Request body ++Don't supply a request body with this method. ++## Response ++If successful, this call returns a `204 No Content`. It doesn't return anything in the response body. ++If the vertical section isn't found, this method returns `404 Not Found`. ++## Example ++### Request ++The following example shows a request. ++<!-- { "blockType": "ignored" } --> ++```http +DELETE https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/verticalSection +``` +### Response ++The following example shows the response. ++<!-- { "blockType": "response" } --> ++```http +HTTP/1.1 204 No Content +``` |
v1.0 | Verticalsection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/verticalsection-get.md | + + Title: 'Get verticalSection' +description: 'Read the properties and relationships of a verticalSection object.' ++ms.localizationpriority: medium +++# Get verticalSection ++Namespace: microsoft.graph ++Read the properties and relationships of a [verticalSection](../resources/verticalsection.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": "verticalsection_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection +``` ++## 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 [verticalSection](../resources/verticalsection.md) object in the response body. ++## Examples ++### Example 1: Get a verticalSection object +#### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++```http +GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/verticalSection +``` ++#### 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.verticalSection" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.verticalSection", + "emphasis": "neutral" +} +``` ++### Example 2: Get a verticalSection object using select and expand +#### Request ++With `$select` and `$expand` statements, you can retrieve verticalSection metadata and associated webParts in a single request. ++<!-- { "blockType": "ignored" } --> ++```http +GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/verticalSection?$select=emphasis&$expand=webparts +``` ++#### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.verticalSection" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "emphasis": "neutral", + "webparts":[{ + "id": "1212fc8d-dd6b-408a-8d5d-9f1cc787efbb", + "innerHtml": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vel.</p>" + }] +} +``` |
v1.0 | Verticalsection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/verticalsection-update.md | + + Title: 'Update verticalSection' +description: "Update the properties of a verticalSection object." ++ms.localizationpriority: medium ++# Update verticalSection ++Namespace: microsoft.graph ++Update the properties of a [verticalSection](../resources/verticalSection.md) object. ++If the vertical section does not exist, this method returns a `404 NotFound` response code. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "verticalsection_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection +``` ++## 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 [verticalSection](../resources/verticalSection.md) resource to update. ++## Response ++If successful, this method returns a `200 OK` response code and an updated [verticalSection](../resources/verticalSection.md) object in the response body. ++If the vertical section does not exist, this method returns a `404 NotFound` response code. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++```http +PATCH /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/verticalSection +Content-Type: application/json ++{ + "emphasis": "strong" +} +``` ++### Response ++The following example shows the response. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.verticalSection", + "truncated": true +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "emphasis": "strong", + "webparts":[ + { + "id":"20a69b85-529c-41f3-850e-c93458aa74eb", + "innerHtml":"<p>sample text in text web part</p>" + } + ] +} +``` |
v1.0 | Virtualendpoint List Auditevents | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-auditevents.md | Namespace: microsoft.graph List all the [cloudPcAuditEvent](../resources/cloudpcauditevent.md) objects for the tenant. ## Permissions 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_cloudpcauditevent" The following example shows a request. ``` http GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/auditEvents ```++# [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 | Virtualendpoint List Cloudpcs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-cloudpcs.md | Namespace: microsoft.graph List the [cloudPC](../resources/cloudpc.md) devices 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). The following example shows how to get a list of all [cloudPC](../resources/clou The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_cloudpcs" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs ``` +# [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 use the `$top` query parameter to get the top The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_cloudpcs_with_top_query" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs?$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) +++ #### Response The following example shows the response. |
v1.0 | Virtualendpoint List Deviceimages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-deviceimages.md | Namespace: microsoft.graph List the properties and relationships of [cloudPcDeviceImage](../resources/cloudpcdeviceimage.md) objects (operating system images) uploaded to 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). 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_cloudpcdeviceimages" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/deviceImages ``` +# [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 | Virtualendpoint List Galleryimages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-galleryimages.md | Namespace: microsoft.graph List the properties and relationships of [cloudPcGalleryImage](../resources/cloudpcgalleryimage.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). 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_cloudpcgalleryimage" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/galleryImages ``` +# [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 | Virtualendpoint List Onpremisesconnections | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-onpremisesconnections.md | List properties and relationships of the [cloudPcOnPremisesConnection](../resour [!INCLUDE [on-premise-rename-note](../../includes/on-premise-rename-note.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": "virtualendpoint-list-onpremisesconnections" } --> +<!-- { "blockType": "permissions", "name": "virtualendpoint_list_onpremisesconnections" } --> [!INCLUDE [permissions-table](../includes/permissions/virtualendpoint-list-onpremisesconnections-permissions.md)] ## HTTP request 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_cloudpconpremisesconnections" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections ``` +# [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 | Virtualendpoint List Provisioningpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-provisioningpolicies.md | Namespace: microsoft.graph List properties and relationships of the [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.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). 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_cloudpcprovisioningpolicies" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies ``` +# [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 | Virtualendpoint List Usersettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-usersettings.md | Namespace: microsoft.graph Get a list of [cloudPcUserSetting](../resources/cloudpcusersetting.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). 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_cloudpcusersetting" The following example shows a request. GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/userSettings ``` +# [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 | Virtualendpoint Post Deviceimages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-post-deviceimages.md | Namespace: microsoft.graph Create a new [cloudPcDeviceImage](../resources/cloudpcdeviceimage.md) object. Upload a custom OS image that you can later provision on Cloud PCs. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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 `201 Created` response code and a [cloudPcD The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_cloudpcdeviceimage_from_cloudpcdeviceimage" 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 | Virtualendpoint Post Onpremisesconnections | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-post-onpremisesconnections.md | Create a new [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnect [!INCLUDE [on-premise-rename-note](../../includes/on-premise-rename-note.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": "virtualendpoint-post-onpremisesconnections" } --> +<!-- { "blockType": "permissions", "name": "virtualendpoint_post_onpremisesconnections" } --> [!INCLUDE [permissions-table](../includes/permissions/virtualendpoint-post-onpremisesconnections-permissions.md)] ## HTTP request If successful, this method returns a `201 Created` response code and a [cloudPcO The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_cloudpconpremisesconnection_from_cloudpconpremisesconnection" 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 |
v1.0 | Virtualendpoint Post Provisioningpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-post-provisioningpolicies.md | Namespace: microsoft.graph Create a new [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.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). If successful, this method returns a `201 Created` response code and a [cloudPcP The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_cloudpcprovisioningpolicy_from_cloudpcprovisioningpolicy" 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 | Virtualendpoint Post Usersettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-post-usersettings.md | Namespace: microsoft.graph Create a new [cloudPcUserSetting](../resources/cloudpcusersetting.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). If successful, this method returns a `201 Created` response code and a [cloudPcU The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_cloudpcusersetting_from_" 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 | Webpart Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/webpart-delete.md | + + Title: "Delete webPart" +description: "Delete a webPart object." ++ms.localizationpriority: medium +++# Delete webPart ++Namespace: microsoft.graph ++Delete a [webPart](../resources/webpart.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": "webpart_delete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +DELETE /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/webParts/{webpart-id} +DELETE /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts/{webpart-index} +DELETE /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns/{horizontal-section-column-id}/webparts/{webpart-index} +``` +## 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. ++## Request body ++Don't supply a request body with this method. ++## Response ++If successful, this method returns a `204 No Content`. It does not return anything in the response body. ++## Example ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "delete-webpart", "scopes": "sites.readwrite.all" } --> ++```http +DELETE https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/webParts/29c08ca7-7f16-4c97-ba05-ea8d2850fc0e +``` ++# [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 +``` ++<!-- +{ + "type": "#page.annotation", + "description": "Delete a webpart object.", + "keywords": "", + "section": "documentation", + "tocPath": "WebParts/Delete", + "suppressions": [] +} +--> |
v1.0 | Webpart Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/webpart-get.md | + + Title: "Get webPart" +description: "Read the properties and relationships of a webPart object." ++ms.localizationpriority: medium +++# Get webPart ++Namespace: microsoft.graph ++Read the properties and relationships of a [webPart](../resources/webpart.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": "webpart_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/webParts/{webpart-id} +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts/{webpart-index} +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns/{horizontal-section-column-id}/webparts/{webpart-index} +``` ++## 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 [standardWebPart](../resources/standardwebpart.md) or [textWebPart](../resources/textwebpart.md) object in the response body. ++## Examples ++### Example 1: Get a webPart object +#### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++```http +GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/webParts/58ce69a6-bcb0-4f35-b6cd-d757d95f1a8e +``` ++#### 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.webPart" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.textWebPart", + "id": "1212fc8d-dd6b-408a-8d5d-9f1cc787efbb", + "innerHtml": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vel.</p>" + } +} +``` ++### Example 2: Get a webPart object using select +#### Request ++With `$select` statement, you can retrieve selected webpart metadata in a request. ++<!-- { "blockType": "ignored" } --> ++```http +GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/webParts/58ce69a6-bcb0-4f35-b6cd-d757d95f1a8e?$select=id +``` ++#### 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.webPart" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.textWebPart", + "id": "1212fc8d-dd6b-408a-8d5d-9f1cc787efbb" + } +} +``` |
v1.0 | Webpart Getposition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/webpart-getposition.md | + + Title: "webPart: getPosition" +description: "Get position information of a webPart" ++ms.localizationpriority: medium +++# webPart: getPosition ++Namespace: microsoft.graph ++Get the [webPartPosition](../resources/webpartposition.md) information of a [webPart](../resources/webpart.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": "webpart_getposition" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/webParts/{webpart-id}/getPositionOfWebPart +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts/{webpart-index}/getPositionOfWebPart +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns/{horizontal-section-column-id}/webparts/{webpart-index}/getPositionOfWebPart +``` ++## 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 [webPartPosition](../resources/webpartposition.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++```http +GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/webParts/a3c93a28-806d-4f1a-b4fc-404848b935f6/getPositionOfWebPart +``` ++### 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.webPartPosition" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "columnId": 1.0, + "horizontalSectionId": 1.0, + "isInVerticalSection": false, + "webpartIndex": 1.0 +} +``` |
v1.0 | Webpart List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/webpart-list.md | + + Title: "List webparts" +description: "Get the webPart collection from a sitePage." ++ms.localizationpriority: medium +++# List webparts ++Namespace: microsoft.graph ++Get the [webPart](../resources/webpart.md) resources from a [sitePage](../resources/sitepage.md). Sort by the order in which they appear on the page. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated 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": "webpart_list" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/webparts +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns/{horizontal-section-column-id}/webparts +GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts +``` ++## 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 [webPart](../resources/webpart.md) objects in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { "blockType": "ignored" } --> ++```http +GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1/columns/1/webparts +``` ++### 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.webPart)" +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.textWebPart", + "id": "d79d70af-27ea-4208-8dce-23c3bf678664", + "innerHtml": "<h2>How do you get started?</h2>" + }, + { + "@odata.type": "#microsoft.graph.standardWebPart", + "id": "6346d908-f20d-4528-902f-3c2a9c8c2442", + "webPartType": "d1d91016-032f-456d-98a4-721247c305e8", + "data": { + "audiences": [], + "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": { + "htmlStrings": [], + "links": [], + "searchablePlainTexts": [], + "imageSources": [ + { + "@odata.type": "#microsoft.graph.metaDataKeyStringPair", + "key": "imageSource", + "value": "/_LAYOUTS/IMAGES/VISUALTEMPLATEIMAGE1.JPG" + } + ] + } + } + } + ] +} +``` |
v1.0 | Webpart Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/webpart-update.md | + + Title: "Update webPart" +description: "Update the properties of a webPart." ++ms.localizationpriority: medium +++# Update webPart ++Namespace: microsoft.graph ++Update the properties of a [webPart](../resources/webpart.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": "webpart_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/webParts/{webpart-id} +PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts/{webpart-index} +PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns/{horizontal-section-column-id}/webparts/{webpart-index} +``` ++## 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 [textWebPart](../resources/textWebPart.md) or [standardWebPart](../resources/standardWebPart.md). ++To ensure successful parsing of the request body, the `@odata.type=#microsoft.graph.textwebpart` or `@odata.type=#microsoft.graph.standardwebpart` must be included in the request body. ++### Supported web parts ++There are two kinds of web parts that can be added to a [sitePage](../resources/sitepage.md): [standardWebPart](../resources/standardWebPart.md) and [textWebPart](../resources/textWebPart.md). ++For [standardWebPart](../resources/standardWebPart.md), only the following are supported when updating using the Microsoft Graph API. Attempting to add unsupported web parts will result in a failure or exception. ++| # | Web Part | Type | +| | -- | -- | +| 1 | Bing Maps | `e377ea37-9047-43b9-8cdb-a761be2f8e09` | +| 2 | Button | `0f087d7f-520e-42b7-89c0-496aaf979d58` | +| 3 | Call To Action | `df8e44e7-edd5-46d5-90da-aca1539313b8` | +| 4 | Divider | `2161a1c6-db61-4731-b97c-3cdb303f7cbb` | +| 5 | Document Embed | `b7dd04e1-19ce-4b24-9132-b60a1c2b910d` | +| 6 | Image | `d1d91016-032f-456d-98a4-721247c305e8` | +| 7 | Image Gallery | `af8be689-990e-492a-81f7-ba3e4cd3ed9c` | +| 8 | Link Preview | `6410b3b6-d440-4663-8744-378976dc041e` | +| 9 | Org Chart | `e84a8ca2-f63c-4fb9-bc0b-d8eef5ccb22b` | +| 10 | People | `7f718435-ee4d-431c-bdbf-9c4ff326f46e` | +| 11 | Quick Links | `c70391ea-0b10-4ee9-b2b4-006d3fcad0cd` | +| 12 | Spacer | `8654b779-4886-46d4-8ffb-b5ed960ee986` | +| 13 | Youtube Embed | `544dd15b-cf3c-441b-96da-004d5a8cea1d` | ++## Response ++If successful, this method returns a `200 OK` response code and an updated [webPart](../resources/webpart.md) object in the response body. ++## Example ++### Request ++The following example shows how to update a webpart. ++<!-- { "blockType": "ignored" } --> ++```http +PATCH /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/webParts/c867fd9e-4c1e-43ec-a448-9760c9fff589 +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.textWebPart", + "innerHtml": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus blandit pellentesque ipsum tempor porta. Phasellus tincidunt et ipsum nec iaculis. Sed eu arcu tristique, congue erat a, consequat lorem. Suspendisse ac ullamcorper elit. Sed ultricies, risus sed hendrerit dictum, nunc massa ornare velit, a pharetra dolor urna quis lorem. Maecenas eget pellentesque purus, nec ultricies risus. Donec rhoncus lorem at euismod varius. Donec auctor sed mi vitae pharetra. Aenean id tempor mauris. Donec dui nulla, semper ut elit id, mattis commodo arcu. Aliquam erat volutpat." +} +``` ++### Response ++If successful, this method returns a [webPart][] in the response body for the updated webpart. ++<!-- { "blockType": "response", "@odata.type": "microsoft.graph.webPart", "truncated": true } --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.textWebPart", + "id": "51053496-e6f3-4161-94ac-07bdf4d92226", + "innerHtml": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus blandit pellentesque ipsum tempor porta. Phasellus tincidunt et ipsum nec iaculis. Sed eu arcu tristique, congue erat a, consequat lorem. Suspendisse ac ullamcorper elit. Sed ultricies, risus sed hendrerit dictum, nunc massa ornare velit, a pharetra dolor urna quis lorem. Maecenas eget pellentesque purus, nec ultricies risus. Donec rhoncus lorem at euismod varius. Donec auctor sed mi vitae pharetra. Aenean id tempor mauris. Donec dui nulla, semper ut elit id, mattis commodo arcu. Aliquam erat volutpat." +} +``` ++[webPart]: ../resources/webPart.md ++<!-- +{ + "type": "#webpart.annotation", + "description": "Update a WebPart.", + "keywords": "", + "section": "documentation", + "tocPath": "WebParts/Update", + "suppressions": [] +} +--> |
v1.0 | Windowssetting Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/windowssetting-get.md | Namespace: microsoft.graph Read the properties and relationships of a [windowsSetting](../resources/windowssetting.md) object by passing the ID of the setting in the URL. This method gets the setting for the signed-in 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). GET https://graph.microsoft.com/v1.0/me/settings/windows/{windowsSettingId} [!INCLUDE [sample-code](../includes/snippets/php/get-windowssetting-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-windowssetting-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Windowssetting List Instances | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/windowssetting-list-instances.md | Namespace: microsoft.graph Get a list of [windowsSettingInstance](../resources/windowssettinginstance.md) objects and their properties for the signed-in 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). GET https://graph.microsoft.com/v1.0/me/settings/windows/{windowsSettingId}/inst [!INCLUDE [sample-code](../includes/snippets/php/list-windowssettinginstance-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-windowssettinginstance-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Windowssettinginstance Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/windowssettinginstance-get.md | Namespace: microsoft.graph Read the properties and relationships of a [windowsSettingInstance](../resources/windowssettinginstance.md) object by passing the Windows setting ID and Windows setting instance ID in the URL. This method gets a **windowsSettingInstance** for the signed-in 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). GET https://graph.microsoft.com/v1.0/me/settings/windows/{windowsSettingId}/inst [!INCLUDE [sample-code](../includes/snippets/php/get-windowssettinginstance-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-windowssettinginstance-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Workbook List Names | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbook-list-names.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookNamedItem](../resources/nameditem.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookNamedItem](../resources/workbooknameditem.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Workbook List Tables | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbook-list-tables.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookTable](../resources/table.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookTable](../resources/workbooktable.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Workbook List Worksheets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbook-list-worksheets.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookWorksheet](../resources/worksheet.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookWorksheet](../resources/workbookworksheet.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Workbook Post Tables | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbook-post-tables.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `201 Created` response code and [WorkbookTable](../resources/table.md) object in the response body. +If successful, this method returns `201 Created` response code and [workbookTable](../resources/workbooktable.md) object in the response body. ## Example ##### Request |
v1.0 | Workbookrange Columnsafter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrange-columnsafter.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id}/range/columnsAfter(cou Don't supply a request body for this method. ## Response-If successful, this method returns `200 OK` response code and [workbookRange](../resources/range.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. |
v1.0 | Workbookrange Columnsbefore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrange-columnsbefore.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id}/range/columnsBefore(co Don't supply a request body for this method. ## Response-If successful, this method returns `200 OK` response code and [workbookRange](../resources/range.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. |
v1.0 | Workbookrange Resizedrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrange-resizedrange.md | POST /me/drive/root:/{item-path}:/workbook/worksheets/{id}/range/resizedRange(de Don't supply a request body for this method. ### Response-If successful, this method returns a `200 OK` response code and a [workbookRange](../resources/range.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [workbookRange](../resources/workbookrange.md) object in the response body. ## Example |
v1.0 | Workbookrange Rowsabove | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrange-rowsabove.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id}/range/rowsAbove(count= Don't supply a request body for this method. ## Response-If successful, this method returns `200 OK` response code and [workbookRange](../resources/range.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. |
v1.0 | Workbookrange Rowsbelow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrange-rowsbelow.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id}/range/rowsBelow(count= Don't supply a request body for this method. ## Response-If successful, this method returns `200 OK` response code and [workbookRange](../resources/range.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 is an example of how to call this API. |
v1.0 | Workbookrangeview Range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrangeview-range.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id}/range(address={address ## Request body ### Response-If successful, this method returns `200 OK` response code and [workbookRange](../resources/range.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 is an example of how to call this API. |
v1.0 | Worksheet Cell | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-cell.md | Don't supply a request body for this method. ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Worksheet Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-get.md | -# Get Worksheet +# Get worksheet Namespace: microsoft.graph Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookWorksheet](../resources/worksheet.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookWorksheet](../resources/workbookworksheet.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Worksheet List Charts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-list-charts.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookChart](../resources/chart.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookChart](../resources/workbookchart.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Worksheet List Names | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-list-names.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookNamedItem](../resources/nameditem.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookNamedItem](../resources/workbooknameditem.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Worksheet List Tables | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-list-tables.md | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookTable](../resources/table.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookTable](../resources/workbooktable.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Worksheet List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-list.md | -# List WorksheetCollection +# List worksheetCollection Namespace: microsoft.graph Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [WorkbookWorksheet](../resources/worksheet.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [workbookWorksheet](../resources/workbookworksheet.md) objects in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Worksheet Post Charts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-post-charts.md | POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/ | Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body-In the request body, supply a JSON representation of [WorkbookChart](../resources/chart.md) object. +In the request body, supply a JSON representation of [workbookChart](../resources/workbookchart.md) object. ## Response -If successful, this method returns `201 Created` response code and [WorkbookChart](../resources/chart.md) object in the response body. +If successful, this method returns `201 Created` response code and [workbookChart](../resources/workbookchart.md) object in the response body. ## Example ##### Request Content-type: application/json -In the request body, supply a JSON representation of [WorkbookChart](../resources/chart.md) object. +In the request body, supply a JSON representation of [workbookChart](../resources/workbookchart.md) object. ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Worksheet Post Tables | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-post-tables.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `201 Created` response code and [WorkbookTable](../resources/table.md) object in the response body. +If successful, this method returns `201 Created` response code and [workbookTable](../resources/workbooktable.md) object in the response body. ## Example ##### Request |
v1.0 | Worksheet Range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-range.md | GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/range ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here is an example of how to call this API. |
v1.0 | Worksheet Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-update.md | In the request body, supply the values for relevant fields that should be update ## Response -If successful, this method returns a `200 OK` response code and updated [WorkbookWorksheet](../resources/worksheet.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [workbookWorksheet](../resources/workbookworksheet.md) object in the response body. ## Example ##### Request The following example shows a request. |
v1.0 | Worksheet Usedrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheet-usedrange.md | Don't supply a request body for this method. ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/range.md) object in the response body. +If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. ## Example Here's an example that shows how to call this API. |
v1.0 | Worksheetcollection Add | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheetcollection-add.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns `201 Created` response code and [workbookWorksheet](../resources/worksheet.md) object in the response body. +If successful, this method returns `201 Created` response code and [workbookWorksheet](../resources/workbookworksheet.md) object in the response body. ## Examples |
v1.0 | Worksheetprotection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/worksheetprotection-get.md | -# Get WorksheetProtection +# Get worksheetProtection Namespace: microsoft.graph Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [WorkbookWorksheetProtection](../resources/worksheetprotection.md) object in the response body. +If successful, this method returns a `200 OK` response code and [workbookWorksheetProtection](../resources/workbookworksheetprotection.md) object in the response body. ## Example ##### Request The following example shows a request. |
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 "/partner-center", "/powershell", "/previous-versions", - "/purview", + "/purview", "/rest", "/security", "/skypeforbusiness", |
v1.0 | Schema Config.Json | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/config/schema-config.json | a/api-reference/v1.0/config/schema-config.json "author", "title", "description", - "doc_type", - "ms.localizationpriority" + "doc_type" + ], + "textToRemoveFromPropertyNames": [ + "(deprecated)" ] }, "schemaDiffConfig": { |
v1.0 | Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/overview.md | Title: "Microsoft Graph REST API v1.0 endpoint reference" -description: "Documentation for the Microsoft Graph REST API v1.0 endpoint, which includes APIs in general availability (GA) status. Features common use cases in v1.0." +description: "Find reference content for Microsoft Graph REST APIs in the v1.0 endpoint, which includes APIs in general availability (GA) status." ms.localizationpriority: high + doc_type: conceptualPageType -API sets on the `v1.0` endpoint (`https://graph.microsoft.com/v1.0`) are in general availability (GA) status, and have gone through a rigorous review-and-feedback process with customers to meet practical, production needs. Updates to APIs on this endpoint are additive in nature and don't break existing app scenarios. +API sets on the `v1.0` endpoint (`https://graph.microsoft.com/v1.0`) have reached general availability (GA), and have gone through a rigorous review-and-feedback process with customers to meet practical, production needs. Updates to APIs on this endpoint are additive in nature and don't break existing app scenarios. ## Common use cases Some of these services are designed to enable rich scenarios around a [user](./r ### User-centric use cases in v1.0 -1. [Get the profile](./api/user-get.md) and [photo](./resources/profilephoto.md) of a user, Lisa. -2. [Get the profile information about Lisa's manager](./api/user-list-manager.md) and [IDs of her direct reports](./api/user-list-directreports.md), all stored in Microsoft Entra ID. -3. [Access Lisa's files on OneDrive](./api/driveitem-list-children.md), find the [identity](./resources/identityset.md) of the last person who modified a [file](./resources/driveitem.md) there, and navigate to that person's profile. -4. [Access Lisa's calendar](./api/calendar-get.md) on Exchange Online and [determine the best time for Lisa to meet with her team](./api/user-findmeetingtimes.md) in the next two weeks. -5. [Subscribe to](./api/subscription-post-subscriptions.md) and [track changes](./api/event-delta.md) in Lisa's calendar, tell Lisa when she's spending more than 80% of her time in meetings. -6. [Set automatic replies](./api/user-update-mailboxsettings.md#example-1) when Lisa is away from the office. -7. [Get the people who are most relevant to Lisa](./api/user-list-people.md), based on communication, collaboration, and business relationships. -8. Get the latest sales projection from a [chart](./resources/chart.md) in an Excel file in Lisa's OneDrive. -9. [Find the tasks assigned to Lisa in Planner](./api/planneruser-list-tasks.md). +- [Get the profile](./api/user-get.md) and [photo](./resources/profilephoto.md) of a user. +- [Get the profile information for a user's manager](./api/user-list-manager.md) and [IDs of their direct reports](./api/user-list-directreports.md), all stored in Microsoft Entra ID. +- [Access a user's files on OneDrive](./api/driveitem-list-children.md), find the [identity](./resources/identityset.md) of the last person who modified a [file](./resources/driveitem.md) there, and go to that person's profile. +- [Access a user's calendar](./api/calendar-get.md) on Exchange Online and [determine the best time to meet with their team](./api/user-findmeetingtimes.md) in the next two weeks. +- [Subscribe to](./api/subscription-post-subscriptions.md) and [track changes](./api/event-delta.md) in a user's calendar, and tell the user when they're spending more than 80% of their time in meetings. +- [Set automatic replies](./api/user-update-mailboxsettings.md#example-1) when a user is away from the office. +- [Get the people who are most relevant to a user](./api/user-list-people.md), based on communication, collaboration, and business relationships. +- Get the latest sales projection from a [chart](./resources/workbookchart.md) in an Excel file in a user's OneDrive. +- [Find the tasks assigned to a user in Planner](./api/planneruser-list-tasks.md). ### Microsoft 365 group use cases in v1.0 -1. Run a report on Microsoft 365 groups in an organization and identify the group with the most [communication among group members](./api/reportroot-getoffice365groupsactivitycounts.md). -2. [Find the plans of this Microsoft 365 group](./api/plannergroup-list-plans.md), and the [assignment of tasks](./resources/plannerassignments.md) in that plan. -3. [Start a new conversation](./api/group-post-conversations.md) in the Microsoft 365 group to determine if members want to [create another group](./api/group-post-groups.md) to share the workload. -4. [Get the default notebook](./api/notebook-get.md) for the group and [create a page](./api/section-post-pages.md) to note the outcome of the investigation. --## Other API versions --There are currently two versions of Microsoft Graph REST APIs - v1.0 and beta. -If you're interested in new or enhanced APIs that are still in preview status, see [Microsoft Graph beta endpoint reference](/graph/api/overview?view=graph-rest-beta&preserve-view=true). --> [!CAUTION] -> APIs in preview status are subject to change, and might break existing scenarios without notice. Don't take a production dependency on APIs in the `beta` endpoint. --Find more information about [versioning and support](/graph/versioning-and-support). +- Run a report on Microsoft 365 groups in an organization and identify the group with the most [communication among group members](./api/reportroot-getoffice365groupsactivitycounts.md). +- [Find the plans of this Microsoft 365 group](./api/plannergroup-list-plans.md), and the [assignment of tasks](./resources/plannerassignments.md) in that plan. +- [Start a new conversation](./api/group-post-conversations.md) in the Microsoft 365 group to determine if members want to [create another group](./api/group-post-groups.md) to share the workload. +- [Get the default notebook](./api/notebook-get.md) for the group and [create a page](./api/section-post-pages.md) to note the outcome of the investigation. ## Call the v1.0 endpoint Microsoft Graph API requests to the v1.0 endpoint use the following pattern: https://graph.microsoft.com/v1.0/{resource}?[query_parameters] ``` -For details, see [Use the Microsoft Graph API](/graph/use-the-api). +For more information about Microsoft Graph REST API calls, see [Use the Microsoft Graph API](/graph/use-the-api). ++## Microsoft Graph beta endpoint ++Currently, two versions of Microsoft Graph REST APIs are available: v1.0 and beta. ++If you're interested in new or enhanced APIs that are still in preview status, see [Microsoft Graph beta endpoint reference](/graph/api/overview?view=graph-rest-beta&preserve-view=true). ++> [!CAUTION] +> APIs in preview status are subject to change, and might break existing scenarios without notice. Don't take a production dependency on APIs in the `beta` endpoint. ++For more information, see [Versioning and support](/graph/versioning-and-support). ## What's new Find out [what's new](/graph/whats-new-overview) in the v1.0 endpoint. -Explore the [API changelog](https://developer.microsoft.com/en-us/graph/changelog) for more details about changes to Microsoft Graph APIs. +For details about changes to Microsoft Graph APIs in v1.0, explore the [API changelog](https://developer.microsoft.com/en-us/graph/changelog/?filterby=v1.0). ## Related content |
v1.0 | Aaduserconversationmember | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/aaduserconversationmember.md | This type inherits from [conversationMember](conversationmember.md). |[Update channel member's role](../api/channel-update-members.md) | [conversationMember](conversationmember.md) | Update the properties of a member of the channel. Only supported for channel with membershipType of `private`.| |[Remove channel member](../api/channel-delete-members.md) | None | Delete a member from a channel. Only supported for `channelType` of `private`.| |[List chat members](../api/chat-list-members.md) | [conversationMember](conversationmember.md) collection | Get the list of all members in a chat.|-|[Add chat member](../api/chat-post-members.md) | Location header | Add a member to a chat.| +|[Add chat member](../api/chat-post-members.md) | Location header | Add a member to a chat.| |[Get chat member](../api/chat-get-members.md) | [conversationMember](conversationmember.md) | Get a member in a chat.|-|[Remove chat member](../api/chat-delete-members.md) | None | Remove a member from a chat.| +|[Remove chat member](../api/chat-delete-members.md) | None | Remove a member from a chat.| ## Properties The following is a JSON representation of the resource. "@odata.type": "#microsoft.graph.aadUserConversationMember", "displayName" : "string", "email" : "string",- "id": "string (identifier)", + "id": "string (identifier)", "roles" : ["string"], "tenantId": "string", "userId" : "string", |
v1.0 | Accesspackage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackage.md | Each access package is referenced by a single access package catalog, and has li |resourceRoleScopes| [accessPackageResourceRoleScope](accesspackageresourcerolescope.md) collection | The resource roles and scopes in this access package. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accesspackageanswerchoice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageanswerchoice.md | Indicates an answer option for an [accessPackageMultipleChoiceQuestion](../resou |:|:|:| |actualValue|String|The actual value of the selected choice. This is typically a string value which is understandable by applications. Required.| |localizations|[accessPackageLocalizedText](../resources/accesspackagelocalizedtext.md) collection|The text of the answer choice represented in a format for a specific locale.|+|text|String|The string to display for this answer; if an `Accept-Language` header is provided, and there is a matching localization in `localizations`, this string will be the matching localized string; otherwise, this string remains as the default non-localized string. Required.| ## Relationships None. |
v1.0 | Accesspackageapprovalstage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageapprovalstage.md | Used for the **stages** property of [approval settings](accesspackageassignmenta |fallbackPrimaryApprovers|[subjectSet](../resources/subjectset.md) collection|The subjects, typically users, who are the fallback primary approvers.| |isApproverJustificationRequired|Boolean|Indicates whether the approver is required to provide a justification for approving a request.| |isEscalationEnabled|Boolean|If `true`, then one or more **escalationApprovers** are configured in this approval stage.|-|primaryApprovers|[subjectSet](../resources/subjectset.md) collection|The subjects, typically users, who will be asked to approve requests. A collection of [singleUser](singleuser.md), [groupMembers](groupmembers.md), [requestorManager](requestormanager.md), [internalSponsors](internalsponsors.md) or [externalSponsors](externalsponsors.md).| +|primaryApprovers|[subjectSet](../resources/subjectset.md) collection|The subjects, typically users, who will be asked to approve requests. A collection of [singleUser](singleuser.md), [groupMembers](groupmembers.md), [requestorManager](requestormanager.md), [internalSponsors](internalsponsors.md), [externalSponsors](externalsponsors.md), or [targetUserSponsors](targetusersponsors.md).| ## Relationships None. |
v1.0 | Accesspackageassignmentapprovalsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageassignmentapprovalsettings.md | Used for the **requestApprovalSettings** property of an [access package assignme ## 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.accessPackageAssignmentApprovalSettings" |
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), |requestor|[accessPackageSubject](../resources/accesspackagesubject.md)|The subject who requested or, if a direct assignment, was assigned. Read-only. Nullable. Supports `$expand`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accesspackageassignmentrequestcallbackdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageassignmentrequestcallbackdata.md | 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.accessPackageAssignmentRequestCallbackData" |
v1.0 | Accesspackageassignmentrequestorsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageassignmentrequestorsettings.md | Provides additional settings to select who can create a request for an access pa ## 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.accessPackageAssignmentRequestorSettings" |
v1.0 | Accesspackageassignmentworkflowextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageassignmentworkflowextension.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accesspackageresourcerolescope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageresourcerolescope.md | The following is a JSON representation of the resource. { "createdDateTime":"String (timestamp)", "id":"String (identifier)",- "modifiedDateTime":"String (timestamp)", - "accessPackageResourceRole":{ + "role":{ "id":"String (identifier)", "displayName":"String", "originSystem":"String", "originId":"String" },- "accessPackageResourceScope":{ + "scope":{ "id":"String (identifier)", "displayName":"String", "description":"String", |
v1.0 | Accesspackageresourcescope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageresourcescope.md | If the resource is in an access package catalog but hasn't yet had its roles add ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Accesspackagesubject | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackagesubject.md | None. |connectedOrganization|[connectedOrganization](connectedorganization.md)|The connected organization of the subject. Read-only. Nullable.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accesspackagetextinputquestion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackagetextinputquestion.md | Inherits from [accessPackageQuestion](../resources/accesspackagequestion.md). 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.accessPackageTextInputQuestion" |
v1.0 | Accessreviewapplyaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewapplyaction.md | None. 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.accessReviewApplyAction" |
v1.0 | Accessreviewhistorydefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewhistorydefinition.md | An **accessReviewHistoryDefinition** contains a list of [accessReviewHistoryInst ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accessreviewhistoryinstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewhistoryinstance.md | Namespace: microsoft.graph ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
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 ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.accessReviewHistoryScheduleSettings" |
v1.0 | Accessreviewinstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewinstance.md | Inherits from [entity](../resources/entity.md). |:|:--|:-| | contactedReviewers |[accessReviewReviewer](../resources/accessreviewreviewer.md) collection| Returns the collection of reviewers who were contacted to complete this review. While the **reviewers** and **fallbackReviewers** properties of the **accessReviewScheduleDefinition** might specify group owners or managers as **reviewers**, **contactedReviewers** returns their individual identities. Supports `$select`. Read-only. | | decisions |[accessReviewInstanceDecisionItem](accessreviewinstancedecisionitem.md) collection | Each user reviewed in an **accessReviewInstance** has a decision item representing if they were approved, denied, or not yet reviewed. |-|stages|[accessReviewStage](accessreviewstage.md) collection| If the instance has multiple stages, this returns the collection of stages. A new stage will only be created when the previous stage ends. The existence, number, and settings of stages on a review instance are created based on the [accessReviewStageSettings](accessreviewstagesettings.md) on the parent [accessReviewScheduleDefinition](accessreviewscheduledefinition.md). | +| stages|[accessReviewStage](accessreviewstage.md) collection| If the instance has multiple stages, this returns the collection of stages. A new stage will only be created when the previous stage ends. The existence, number, and settings of stages on a review instance are created based on the [accessReviewStageSettings](accessreviewstagesettings.md) on the parent [accessReviewScheduleDefinition](accessreviewscheduledefinition.md). | ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here is a JSON representation of the resource. "@odata.type": "microsoft.graph.accessReviewReviewer" } ],- "displayName": "string", "endDateTime": "string (timestamp)", "fallbackReviewers": [ { |
v1.0 | Accessreviewinstancedecisionitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewinstancedecisionitem.md | +toc.keywords: [ access review decisions ] # accessReviewInstanceDecisionItem resource type |
v1.0 | Accessreviewinstancedecisionitemresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewinstancedecisionitemresource.md | Every decision item in an access review represents a principal's access to a res 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.accessReviewInstanceDecisionItemResource" |
v1.0 | Accessreviewnotificationrecipientscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewnotificationrecipientscope.md | None. 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.accessReviewNotificationRecipientScope" |
v1.0 | Accessreviewscheduledefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewscheduledefinition.md | An accessReviewScheduleDefinition contains a list of [accessReviewInstance](acce | instances|[accessReviewInstance](accessreviewinstance.md) collection | If the **accessReviewScheduleDefinition** is a recurring access review, instances represent each recurrence. A review that doesn't recur will have exactly one instance. Instances also represent each unique resource under review in the **accessReviewScheduleDefinition**. If a review has multiple resources and multiple instances, each resource has a unique instance for each recurrence. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accessreviewstage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewstage.md | Every **accessReviewStage** contains a list of [decision items](accessreviewinst |decisions|[accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) collection|Each user reviewed in an accessReviewStage has a decision item representing if they were approved, denied, or not yet reviewed.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Accessreviewsv2 Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewsv2-overview.md | The following table lists the methods that you can use to interact with access r The following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) are required for a calling user to manage access reviews. -| Operation | Application permissions | Required directory role of the calling user | +| Operation | Application permissions | Least privileged directory role of the calling user | |:|:|:--|-| Read | AccessReview.Read.All or AccessReview.ReadWrite.All | Global Administrator, Global Reader, Security Administrator, Security Reader or User Administrator | -| Create, Update or Delete | AccessReview.ReadWrite.All | Global Administrator or User Administrator | +| Read | AccessReview.Read.All or AccessReview.ReadWrite.All | Global Reader, Security Administrator, Security Reader or User Administrator | +| Create, Update or Delete | AccessReview.ReadWrite.All | User Administrator | In addition, a user who is an assigned reviewer of an access review can manage their decisions, without needing to be in a directory role. |
v1.0 | Activitybasedtimeoutpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/activitybasedtimeoutpolicy.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Addin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/addin.md | Title: "addIn resource type" -description: "Here's a JSON representation of the resource." +description: "Defines custom behavior that a consuming service can use to call an app in specific contexts." ms.localizationpriority: medium doc_type: resourcePageType Defines custom behavior that a consuming service can use to call an app in speci ## Properties | Property | Type |Description| |:|:--|:-|-|ID|guid|| -|properties|[keyValue](keyvalue.md) collection|| -|type|string|| +|id|GUID|The unique identifier for the **addIn** object.| +|properties|[keyValue](keyvalue.md) collection|The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the **addIns** collection. Required.| +|type|string|The unique name for the functionality exposed by the app. | ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Administrativeunit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/administrativeunit.md | doc_type: resourcePageType Namespace: microsoft.graph -An administrative unit provides a conceptual container for user, group, and device directory objects. Using administrative units, a company administrator can now delegate administrative responsibilities to manage the users, groups, and devices contained within or scoped to an administrative unit to a regional or departmental administrator. This resource is an open type that allows other properties to be passed in. +An administrative unit provides a conceptual container for user, group, and device directory objects. With administrative units, a company administrator can now delegate administrative responsibilities to manage the users, groups, and devices contained within or scoped to an administrative unit to a regional or departmental administrator. For more information about administrative units, see [Administrative units in Microsoft Entra ID](/entra/identity/role-based-access-control/administrative-units). -Let's look at an example. Imagine that Contoso Corp is made up of two divisions - a West Coast Division and an East Coast Division. Directory roles at Contoso are scoped to the entire tenant. Lee, a Contoso company administrator, wants to delegate administrative responsibilities, but scope them to the West Coast Division or the East Coast division. Lee can create a *West Coast administrative unit* and place all West Coast users into this administrative unit. Similarly, Lee can create an *East Coast administrative unit*. Now Lee, can start delegating administrative responsibilities to others, but **scoped** to the new administrative units they created. Lee places Jennifer in a *helpdesk administrator* role **scoped** to the *West Coast administrative unit*. This allows Jennifer to reset any user's password, but only if those users are in the *West Coast administrative unit*. Similarly, Lee places Dave in a *user account administrator* role **scoped** to the *East Coast administrative unit*. This allows Dave to update users, assign licenses and reset any user's password, but only if those users are in the *East Coast administrative unit*. For a video overview, please see [Introduction to Microsoft Entra Administrative Units](https://channel9.msdn.com/Series/Windows-Azure-Active-Directory/Introduction-to-Azure-Active-Directory-Administrative-Units). +This resource is an open type that allows other properties to be passed in. This resource supports: This resource supports: |[Create](../api/directory-post-administrativeunits.md) | [administrativeUnit](administrativeunit.md) | Create a new administrative unit.| |[List](../api/directory-list-administrativeunits.md) | [administrativeUnit](administrativeunit.md) collection |List properties of all administrativeUnits.| |[Get](../api/administrativeunit-get.md) | [administrativeUnit](administrativeunit.md) |Read properties and relationships of a specific administrativeUnit object.|-|[Update](../api/administrativeunit-update.md) | [administrativeUnit](administrativeunit.md) |Update administrativeUnit object. | +|[Update](../api/administrativeunit-update.md) | [administrativeUnit](administrativeunit.md) |Update administrativeUnit object. | |[Delete](../api/administrativeunit-delete.md) | None |Delete administrativeUnit object. | |[Add a member](../api/administrativeunit-post-members.md) |[directoryObject](directoryobject.md)| Add a member (user, group, or device).| |[List members](../api/administrativeunit-list-members.md) |[directoryObject](directoryobject.md) collection| Get the list of (user, group, or device) members.| This resource supports: > [!IMPORTANT] > Specific usage of `$filter` and the `$search` query parameter is 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#administrative-unit-properties). -| Property | Type |Description| +| Property | Type |Description| |:|:--|:-| |description|String|An optional description for the administrative unit. Supports `$filter` (`eq`, `ne`, `in`, `startsWith`), `$search`.| |displayName|String|Display name for the administrative unit. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderby`.| This resource supports: > Directory extensions and associated data are returned by default while schema extensions and associated data returned only on `$select`. ## Relationships-| Relationship | Type |Description| +| Relationship | Type |Description| |:|:--|:-| |members|[directoryObject](directoryobject.md) collection|Users and groups that are members of this administrative unit. Supports `$expand`.| |extensions|[extension](extension.md) collection|The collection of open extensions defined for this administrative unit. Nullable.| This resource supports: ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Agreementfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/agreementfile.md | Inherits from [agreementFileProperties](agreementfileproperties.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Agreementfilelocalization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/agreementfilelocalization.md | Inherits from [agreementFileProperties](agreementfileproperties.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Agreementfileversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/agreementfileversion.md | Inherits from [agreementFileProperties](agreementfileproperties.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Alert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/alert.md | Title: "alert resource type" + Title: "alert resource type (deprecated)" description: "Represents potential security issues within a customer's tenant that Microsoft or partner security solutions have identified." ms.localizationpriority: high -# alert resource type +# alert resource type (deprecated) Namespace: microsoft.graph -This resource corresponds to the first generation of alerts in the Microsoft Graph security API, representing potential security issues within a customer's tenant that Microsoft or a partner security solution has identified. +> [!NOTE] +> The legacy alerts API is deprecated and will be removed by April 2026. We recommend that you migrate to the new [alerts and incidents](/graph/api/resources/security-alert) API. ++This resource corresponds to the first generation of alerts in the Microsoft Graph security API, representing potential security issues within a customer's tenant that Microsoft or a partner security solution identifies. This type of alerts federates calling of supported Azure and Microsoft 365 Defender security providers listed in [Use the Microsoft Graph security API](security-api-overview.md#legacy-alerts). It aggregates common alert data among the different domains to allow applications to unify and streamline management of security issues across all integrated solutions. To learn more, see the sample queries in [Graph Explorer](https://developer.micr | assignedTo | String | Name of the analyst the alert is assigned to for triage, investigation, or remediation (supports [update](../api/alert-update.md)). | | azureSubscriptionId | String | Azure subscription ID, present if this alert is related to an Azure resource. | | azureTenantId | String | Microsoft Entra tenant ID. Required. |-| category | String | Category of the alert (for example, credentialTheft, ransomware, etc.). | +| category | String | Category of the alert (for example, credentialTheft, ransomware). | | closedDateTime | DateTimeOffset | Time at which the alert was closed. 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` (supports [update](../api/alert-update.md)). | | cloudAppStates | [cloudAppSecurityState](cloudappsecuritystate.md) collection | Security-related stateful information generated by the provider about the cloud application/s related to this alert. | | comments | String collection | Customer-provided comments on alert (for customer alert management) (supports [update](../api/alert-update.md)). | To learn more, see the sample queries in [Graph Explorer](https://developer.micr | createdDateTime | DateTimeOffset | Time at which the alert was created by the alert provider. 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`. Required. | | description | String | Alert description. | | detectionIds | String collection | Set of alerts related to this alert entity (each alert is pushed to the SIEM as a separate record). |-| eventDateTime | DateTimeOffset | Time at which the event(s) that served as the trigger(s) to generate the alert occurred. 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`. Required. | -| feedback | alertFeedback | Analyst feedback on the alert. Possible values are: `unknown`, `truePositive`, `falsePositive`, `benignPositive`. (supports [update](../api/alert-update.md)) | +| eventDateTime | DateTimeOffset | Time at which the event or events that served as the trigger to generate the alert occurred. 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`. Required. | +| feedback | alertFeedback | Analyst feedback on the alert. Possible values are: `unknown`, `truePositive`, `falsePositive`, `benignPositive`. Supports [update](../api/alert-update.md). | | | fileStates | [fileSecurityState](filesecuritystate.md) collection | Security-related stateful information generated by the provider about the file(s) related to this alert. | | hostStates | [hostSecurityState](hostsecuritystate.md) collection | Security-related stateful information generated by the provider about the host(s) related to this alert. | | id | String | Provider-generated GUID/unique identifier. Read-only. Required. | To learn more, see the sample queries in [Graph Explorer](https://developer.micr | registryKeyStates | [registryKeyState](registrykeystate.md) collection | Security-related stateful information generated by the provider about the registry keys related to this alert. | | securityResources | [securityResource](securityResource.md) collection | Resources related to current alert. For example, for some alerts this can have the Azure Resource value. | | severity | alertSeverity | Alert severity - set by vendor/provider. Possible values are: `unknown`, `informational`, `low`, `medium`, `high`. Required. |-| sourceMaterials | String collection | Hyperlinks (URIs) to the source material related to the alert, for example, provider's user interface for alerts or log search, etc. | +| sourceMaterials | String collection | Hyperlinks (URIs) to the source material related to the alert, for example, provider's user interface for alerts or log search. | | status | alertStatus | Alert lifecycle status (stage). Possible values are: `unknown`, `newAlert`, `inProgress`, `resolved`. (supports [update](../api/alert-update.md)). Required. |-| tags | String collection | User-definable labels that can be applied to an alert and can serve as filter conditions (for example "HVA", "SAW", etc.) (supports [update](../api/alert-update.md)). | +| tags | String collection | User-definable labels that can be applied to an alert and can serve as filter conditions (for example "HVA", "SAW") (supports [update](../api/alert-update.md)). | | title | String | Alert title. Required. | | triggers | [alertTrigger](alerttrigger.md) collection | Security-related information about the specific properties that triggered the alert (properties appearing in the alert). Alerts might contain information about multiple users, hosts, files, ip addresses. This field indicates which properties triggered the alert generation. | | userStates | [userSecurityState](usersecuritystate.md) collection | Security-related stateful information generated by the provider about the user accounts related to this alert. | None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Allowedvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/allowedvalue.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Anonymousguestconversationmember | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/anonymousguestconversationmember.md | Inherits from [conversationMember](../resources/conversationmember.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Apiapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/apiapplication.md | Specifies settings for an application that implements a web API. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Appidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/appidentity.md | Indicates the identity of the application that performed the action or was chang ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Applemanagedidentityprovider | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/applemanagedidentityprovider.md | Retrieve the **developerId**, **serviceId**, **keyId**, and the **certificateDat ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Application | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/application.md | This resource supports: |[Create application](../api/application-post-applications.md) | [application](application.md) | Creates (registers) a new application.| |[Get application](../api/application-get.md) | [application](application.md) |Read properties and relationships of application object.| |[Update application](../api/application-update.md) | None |Update application object. |+|[Upsert application](../api/application-upsert.md) | [application](application.md) | Create a new application if it doesn't exist, or update the properties of an existing application.| |[Delete application](../api/application-delete.md) | None |Delete application object. | |[Get delta](../api/application-delta.md)|[application](application.md)|Get newly created, updated, or deleted applications without performing a full read of the entire resource collection.| |[List deleted applications](../api/directory-deleteditems-list.md) | [directoryObject](directoryobject.md) collection | Retrieve a list of recently deleted applications. | This resource supports: |[Remove password](../api/application-removepassword.md)|[passwordCredential](passwordcredential.md)|Remove a password from an application.| |[Add key](../api/application-addkey.md)|[keyCredential](keycredential.md)|Add a key credential to an application.| |[Remove key](../api/application-removekey.md)|None|Remove a key credential from an application.|-|**Extensions**| | | -| [List extensionProperties](../api/application-list-extensionproperty.md) | [extensionProperty](extensionProperty.md) collection | List extension properties on an application object. | -| [Create extensionProperties](../api/application-post-extensionproperty.md) | [extensionProperty](extensionProperty.md) | Create an extension property on an application object. | -| [Get extensionProperty](../api/extensionproperty-delete.md) | None | Get an extension property from an application object. | -| [Delete extensionProperty](../api/extensionproperty-delete.md) | None | Delete an extension property from an application object. | -|[Get available extension properties](../api/directoryobject-getavailableextensionproperties.md)|[extensionProperty](../resources/extensionproperty.md) collection|Get all or a filtered list of the directory extension properties that are registered in a directory.| -|**Federated identity credentials**| | | -| [List federatedIdentityCredential](../api/application-list-federatedidentitycredentials.md) | [federatedIdentityCredential](../resources/federatedidentitycredential.md) collection | List federated identity credentials on an application object. | -| [Create federatedIdentityCredential](../api/application-post-federatedidentitycredentials.md) | [federatedIdentityCredential](../resources/federatedidentitycredential.md) | Create a federated identity credential on an application object. | -| [Get federatedIdentityCredential](../api/federatedidentitycredential-get.md) | [federatedIdentityCredential](../resources/federatedidentitycredential.md) | Retrieve the properties of a federated identity credential. | -| [Update federatedIdentityCredential](../api/federatedidentitycredential-update.md) | None | Update a federated identity credential of an application object. | -| [Delete federatedIdentityCredential](../api/federatedidentitycredential-delete.md) | None | Delete a federated identity credential from an application object. | |**Owners**| | | |[List owners](../api/application-list-owners.md) |[directoryObject](directoryobject.md) collection| Get the owners of an application.| |[Add owner](../api/application-post-owners.md) |[directoryObject](directoryobject.md)| Assign an owner to an application. Application owners can be users or service principals.| |[Remove owner](../api/application-delete-owners.md) |None| Remove an owner from an application. As a recommended best practice, apps should have at least two owners.|-|**Policies**| | | -|[Assign tokenIssuancePolicy](../api/application-post-tokenissuancepolicies.md)| [tokenIssuancePolicy](tokenissuancepolicy.md) collection| Assign a tokenIssuancePolicy to this object.| -|[List tokenIssuancePolicies](../api/application-list-tokenissuancepolicies.md)| [tokenIssuancePolicy](tokenissuancepolicy.md) collection| Get all tokenIssuancePolicies assigned to this object.| -|[Remove tokenIssuancePolicy](../api/application-delete-tokenissuancepolicies.md)| [tokenIssuancePolicy](tokenissuancepolicy.md) collection| Remove a tokenIssuancePolicy from this object.| -|[Assign tokenLifetimePolicy](../api/application-post-tokenlifetimepolicies.md)| [tokenLifetimePolicy](tokenlifetimepolicy.md) collection| Assign a tokenLifetimePolicy to this object.| -|[List tokenLifetimePolicies](../api/application-list-tokenlifetimepolicies.md)| [tokenLifetimePolicy](tokenlifetimepolicy.md) collection| Get all tokenLifetimePolicies assigned to this object.| -|[Remove tokenLifetimePolicy](../api/application-delete-tokenlifetimepolicies.md)| [tokenLifetimePolicy](tokenlifetimepolicy.md) collection| Remove a tokenLifetimePolicy from this object.| |**Verified publisher**| | | |[Set verified publisher](../api/application-setverifiedpublisher.md)| None | Set the verified publisher of an application.| |[Unset verified publisher](../api/application-unsetverifiedpublisher.md)| None | Unset the verified publisher of an application.| This resource supports: | displayName | String | The display name for the application. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderby`. | | groupMembershipClaims | String | Configures the `groups` claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values: `None`, `SecurityGroup` (for security groups and Microsoft Entra roles), `All` (this gets all of the security groups, distribution groups, and Microsoft Entra directory roles that the signed-in user is a member of). | | id | String | Unique identifier for the application object. This property is referred to as **Object ID** in the Microsoft Entra admin center. Inherited from [directoryObject](directoryobject.md). Key. Not nullable. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`).|-| identifierUris | String collection | Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you reference in your API's code, and it must be globally unique. You can use the default value provided, which is in the form `api://<application-client-id>`, or specify a more readable URI like `https://contoso.com/api`. For more information on valid identifierUris patterns and best practices, see [Microsoft Entra application registration security best practices](/azure/active-directory/develop/security-best-practices-for-app-registration#appid-uri-configuration). Not nullable. <br><br>Supports `$filter` (`eq`, `ne`, `ge`, `le`, `startsWith`).| +| identifierUris | String collection | Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you reference in your API's code, and it must be globally unique. You can use the default value provided, which is in the form `api://<appId>`, or specify a more readable URI like `https://contoso.com/api`. For more information on valid identifierUris patterns and best practices, see [Microsoft Entra application registration security best practices](/azure/active-directory/develop/security-best-practices-for-app-registration#appid-uri-configuration). Not nullable. <br><br>Supports `$filter` (`eq`, `ne`, `ge`, `le`, `startsWith`).| | info | [informationalUrl](informationalurl.md) | Basic profile information of the application such as app's marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: [Add Terms of service and privacy statement for registered Microsoft Entra apps](/azure/active-directory/develop/howto-add-terms-of-service-privacy-statement). <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, and `eq` on `null` values). | | isDeviceOnlyAuthSupported | Boolean | Specifies whether this application supports device authentication without a user. The default is `false`. | | isFallbackPublicClient | Boolean | Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is `false`, which means the fallback application type is confidential client such as a web app. There are certain scenarios where Microsoft Entra ID can't determine the client application type. For example, the [ROPC](https://tools.ietf.org/html/rfc6749#section-4.3) flow where it's configured without specifying a redirect URI. In those cases, Microsoft Entra ID interprets the application type based on the value of this property.| This resource supports: | samlMetadataUrl | String | The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable. | | serviceManagementReference | String | References application or service contact information from a Service or Asset Management database. Nullable. | | servicePrincipalLockConfiguration | [servicePrincipalLockConfiguration](servicePrincipalLockConfiguration.md) | Specifies whether sensitive properties of a multitenant application should be locked for editing after the application is provisioned in a tenant. Nullable. `null` by default. |-| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. The possible values are: `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` (default), and `PersonalMicrosoftAccount`. See more in the [table](#signinaudience-values). <br/><br/>The value of this object also limits the number of permissions an app can request. For more information, see [Limits on requested permissions per app](#limits-on-requested-permissions-per-app). <br><br>The value for this property has implications on other app object properties. As a result, if you change this property, you might need to change other properties first. For more information, see [Validation differences for signInAudience](/azure/active-directory/develop/supported-accounts-validation?context=graph/context).<br><br>Supports `$filter` (`eq`, `ne`, `not`).| +| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. The possible values are: `AzureADMyOrg` (default), `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount`, and `PersonalMicrosoftAccount`. See more in the [table](#signinaudience-values). <br/><br/>The value of this object also limits the number of permissions an app can request. For more information, see [Limits on requested permissions per app](#limits-on-requested-permissions-per-app). <br><br>The value for this property has implications on other app object properties. As a result, if you change this property, you might need to change other properties first. For more information, see [Validation differences for signInAudience](/azure/active-directory/develop/supported-accounts-validation?context=graph/context).<br><br>Supports `$filter` (`eq`, `ne`, `not`).| | spa | [spaApplication](../resources/spaapplication.md) | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. | | tags |String collection| Custom strings that can be used to categorize and identify the application. Not nullable. Strings added here will also appear in the **tags** property of any associated [service principals](serviceprincipal.md).<br><br>Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`) and `$search`.| | tokenEncryptionKeyId |String|Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to. 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.|+| uniqueName | String | The unique identifier that can be assigned to an application and used as an alternate key. Immutable. Read-only. | | verifiedPublisher | [verifiedPublisher](verifiedPublisher.md) | Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see [Publisher verification](/azure/active-directory/develop/publisher-verification-overview).| | web |[webApplication](webapplication.md)| Specifies settings for a web application. | This resource supports: | Value | Description | |:|:--|-|AzureADMyOrg|Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single tenant).| +|AzureADMyOrg|Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single tenant). This is the default value for the **signInAudience** property. | |AzureADMultipleOrgs|Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).|-|AzureADandPersonalMicrosoftAccount|Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant. For authenticating users with Azure AD B2C user flows, use `AzureADandPersonalMicrosoftAccount`. This value allows for the widest set of user identities including local accounts and user identities from Microsoft, Facebook, Google, Twitter, or any OpenID Connect provider. This is the default value for the **signInAudience** property. | +|AzureADandPersonalMicrosoftAccount|Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant. For authenticating users with Azure AD B2C user flows, use `AzureADandPersonalMicrosoftAccount`. This value allows for the widest set of user identities including local accounts and user identities from Microsoft, Facebook, Google, Twitter, or any OpenID Connect provider. | |PersonalMicrosoftAccount|Users with a personal Microsoft account only.| The following JSON representation shows the resource type. "spa": {"@odata.type": "microsoft.graph.spaApplication"}, "tags": ["String"], "tokenEncryptionKeyId": "String",+ "uniqueName": "String", "verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}, "web": {"@odata.type": "microsoft.graph.webApplication"} } |
v1.0 | Applicationauthenticationmethodpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/applicationauthenticationmethodpolicy.md | Depending on whether your app is a single tenant or multitenant app, you apply t ## Requirements -- Management of application authentication method policies can be performed by a global administrator, application administrator, or cloud application administrator.+- The least privileged Microsoft Entra roles for the management of application authentication method policies are Application Administrator and Cloud Application Administrator. - All app policy management operations require a [Microsoft Entra Workload ID Premium license](/azure/active-directory/workload-identities/workload-identities-faqs#what-is-the-cost-of-workload-identities-premium-plan). ## Next steps |
v1.0 | Applications Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/applications-api-overview.md | description: "Learn how to manage the lifecycle and settings for Microsoft Entra Last updated : 04/05/2024 ms.localizationpriority: medium |
v1.0 | Applicationserviceprincipal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/applicationserviceprincipal.md | Title: 'applicationServicePrincipal resource type' description: 'A combination of an application and a servicePrincipal.' ms.localizationpriority: medium-++ doc_type: resourcePageType |
v1.0 | Appliedconditionalaccesspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/appliedconditionalaccesspolicy.md | Title: "appliedConditionalAccessPolicy resource type" description: "Indicates the attributes related to applied conditional access policy or policies that are triggered by the corresponding sign-in activity." ms.localizationpriority: medium + doc_type: resourcePageType Indicates the attributes related to applied conditional access policy or policie ## Properties -| Property | Type |Description| +| Property | Type |Description| |:|:--|:-|-|displayName|String|Refers to the Name of the conditional access policy (example: ΓÇ£Require MFA for SalesforceΓÇ¥).| -|enforcedGrantControls|String collection|Refers to the grant controls enforced by the conditional access policy (example: ΓÇ£Require multifactor authenticationΓÇ¥).| -|enforcedSessionControls|String collection|Refers to the session controls enforced by the conditional access policy (example: ΓÇ£Require app enforced controlsΓÇ¥).| +|displayName|String|Refers to the Name of the conditional access policy (example: "Require MFA for Salesforce").| +|enforcedGrantControls|String collection|Refers to the grant controls enforced by the conditional access policy (example: "Require multifactor authentication").| +|enforcedSessionControls|String collection|Refers to the session controls enforced by the conditional access policy (example: "Require app enforced controls").| |id|String|An identifier of the conditional access policy. Supports `$filter` (`eq`).| |result|appliedConditionalAccessPolicyResult| Indicates the result of the CA policy that was triggered. Possible values are: `success`, `failure`, `notApplied` (policy isn't applied because policy conditions weren't met), `notEnabled` (This is due to the policy in a disabled state), `unknown`, `unknownFutureValue`, `reportOnlySuccess`, `reportOnlyFailure`, `reportOnlyNotApplied`, `reportOnlyInterrupted`. 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): `reportOnlySuccess`, `reportOnlyFailure`, `reportOnlyNotApplied`, `reportOnlyInterrupted`.| ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Approle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/approle.md | With [appRoleAssignments](approleassignment.md), app roles can be assigned to us ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Appscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/appscope.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Assignedlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/assignedlabel.md | Represents a sensitivity label assigned to a Microsoft 365 group. Sensitivity la ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Assignedlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/assignedlicense.md | Title: "assignedLicense resource type" description: "Represents a license assigned to a user. The **assignedLicenses** property of the user entity is a collection of **assignedLicense**." ms.localizationpriority: medium + doc_type: resourcePageType Represents a license assigned to a user. The **assignedLicenses** property of th ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Assignedplan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/assignedplan.md | The following table describes the possible statuses for the **capabilityStatus** ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Attachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/attachment.md | None ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Attachmentbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/attachmentbase.md | Inherits from [entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Attachmentinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/attachmentinfo.md | Represents the attributes of an attachment. 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.attachmentInfo" |
v1.0 | Attachmentitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/attachmentitem.md | Represents attributes of an item to be attached. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Attendee | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/attendee.md | Derived from [attendeeBase](attendeebase.md). ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Attendeeavailability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/attendeeavailability.md | The availability of an attendee. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Attendeebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/attendeebase.md | Derived from [recipient](recipient.md). ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Auditactivityinitiator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/auditactivityinitiator.md | Identity the resource object that initiates the activity. The initiator can be a ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Authentication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authentication.md | None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationattributecollectioninputconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationattributecollectioninputconfiguration.md | + + Title: "authenticationAttributeCollectionInputConfiguration resource type" +description: "Represents the configuration of attributes being collected on an attribute collection page that is part of a self-service user flow for external identities." ++ms.localizationpriority: medium ++++# authenticationAttributeCollectionInputConfiguration resource type ++Namespace: microsoft.graph ++Represents the display configuration of attributes being collected on an attribute collection page that is part of a self-service user flow for external identities. ++## Properties +|Property|Type|Description| +|:|:|:| +|attribute|String|The built-in or custom attribute for which a value is being collected.| +|defaultValue|String|The default value of the attribute displayed to the end user.| +|editable|Boolean|Whether the attribute is editable by the end user. | +|hidden|Boolean|Whether the attribute is displayed to the end user.| +|inputType|authenticationAttributeCollectionInputType|The type of input field. The possible values are: `text`, `radioSingleSelect`, `checkboxMultiSelect`, `boolean`, `checkboxSingleSelect`, `unknownFutureValue`.| +|label|String|The label of the attribute field that is displayed to end user, unless overridden.| +|options|[authenticationAttributeCollectionOptionConfiguration](../resources/authenticationattributecollectionoptionconfiguration.md) collection|The option values for certain multiple-option input types.| +|required|Boolean|Whether the field is required.| +|validationRegEx|String|The regex for the value of the field.| +|writeToDirectory|Boolean|Whether the value collected is stored.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.authenticationAttributeCollectionInputConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.authenticationAttributeCollectionInputConfiguration", + "attribute": "String", + "label": "String", + "inputType": "String", + "defaultValue": "String", + "hidden": "Boolean", + "editable": "Boolean", + "writeToDirectory": "Boolean", + "required": "Boolean", + "validationRegEx": "String", + "options": [ + { + "@odata.type": "microsoft.graph.authenticationAttributeCollectionOptionConfiguration" + } + ] +} +``` + |
v1.0 | Authenticationattributecollectionoptionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationattributecollectionoptionconfiguration.md | + + Title: "authenticationAttributeCollectionOptionConfiguration resource type" +description: "Represents the configuration of option values for certain input types on an attribute collection page that is part of a self-service user flow for external identities." ++ms.localizationpriority: medium ++++# authenticationAttributeCollectionOptionConfiguration resource type ++Namespace: microsoft.graph ++Represents the option values for certain input types, such as radio buttons, on an attribute collection page that is part of a self-service user flow for external identities. ++## Properties +|Property|Type|Description| +|:|:|:| +|label|String|The label of the option that will be displayed to user, unless overridden.| +|value|String|The value of the option that will be stored.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.authenticationAttributeCollectionOptionConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.authenticationAttributeCollectionOptionConfiguration", + "label": "String", + "value": "String" +} +``` + |
v1.0 | Authenticationattributecollectionpage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationattributecollectionpage.md | + + Title: "authenticationAttributeCollectionPage resource type" +description: "Represents the attribute collection page that is part of a self-service user flow for external identities." ++ms.localizationpriority: medium ++++# authenticationAttributeCollectionPage resource type ++Namespace: microsoft.graph ++Represents the attribute collection page that is part of a self-service user flow for external identities. ++## Properties +|Property|Type|Description| +|:|:|:| +|views|[authenticationAttributeCollectionPageViewConfiguration](../resources/authenticationattributecollectionpageviewconfiguration.md) collection|A collection of displays of the attribute collection page.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.authenticationAttributeCollectionPage" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.authenticationAttributeCollectionPage", + "views": [ + { + "@odata.type": "microsoft.graph.authenticationAttributeCollectionPageViewConfiguration" + } + ] +} +``` + |
v1.0 | Authenticationattributecollectionpageviewconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationattributecollectionpageviewconfiguration.md | + + Title: "authenticationAttributeCollectionPageViewConfiguration resource type" +description: "Represents the view of the attribute collection page that is part of a self-service user flow for external identities." ++ms.localizationpriority: medium ++++# authenticationAttributeCollectionPageViewConfiguration resource type ++Namespace: microsoft.graph ++Represents the display of the attribute collection page that is part of a self-service user flow for external identities. ++## Properties +|Property|Type|Description| +|:|:|:| +|description|String|The description of the page.| +|inputs|[authenticationAttributeCollectionInputConfiguration](../resources/authenticationattributecollectioninputconfiguration.md) collection|The display configuration of attributes being collected on the attribute collection page.| +|title|String|The title of the attribute collection page.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.authenticationAttributeCollectionPageViewConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.authenticationAttributeCollectionPageViewConfiguration", + "title": "String", + "description": "String", + "inputs": [ + { + "@odata.type": "microsoft.graph.authenticationAttributeCollectionInputConfiguration" + } + ] +} +``` + |
v1.0 | Authenticationcombinationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationcombinationconfiguration.md | This is an abstract type. In use, [fido2combinationConfigurations](fido2combinat ## Relationships |id|String|A unique system-generated identifier.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationconditionapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationconditionapplication.md | + + Title: "authenticationConditionApplication resource type" +description: "Represents the application that is triggered for an authenticationEventListener." ++ms.localizationpriority: medium ++++# authenticationConditionApplication resource type ++Namespace: microsoft.graph ++Represents the application that is triggered for an authenticationEventListener. ++## Methods ++None. ++## Properties +|Property|Type|Description| +|:|:|:| +|appId|String|The identifier for an application corresponding to a condition that triggers an authenticationEventListener.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.authenticationConditionApplication", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.authenticationConditionApplication", + "appId": "String" +} +``` + |
v1.0 | Authenticationconditions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationconditions.md | + + Title: "authenticationConditions resource type" +description: "The conditions on which an authenticationEventListener should trigger." ++ms.localizationpriority: medium ++++# authenticationConditions resource type ++Namespace: microsoft.graph ++The conditions on which an authenticationEventListener should trigger. ++## Properties +|Property|Type|Description| +|:|:|:| +|applications|[authenticationConditionsApplications](../resources/authenticationconditionsapplications.md)|Applications which trigger a custom authentication extension.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.authenticationConditions" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.authenticationConditions", + "applications": { + "@odata.type": "microsoft.graph.authenticationConditionsApplications" + } +} +``` + |
v1.0 | Authenticationconditionsapplications | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationconditionsapplications.md | + + Title: "authenticationConditionsApplications resource type" +description: "The applications on which an authenticationEventListener should trigger." ++ms.localizationpriority: medium ++++# authenticationConditionsApplications resource type ++Namespace: microsoft.graph ++The applications on which an authenticationEventListener should trigger. ++## Properties +None. ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|includeApplications|[authenticationConditionApplication](../resources/authenticationconditionapplication.md) collection|Collection of the application conditions on which an authenticationEventListener should trigger.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.authenticationConditionsApplications" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.authenticationConditionsApplications" +} +``` + |
v1.0 | Authenticationconfigurationvalidation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationconfigurationvalidation.md | + + Title: "authenticationConfigurationValidation resource type" +description: "The result of a validateAuthenticationConfiguration action that validates a customAuthenticationExtension configuration." ++ms.localizationpriority: medium ++++# authenticationConfigurationValidation resource type ++Namespace: microsoft.graph ++The validation result of a [validateAuthenticationConfiguration action](../api/customauthenticationextension-validateauthenticationconfiguration.md) that validates a [customAuthenticationExtension](../resources/customauthenticationextension.md) configuration. ++## Properties +|Property|Type|Description| +|:|:|:| +|errors|[genericError](../resources/genericerror.md) collection|Errors in the validation result of a [customAuthenticationExtension](../resources/customauthenticationextension.md).| +|warnings|[genericError](../resources/genericerror.md) collection|Warnings in the validation result of a [customAuthenticationExtension](../resources/customauthenticationextension.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.authenticationConfigurationValidation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.authenticationConfigurationValidation", + "errors": [ + { + "@odata.type": "microsoft.graph.genericError" + } + ], + "warnings": [ + { + "@odata.type": "microsoft.graph.genericError" + } + ] +} +``` + |
v1.0 | Authenticationcontextclassreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationcontextclassreference.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Authenticationeventlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationeventlistener.md | + + Title: "authenticationEventListener resource type" +description: "Listener for taking action on events in the authentication process." ++ms.localizationpriority: medium ++++# authenticationEventListener resource type ++Namespace: microsoft.graph ++To customize the authentication process, listeners can be registered which specify that for some event, on some conditions, some custom logic can be invoked. This is an abstract type from which the following types are derived. ++- [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 +- [onTokenIssuanceStartListener resource type](../resources/ontokenissuancestartlistener.md) resource type ++Inherits from [entity](../resources/entity.md). ++> [!NOTE] +> +> You can have a maximum of 250 event listeners. +++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/identitycontainer-list-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md) collection|Retrieve a list of the object types that are derived from **authenticationEventListener**.| +|[Create](../api/identitycontainer-post-authenticationeventlisteners.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Create a new object type that is derived from **authenticationEventListener**.| +|[Get](../api/authenticationeventlistener-get.md)|[authenticationEventListener](../resources/authenticationeventlistener.md)|Read the properties and relationships of an object type that is derived from **authenticationEventListener**.| +|[Update](../api/authenticationeventlistener-update.md)|None|Update the properties of an object type that is derived from **authenticationEventListener**.| +|[Delete](../api/authenticationeventlistener-delete.md)|None|Delete an object type that is derived from **authenticationEventListener**.| ++## Properties +|Property|Type|Description| +|:|:|:| +|conditions|[authenticationConditions](../resources/authenticationconditions.md)|The conditions on which this authenticationEventListener should trigger.| +|id|String|Identifier for this authenticationEventListener. Inherited from [entity](../resources/entity.md).| +|authenticationEventsFlowId|String|Indicates the authenticationEventListener is associated with an [authenticationEventsFlow](../resources/authenticationeventsflow.md). Read-only. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.authenticationEventListener", + "baseType": "microsoft.graph.entity", + "openType": true +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.authenticationEventListener", + "id": "String (identifier)", + "conditions": { + "@odata.type": "microsoft.graph.authenticationConditions" + }, + "authenticationEventsFlowId": "String" +} +``` + |
v1.0 | Authenticationeventsflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationeventsflow.md | + + Title: "authenticationEventsFlow resource type" +description: "An abstract entity that represents a multi-event policy used to orchestrate an authentication flow." ++ms.localizationpriority: medium ++++# authenticationEventsFlow resource type ++Namespace: microsoft.graph ++Represents a multi-event policy, that is, a **user flow**, and holds the handler configuration for multiple events. Each property of name *eventType* is optional and corresponds to the handler configuration on the event listener. This resource allows for managing multiple [authenticationEventListener](../resources/authenticationeventlistener.md) objects under the same priority and condition set. This resource provides a better-managed view of checking which event listeners are executed under a certain circumstance. ++If no handler is set for an event, then this policy doesn't effect that event in any authentication, and no listener is created for that event. ++Additionally, this entity works as an orchestration step for the various event listeners it manages. For each event listener that it manages, it creates, modifies, or deletes the event listener accordingly. This means on creation time, it creates multiple event listeners and manages any rollback scenarios for any failing requests. ++This resource is an abstract type from which the [externalUsersSelfServiceSignUpEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object type is derived. ++Inherits from [entity](../resources/entity.md). ++## Methods +## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/identitycontainer-list-authenticationeventsflows.md)|[authenticationEventsFlow](../resources/authenticationeventsflow.md) collection|Retrieve a list of the [authenticationEventsFlow](../resources/authenticationeventsflow.md) objects and their properties. Only objects of the [externalUserSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) subtype are available.| +|[Create](../api/identitycontainer-post-authenticationeventsflows.md)|[authenticationEventsFlow](../resources/authenticationeventsflow.md)|Create a new [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. Only objects of the [externalUserSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) subtype are supported.| +|[Get](../api/authenticationeventsflow-get.md)|[authenticationEventsFlow](../resources/authenticationeventsflow.md)|Read the properties and relationships of an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. Only objects of the [externalUserSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) subtype are available.| +|[Update](../api/authenticationeventsflow-update.md)|None|Update the properties of an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. Only objects of the [externalUserSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) subtype are available.| +|[Delete](../api/authenticationeventsflow-delete.md)|None|Delete an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. Only objects of the [externalUserSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) subtype are supported. | +|**Identity providers in a user flow**||| +|[List](../api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders.md)|[identityProviderBase](../resources/identityproviderbase.md) collection|Get the identity providers that are defined for an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object type.| +|[Add](../api/onauthenticationmethodloadstartexternalusersselfservicesignup-post-identityproviders.md)|None|Add an identity provider to an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object type. The identity provider must first be configured in the tenant.| +|[Remove](../api/onauthenticationmethodloadstartexternalusersselfservicesignup-delete-identityproviders.md)|None|Remove an identity provider from an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object type.| +|**User flow attributes**||| +|[List](../api/identityuserflowattribute-list.md)|identityUserFlowAttributes collection|Retrieve all built-in and custom user flow attributes.| +|[Create](../api/identityuserflowattribute-post.md)|identityUserFlowAttribute|Create a new custom user flow attribute.| +|[Get](../api/identityuserflowattribute-get.md) |identityUserFlowAttribute|Retrieve properties of a user flow attribute.| +|[Update](../api/identityuserflowattribute-update.md)|None|Update a custom user flow attribute.| +|[Delete](../api/identityuserflowattribute-delete.md)|None|Delete a custom user flow attribute.| +|[List attributes in a user flow](../api/onattributecollectionexternalusersselfservicesignup-list-attributes.md)|None|Get the collection of **identityUserFlowAttribute** objects associated with an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|[List attributes in a user flow](../api/onattributecollectionexternalusersselfservicesignup-list-attributes.md)|None|Get the collection of **identityUserFlowAttribute** objects associated with an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|[Add attribute to a user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md)|None|Add an **identityUserFlowAttribute** object associated with an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|[Remove attribute from a user flow](../api/onattributecollectionexternalusersselfservicesignup-delete-attributes.md)|None|Remove an **identityUserFlowAttribute** object associated with an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|**Linked applications**||| +|[List](../api/authenticationconditionsapplications-list-includeapplications.md)|[authenticationConditionApplication](../resources/authenticationconditionapplication.md) collection|List the applications linked to an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|[Add](../api/authenticationconditionsapplications-post-includeapplications.md)|None|Add an application to an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| +|[Remove](../api/authenticationconditionapplication-delete.md)|None|Remove an application from an external identities self-service sign-up user flow that's represented by an **externalUsersSelfServiceSignupEventsFlow** object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|The unique identifier for the entity. Read-only. Inherited from [entity](../resources/entity.md). Autogenerated.| +|displayName|String|Required. The display name for the events policy.| +|description|String|The description of the events policy.| +|conditions|[authenticationConditions](../resources/authenticationconditions.md)|The conditions representing the context of the authentication request that's used to decide whether the events policy is invoked.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.authenticationEventsFlow", + "baseType": "microsoft.graph.entity", + "openType": true +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.authenticationEventsFlow", + "id": "String (identifier)", + "displayName": "String", + "description": "String", + "conditions": { + "@odata.type": "microsoft.graph.authenticationConditions" + } +} +``` + |
v1.0 | Authenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationmethodconfiguration.md | The following authentication methods are derived from the **authenticationMethod None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Authenticationmethodsroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationmethodsroot.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Authenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationmethodtarget.md | Namespace: microsoft.graph A collection of groups that are enabled to use an authentication method as part of an authentication method policy in Microsoft Entra ID. +The following types are derived from this resource type: +- [microsoftAuthenticatorAuthenticationMethodTarget](../resources/microsoftauthenticatorauthenticationmethodtarget.md) +- [smsAuthenticationMethodTarget](../resources/smsauthenticationmethodtarget.md) + ## Properties |Property|Type|Description| A collection of groups that are enabled to use an authentication method as part None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Automaticrepliesmailtips | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/automaticrepliesmailtips.md | Namespace: microsoft.graph ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Automaticrepliessetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/automaticrepliessetting.md | respond to emails. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Azure Ad Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/azure-ad-overview.md | - Title: "Working with Microsoft Entra resources in Microsoft Graph" -description: "With Microsoft Graph, you can access Microsoft Entra resources to enable scenarios like managing administrator (directory) roles, inviting external users to an organization, and, if you are a Cloud Solution Provider (CSP), managing your customer's data. Microsoft Graph also provides methods that apps can use to, for example, discover information about users' transitive group and role memberships. " ---doc_type: conceptualPageType Previously updated : 07/07/2022---# Working with Microsoft Entra resources in Microsoft Graph --With Microsoft Graph, you can access [Microsoft Entra](/azure/active-directory/active-directory-whatis) resources to enable scenarios like managing administrator (directory) roles, inviting external users to an organization, and, if you are a [Cloud Solution Provider (CSP)](https://partner.microsoft.com/cloud-solution-provider), managing your customer's data. Microsoft Graph also provides methods that apps can use to, for example, discover information about users' transitive group and role memberships. --> **Note**: Some Microsoft Entra resources are documented in other sections of the API reference. For more information, see [Users](users.md) and [Groups](group.md). ---## Authorization --To call the Microsoft Graph APIs on Microsoft Entra resources, your app will need the appropriate permissions. Many of the APIs exposed on Microsoft Entra resources require one of the [_Directory_ permissions](/graph/permissions-reference#directory-permissions). Directory permissions are highly privileged and always require administrator consent. --If your app is acting on behalf of a user (delegated permissions), that user will likely need to be a member of an appropriate [administrator role](/azure/active-directory/active-directory-assign-admin-roles) for your app to successfully call many of the Microsoft Entra APIs. --For more information about permissions, including delegated and application permissions, see [Permissions](/graph/permissions-reference). --## Common use cases --The following table lists some common use cases for Microsoft Entra resources. --| **Use cases** | **REST resources** | **See also** | -|:|:--|:-| -| **Directory object and methods** | | | -| `directoryObject` is the base class that many directory resources, like users and groups, inherit from. Microsoft Graph exposes several methods that you can use to discover information about users, groups, and other directory objects. For example, you can check for transitive membership in a list of groups, return all the groups and directory roles that a directory object is a transitive member of, or get all the resources of a specified type (like user or group) from a list of generic resource IDs. | [directoryObject](../resources/directoryobject.md) | N/A | -| **Manage directory (administrator) roles** | | | -| Activate directory roles in a Microsoft Entra tenant and manage user memberships in directory roles. Directory roles are also known as administrator roles. | [directoryRole](../resources/directoryrole.md) <br/>[directoryRoleTemplate](../resources/directoryroletemplate.md) | [Assigning Microsoft Entra administrator roles](/azure/active-directory/active-directory-assign-admin-roles) | -| Apply predefined group settings across a tenant or to individual resource instances. Group settings control behaviors like blocked word lists for group display names, whether guest users are allowed to be group owners, and much more. | [groupSetting](../resources/groupsetting.md) <br/>[groupSettingTemplate](../resources/groupsettingtemplate.md)| [Microsoft Entra cmdlets for configuring group settings](/azure/active-directory/active-directory-accessmanagement-groups-settings-cmdlets)| -| **Manage devices** | | | -| Manage devices registered in the organization. Devices are registered to users and include items like laptops, desktops, tablets, and mobile phones. Devices are typically created in the cloud using the Device Registration Service or by Microsoft Intune. They're used by conditional access policies for multifactor authentication. | [device](../resources/device.md) | [Getting started with Microsoft Entra device registration](/mem/intune/enrollment/).<br/><br/>[What is Intune?](/mem/intune/fundamentals/what-is-intune)<br/><br/>[Enroll devices for management in Intune](/mem/intune/enrollment/) | -| **Partner tenant management** | | | -| Get information about partnerships with customer tenants.<br/><br/>**Note:** This applies to partner tenants only. Partner tenants are Microsoft Entra tenants that belong to Microsoft partners who are either part of the [Microsoft Cloud Solution Provider](https://partnercenter.microsoft.com/partner/programs), Office 365 Syndication, or Microsoft Advisor partner programs. | [contract](../resources/contract.md) | [Call Microsoft Graph from a Cloud Solution Provider application](/graph/auth-cloudsolutionprovider) | -| Manage domains associated with a tenant. Domain operations enable registrars to automate domain association for services such as Microsoft 365. | [domain](../resources/domain.md) | [Add a custom domain name to Microsoft Entra ID](/azure/active-directory/active-directory-domains-add-azure-portal) | -| **Tenant management** | | | -| Get information about an organization, such as its business address, technical and notification contacts, the service plans that it's subscribed to, and the domains associated with it. | [organization](../resources/organization.md) | N/A | -| Get information about the service SKUs that a company is subscribed to. | [subscribedSku](../resources/subscribedsku.md) | N/A | -| Invite external (guest) users to an organization. | [invitation](../resources/invitation.md) | [What is Microsoft Entra B2B collaboration?](/azure/active-directory/active-directory-b2b-what-is-azure-ad-b2b) | -| Manage branding for the sign-in experience of an organization. | [organizationalbranding](../resources/organizationalbranding.md) | [Add branding to your organization's Microsoft Entra sign-in page](/azure/active-directory/fundamentals/customize-branding)| -| **Consent requests** | | | -| Manage the consent request workflow for users attempting to access apps that require admin authorization. | [Consent requests API](../resources/consentrequests-overview.md) |[Configure the admin consent workflow](/azure/active-directory/manage-apps/configure-admin-consent-workflow) | --## Next steps -Directory resources and APIs can open up new ways for you to engage with users and manage their experiences with Microsoft Graph. To learn more: --- Drill down on the methods and properties of the resources most helpful to your scenario.-- Try the API in the [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). |
v1.0 | Azureadtokenauthentication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/azureadtokenauthentication.md | + + Title: "azureAdTokenAuthentication resource type" +description: "Defines the Microsoft Entra application used to authenticate with a custom extension." ++ms.localizationpriority: medium ++++# azureAdTokenAuthentication resource type ++Namespace: microsoft.graph ++Defines the Microsoft Entra application used to authenticate an app with a custom extension. Only the app ID of the application is required. Derived from [customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|resourceId|String|The **appID** of the Microsoft Entra application to use to authenticate an app with a custom extension.| ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.azureAdTokenAuthentication", + "baseType": "microsoft.graph.customExtensionAuthenticationConfiguration" +} +--> ++``` json +{ + "@odata.type": "#microsoft.graph.azureAdTokenAuthentication", + "resourceId": "String" + } +``` |
v1.0 | B2xidentityuserflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/b2xidentityuserflow.md | Inherits from base class [identityUserFlow](../resources/identityuserflow.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Basesitepage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/basesitepage.md | + + Title: "baseSitePage resource type" +description: "An abstract type that represents a baseSitePage in the site page library." ++ms.localizationpriority: medium +++# baseSitePage resource type ++Namespace: microsoft.graph ++++An abstract type that represents a page in the site page library. ++Inherits from [baseItem](../resources/baseitem.md). ++## Methods ++| Method | Return type | Description | +| : | : | :- | +| [List baseSitePage](../api/basesitepage-list.md) | [baseSitePage](../resources/basesitepage.md) collection | Get the collection of [baseSitePage](../resources/basesitepage.md) objects from the site pages [list](../resources/list.md) in a [site](../resources/site.md). | +| [Get baseSitePage](../api/baseSitePage-get.md) | [baseSitePage](../resources/basesitepage.md) | Get the metadata for a [baseSitePage](../resources/basesitepage.md) in the site pages [list](../resources/list.md) in a [site](../resources/site.md). | +| [Delete baseSitePage](../api/baseSitePage-delete.md) | None | Delete a [baseSitePage](../resources/basesitepage.md) object. | ++## Properties ++| Property | Type | Description | +| :- | :- | : | +| contentType | [contentTypeInfo](../resources/contentTypeInfo.md) | The content type of this item. Inherited from [baseItem](../resources/baseitem.md). | +| createdBy | [identitySet](../resources/identityset.md) | Identity of the creator of this item. Read-only. Inherited from [baseItem](../resources/baseitem.md). | +| createdDateTime | DateTimeOffset | The date and time the item was created. Read-only. Inherited from [baseItem](../resources/baseitem.md). | +| description | String | The descriptive text for the item. Inherited from [baseItem](../resources/baseitem.md). | +| eTag | String | ETag for the item. Inherited from [baseItem](../resources/baseitem.md). | +| id | String | The unique identifier of the item. Inherited from [entity](../resources/entity.md). | +| lastModifiedBy | [identitySet](../resources/identityset.md) | The identity of the last modifier of this item. Read-only. Inherited from [baseItem](../resources/baseitem.md). | +| lastModifiedDateTime | DateTimeOffset | The date and time the item was last modified. Read-only. Inherited from [baseItem](../resources/baseitem.md). | +| name | String | The name of the item. Inherited from [baseItem](../resources/baseitem.md). | +| pageLayout | [pageLayoutType](../resources/basesitepage.md#pagelayouttype-values) | The name of the page layout of the page. The possible values are: `microsoftReserved`, `article`, `home`, `unknownFutureValue`. | +| parentReference | [itemReference](../resources/itemreference.md) | Parent information, if the item has a parent. Inherited from [baseItem](../resources/baseitem.md). | +| publishingState | [publicationFacet](../resources/publicationfacet.md) | The publishing status and the MM.mm version of the page. | +| title | String | Title of the sitePage. | +| webUrl | String | URL that displays the resource in the browser. Read-only. Inherited from [baseItem](../resources/baseitem.md). | ++### pageLayoutType values ++| Value | Description | +| | | +| microsoftReserved | The page is a special type reserved for Microsoft use only. | +| article | The page is an article page. | +| home | The page is a home page. | +| unknownFutureValue | Marker value for future compatibility. | ++## Relationships ++| Relationship | Type | Description | +| :-- | : | : | +| createdByUser | [user](../resources/user.md) | Identity of the creator of this item. Read-only. Inherited from [baseItem](../resources/baseitem.md) | +| lastModifiedByUser | [user](../resources/user.md) | Identity of the last modifier of this item. Read-only. Inherited from [baseItem](../resources/baseitem.md) | ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.baseSitePage", + "baseType": "microsoft.graph.baseItem", + "openType": true +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.baseSitePage", + "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" + } +} +``` |
v1.0 | Basicauthentication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/basicauthentication.md | 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.basicAuthentication" |
v1.0 | Bitlocker | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bitlocker.md | None. | recoveryKeys | [bitlockerRecoveryKey](../resources/bitlockerrecoverykey.md) collection | The recovery keys associated with the bitlocker entity. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.bitlocker", |
v1.0 | Bookingappointment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingappointment.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Bookingcurrency | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingcurrency.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Bookingcustomerbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingcustomerbase.md | Base type of [bookingCustomer](bookingcustomer.md) |id|String|ID of the customer. Inherited from [entity](../resources/entity.md).| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Bookingquestionassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingquestionassignment.md | Contains the set of custom questions associated with a particular service. ## Properties |Property|Type|Description| |:|:|:|-|isRequired|Boolean|The ID of the custom question.| -|questionId|String|Indicates whether it's mandatory to answer the custom question.| +|isRequired|Boolean|Indicates whether it's mandatory to answer the custom question.| +|questionId|String|The ID of the custom question.| ## 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.bookingQuestionAssignment" |
v1.0 | Bookingstaffmemberbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingstaffmemberbase.md | Base type of [bookingStaffMember](bookingstaffmember.md). |id|String|ID of the staff member. Inherited from [entity](../resources/entity.md).| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Broadcastmeetingcaptionsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/broadcastmeetingcaptionsettings.md | The following table shows the supported language codes for translation languages ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.broadcastMeetingCaptionSettings" |
v1.0 | Broadcastmeetingsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/broadcastmeetingsettings.md | Represents settings related to a [live event](/microsoftteams/teams-live-events/ ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Builtinidentityprovider | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/builtinidentityprovider.md | This type inherits from [identityProviderBase](../resources/identityproviderbase ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Calendargroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/calendargroup.md | A group of user calendars. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Calendarpermission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/calendarpermission.md | Once a share recipient or delegate has been set up for a calendar, you can [upda ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Call | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/call.md | https://teams.microsoft.com/l/meetup-join/19:meeting_NTg0NmQ3NTctZDVkZC00YzRhLTh ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. "mediaState": {"@odata.type": "#microsoft.graph.callMediaState"}, "meetingInfo": {"@odata.type": "#microsoft.graph.meetingInfo"}, "myParticipantId": "String", - "replacesContext": "String", "requestedModalities": ["String"], "resultInfo": {"@odata.type": "#microsoft.graph.resultInfo"}, "source": {"@odata.type": "#microsoft.graph.participantInfo"}, |
v1.0 | Callrecords Feedbacktokenset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/callrecords-feedbacktokenset.md | Explicit property names won't be documented since the feedback token names can c ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. ], "@odata.type": "microsoft.graph.callRecords.feedbackTokenSet",- "baseType": null + "openType": true }--> ```json |
v1.0 | Callrecords Segment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/callrecords-segment.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Canvaslayout | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/canvaslayout.md | + + Title: 'canvasLayout resource type' +description: Represents the layout of the content in a given SharePoint page. ++ms.localizationpriority: medium +++# canvasLayout resource type ++Namespace: microsoft.graph ++++Represents the layout of the content in a given SharePoint page. ++Inherits from [entity](../resources/entity.md). ++## Methods ++None. ++## Properties ++| Property | Type | Description | +| :- | :-- | :-- | +| id | String | The unique identifier of the resource. Inherited from [entity](../resources/entity.md). | ++## Relationships ++| Relationship | Type | Description | +| :-- | :- | :-- | +| horizontalSections | [horizontalSection](../resources/horizontalsection.md) collection | Collection of horizontal sections on the SharePoint page. | +| verticalSection | [verticalSection](../resources/verticalsection.md) | Vertical section on the SharePoint page. | ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.canvasLayout", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.canvasLayout", + "id": "String (identifier)", + /* relationships */ + "horizontalSections": { + "@odata.type": "Collection(microsoft.graph.horizontalSection)" + }, + "verticalSection": { "@odata.type": "microsoft.graph.verticalSection" } +} +``` |
v1.0 | Certificateauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/certificateauthority.md | Title: "certificateAuthority resource type" description: "Represents a certificate authority." ms.localizationpriority: medium-+ doc_type: "resourcePageType" doc_type: "resourcePageType" Namespace: microsoft.graph -Represents a certificate authority. +Used by the **certificateAuthorities** property of [certificateBasedAuthConfiguration resource type](certificatebasedauthconfiguration.md) to represent a certificate authority. ## Properties |
v1.0 | Certificatebasedauthconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/certificatebasedauthconfiguration.md | Title: "certificateBasedAuthConfiguration resource type" description: "Represents a collection of certificate authorities." ms.localizationpriority: medium-+ doc_type: "resourcePageType" +toc.keywords: [ CBA ] # certificateBasedAuthConfiguration resource type |
v1.0 | Certification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/certification.md | The certification property of an application is read-only, and can't be manually |lastCertificationDateTime|DateTimeOffset|The timestamp when the certification for the application was most recently added or updated.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Change Notifications Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/change-notifications-api-overview.md | Title: "Overview: Microsoft Graph API change notifications" description: "Deliver change notifications to clients." ms.localizationpriority: high + doc_type: conceptualPageType Last updated 09/10/2022 |
v1.0 | Changenotification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/changenotification.md | description: "Represents the change notification sent to the subscriber." ms.localizationpriority: medium doc_type: resourcePageType+ # changeNotification resource type |
v1.0 | Changenotificationcollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/changenotificationcollection.md | description: "Represents a collection of subscription notifications sent to the ms.localizationpriority: medium doc_type: resourcePageType+ # changeNotificationCollection resource type |
v1.0 | Changenotificationencryptedcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/changenotificationencryptedcontent.md | description: "A changeNotificationEncryptedContent object represents the encrypt ms.localizationpriority: medium doc_type: resourcePageType+ # changeNotificationEncryptedContent resource type |
v1.0 | Chart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chart.md | - Title: "Chart resource type" -description: "Represents a chart object in a workbook." ---doc_type: resourcePageType ---# Chart resource type --Namespace: microsoft.graph --Represents a chart object in a workbook. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get Chart](../api/chart-get.md) | [WorkbookChart](chart.md) |Read properties and relationships of chart object.| -|[Create ChartSeries](../api/chart-post-series.md) |[WorkbookChartSeries](chartseries.md)| Create a new ChartSeries by posting to the series collection.| -|[List series](../api/chart-list-series.md) |[WorkbookChartSeries](chartseries.md) collection| Get a ChartSeries object collection.| -|[Update](../api/chart-update.md) | [WorkbookChart](chart.md) |Update Chart object. | -|[Image](../api/chart-image.md)|Image base64 encoded string|Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.| -|[Delete](../api/chart-delete.md)|None|Deletes the chart object.| -|[Setdata](../api/chart-setdata.md)|None|Resets the source data for the chart.| -|[Setposition](../api/chart-setposition.md)|None|Positions the chart relative to cells on the worksheet.| -|[List](../api/chart-list.md) | [WorkbookChart](chart.md) collection |Get chart object collection. | -|[Itemat](../api/chartcollection-itemat.md)|[WorkbookChart](chart.md)|Gets a chart based on its position in the collection.| -|[Add](../api/chartcollection-add.md)|[WorkbookChart](chart.md)|Creates a new chart.| --## Properties -| Property | Type |Description| -|:|:--|:-| -|height|double|Represents the height, in points, of the chart object.| -|id|string|Gets a chart based on its position in the collection. Read-only.| -|left|double|The distance, in points, from the left side of the chart to the worksheet origin.| -|name|string|Represents the name of a chart object.| -|top|double|Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).| -|width|double|Represents the width, in points, of the chart object.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|axes|[WorkbookChartAxes](chartaxes.md)|Represents chart axes. Read-only.| -|dataLabels|[WorkbookChartDataLabels](chartdatalabels.md)|Represents the datalabels on the chart. Read-only.| -|format|[WorkbookChartAreaFormat](chartareaformat.md)|Encapsulates the format properties for the chart area. Read-only.| -|legend|[WorkbookChartLegend](chartlegend.md)|Represents the legend for the chart. Read-only.| -|series|[WorkbookChartSeries](chartseries.md) collection|Represents either a single series or collection of series in the chart. Read-only.| -|title|[WorkbookChartTitle](charttitle.md)|Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only.| -|worksheet|[WorkbookWorksheet](worksheet.md)|The worksheet containing the current chart. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "keyProperty": "id", - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChart" -}--> --```json -{ - "height": 1024, - "id": "string", - "left": 1024, - "name": "string", - "top": 1024, - "width": 1024 -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "Chart resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartareaformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartareaformat.md | - Title: "ChartAreaFormat resource type" -description: "Encapsulates the format properties for the overall chart area." ---doc_type: resourcePageType ---# ChartAreaFormat resource type --Namespace: microsoft.graph --Encapsulates the format properties for the overall chart area. ---## Methods -None --## Properties -None --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|fill|[WorkbookChartFill](chartfill.md)|Represents the fill format of an object, which includes background formatting information. Read-only.| -|font|[WorkbookChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartAreaFormat" -}--> --```json -{ - "fill": {"@odata.type": "microsoft.graph.workbookChartFill"}, - "font": {"@odata.type": "microsoft.graph.workbookChartFont"} -} -``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartAreaFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartaxes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartaxes.md | - Title: "ChartAxes resource type" -description: "Represents the chart axes." ---doc_type: resourcePageType ---# ChartAxes resource type --Namespace: microsoft.graph --Represents the chart axes. ---## Methods -None --## Properties -None --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|categoryAxis|[WorkbookChartAxis](chartaxis.md)|Represents the category axis in a chart. Read-only.| -|seriesAxis|[WorkbookChartAxis](chartaxis.md)|Represents the series axis of a 3-dimensional chart. Read-only.| -|valueAxis|[WorkbookChartAxis](chartaxis.md)|Represents the value axis in an axis. Read-only.| --## JSON representation --Here's a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartAxes" -}--> --```json -{ - "categoryAxis": {"@odata.type": "microsoft.graph.workbookChartAxis"}, - "seriesAxis": {"@odata.type": "microsoft.graph.workbookChartAxis"}, - "valueAxis": {"@odata.type": "microsoft.graph.workbookChartAxis"} -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartAxes resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartaxis | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartaxis.md | - Title: "ChartAxis resource type" -description: "Represents a single axis in a chart." ---doc_type: resourcePageType ---# ChartAxis resource type --Namespace: microsoft.graph --Represents a single axis in a chart. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get ChartAxis](../api/chartaxis-get.md) | [WorkbookChartAxis](chartaxis.md) |Read properties and relationships of chartAxis object.| -|[Update](../api/chartaxis-update.md) | [WorkbookChartAxis](chartaxis.md) |Update ChartAxis object. | --## Properties -| Property | Type |Description| -|:|:--|:-| -| id |string | Unique identifier. Read-only.| -|majorUnit|Json|Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number.| -|maximum|Json|Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.| -|minimum|Json|Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.| -|minorUnit|Json|Represents the interval between two minor tick marks. "Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|format|[WorkbookChartAxisFormat](chartaxisformat.md)|Represents the formatting of a chart object, which includes line and font formatting. Read-only.| -|majorGridlines|[WorkbookChartGridlines](chartgridlines.md)|Returns a gridlines object that represents the major gridlines for the specified axis. Read-only.| -|minorGridlines|[WorkbookChartGridlines](chartgridlines.md)|Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only.| -|title|[WorkbookChartAxisTitle](chartaxistitle.md)|Represents the axis title. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "keyProperty": "id", - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartAxis" -}--> --```json -{ - "format": {"@odata.type": "microsoft.graph.workbookChartAxisFormat"}, - "id": "string", - "majorGridlines": {"@odata.type": "microsoft.graph.workbookChartGridlines"}, - "majorUnit": "string", - "maximum": "string", - "minimum": "string", - "minorGridlines": {"@odata.type": "microsoft.graph.workbookChartGridlines"}, - "minorUnit": "string", - "title": {"@odata.type": "microsoft.graph.workbookChartAxisTitle"} -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartAxis resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartaxisformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartaxisformat.md | - Title: "ChartAxisFormat resource type" -description: "Encapsulates the format properties for the chart axis." ---doc_type: resourcePageType ---# ChartAxisFormat resource type --Namespace: microsoft.graph --Encapsulates the format properties for the chart axis. ---## Methods -None -## Properties -None --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|font|[WorkbookChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for a chart axis element. Read-only.| -|line|[WorkbookChartLineFormat](chartlineformat.md)|Represents chart line formatting. Read-only.| ---## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartAxisFormat" -}--> --```json -{ - "font": {"@odata.type": "microsoft.graph.workbookChartFont"}, - "line": {"@odata.type": "microsoft.graph.workbookChartLineFormat"} -} -``` ---<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartAxisFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartaxistitle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartaxistitle.md | - Title: "ChartAxisTitle resource type" -description: "Represents the title of a chart axis." ---doc_type: resourcePageType ---# ChartAxisTitle resource type --Namespace: microsoft.graph --Represents the title of a chart axis. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get ChartAxisTitle](../api/chartaxistitle-get.md) | [WorkbookChartAxisTitle](chartaxistitle.md) |Read properties and relationships of chartAxisTitle object.| -|[Update](../api/chartaxistitle-update.md) | [WorkbookChartAxisTitle](chartaxistitle.md) |Update ChartAxisTitle object. | --## Properties -| Property | Type |Description| -|:|:--|:-| -|text|string|Represents the axis title.| -|visible|boolean|A boolean that specifies the visibility of an axis title.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|format|[WorkbookChartAxisTitleFormat](chartaxistitleformat.md)|Represents the formatting of chart axis title. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [], - "@odata.type": "microsoft.graph.workbookChartAxisTitle" -}--> --```json -{ - "format": {"@odata.type":"microsoft.graph.workbookChartAxisTitleFormat"}, - "text": "string", - "visible": true -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartAxisTitle resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartaxistitleformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartaxistitleformat.md | - Title: "ChartAxisTitleFormat resource type" -description: "Represents the chart axis title formatting." ---doc_type: resourcePageType ---# ChartAxisTitleFormat resource type --Namespace: microsoft.graph --Represents the chart axis title formatting. ---## Methods -None --## Properties -None --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|font|[WorkbookChartFont](chartfont.md)|Represents the font attributes, such as font name, font size, color, etc. of chart axis title object. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartAxisTitleFormat" -}--> --```json -{ - "font": {"@odata.type": "microsoft.graph.workbookChartFont"} -} -``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartAxisTitleFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartdatalabelformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartdatalabelformat.md | - Title: "ChartDataLabelFormat resource type" -description: "Encapsulates the format properties for the chart data labels." ---doc_type: resourcePageType ---# ChartDataLabelFormat resource type --Namespace: microsoft.graph --Encapsulates the format properties for the chart data labels. ---## Methods -None --## Properties -None --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|fill|[WorkbookChartFill](chartfill.md)|Represents the fill format of the current chart data label. Read-only.| -|font|[WorkbookChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for a chart data label. Read-only.| ---## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartDataLabelFormat" -}--> --```json -{ - "fill": {"@odata.type": "microsoft.graph.workbookChartFill"}, - "font": {"@odata.type": "microsoft.graph.workbookChartFont"} -} -``` ---<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartDataLabelFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartdatalabels | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartdatalabels.md | - Title: "ChartDataLabels resource type" -description: "Represents a collection of all the data labels on a chart point." ---doc_type: resourcePageType ---# ChartDataLabels resource type --Namespace: microsoft.graph --Represents a collection of all the data labels on a chart point. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get ChartDataLabels](../api/chartdatalabels-get.md) | [WorkbookChartDataLabels](chartdatalabels.md) |Read properties and relationships of chartDataLabels object.| -|[Update](../api/chartdatalabels-update.md) | [WorkbookChartDataLabels](chartdatalabels.md) |Update ChartDataLabels object. | --## Properties -| Property | Type |Description| -|:|:--|:-| -|position|string|DataLabelPosition value that represents the position of the data label. The possible values are: `None`, `Center`, `InsideEnd`, `InsideBase`, `OutsideEnd`, `Left`, `Right`, `Top`, `Bottom`, `BestFit`, `Callout`.| -|separator|string|String representing the separator used for the data labels on a chart.| -|showBubbleSize|boolean|Boolean value representing if the data label bubble size is visible or not.| -|showCategoryName|boolean|Boolean value representing if the data label category name is visible or not.| -|showLegendKey|boolean|Boolean value representing if the data label legend key is visible or not.| -|showPercentage|boolean|Boolean value representing if the data label percentage is visible or not.| -|showSeriesName|boolean|Boolean value representing if the data label series name is visible or not.| -|showValue|boolean|Boolean value representing if the data label value is visible or not.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|format|[WorkbookChartDataLabelFormat](chartdatalabelformat.md)|Represents the format of chart data labels, which includes fill and font formatting. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [], - "@odata.type": "microsoft.graph.workbookChartDataLabels" -}--> --```json -{ - "position": "string", - "separator": "string", - "showBubbleSize": true, - "showCategoryName": true, - "showLegendKey": true, - "showPercentage": true, - "showSeriesName": true, - "showValue": true -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartDataLabels resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartfill | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartfill.md | - Title: "ChartFill resource type" -description: "Represents the fill formatting for a chart element." ---doc_type: resourcePageType ---# ChartFill resource type --Namespace: microsoft.graph --Represents the fill formatting for a chart element. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Clear](../api/chartfill-clear.md)|None|Clear the fill color of a chart element.| -|[Setsolidcolor](../api/chartfill-setsolidcolor.md)|None|Sets the fill formatting of a chart element to a uniform color.| --## Properties -None --## Relationships -None ---## JSON representation --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartFill" -}--> --```json -{ -} -``` ---<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartFill resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartfont | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartfont.md | - Title: "ChartFont resource type" -description: "This object represents the font attributes (font name, font size, color, etc.) for a chart object." ---doc_type: resourcePageType ---# ChartFont resource type --Namespace: microsoft.graph --This object represents the font attributes (font name, font size, color, etc.) for a chart object. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get ChartFont](../api/chartfont-get.md) | [WorkbookChartFont](chartfont.md) |Read properties and relationships of chartFont object.| -|[Update](../api/chartfont-update.md) | [WorkbookChartFont](chartfont.md) |Update ChartFont object. | --## Properties -| Property | Type |Description| -|:|:--|:-| -|bold|boolean|Represents the bold status of font.| -|color|string|HTML color code representation of the text color. for example #FF0000 represents Red.| -|italic|boolean|Represents the italic status of the font.| -|name|string|Font name (for example "Calibri")| -|size|double|Size of the font (for example 11)| -|underline|string|Type of underline applied to the font. The possible values are: `None`, `Single`.| --## Relationships -None ---## JSON representation --Here's a JSON representation of the resource. --<!--{ - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [], - "@odata.type": "microsoft.graph.workbookChartFont" -}--> --```json -{ - "bold": true, - "color": "string", - "italic": true, - "name": "string", - "size": 1024, - "underline": "string" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartFont resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartgridlines | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartgridlines.md | - Title: "ChartGridlines resource type" -description: "Represents major or minor gridlines on a chart axis." ---doc_type: resourcePageType ---# ChartGridlines resource type --Namespace: microsoft.graph --Represents major or minor gridlines on a chart axis. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get ChartGridlines](../api/chartgridlines-get.md) | [WorkbookChartGridlines](chartgridlines.md) |Read properties and relationships of chartGridlines object.| -|[Update](../api/chartgridlines-update.md) | [WorkbookChartGridlines](chartgridlines.md) |Update ChartGridlines object. | --## Properties -| Property | Type |Description| -|:|:--|:-| -|visible|boolean|Boolean value representing if the axis gridlines are visible or not.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|format|[WorkbookChartGridlinesFormat](chartgridlinesformat.md)|Represents the formatting of chart gridlines. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!-- { - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [ -- ], - "@odata.type": "microsoft.graph.workbookChartGridlines" -}--> --```json -{ - "visible": true -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartGridlines resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartgridlinesformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartgridlinesformat.md | - Title: "ChartGridlinesFormat resource type" -description: "Encapsulates the format properties for chart gridlines." ---doc_type: resourcePageType ---# ChartGridlinesFormat resource type --Namespace: microsoft.graph --Encapsulates the format properties for chart gridlines. ---## Methods -None --## Properties -None --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|line|[WorkbookChartLineFormat](chartlineformat.md)|Represents chart line formatting. Read-only.| ---## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartGridlinesFormat" -}--> --```json -{ - "line": {"@odata.type": "microsoft.graph.workbookChartLineFormat"} -} -``` ---<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartGridlinesFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartlegend | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartlegend.md | - Title: "ChartLegend resource type" -description: "Represents the legend in a chart." ---doc_type: resourcePageType ---# ChartLegend resource type --Namespace: microsoft.graph --Represents the legend in a chart. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get ChartLegend](../api/chartlegend-get.md) | [WorkbookChartLegend](chartlegend.md) |Read properties and relationships of chartLegend object.| -|[Update](../api/chartlegend-update.md) | [WorkbookChartLegend](chartlegend.md) |Update ChartLegend object. | --## Properties -| Property | Type |Description| -|:|:--|:-| -|overlay|boolean|Boolean value for whether the chart legend should overlap with the main body of the chart.| -|position|string|Represents the position of the legend on the chart. The possible values are: `Top`, `Bottom`, `Left`, `Right`, `Corner`, `Custom`.| -|visible|boolean|A boolean value the represents the visibility of a ChartLegend object.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|format|[WorkbookChartLegendFormat](chartlegendformat.md)|Represents the formatting of a chart legend, which includes fill and font formatting. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!-- { - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [ -- ], - "@odata.type": "microsoft.graph.workbookChartLegend" -}--> --```json -{ - "format": {"@odata.type":"microsoft.graph.workbookChartLegendFormat"}, - "overlay": true, - "position": "string", - "visible": true -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartLegend resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartlegendformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartlegendformat.md | - Title: "ChartLegendFormat resource type" -description: "Encapsulates the format properties of a chart legend." ---doc_type: resourcePageType ---# ChartLegendFormat resource type --Namespace: microsoft.graph --Encapsulates the format properties of a chart legend. ---## Methods -None --## Properties -None --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|fill|[WorkbookChartFill](chartfill.md)|Represents the fill format of an object, which includes background formating information. Read-only.| -|font|[WorkbookChartFont](chartfont.md)|Represents the font attributes such as font name, font size, color, etc. of a chart legend. Read-only.| ---## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartLegendFormat" -}--> --```json -{ - "fill": {"@odata.type": "microsoft.graph.workbookChartFill"}, - "font": {"@odata.type": "microsoft.graph.workbookChartFont"} -} -``` ---<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartLegendFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartlineformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartlineformat.md | - Title: "ChartLineFormat resource type" -description: "Encapsulates the formatting options for line elements." ---doc_type: resourcePageType ---# ChartLineFormat resource type --Namespace: microsoft.graph --Enapsulates the formatting options for line elements. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get ChartLineFormat](../api/chartlineformat-get.md) | [WorkbookChartLineFormat](chartlineformat.md) |Read properties and relationships of chartLineFormat object.| -|[Update](../api/chartlineformat-update.md) | [WorkbookChartLineFormat](chartlineformat.md) |Update ChartLineFormat object. | -|[Clear](../api/chartlineformat-clear.md)|None|Clear the line format of a chart element.| --## Properties -| Property | Type |Description| -|:|:--|:-| -|color|string|HTML color code representing the color of lines in the chart.| --## Relationships -None ---## JSON representation --Here's a JSON representation of the resource. --<!--{ - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [], - "@odata.type": "microsoft.graph.workbookChartLineFormat" -}--> --```json -{ - "color": "string" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartLineFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartpoint.md | - Title: "ChartPoint resource type" -description: "Represents a point of a series in a chart." ---doc_type: resourcePageType ---# ChartPoint resource type --Namespace: microsoft.graph --Represents a point of a series in a chart. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get ChartPoint](../api/chartpoint-get.md) | [WorkbookChartPoint](chartpoint.md) |Read properties and relationships of chartPoint object.| -|[List](../api/chartpoint-list.md) | [WorkbookChartPoint](chartpoint.md) collection |Get chartPoint object collection. | -|[ItemAt](../api/chartpointscollection-itemat.md)|[WorkbookChartPoint](chartpoint.md)|Retrieve a point based on its position within the series.| --## Properties -| Property | Type |Description| -|:|:--|:-| -|ID|string|unique identifier| -|value|Json|Returns the value of a chart point. Read-only.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|format|[WorkbookChartPointFormat](chartpointformat.md)|Encapsulates the format properties chart point. Read-only.| --## JSON representation --Here's a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "keyProperty": "id", - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartPoint" -}--> --```json -{ - "id": "string", - "value": "string" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartPoint resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartpointformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartpointformat.md | - Title: "ChartPointFormat resource type" -description: "Represents formatting object for chart points." ---doc_type: resourcePageType ---# ChartPointFormat resource type --Namespace: microsoft.graph --Represents formatting object for chart points. ---## Methods -None --## Properties -None --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|fill|[WorkbookChartFill](chartfill.md)|Represents the fill format of a chart, which includes background formatting information. Read-only.| ---## JSON representation --Here's a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartPointFormat" -}--> --```json -{ - "fill": {"@odata.type": "microsoft.graph.workbookChartFill"} -} -``` ---<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartPointFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartseries | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartseries.md | - Title: "ChartSeries resource type" -description: "Represents a series in a chart." ---doc_type: resourcePageType ---# ChartSeries resource type --Namespace: microsoft.graph --Represents a series in a chart. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get ChartSeries](../api/chartseries-get.md) | [WorkbookChartSeries](chartseries.md) |Read properties and relationships of chartSeries object.| -|[Create ChartPoints](../api/chartseries-post-points.md) |[ChartPoints](chartpoint.md)| Create a new ChartPoints by posting to the points collection.| -|[List points](../api/chartseries-list-points.md) |[ChartPoints](chartpoint.md) collection| Get a ChartPoints object collection.| -|[Update](../api/chartseries-update.md) | [WorkbookChartSeries](chartseries.md) |Update ChartSeries object. | -|[List](../api/chartseries-list.md) | [WorkbookChartSeries](chartseries.md) collection |Get chartSeries object collection. | -|[ItemAt](../api/chartseriescollection-itemat.md)|[WorkbookChartSeries](chartseries.md)|Retrieves a series based on its position in the collection| --## Properties -| Property | Type |Description| -|:|:--|:-| -|name|string|Represents the name of a series in a chart.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|format|[WorkbookChartSeriesFormat](chartseriesformat.md)|Represents the formatting of a chart series, which includes fill and line formatting. Read-only.| -|points|[WorkbookChartPoint](chartpoint.md) collection|Represents a collection of all points in the series. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!-- { - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [ -- ], - "@odata.type": "microsoft.graph.workbookChartSeries" -}--> --```json -{ - "name": "string" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartSeries resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chartseriesformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chartseriesformat.md | - Title: "ChartSeriesFormat resource type" -description: "encapsulates the format properties for the chart series" ---doc_type: resourcePageType ---# ChartSeriesFormat resource type --Namespace: microsoft.graph --encapsulates the format properties for the chart series ---## Methods -None --## Properties -None --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|fill|[WorkbookChartFill](chartfill.md)|Represents the fill format of a chart series, which includes background formatting information. Read-only.| -|line|[WorkbookChartLineFormat](chartlineformat.md)|Represents line formatting. Read-only.| ---## JSON representation --Here's a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartSeriesFormat" -}--> --```json -{ - "fill": {"@odata.type": "microsoft.graph.workbookChartFill"}, - "line": {"@odata.type": "microsoft.graph.workbookChartLineFormat"} -} -``` ---<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartSeriesFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Charttitle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/charttitle.md | - Title: "ChartTitle resource type" -description: "Represents a chart title object of a chart." ---doc_type: resourcePageType ---# ChartTitle resource type --Namespace: microsoft.graph --Represents a chart title object of a chart. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get ChartTitle](../api/charttitle-get.md) | [WorkbookChartTitle](charttitle.md) |Read properties and relationships of chartTitle object.| -|[Update](../api/charttitle-update.md) | [WorkbookChartTitle](charttitle.md) |Update ChartTitle object. | --## Properties -| Property | Type |Description| -|:|:--|:-| -|overlay|boolean|Boolean value representing if the chart title will overlay the chart or not.| -|text|string|Represents the title text of a chart.| -|visible|boolean|A boolean value that represents the visibility of a chart title object.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|format|[WorkbookChartTitleFormat](charttitleformat.md)|Represents the formatting of a chart title, which includes fill and font formatting. Read-only.| --## JSON representation --Here's a JSON representation of the resource. --<!-- { - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [ -- ], - "@odata.type": "microsoft.graph.workbookChartTitle" -}--> --```json -{ - "overlay": true, - "text": "string", - "visible": true -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartTitle resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Charttitleformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/charttitleformat.md | - Title: "ChartTitleFormat resource type" -description: "Encapsulates the format properties for the chart title." ---doc_type: resourcePageType ---# ChartTitleFormat resource type --Namespace: microsoft.graph --Encapsulates the format properties for the chart title. ---## Methods -None --## Properties -None --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|fill|[WorkbookChartFill](chartfill.md)|Represents the fill format of an object, which includes background formatting information. Read-only.| -|font|[WorkbookChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only.| ----## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookChartTitleFormat" -}--> --```json -{ - "fill": {"@odata.type": "microsoft.graph.workbookChartFill"}, - "font": {"@odata.type": "microsoft.graph.workbookChartFont"} -} -``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "ChartAreaFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Chatmessagehostedcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chatmessagehostedcontent.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Chatmessageinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chatmessageinfo.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Chatmessagepolicyviolation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chatmessagepolicyviolation.md | Represents a policy violation on a chat message. Policy violations are typically ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Cloudappsecuritystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/cloudappsecuritystate.md | Contains stateful information about the cloud application (destinationServiceNam ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Cloudclipboardroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/cloudclipboardroot.md | +toc. Title: Cloud clipboard # cloudClipboardRoot resource type |
v1.0 | Cloudpc Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/cloudpc-api-overview.md | Title: "Working with Windows 365 Cloud PCs using the Microsoft Graph API" description: "The Microsoft Graph API enables programmatic access to Cloud PC information and management actions on your organization." ms.localizationpriority: medium -doc_type: resourcePageType # Working with Windows 365 Cloud PCs using the Microsoft Graph API |
v1.0 | Cloudpconpremisesconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/cloudpconpremisesconnection.md | description: "Represents a defined collection of Azure resource information that ms.localizationpriority: medium -doc_type: resourcePageType +toc. Title: Cloud PC Azure network connection # cloudPcOnPremisesConnection resource type The following is an example of the resource type. "@odata.type": "microsoft.graph.cloudPcOnPremisesConnectionStatusDetail", "endDateTime": "String (timestamp)", "healthChecks": [- { + { "@odata.type": "microsoft.graph.cloudPcOnPremisesConnectionHealthCheck", "additionalDetail": "String", "displayName": "String", |
v1.0 | Cloudpcwindowssetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/cloudpcwindowssetting.md | The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.cloudPcWindowsSetting",- "language": "String" + "locale": "String" } ``` |
v1.0 | Commsoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/commsoperation.md | The following example is a JSON representation of the resource. "optionalProperties": [ ],- "@odata.type": "microsoft.graph.commsOperation" + "@odata.type": "microsoft.graph.commsOperation", + "baseType": "microsoft.graph.entity" }--> ```json { |
v1.0 | Conditionalaccessguestsorexternalusers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/conditionalaccessguestsorexternalusers.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Conditionalaccesssessioncontrols | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/conditionalaccesssessioncontrols.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Connectors Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/connectors-api-overview.md | The following are current known limitations: - An application is limited to 25 concurrent operations on a connection. - Connections have a capacity limit of 5,000,000 items or ~350 GB of data. - Maximum size of an `externalItem` entity is 4 MB.-- Sorting results is not supported. ## Next steps |
v1.0 | Consentrequests Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/consentrequests-overview.md | Before an app can be used to access any data in your organization, the admin mus The Microsoft Entra consent workflow allows users to request the tenant admins to grant consent to apps that require admin approval. The consent requests APIs in Microsoft Graph allows admin to configure the consent workflow and track consent requests for both apps and users. >[!NOTE]->The current APIs are limited to configuring the workflow and reading the list of requests. At this time, there arenΓÇÖt any methods available to programmatically approve or deny a request. However, the contents of the request can be used to recreate a URL which can be used to grant admin consent and approve a request. +>The current APIs are limited to configuring the workflow and reading the list of requests. At this time, there aren't any methods available to programmatically approve or deny a request. However, the contents of the request can be used to recreate a URL which can be used to grant admin consent and approve a request. [!INCLUDE [GDPR-related-guidance](../../includes/gdpr-msgraph-export-note.md)] You can: The following directory roles are required for a calling application. -| Operation | Delegated permissions | Required directory role of the calling user | +| Operation | Delegated permissions | Least privileged directory role of the calling user | |:|:|:--|-| Read | ConsentRequest.Read.All, ConsentRequest.ReadWrite.All | Global Reader, Cloud App Administrator, Application Administrator, or Global Administrator | +| Read | ConsentRequest.Read.All, ConsentRequest.ReadWrite.All | Global Reader, Cloud App Administrator, Application Administrator | ## Related content |
v1.0 | Contact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/contact.md | The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "baseType": "microsoft.graph.outlookItem", "openType": true, "optionalProperties": [ "extensions", The following is a JSON representation of the resource. ], "keyProperty": "id", "@odata.type": "microsoft.graph.contact",+ "baseType": "microsoft.graph.outlookItem", "@odata.annotations": [ { "property": "extensions", |
v1.0 | Contenttypeinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/contenttypeinfo.md | Represents the SharePoint [contentType](contenttype.md) of an item. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.contentTypeInfo", "@type.aka": "oneDrive.contentTypeFacet" } --> |
v1.0 | Contract | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/contract.md | None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Controlscore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/controlscore.md | Namespace: microsoft.graph Contains a tenant score and description for an individual control. ## Properties--|Name |Type |Description | -|:--|:--|:--| +|Property|Type|Description| +|:|:|:| |controlCategory|String|Control action category (Identity, Data, Device, Apps, Infrastructure).| |controlName|String|Control unique name.| |description|String| Description of the control.| |
v1.0 | Conversation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/conversation.md | This resource supports subscribing to [change notifications](/graph/webhooks). ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Conversationmemberroleupdatedeventmessagedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/conversationmemberroleupdatedeventmessagedetail.md | The following is a JSON representation of the resource. "conversationMemberRoles": [ "String" ],- "converstaionMemberUser": { + "conversationMemberUser": { "@odata.type": "microsoft.graph.teamworkUserIdentity" }, "initiator": { |
v1.0 | Conversationthread | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/conversationthread.md | A new thread is created when a recipient is removed from the thread. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Convertidresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/convertidresult.md | The result of an ID format conversion performed by the [translateExchangeIds](.. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Crosstenantaccesspolicy Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/crosstenantaccesspolicy-overview.md | Title: "Cross-tenant access settings API overview" description: "Cross-tenant access settings let you manage both B2B collaboration and B2B direct connect for your organization." ms.localizationpriority: medium -doc_type: resourcePageType # Cross-tenant access settings API overview Granular controls let you determine the users, groups, and apps, both in your or + **Partner-specific access settings** which allow you to configure customized settings for individual organizations. For the configured organizations, this configuration takes precedence over the default settings. Therefore, while Microsoft Entra B2B collaboration and Microsoft Entra B2B direct connect might be disabled across your organization by default, you can enable these features for a specific external organization. > [!IMPORTANT]-> +> > By configuring B2B direct connect outbound settings, you allow external organizations that you have enabled outbound settings with to access limited contact data about your users. Microsoft shares this data with those organizations to help them send a request to connect with your users. Data collected by external organizations, including limited contact data, is subject to the privacy policies and practices of those organizations. ## Default cross-tenant access settings Unless you configure all the properties of the partner-specific object, some of ## Inbound trust settings in cross-tenant access settings -Inbound trust settings enable you to trust the MFA guest users perform in their home directories, preventing guest users from having to perform MFA both in their home directories and in your directory. With inbound trust settings, you enable a seamless authentication experience for your guest users and save on the MFA costs incurred by your organization. +Inbound trust settings enable you to trust the MFA guest users perform in their home directories, preventing guest users from having to perform MFA both in their home directories and in your directory. With inbound trust settings, you enable a seamless authentication experience for your guest users and save on the MFA costs incurred by your organization. For example, when you configure your trust settings to trust MFA, your MFA policies are still applied to guest users, but users who have already completed MFA in their home tenants don't have to complete MFA again in your tenant. The cross-tenant access settings API can be used to set up multiple configuratio </td> <td> Users in group 'g1' are blocked from accessing application 'a1' only. All users, including users in group 'g1' are able to access any other application. </td> </tr>+<tr> +<td> + Prioritize using an external federation over Entra ID during guest user invitation redemption +</td> +<td> ++``` json +"invitationRedemptionIdentityProviderConfiguration": { + "primaryIdentityProviderPrecedenceOrder": [ + "externalFederation", + "azureActiveDirectory", + "socialIdentityProviders" + ], + "fallbackIdentityProvider": "defaultConfiguredIdp" +} +``` +</td> +<td> +Check if the guest user is from an externally federated partner before trying Entra ID for authentication. +</td> +</tr> </table> ## Cross-tenant access settings vs tenant restrictions Cross-tenant access settings outbound controls are for controlling how **your or ## Related content -- [Tutorial: Configure cross-tenant synchronization](/entra/identity/multi-tenant-organizations/cross-tenant-synchronization-configure-graph?tabs=ms-graph&toc=/graph/toc.json) +- [Tutorial: Configure cross-tenant synchronization](/entra/identity/multi-tenant-organizations/cross-tenant-synchronization-configure-graph?tabs=ms-graph&toc=/graph/toc.json) |
v1.0 | Crosstenantaccesspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/crosstenantaccesspolicy.md | Represents the base policy in the directory for cross-tenant access settings. |:|:|:| |default|[crossTenantAccessPolicyConfigurationDefault](../resources/crosstenantaccesspolicyconfigurationdefault.md)|Defines the default configuration for how your organization interacts with external Microsoft Entra organizations.| |partners|[crossTenantAccessPolicyConfigurationPartner](../resources/crosstenantaccesspolicyconfigurationpartner.md) collection|Defines partner-specific configurations for external Microsoft Entra organizations.|+|templates|[policyTemplate](../resources/policytemplate.md)|Represents the base policy in the directory for multitenant organization settings.| ## JSON representation |
v1.0 | Crosstenantaccesspolicyconfigurationdefault | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md | The default configuration defined for inbound and outbound settings of Microsoft |Property|Type|Description| |:|:|:|-| automaticUserConsentSettings | [inboundOutboundPolicyConfiguration](../resources/inboundoutboundpolicyconfiguration.md) | Determines the default configuration for automatic user consent settings. The **inboundAllowed** and **outboundAllowed** properties are always `false` and cannot be updated in the default configuration. Read-only. | +| automaticUserConsentSettings | [inboundOutboundPolicyConfiguration](../resources/inboundoutboundpolicyconfiguration.md) | Determines the default configuration for automatic user consent settings. The **inboundAllowed** and **outboundAllowed** properties are always `false` and can't be updated in the default configuration. Read-only. | | b2bCollaborationInbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) |Defines your default configuration for users from other organizations accessing your resources via Microsoft Entra B2B collaboration. | | b2bCollaborationOutbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) |Defines your default configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B collaboration. | | b2bDirectConnectInbound |[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) | Defines your default configuration for users from other organizations accessing your resources via Microsoft Entra B2B direct connect. | | b2bDirectConnectOutbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) |Defines your default configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B direct connect. | | inboundTrust | [crossTenantAccessPolicyInboundTrust](../resources/crosstenantaccesspolicyinboundtrust.md) | Determines the default configuration for trusting other Conditional Access claims from external Microsoft Entra organizations. |-| isServiceDefault | Boolean | If `true`, the default configuration is set to the system default configuration. If `false`, the default settings have been customized. | +| invitationRedemptionIdentityProviderConfiguration | [defaultInvitationRedemptionIdentityProviderConfiguration](../resources/defaultInvitationRedemptionIdentityProviderConfiguration.md) | Defines the priority order based on which an identity provider is selected during invitation redemption for a guest user. | +| isServiceDefault | Boolean | If `true`, the default configuration is set to the system default configuration. If `false`, the default settings are customized. | ## Relationships None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", The following is a JSON representation of the resource. "b2bDirectConnectInbound": {"@odata.type": "microsoft.graph.crossTenantAccessPolicyB2BSetting"}, "b2bDirectConnectOutbound": {"@odata.type": "microsoft.graph.crossTenantAccessPolicyB2BSetting"}, "inboundTrust": {"@odata.type": "microsoft.graph.crossTenantAccessPolicyInboundTrust"},+ "invitationRedemptionIdentityProviderConfiguration": { + "@odata.type": "microsoft.graph.defaultInvitationRedemptionIdentityProviderConfiguration" + }, "isServiceDefault": "Boolean" } ``` |
v1.0 | Crosstenantaccesspolicyconfigurationpartner | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationpartner.md | For any partner-specific property that is `null`, these settings inherit the beh | b2bDirectConnectInbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) | Defines your partner-specific configuration for users from other organizations accessing your resources via Azure B2B direct connect. | | b2bDirectConnectOutbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) | Defines your partner-specific configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B direct connect. | | inboundTrust | [crossTenantAccessPolicyInboundTrust](../resources/crosstenantaccesspolicyinboundtrust.md) | Determines the partner-specific configuration for trusting other Conditional Access claims from external Microsoft Entra organizations. |+| isInMultiTenantOrganization | Boolean | Identifies whether a tenant is a member of a multitenant organization. | | isServiceProvider | Boolean | Identifies whether the partner-specific configuration is a Cloud Service Provider for your organization. | | tenantId | String | The tenant identifier for the partner Microsoft Entra organization. Read-only. Key.| For any partner-specific property that is `null`, these settings inherit the beh ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "tenantId", Here's a JSON representation of the resource. "b2bDirectConnectInbound": {"@odata.type": "microsoft.graph.crossTenantAccessPolicyB2BSetting"}, "b2bDirectConnectOutbound": {"@odata.type": "microsoft.graph.crossTenantAccessPolicyB2BSetting"}, "inboundTrust": {"@odata.type": "microsoft.graph.crossTenantAccessPolicyInboundTrust"},+ "isInMultiTenantOrganization": "Boolean", "isServiceProvider": "Boolean", "tenantId": "String (identifier)" } |
v1.0 | Customauthenticationextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/customauthenticationextension.md | + + Title: "customAuthenticationExtension resource type" +description: "Custom authentication extensions let you interact with external systems during a user authentication session." ++ms.localizationpriority: medium ++++# customAuthenticationExtension resource type ++Namespace: microsoft.graph ++Custom authentication extensions define interactions with external systems during a user authentication session. This is an abstract type from which the following types are derived. ++- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type. ++Inherits from [customCalloutExtension](../resources/customcalloutextension.md). ++Learn how to use this API when [Configuring a custom claim provider token issuance event](/azure/active-directory/develop/custom-extension-get-started?tabs=microsoft-graph?toc=/graph/toc.json&context=graph/context). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/identitycontainer-list-customauthenticationextensions.md)|[customAuthenticationExtension](../resources/customauthenticationextension.md) collection|Retrieve a list of the object types that are derived from **customAuthenticationExtension**.| +|[Create](../api/identitycontainer-post-customauthenticationextensions.md)|[customAuthenticationExtension](../resources/customauthenticationextension.md)|Create a new object type that is derived from **customAuthenticationExtension**.| +|[Get](../api/customauthenticationextension-get.md)|[customAuthenticationExtension](../resources/customauthenticationextension.md)|Read the properties and relationships of an object type that is derived from **customAuthenticationExtension**.| +|[Update](../api/customauthenticationextension-update.md)|None|Update the properties of an object type that is derived from **customAuthenticationExtension**.| +|[Delete](../api/customauthenticationextension-delete.md)|None|Delete an object type that is derived from **customAuthenticationExtension**.| +|[Validate authentication configuration](../api/customauthenticationextension-validateauthenticationconfiguration.md)|[authenticationConfigurationValidation](../resources/authenticationconfigurationvalidation.md)|Check validity of the endpoint and authentication configuration for a [customAuthenticationExtension](../resources/customauthenticationextension.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|The authentication configuration for the customAuthenticationExtension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).| +|clientConfiguration|[customExtensionClientConfiguration](../resources/customextensionclientconfiguration.md)|The connection settings for the customAuthenticationExtension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).| +|description|String|The description of the customAuthenticationExtension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).| +|displayName|String|The display name for the customAuthenticationExtension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).| +|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The HTTP endpoint that this custom extension calls. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).| +|id|String|Identifier for the customAuthenticationExtension. Inherited from [entity](../resources/entity.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.customAuthenticationExtension", + "baseType": "microsoft.graph.customCalloutExtension", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customAuthenticationExtension", + "id": "String (identifier)", + "authenticationConfiguration": { + "@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration" + }, + "clientConfiguration": { + "@odata.type": "microsoft.graph.customExtensionClientConfiguration" + }, + "description": "String", + "displayName": "String", + "endpointConfiguration": { + "@odata.type": "microsoft.graph.customExtensionEndpointConfiguration" + } +} +``` ++## Related content ++- [Configure a custom claim provider token issuance event](/azure/active-directory/develop/custom-extension-get-started?tabs=microsoft-graph?toc=/graph/toc.json&context=graph/context) + |
v1.0 | Customcalloutextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/customcalloutextension.md | An abstract type that defines the configuration for apps that can extend the cus This abstract type is inherited by the following derived types. - [customTaskExtension](../resources/identitygovernance-customtaskextension.md)+- [customAuthenticationExtension](../resources/customauthenticationextension.md) - [accessPackageAssignmentRequestWorkflowExtension](accesspackageassignmentrequestworkflowextension.md) - [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md) None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Customextensionauthenticationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/customextensionauthenticationconfiguration.md | Namespace: microsoft.graph Abstract base type that exposes the configuration for the **authenticationConfiguration** property of the derived types that inherit from the [customCalloutExtension](customcalloutextension.md) abstract type. -This abstract type is inherited by the following resource type: -+This abstract type is inherited by the following resource types: +- [azureAdTokenAuthentication](../resources/azureadtokenauthentication.md) - [azureAdPopTokenAuthentication](../resources/azureAdPopTokenAuthentication.md) -The type of token authentication used depends on the token security. If the value is Proof of Possession, you'll use the [azureAdPopTokenAuthentication](../resources/azureAdPopTokenAuthentication.md) resource type. +The type of token authentication used depends on the token security. If the token security value is normal, you use the [azureAdTokenAuthentication](../resources/azureadtokenauthentication.md) resource type. If the value is Proof of Possession, you use the [azureAdPopTokenAuthentication](../resources/azureAdPopTokenAuthentication.md) resource type. ## Properties 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.customExtensionAuthenticationConfiguration", |
v1.0 | Customextensionclientconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/customextensionclientconfiguration.md | doc_type: resourcePageType Namespace: microsoft.graph -Connection settings that define how long Microsoft Entra ID can wait for a response from an external app before it shuts down the connection when trying to trigger the external app. Only **timeoutInMilliseconds** is supported. +Connection settings that define how long Microsoft Entra ID can wait for a response from an external app before it shuts down the connection when trying to trigger the external app. ## Properties |Property|Type|Description| |:|:|:| |timeoutInMilliseconds|Int32|The max duration in milliseconds that Microsoft Entra ID waits for a response from the external app before it shuts down the connection. The valid range is between `200` and `2000` milliseconds. Default duration is `1000`.|+|maximumRetries|Int32|The max number of retries that Microsoft Entra ID makes to the external API. Values of 0 or 1 are supported. If `null`, the default for the service applies.| ## 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.customExtensionClientConfiguration" Here's a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",- "timeoutInMilliseconds": "Integer" + "timeoutInMilliseconds": "Integer", + "maximumRetries": "Integer" } ``` |
v1.0 | Customextensionendpointconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/customextensionendpointconfiguration.md | Namespace: microsoft.graph Abstract base type that exposes the derived types used to configure the **endpointConfiguration** property of a custom extension. This abstract type is inherited by the following type: -- [logicAppTriggerEndpointConfiguration](logicapptriggerendpointconfiguration.md) - configure this object.+- [logicAppTriggerEndpointConfiguration](logicapptriggerendpointconfiguration.md) - configure this object for the [customTaskExtension](../resources/identitygovernance-customtaskextension.md) in Lifecycle Workflows in Entitlement Management access package request and assignment cycles. +- [httpRequestEndpoint](../resources/httprequestendpoint.md) - configure this object to [validate a custom authentication extension](../api/customauthenticationextension-validateauthenticationconfiguration.md). ## Properties None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.customExtensionEndpointConfiguration", |
v1.0 | Customextensionoverwriteconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/customextensionoverwriteconfiguration.md | + + Title: "customExtensionOverwriteConfiguration resource type" +description: "Configuration regarding properties of the custom extension which can be overwritten per event listener. If no values are provided, the properties on the custom extension are used." ++ms.localizationpriority: medium ++++# customExtensionOverwriteConfiguration resource type ++Namespace: microsoft.graph ++Configuration regarding properties of the custom extension which can be overwritten per event listener. If no values are provided, the properties on the custom extension are used. ++## Properties +|Property|Type|Description| +|:|:|:| +|clientConfiguration|[customExtensionClientConfiguration](../resources/customextensionclientconfiguration.md)|Configuration regarding properties of the custom extension which can be overwritten per event listener. If no values are provided, the properties on the custom extension are used.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.customExtensionOverwriteConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customExtensionOverwriteConfiguration", + "clientConfiguration": { + "@odata.type": "microsoft.graph.customExtensionClientConfiguration" + } +} +``` + |
v1.0 | Customtimezone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/customtimezone.md | Represents a time zone where the transition from standard to daylight saving tim ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Datasubject | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/datasubject.md | The following is a JSON representation of the resource. "email": "String", "firstName": "String", "lastName": "String",- "residency": "String", - "SSN": "String" + "residency": "String" } ``` |
v1.0 | Datetimetimezone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/datetimetimezone.md | Describes the date, time, and time zone of a point in time. In general, the **timeZone** property _can_ be set to any of the [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones), as well as the other [time zones supported by the calendar API](#additional-time-zones). - Methods such as [create](../api/user-post-events.md) or [update](../api/event-update.md) might not support all **dateTimeTimeZone** time zones.-- If you use **dateTimeTimeZone** with the [virtual event](../resources/virtualevent.md) APIs, the only supported format for the **timeZone** property is [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones).+- If you use **dateTimeTimeZone** with the [virtual event](../resources/virtualevent.md) APIs, the only supported format for the **timeZone** property is 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). ### Additional time zones |
v1.0 | Daylighttimezoneoffset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/daylighttimezoneoffset.md | daylight saving time to standard occurs at 2 AM on the fourth Sunday of May, eve ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Defaultinvitationredemptionidentityproviderconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/defaultinvitationredemptionidentityproviderconfiguration.md | + + Title: "defaultInvitationRedemptionIdentityProviderConfiguration resource type" +description: "Defines the invitation redemption provider configuration to set redemption flow settings for Microsoft Entra ID B2B collaboration." ++ms.localizationpriority: medium ++++# defaultInvitationRedemptionIdentityProviderConfiguration resource type ++Namespace: microsoft.graph ++Defines the invitation redemption provider configuration to set redemption flow settings for Microsoft Entra ID B2B collaboration. ++Inherits from [invitationRedemptionIdentityProviderConfiguration](../resources/invitationRedemptionIdentityProviderConfiguration.md) ++## Properties ++|Property|Type|Description| +|:|:|:| +| primaryIdentityProviderPrecedenceOrder | b2bIdentityProvidersType collection | Collection of identity providers in priority order of preference to be used for guest invitation redemption. Possible values are: `azureActiveDirectory`, `externalFederation`, or `socialIdentityProviders`. | +| fallbackIdentityProvider | b2bIdentityProvidersType | The fallback identity provider to be used in case no primary identity provider can be used for guest invitation redemption. Possible values are: `defaultConfiguredIdp`, `emailOneTimePasscode`, or `microsoftAccount`. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.defaultInvitationRedemptionIdentityProviderConfiguration" +} +--> ++``` json +{ + "primaryIdentityProviderPrecedenceOrder": ["String"], + "fallbackIdentityProvider": "String" +} +``` |
v1.0 | Delegatedadminrelationship | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/delegatedadminrelationship.md | Represents a delegated admin relationship between a partner and customer. |requests|[delegatedAdminRelationshipRequest](../resources/delegatedadminrelationshiprequest.md) collection|The requests associated with the delegated admin relationship.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Delegatedadminrelationshipoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/delegatedadminrelationshipoperation.md | Represents a long-running operation related to a delegated admin relationship. A |data|String|The data (payload) for the operation. Read-only.| |id|String|The unique identifier of the delegated admin long-running operation. Read-only. Inherited from [entity](../resources/entity.md).| |lastModifiedDateTime|DateTimeOffset|The time in ISO 8601 format and in UTC time when the long-running operation was last modified. Read-only.|-|operationType|delegatedAdminRelationshipOperationType|The type of long-running operation. The possible values are: `delegatedAdminAccessAssignmentUpdate`, `unknownFutureValue`. Read-only.| +|operationType|delegatedAdminRelationshipOperationType|The type of long-running operation. The possible values are: `delegatedAdminAccessAssignmentUpdate`, `unknownFutureValue`,`delegatedAdminRelationshipUpdate`. Read-only. You must use the `Prefer: include-unknown-enum-members` request header to get the following value from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `delegatedAdminRelationshipUpdate`.| |status|longRunningOperationStatus|The status of the operation. Read-only. The possible values are: `notStarted`, `running`, `succeeded`, `failed`, `unknownFutureValue`. Read-only. Supports `$orderby`.| ## Relationships None. ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Delegatedadminrelationships Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/delegatedadminrelationships-api-overview.md | Title: "Granular delegated admin privileges (GDAP) API overview" description: "Granular delegated admin privileges (GDAP) allow Microsoft partners to configure and request granular and time-bound access to their customers' environments, allowing customers to enforce a least-privileged access for Microsoft partners." ms.localizationpriority: medium -doc_type: resourcePageType # Granular delegated admin privileges (GDAP) API overview The following diagram shows the status of the Delegated Admin relationship trans Send the invitation link to the customer for them to approve the GDAP request. For example, `https://admin.microsoft.com/AdminPortal/Home#/partners/invitation/granularAdminRelationships/5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836` is an invitation link, where `5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836` is the admin relationship request ID. After the customer approves the GDAP request, the GDAP relationship will transition to an active state. -To finalize the workflow for enabling admin on behalf of (AOBO) management of the customer's tenant, proceed by creating a new access assignment for the delegated admin relationship by using the [Create accessAssignments](../api/delegatedadminrelationship-post-accessassignments.md) API. +To finalize the workflow for enabling admin on behalf of (AOBO) management of the customer's tenant, proceed by creating a new access assignment for the delegated admin relationship by using the [Create accessAssignments](../api/delegatedadminrelationship-post-accessassignments.md) API. ### Lifecycle of a GDAP relationship access assignment |
v1.0 | Deleted | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/deleted.md | See [view changes for an item](../api/driveitem-delta.md) for more information o ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Deleteditemcontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/deleteditemcontainer.md | Inherits from [entity](../resources/entity.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Detailsinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/detailsinfo.md | The **detailsInfo** resource is a JSON string that contains more properties such ## 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.detailsInfo", |
v1.0 | Device | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/device.md | This resource is an open type that allows other properties to be passed in. You | Property | Type |Description| |:|:--|:-|-|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Required. Default is `true`. <br/><br/> Supports `$filter` (`eq`, `ne`, `not`, `in`). Only callers in Global Administrator and Cloud Device Administrator roles can set this property.| +|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Required. Default is `true`. <br/><br/> Supports `$filter` (`eq`, `ne`, `not`, `in`). Only callers with at least the Cloud Device Administrator role can set this property.| |alternativeSecurityIds|[alternativeSecurityId](alternativeSecurityId.md) collection| For internal use only. Not nullable. Supports `$filter` (`eq`, `not`, `ge`, `le`).| |approximateLastSignInDateTime|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` (`eq`, `ne`, `not`, `ge`, `le`, and `eq` on `null` values) and `$orderby`. | |complianceExpirationDateTime|DateTimeOffset| The timestamp when the device is no longer deemed compliant. 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. | This resource is an open type that allows other properties to be passed in. You |deviceVersion|Int32| For internal use only. | |displayName|String|The display name for the device. Required. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderby`. | |enrollmentProfileName|String|Enrollment profile applied to the device. For example, `Apple Device Enrollment Profile`, `Device enrollment - Corporate device identifiers`, or `Windows Autopilot profile name`. This property is set by Intune.|+|enrollmentType|String|Enrollment type of the device. This property is set by Intune. Possible values are: `unknown`, `userEnrollment`, `deviceEnrollmentManager`, `appleBulkWithUser`, `appleBulkWithoutUser`, `windowsAzureADJoin`, `windowsBulkUserless`, `windowsAutoEnrollment`, `windowsBulkAzureDomainJoin`, `windowsCoManagement`.| | extensionAttributes | [onPremisesExtensionAttributes](onpremisesextensionattributes.md) | Contains extension attributes 1-15 for the device. The individual extension attributes are not selectable. These properties are mastered in cloud and can be set during creation or update of a device object in Microsoft Entra ID. <br><br>Supports `$filter` (`eq`, `not`, `startsWith`, and `eq` on `null` values). | |id|String|The unique identifier for the device. Inherited from [directoryObject](directoryobject.md). Key, Not nullable. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`). | |isCompliant|Boolean|`true` if the device complies with Mobile Device Management (MDM) policies; otherwise, `false`. Read-only. This can only be updated by Intune for any device OS type or by an [approved MDM app](/windows/client-management/mdm/azure-active-directory-integration-with-mdm) for Windows OS devices. Supports `$filter` (`eq`, `ne`, `not`).| |isManaged|Boolean|`true` if the device is managed by a Mobile Device Management (MDM) app; otherwise, `false`. This can only be updated by Intune for any device OS type or by an [approved MDM app](/windows/client-management/mdm/azure-active-directory-integration-with-mdm) for Windows OS devices. Supports `$filter` (`eq`, `ne`, `not`). | |manufacturer|String| Manufacturer of the device. Read-only. |+|isRooted|Boolean|`true` if the device is rooted; `false` if the device is jail-broken. This property can only be updated by Intune.| +|managementType|String|The management channel of the device. This property is set by Intune. Possible values are: `eas`, `mdm`, `easMdm`, `intuneClient`, `easIntuneClient`, `configurationManagerClient`, `configurationManagerClientMdm`, `configurationManagerClientMdmEas`, `unknown`, `jamf`, `googleCloudDevicePolicyController`.| |mdmAppId|String|Application identifier used to register device into MDM. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`).| |model|String| Model of the device. Read-only. | |onPremisesLastSyncDateTime|DateTimeOffset|The last time at which the object was synced with the on-premises directory. 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` (`eq`, `ne`, `not`, `ge`, `le`, `in`).|+|onPremisesSecurityIdentifier|String|The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on `$select`. Supports `$filter` (`eq`).| |onPremisesSyncEnabled|Boolean|`true` if this object is synced from an on-premises directory; `false` if this object was originally synced from an on-premises directory but is no longer synced; `null` if this object has never been synced from an on-premises directory (default). Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). | |operatingSystem|String| The type of operating system on the device. Required. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `startsWith`, and `eq` on `null` values). | |operatingSystemVersion|String|The version of the operating system on the device. Required. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `startsWith`, and `eq` on `null` values). | The following is a JSON representation of the resource. "deviceVersion": "Int32", "displayName": "String", "enrollmentProfileName": "String",+ "enrollmentType": "String", "extensionAttributes": {"@odata.type": "microsoft.graph.onPremisesExtensionAttributes"}, "id": "String (identifier)", "isCompliant": "Boolean", "isManaged": "Boolean",+ "isRooted": "Boolean", + "managementType": "String", "manufacturer": "String", "mdmAppId": "String", "model": "String", "onPremisesLastSyncDateTime": "String (timestamp)",+ "onPremisesSecurityIdentifier": "Boolean", "onPremisesSyncEnabled": "Boolean", "operatingSystem": "String", "operatingSystemVersion": "String", |
v1.0 | Devicedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/devicedetail.md | Indicates device details associated with a device used for signing in. The infor ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Directory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/directory.md | ms.localizationpriority: medium doc_type: resourcePageType+toc. Title: Deleted item # directory resource type Inherits from [entity](entity.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Directoryaudit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/directoryaudit.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Directoryrole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/directoryrole.md | This resource supports: ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Directoryroletemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/directoryroletemplate.md | None ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Domain | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domain.md | Title: "domain resource type" description: "Represents a domain associated with the tenant."-+ ms.localizationpriority: medium doc_type: resourcePageType 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. 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. To associate a domain with a tenant: To associate a domain with a tenant: 2. [Retrieve](../api/domain-list-verificationdnsrecords.md) the domain verification records. Add the verification record details to the domain's zone file using the domain registrar or DNS server configuration. -3. [Verify](../api/domain-verify.md) the ownership of the domain. This will verify the domain and set the **isVerified** property to `true`. +3. [Verify](../api/domain-verify.md) the ownership of the domain. This verifies the domain and sets the **isVerified** property to `true`. 4. [Indicate](../api/domain-update.md) the supported services you plan to use with the domain. To associate a domain with a tenant: | Property | Type | Description | |:|:--|:-|-|authenticationType|String| Indicates the configured authentication type for the domain. The value is either `Managed` or `Federated`. `Managed` indicates a cloud managed domain where Microsoft Entra ID performs user authentication. `Federated` indicates authentication is federated with an identity provider such as the tenant's on-premises Active Directory via Active Directory Federation Services. Not nullable. | +|authenticationType|String| Indicates the configured authentication type for the domain. The value is either `Managed` or `Federated`. `Managed` indicates a cloud managed domain where Microsoft Entra ID performs user authentication. `Federated` indicates authentication is federated with an identity provider such as the tenant's on-premises Active Directory via Active Directory Federation Services. Not nullable. <br/><br/>To update this property in delegated scenarios, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission. | |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 has been 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 is 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 is only one initial domain per company. Not nullable | +|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 | +|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 is not set, a default value of 14 days will be used.| -|passwordValidityPeriodInDays|Int32| Specifies the length of time that a password is valid before it must be changed. If the property is not set, a default value of 90 days will be used. | +|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.| +|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 which you can add/remove using Graph API include: `Email`, `OfficeCommunicationsOnline`, `Yammer`. Not nullable.| +|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 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`.| +|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`.| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Domaindnscnamerecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domaindnscnamerecord.md | Title: "domainDnsCnameRecord resource type" description: "Represents a CNAME record added to the DNS zone file of a particular domain in the tenant."-+ ms.localizationpriority: medium doc_type: resourcePageType Represents a CNAME record added to the DNS zone file of a particular domain in t Direct queries to this resource aren't supported. See the [domain](domain.md) article for information on how to query for domain service records. ## Properties-| Property | Type |Description| +| Property | Type |Description| |:|:--|:-| |canonicalName|String| The canonical name of the CNAME record. Used to configure the CNAME record at the DNS host. | |id|String| Unique identifier assigned to this entity. Not nullable, Read-only| None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Domaindnsmxrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domaindnsmxrecord.md | Title: "domainDnsMxRecord resource type" description: "Represents a MX record added to the DNS zone file of a particular domain in the tenant."-+ ms.localizationpriority: medium doc_type: resourcePageType Represents a MX record added to the DNS zone file of a particular domain in the Direct queries to this resource aren't supported. See the [domain](domain.md) article for information on how to query for domain service records. ## Properties-| Property | Type |Description| +| Property | Type |Description| |:|:--|:-| |id|String| Unique identifier assigned to this entity. Not nullable, Read-only.| |isOptional|Boolean| If false, the MX record must be configured by the customer at the DNS host for Microsoft Online Services to operate correctly with the domain. | Direct queries to this resource aren't supported. See the [domain](domain.md) ar None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Domaindnsrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domaindnsrecord.md | Title: "domainDnsRecord resource type" description: "The domainDnsRecord entity is used to present DNS records." ms.localizationpriority: medium-+ doc_type: resourcePageType doc_type: resourcePageType Namespace: microsoft.graph -For each [domain](domain.md) in the tenant, you may be required to add DNS record(s) to the DNS zone file of the domain before the domain can be used by Microsoft Online Services. These DNS records are represented +For each [domain](domain.md) in the tenant, you may be required to add DNS records to the DNS zone file of the domain before the domain can be used by Microsoft Online Services. These DNS records are represented. The **domainDnsRecord** resource type is used to present such DNS records as exposed through the **serviceConfigurationRecords** and **verificationDnsRecords**. This resource type is the base entity for the following resources: + [domainDnsCnameRecord](domaindnscnamerecord.md) The **domainDnsRecord** resource type is used to present such DNS records as exp None. ## Properties-| Property | Type |Description| +| Property | Type |Description| |:|:--|:-| |id|String| Unique identifier assigned to this entity. Not nullable, Read-only.|-|isOptional|Boolean| If `false`, this record must be configured by the customer at the DNS host for Microsoft Online Services to operate correctly with the domain. | +|isOptional|Boolean| If `false`, the customer must configure this record at the DNS host for Microsoft Online Services to operate correctly with the domain. | |label|String| Value used when configuring the name of the DNS record at the DNS host. | |recordType|String| Indicates what type of DNS record this entity represents. The value can be `CName`, `Mx`, `Srv`, or `Txt`. | |supportedService|String| Microsoft Online Service or feature that has a dependency on this DNS record. Can be one of the following values: `null`, `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer`, `Intune`.| None. None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Domaindnssrvrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domaindnssrvrecord.md | Title: "domainDnsSrvRecord resource type" description: "Represents a SRV record added to the DNS zone file of a particular domain in the tenant."-+ ms.localizationpriority: medium doc_type: resourcePageType None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Domaindnstxtrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domaindnstxtrecord.md | Title: "domainDnsTxtRecord resource type" description: "Represents a TXT record added to the DNS zone file of a particular domain in the tenant."-+ ms.localizationpriority: medium doc_type: resourcePageType Represents a TXT record added to the DNS zone file of a particular domain in the Direct queries to this resource aren't supported. See the [domain](domain.md) article for information on how to query for domain service records. ## Properties-| Property | Type |Description| +| Property | Type |Description| |:|:--|:-| |id|String| Unique identifier assigned to this entity. Not nullable, Read-only. | |isOptional|Boolean| If false, the TXT record must be configured by the customer at the DNS host for Microsoft Online Services to operate correctly with the domain. | None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Domaindnsunavailablerecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domaindnsunavailablerecord.md | Title: "domainDnsUnavailableRecord resource type" description: "Indicates that serviceConfigurationRecords can't be generated." ms.localizationpriority: medium-+ doc_type: resourcePageType When you query for the navigation property **serviceConfigurationRecords** for a Direct queries to this resource aren't supported. See the [domain](domain.md) article for information on how to query for domain service records. ## Properties-| Property | Type |Description| +| Property | Type |Description| |:|:--|:-| |description|String|Provides the reason why the **DomainDnsUnavailableRecord** entity is returned. | Direct queries to this resource aren't supported. See the [domain](domain.md) ar None ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Domainidentitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domainidentitysource.md | When you're [creating a new connectedOrganization](../api/entitlementmanagement- ## 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.domainIdentitySource", |
v1.0 | Domainstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domainstate.md | Title: "domainState resource type" description: "Represents the status of asynchronous operations scheduled on a domain."-+ ms.localizationpriority: medium doc_type: resourcePageType Represents the status of asynchronous operations scheduled on a domain. | Property | Type | Description | |:|:--|:-| | lastActionDateTime | DateTimeOffset | Timestamp for when the last activity occurred. The value is updated when an operation is scheduled, the asynchronous task starts, and when the operation completes. |-| operation | String | Type of asynchronous operation. The values can be *ForceDelete* or *Verification* | -| status | String | Current status of the operation. <br> *Scheduled* - Operation has been scheduled but has not started. <br> *InProgress* - Task has started and is in progress. <br> *Failed* - Operation has failed. | +| operation | String | Type of asynchronous operation. The values can be `ForceDelete` or `Verification`. | +| status | String | Current status of the operation. <br> `Scheduled` - Operation is scheduled but hasn't started. <br> `InProgress` - Task is in progress. <br> `Failed` - The operation failed. | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Driveitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/driveitem.md | The **driveItem** resource is derived from [**baseItem**][baseItem] and inherits "analytics": {"@odata.type": "microsoft.graph.itemAnalytics"}, "children": [{ "@odata.type": "microsoft.graph.driveItem" }], "createdByUser": { "@odata.type": "microsoft.graph.user" },- "itemRetentionLabel": [{ "@odata.type": "microsoft.graph.itemRetentionLabel" }], + "retentionLabel": { "@odata.type": "microsoft.graph.itemRetentionLabel" }, "lastModifiedByUser": { "@odata.type": "microsoft.graph.user" }, "permissions": [ {"@odata.type": "microsoft.graph.permission"} ], "subscriptions": [ {"@odata.type": "microsoft.graph.subscription"} ], |
v1.0 | Driverecipient | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/driverecipient.md | Last updated 09/10/2017 Title: DriveRecipient + Title: driveRecipient resource type ms.localizationpriority: medium description: "The driveRecipient resource represents a person, group, or other recipient to share with using the invite action." doc_type: resourcePageType -# driveRecipient resource +# driveRecipient resource type Namespace: microsoft.graph |
v1.0 | Educationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationassignment.md | Inherits from [entity](../resources/entity.md). |id|String| The unique identifier for the **assignment**. Inherited from [entity](../resources/entity.md). Read-only.| |instructions|[itemBody](itembody.md)| Instructions for the assignment. The instructions and the display name tell the student what to do. | |lastModifiedBy|[identitySet](identityset.md)| Who last modified the **assignment**. |-|lastModifiedDateTime|DateTimeOffset|Moment when the **assignment** 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`| +|lastModifiedDateTime|DateTimeOffset|The date and time on which the **assignment** was modified. A student submission doesn't modify the assignment; only teachers can update assignments. 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`| |moduleUrl|string| The URL of the module from which to access the **assignment**.| |notificationChannelUrl|String|Optional field to specify the URL of the [channel](channel.md) to post the **assignment** publish notification. If not specified or null, defaults to the `General` channel. This field only applies to **assignments** where the **assignTo** value is [educationAssignmentClassRecipient](educationassignmentclassrecipient.md). Updating the **notificationChannelUrl** isn't allowed after the assignment is published.| |resourcesFolderUrl|string| Folder URL where all the file resources for this **assignment** are stored.| |
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 * ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationassignmentresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationassignmentresource.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationassignmentsettings.md | Specifies class-level assignments settings. |gradingCategories|[educationGradingCategory](educationgradingcategory.md) collection| When set, enables users to weight assignments differently when computing a class average grade.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
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. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationorganization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationorganization.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationschool | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationschool.md | Inherits from [educationOrganization](../resources/educationorganization.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 |[List resources](../api/educationsubmission-list-resources.md) |[educationSubmissionResource](educationsubmissionresource.md) collection| Get an **educationSubmissionResource** object collection.| |[List submittedResources](../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.|-|[return](../api/educationsubmission-return.md)|[educationSubmission](educationsubmission.md)|A teacher uses return to indicate that the grades/feedback can be shown to the student.| -|[reassign](../api/educationsubmission-reassign.md)|[educationSubmission](educationsubmission.md)|Reassign the submission to the student with feedback for review.| -|[Set up submission specific resources folder](../api/educationsubmission-setupResourcesFolder.md) |[educationSubmission](educationsubmission.md) | Create a SharePoint folder (under pre-defined location) to upload files as submission resources. | -|[submit](../api/educationsubmission-submit.md)|[educationSubmission](educationsubmission.md)|A student uses submit to turn in the **assignment**. This copies the resources into the **submittedResources** folder for grading and updates the status.| -|[unsubmit](../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 copies the resources into the **workingResources** folder for grading and updates the status.| +|[Excuse a 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 a 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 a submission](../api/educationsubmission-reassign.md)|[educationSubmission](educationsubmission.md)|Reassign the submission to the student with feedback for review.| +|[Set up submission specific resources folder](../api/educationsubmission-setupResourcesFolder.md) |[educationSubmission](educationsubmission.md) | Create a SharePoint folder (under predefined location) to upload files as submission resources. | +|[Submit a 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 a 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| |:|:--|:-| |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`.| |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`.|-|status|string| Read-only. Possible values are: `working`, `submitted`, `returned`, and `reassigned`. 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): `reassigned`.| +|status|educationSubmissionStatus| Read-only. Possible values are: `excused`, `reassigned`, `returned`, `submitted` and `working`. 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): `excused` and `reassigned`.| |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`.| |webUrl|String| The deep link URL for the given submission.| + ## Relationships | Relationship | Type |Description| |:|:--|:-| |
v1.0 | Educationsubmissionresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationsubmissionresource.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationterm | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationterm.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Educationuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationuser.md | Inherits from [entity](../resources/entity.md). | mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Supports `$filter`. | | middleName | String | The middle name of the user. | | mobilePhone | String | The primary cellular telephone number for the user. |+| officeLocation | String | The office location for the user. | | onPremisesInfo | [educationOnPremisesInfo](../resources/educationonpremisesinfo.md) | Additional information used to associate the Microsoft Entra user with its Active Directory counterpart. | | 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. 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. | | preferredLanguage | String | The preferred language for the user that should follow the ISO 639-1 code, for example, `en-US`. | | primaryRole | educationUserRole | Default role for a user. The user's role might be different in an individual class. Possible values are: `student`, `teacher`, `none`, `unknownFutureValue`. | | provisionedPlans | [provisionedPlan](../resources/provisionedplan.md) collection | The plans that are provisioned for the user. Read-only. Not nullable. |+| refreshTokensValidFromDateTime | DateTimeOffset | Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. <br><br>Returned only on `$select`. Read-only. | | relatedContacts | [relatedContact] collection | Related records associated with the user. Read-only. | | residenceAddress | [physicalAddress](../resources/physicaladdress.md) | The address where the user lives. | | showInAddressList | Boolean | `True` if the Outlook Global Address List should contain this user; otherwise, `false`. If not set, this will be treated as `true`. For users invited through the invitation manager, this property will be set to `false`. | |
v1.0 | Email Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/email-activity-reports.md | - Title: "Email activity reports" -description: "Use the email activity reports to get a high level view of email traffic within your organization. You can also drill into the Email Activity widget to understand the trends and details of the email activity per user in your organization." ---doc_type: conceptualPageType ---# Email activity reports --Namespace: microsoft.graph --Use the email activity reports to get a high level view of email traffic within your organization. You can also drill into the Email Activity widget to understand the trends and details of the email activity per user in your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Email Activity](https://support.office.com/client/Email-activity-1cbe2c00-ca65-4fb9-9663-1bbfa58ebe44). --## Reports --| Function | 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. | - |
v1.0 | Email App Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/email-app-usage-reports.md | - Title: "Email app usage reports" -description: "Use the email app usage reports to see how many email apps are used to connect to Exchange Online. You can also see which versions of Outlook apps are used which will enable you to follow up with users who should upgrade to supported Outlook versions." ---doc_type: conceptualPageType ---# Email app usage reports --Namespace: microsoft.graph --Use the email app usage reports to see how many email apps are used to connect to Exchange Online. You can also see which versions of Outlook apps are used which will enable you to follow up with users who should upgrade to supported Outlook versions. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Email apps usage](https://support.office.com/client/Email-apps-usage-c2ce12a2-934f-4dd4-ba65-49b02be4703d). --## Reports --| Function | 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. | - |
v1.0 | Emailaddress | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/emailaddress.md | The name and email address of a contact or message recipient. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Emailauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/emailauthenticationmethodconfiguration.md | Inherits from [authenticationMethodConfiguration](../resources/authenticationmet ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Emailfileassessmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/emailfileassessmentrequest.md | Inherits from [threatAssessmentRequest](threatassessmentrequest.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Emailidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/emailidentity.md | Inherits from [identity](../resources/identity.md). 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.emailIdentity" |
v1.0 | Emailpayloaddetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/emailpayloaddetail.md | None. The following JSON representation shows the resource type. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.emailPayloadDetail" + "@odata.type": "microsoft.graph.emailPayloadDetail", + "baseType": "microsoft.graph.payloadDetail" } --> ``` json |
v1.0 | Employeeorgdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/employeeorgdata.md | Title: "employeeOrgData resource type" description: "Represents organization data associated with a user." ms.localizationpriority: medium doc_type: resourcePageType+ |
v1.0 | Entitlementmanagement Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/entitlementmanagement-overview.md | The following table lists the methods that you can use to interact with entitlem ## Related content - [What is Microsoft Entra entitlement management?](/azure/active-directory/governance/entitlement-management-overview)-- [subjectSet](subjectset.md) subtypes [singleUser](singleuser.md), [groupMembers](groupmembers.md), [connectedOrganizationMembers](connectedorganizationmembers.md), [requestorManager](requestormanager.md), [internalSponsors](internalsponsors.md), and [externalSponsors](externalsponsors.md).+- [subjectSet](subjectset.md) subtypes [singleUser](singleuser.md), [groupMembers](groupmembers.md), [connectedOrganizationMembers](connectedorganizationmembers.md), [requestorManager](requestormanager.md), [internalSponsors](internalsponsors.md), [externalSponsors](externalsponsors.md), and [targetUserSponsors](targetusersponsors.md). - [accessPackageSubject](accesspackagesubject.md) - Used in the [accessPackageAssignment](accesspackageassignment.md) as a subject user who has an access package assignment. - [identitySource](identitysource.md) - used in the [connectedOrganization](connectedorganization.md), one of [azureActiveDirectoryTenant](azureactivedirectorytenant.md), [domainIdentitySource](domainidentitysource.md) or [externalDomainFederation](externaldomainfederation.md). |
v1.0 | Entity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/entity.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Enums Security | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/enums-security.md | +### actionAfterRetentionPeriod values ++| Member | +| : | +| none | +| delete | +| startDispositionReview | +| unknownFutureValue | + ### behaviorDuringRetentionPeriod values | Member | Namespace: microsoft.graph.security | markdown | | unknownFutureValue | +### defaultRecordBehavior values ++| Member | +| :-- | +| startLocked | +| startUnlocked | +| unknownFutureValue | + ### detectionStatus values | Member Namespace: microsoft.graph.security | messages | | unknownFutureValue | +### retentionTrigger values ++| Member | +| :-- | +| dateLabeled | +| dateCreated | +| dateModified | +| dateOfEvent | +| unknownFutureValue | + ### vulnerabilitySeverity values | Member | |
v1.0 | Enums | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/enums.md | Namespace: microsoft.graph | serviceProvider | | unknownFutureValue | +### migrationStatus values ++|Member| +|:| +|ready| +|needsReview| +|additionalStepsRequired| +|unknownFutureValue| + ### appCredentialRestrictionType values | Member | Namespace: microsoft.graph | user | | group | +### multiTenantOrganizationMemberProcessingStatus values ++|Member| +|:| +|notStarted| +|running| +|succeeded| +|failed| +|unknownFutureValue| ++### multiTenantOrganizationMemberRole values ++|Member| +|:| +|owner| +|member| +|unknownFutureValue| ++### multiTenantOrganizationMemberState values ++|Member| +|:| +|pending| +|active| +|removed| +|unknownFutureValue| ++### multiTenantOrganizationState values ++|Member| +|:| +|active| +|inactive| +|unknownFutureValue| ++### templateApplicationLevel values ++|Member| +|:| +|none| +|newPartners| +|existingPartners| +|unknownFutureValue| + ### federatedIdpMfaBehavior values | Member | | :- | Possible values for user account types (group membership), per Windows definitio | emailBox | | checkboxMultiSelect | +### authenticationAttributeCollectionInputType values ++|Member| +|:| +|text| +|radioSingleSelect| +|checkboxMultiSelect| +|boolean| +|unknownFutureValue| + ### teamworkActivityTopicSource values | Member | Possible values for user account types (group membership), per Windows definitio | Failed | | EntryLevelErrors | +### stagedFeatureName values ++| Member | +|:-| +| passthroughAuthentication | +| seamlessSso | +| passwordHashSync | +| emailAsAlternateId | +| unknownFutureValue | +| certificateBasedAuthentication | +| multiFactorAuthentication | + ### synchronizationJobRestartScope values |Member| Possible values for user account types (group membership), per Windows definitio | assigned | | unknownFutureValue | | inactive |++### b2bIdentityProvidersType values ++|Member| +|:--| +|azureActiveDirectory| +|externalFederation| +|socialIdentityProviders| +|emailOneTimePasscode| +|microsoftAccount| +|defaultConfiguredIdp| +|unknownFutureValue| |
v1.0 | Event | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/event.md | This resource supports: ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here is a JSON representation of the resource "singleValueExtendedProperties", "multiValueExtendedProperties" ],- "@odata.type": "microsoft.graph.event" + "@odata.type": "microsoft.graph.event", + "baseType": "microsoft.graph.outlookItem" }--> ```json |
v1.0 | Eventmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/eventmessage.md | Aside from a meeting request, an **eventMessage** instance can be found in an in ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource",- "baseType": "microsoft.graph.message", "optionalProperties": [ "attachments", "event", Here is a JSON representation of the resource "multiValueExtendedProperties", "singleValueExtendedProperties" ],- "baseType": "microsoft.graph.message", "@odata.type": "microsoft.graph.eventMessage",+ "baseType": "microsoft.graph.message", "@odata.annotations": [ { "property": "event", |
v1.0 | Eventmessagerequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/eventmessagerequest.md | To respond to the meeting request, first, use the **event** navigation property ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Extension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/extension.md | An abstract type to support the OData v4 open type [openTypeExtension](opentypee ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "abstract": "true", |
v1.0 | Extensionproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/extensionproperty.md | Title: "extensionProperty resource type (directory extensions)" description: "Represents a directory extension." ms.localizationpriority: medium + doc_type: "resourcePageType"+toc. Title: Directory extension # extensionProperty resource type (directory extensions) |
v1.0 | Extensionschemaproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/extensionschemaproperty.md | Title: "extensionSchemaProperty resource type" description: "Use the **extensionSchemaProperty** resource to define a property's name and its type, as part of a schemaExtension definition." ms.localizationpriority: medium + doc_type: resourcePageType Use the **extensionSchemaProperty** resource to define a property's name and its ## Properties-| Property | Type |Description| +| Property | Type |Description| |:|:--|:-| |name|String| The name of the strongly typed property defined as part of a schema extension.|-|type|String| The type of the property that is defined as part of a schema extension. Allowed values are `Binary`, `Boolean`, `DateTime`, `Integer` or `String`. See the table in the Supported property data types section for more details.| +|type|String| The type of the property that is defined as part of a schema extension. Allowed values are `Binary`, `Boolean`, `DateTime`, `Integer`, or `String`. For more information, see [Supported property data types](#supported-property-data-types).| ### Supported property data types The following data types are supported when defining a property in a schema exte | Property Type | Remarks | |-|| | Binary | 256 bytes maximum. |-| Boolean | Not supported for contacts, messages, events and posts. | +| Boolean | Not supported for contacts, messages, events, and posts. | | DateTime | Must be specified in ISO 8601 format and is stored in UTC. | | Integer | 32-bit value. Not supported for contacts, messages, events and posts. | | String | 256 characters maximum. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Externalconnectors Acl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/externalconnectors-acl.md | An access control entry for an item indexed by a Microsoft Search externalConnec 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.externalConnectors.acl" |
v1.0 | Externalconnectors Identity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/externalconnectors-identity.md | Represents an [identity](externalconnectors-identity.md) used to set permissions None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Externalconnectors Property | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/externalconnectors-property.md | A [schema](externalconnectors-schema.md) property definition for a Microsoft Sea 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.externalConnectors.property" |
v1.0 | Externalsponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/externalsponsors.md | None. ## 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.externalSponsors", |
v1.0 | Externalusersselfservicesignupeventsflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/externalusersselfservicesignupeventsflow.md | + + Title: "externalUsersSelfServiceSignUpEventsFlow resource type" +description: "Represents a self-service user flow for external identities within a Microsoft Entra External ID in workforce or external tenants." ++ms.localizationpriority: medium ++++# externalUsersSelfServiceSignUpEventsFlow resource type ++Namespace: microsoft.graph ++Represents a self-service user flow for external identities within a Microsoft Entra External ID in workforce or external tenants. A user flow is implemented as a multi-event policy executing the specific events at specific points of user interaction. ++Inherits from [authenticationEventsFlow](../resources/authenticationeventsflow.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| +|:|:|:| +|id|String|The unique identifier for the entity. Read-only. Inherited from [entity](../resources/entity.md).| +|displayName|String|Required. The display name for the events policy. Must be unique. Inherited from [authenticationEventsFlow](../resources/authenticationeventsflow.md).| +|description|String|Optional. The description of the events policy. Inherited from [authenticationEventsFlow](../resources/authenticationeventsflow.md).| +|conditions|[authenticationConditions](../resources/authenticationconditions.md)|Optional. The conditions representing the context of the authentication request which is used to decide whether the events policy is invoked. Inherited from [authenticationEventsFlow](../resources/authenticationeventsflow.md).| +|onInteractiveAuthFlowStart|[onInteractiveAuthFlowStartHandler](../resources/oninteractiveauthflowstarthandler.md)|Required. The configuration for what to invoke when an authentication flow is ready to be initiated. | +|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|The configuration for what to invoke when attributes are ready to be collected from the user.| +|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.| +|onUserCreateStart|[onUserCreateStartHandler](../resources/onusercreatestarthandler.md)|The configuration for what to invoke during user creation.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "baseType": "microsoft.graph.authenticationEventsFlow", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", + "id": "String (identifier)", + "displayName": "String", + "description": "String", + "conditions": { + "@odata.type": "microsoft.graph.authenticationConditions" + }, + "onInteractiveAuthFlowStart": { + "@odata.type": "microsoft.graph.onInteractiveAuthFlowStartHandler" + }, + "onAuthenticationMethodLoadStart": { + "@odata.type": "microsoft.graph.onAuthenticationMethodLoadStartHandler" + }, + "onAttributeCollection": { + "@odata.type": "microsoft.graph.onAttributeCollectionHandler" + }, + "onUserCreateStart": { + "@odata.type": "microsoft.graph.onUserCreateStartHandler" + } +} +``` + |
v1.0 | Featurerolloutpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/featurerolloutpolicy.md | Title: "featureRolloutPolicy resource type" description: "Represents a feature rollout policy associated with a directory object." ms.localizationpriority: medium + doc_type: "resourcePageType" The following are limitations of feature rollout: - The **appliesTo** field only supports groups. - Dynamic groups and nested groups are not supported. -The following are pre-requisites for each of the features that are currently supported for rollout using this rollout policy. --### Passthrough Authentication --* Identify a server running Windows Server 2012 R2 or later where you want the [PassthroughAuthentication](/azure/active-directory/hybrid/how-to-connect-pta) Agent to run. Ensure that the server is domain-joined, can authenticate selected users with Active Directory, and can communicate with Microsoft Entra ID on outbound ports / URLs. -* [Download](https://aka.ms/getauthagent) & install the Microsoft Entra Connect Authentication Agent on the server. -* To enable high availability, install additional Authentication Agents on other servers as described [here](/azure/active-directory/hybrid/how-to-connect-pta-quick-start#step-4-ensure-high-availability). -* Ensure that you have configured your [Smart Lockout](/azure/active-directory/authentication/howto-password-smart-lockout) settings appropriately. This is to ensure that your users’ on-premises Active Directory accounts don’t get locked out by bad actors. --### SeamlessSso --* Enable [SeamlessSso](/azure/active-directory/hybrid/how-to-connect-sso) for the AD forests based on [these](/azure/active-directory/hybrid/tshoot-connect-sso#manual-reset-of-the-feature) instructions. --### PasswordHashSync --* Enable [PasswordHashSync](/azure/active-directory/hybrid/whatis-phs) from the “Optional features” page in Microsoft Entra Connect. --### EmailAsAlternateId --* Associate alternate email with user accounts. +For more information about staged rollout, see [How to configure staged rollout in Microsoft Entra ID](https://www.youtube.com/watch?v=LFTE1epYDFQ). ## Methods The following are pre-requisites for each of the features that are currently sup |:-|:|:| |description|String|A description for this feature rollout policy.| |displayName|String|The display name for this feature rollout policy.|-|feature|stagedFeatureName| Possible values are: `passthroughAuthentication`, `seamlessSso`, `passwordHashSync`, `emailAsAlternateId`, `unknownFutureValue`.| +|feature|stagedFeatureName| Possible values are: `passthroughAuthentication`, `seamlessSso`, `passwordHashSync`, `emailAsAlternateId`, `unknownFutureValue`, `certificateBasedAuthentication`, `multiFactorAuthentication`. 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): `certificateBasedAuthentication`, `multiFactorAuthentication`. For more information about the prerequisites for the enabled features, see [Prerequisites for enabled features](#prerequisites-for-enabled-features).| |id|String| Read-only.| |isAppliedToOrganization|Boolean|Indicates whether this feature rollout policy should be applied to the entire organization.| |isEnabled|Boolean|Indicates whether the feature rollout is enabled.| -### stagedFeatureName values +### Prerequisites for enabled features ++The following are prerequisites for each of the features that are currently supported for rollout using this rollout policy. -|Member| -|:| -|passthroughAuthentication| -|seamlessSso| -|passwordHashSync| -|emailAsAlternateId| -|unknownFutureValue| +#### Passthrough Authentication ++* Identify a server running Windows Server 2012 R2 or later where you want the [PassthroughAuthentication](/azure/active-directory/hybrid/how-to-connect-pta) Agent to run. Ensure that the server is domain-joined, can authenticate selected users with Active Directory, and can communicate with Microsoft Entra ID on outbound ports / URLs. +* [Download](https://aka.ms/getauthagent) & install the Microsoft Entra Connect Authentication Agent on the server. +* To enable high availability, install additional Authentication Agents on other servers as described [here](/azure/active-directory/hybrid/how-to-connect-pta-quick-start#step-4-ensure-high-availability). +* Ensure that you've configured your [Smart Lockout](/azure/active-directory/authentication/howto-password-smart-lockout) settings appropriately. This is to ensure that your users' on-premises Active Directory accounts don't get locked out by bad actors. ++#### SeamlessSso ++* Enable [SeamlessSso](/azure/active-directory/hybrid/how-to-connect-sso) for the AD forests based on [these](/azure/active-directory/hybrid/tshoot-connect-sso#manual-reset-of-the-feature) instructions. ++#### PasswordHashSync ++* Enable [PasswordHashSync](/azure/active-directory/hybrid/whatis-phs) from the "Optional features" page in Microsoft Entra Connect. ++#### EmailAsAlternateId ++* Associate alternate email with user accounts. ## Relationships | Relationship | Type | Description | |:-|:|:|-|appliesTo|[directoryObject](directoryobject.md) collection| Nullable. Specifies a list of directoryObjects that feature is enabled for.| +|appliesTo|[directoryObject](directoryobject.md) collection| Nullable. Specifies a list of directoryObject resources that feature is enabled for.| ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", The following is a JSON representation of the resource. } ``` +## Related content ++- [Migrate to cloud authentication using Staged Rollout](/entra/identity/hybrid/connect/how-to-connect-staged-rollout) + <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 2019-02-04 14:57:30 UTC --> <!-- { |
v1.0 | Federatedidentitycredential | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/federatedidentitycredential.md | Inherits from [entity](../resources/entity.md). |[Create federatedIdentityCredential](../api/application-post-federatedidentitycredentials.md)|[federatedIdentityCredential](../resources/federatedidentitycredential.md)|Create a new [federatedIdentityCredential](../resources/federatedidentitycredential.md) object.| |[Get federatedIdentityCredential](../api/federatedidentitycredential-get.md)|[federatedIdentityCredential](../resources/federatedidentitycredential.md)|Read the properties and relationships of a [federatedIdentityCredential](../resources/federatedidentitycredential.md) object.| |[Update federatedIdentityCredential](../api/federatedidentitycredential-update.md)|None|Update the properties of a [federatedIdentityCredential](../resources/federatedidentitycredential.md) object.|+|[Upsert federatedIdentityCredential](../api/federatedidentitycredential-upsert.md)|[federatedIdentityCredential](../resources/federatedidentitycredential.md)|Create a new [federatedIdentityCredential](../resources/federatedidentitycredential.md) if it doesn't exist, or update the properties of an existing [federatedIdentityCredential](../resources/federatedidentitycredential.md) object.| |[Delete federatedIdentityCredential](../api/federatedidentitycredential-delete.md)|None|Deletes a [federatedIdentityCredential](../resources/federatedidentitycredential.md) object.| ## Properties Inherits from [entity](../resources/entity.md). | description | String | The unvalidated description of the federated identity credential, provided by the user. It has a limit of 600 characters. Optional. | | id| String | The unique identifier for the federated identity. Required. Read-only. | | issuer | String | The URL of the external identity provider, which must match the `issuer` claim of the external token being exchanged. The combination of the values of **issuer** and **subject** must be unique within 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. The string is immutable after it's created. Required. Not nullable. Supports `$filter` (`eq`). | +| name | String | The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. The string is immutable after it's created. Alternate key. Required. Not nullable. Supports `$filter` (`eq`). | | subject | String | Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format; 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. The combination of **issuer** and **subject** must be unique within the app. It has a limit of 600 characters. Supports `$filter` (`eq`). | |
v1.0 | Fido2combinationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/fido2combinationconfiguration.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Fieldvalueset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/fieldvalueset.md | Last updated 09/11/2017 Title: FieldValueSet + Title: fieldValueSet resource type ms.localizationpriority: medium description: "Represents the column values in a listItem resource." doc_type: resourcePageType -# FieldValueSet resource +# fieldValueSet resource type Namespace: microsoft.graph |
v1.0 | File | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/file.md | In addition to other properties, files have a **content** relationship that cont ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Fileassessmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/fileassessmentrequest.md | The file can be a text file or Word document or binary file received in an email ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Fileattachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/fileattachment.md | None. ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Filter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/filter.md | - Title: "Filter resource type" -description: "Manages the filtering of a table's column." ---doc_type: resourcePageType ---# Filter resource type --Namespace: microsoft.graph --Manages the filtering of a table's column. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Apply](../api/filter-apply.md)|None|Apply the given filter criteria on the given column.| -|[Clear](../api/filter-clear.md)|None|Clear the filter on the given column.| --## Properties --| Name | Type |Description| -|:|:--|:-| -|criteria|[WorkbookFilterCriteria](filtercriteria.md)|The currently applied filter on the given column. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!-- { - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [ -- ], - "@odata.type": "microsoft.graph.workbookFilter" -}--> --```json -{ - "criteria": {"@odata.type": "microsoft.graph.workbookFilterCriteria" } -} -``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "Filter resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Filtercriteria | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/filtercriteria.md | Title: "filterCriteria resource type" + Title: "workbookFilterCriteria resource type" description: "Represents the filtering criteria applied to a column." ms.localizationpriority: medium -# filterCriteria resource type +# workbookFilterCriteria resource type Namespace: microsoft.graph Represents the filtering criteria applied to a column. +## Properties ++| Property | Type |Description| +|:-|:-|:-| +| color | String | The color applied to the cell. | +| criterion1 | String | A custom criterion. | +| criterion2 | String | A custom criterion. | +| dynamicCriteria | String | A dynamic formula specified in a custom filter. | +| filterOn | String | Indicates whether a filter is applied to a column. | +| icon | [workbookIcon](workbookicon.md) | An icon applied to a cell via conditional formatting. | +| operator | String | An operator in a cell; for example, `=`, `>`, `<`, `<=`, or `<>`. | +| values | [Json](json.md) | The values that appear in the cell. | + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Filterdatetime | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/filterdatetime.md | Title: "FilterDatetime resource type" + Title: "workbookFilterDatetime resource type" description: "Represents how to filter a date when filtering on values." ms.localizationpriority: medium -# FilterDatetime resource type +# workbookFilterDatetime resource type Namespace: microsoft.graph Represents how to filter a date when filtering on values. ## Properties | Property | Type |Description| |:|:--|:-|-|date|string|The date in ISO8601 format used to filter data.| -|specificity|string|How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specificity is set to "month", the filter operation will keep all rows with a date in the month of April 2009. The possible values are: `Year`, `Monday`, `Day`, `Hour`, `Minute`, `Second`.| +|date|String|The date in ISO 8601 format used to filter data.| +|specificity|String|Defines how specific you should use the **date** to keep data. For example, if the date is `2005-04-02` and the **specificity** property is set to `month`, the filter operation keeps all rows with a date in the month of April 2009. The possible values are: `Year`, `Month`, `Day`, `Hour`, `Minute`, `Second`.| ## Relationships-None +None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. ```json {- "date": "string", - "specificity": "string" + "date": "String", + "specificity": "String" }- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Folder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/folder.md | The **Folder** resource groups folder-related data on an item into a single stru ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Followupflag | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/followupflag.md | Allows setting a flag in an item for the user to follow up on later. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Formatprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/formatprotection.md | Title: "formatProtection resource type" + Title: "workbookFormatProtection resource type" description: "Represents the format protection of a range object." ms.localizationpriority: medium -# formatProtection resource type +# workbookFormatProtection resource type Namespace: microsoft.graph Represents the format protection of a range object. | Method | Return Type |Description| |:|:--|:-|-|[Get FormatProtection](../api/formatprotection-get.md) | [FormatProtection](formatprotection.md) |Read properties and relationships of formatProtection object.| -|[Update](../api/formatprotection-update.md) | [FormatProtection](formatprotection.md) |Update FormatProtection object. | +|[Get workbookFormatProtection](../api/formatprotection-get.md) | [workbookFormatProtection](formatprotection.md) |Read properties and relationships of formatProtection object.| +|[Update](../api/formatprotection-update.md) | [workbookFormatProtection](formatprotection.md) |Update FormatProtection object. | ## Properties | Property | Type |Description| None. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Genericerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/genericerror.md | A general-purpose error. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here is a JSON representation of the resource. ```json {+ "@odata.type": "#microsoft.graph.genericError", "code": "String", "message": "String" } |
v1.0 | Geocoordinates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/geocoordinates.md | If a [**DriveItem**](driveitem.md) has a non-null **location** facet, the item r ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Group | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/group.md | This resource supports: | [Get group](../api/group-get.md) | [group](group.md) | Read properties of a group object. | | [List groups](../api/group-list.md) | [group](group.md) collection | List group objects and their properties. | | [Update group](../api/group-update.md) | None | Update the properties of a group object. |+| [Upsert group](../api/group-upsert.md) | [group](group.md) | Create a new group if it doesn't exist, or update the properties of an existing group. | | [Delete group](../api/group-delete.md) | None | Delete group object. | | [delta](../api/group-delta.md) | group collection | Get incremental changes for groups. | | [Add members](../api/group-post-members.md) | None | Add a member to this group by posting to the **members** navigation property (supported for security groups and Microsoft 365 groups only). | This resource supports: | hideFromOutlookClients | Boolean | True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. The default value is `false`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). | | id | String | The unique identifier for the group. <br><br>Returned by default. Inherited from [directoryObject](directoryobject.md). Key. Not nullable. Read-only.<br><br>Supports `$filter` (`eq`, `ne`, `not`, `in`). | isArchived | Boolean | When a group is associated with a team, this property determines whether the team is in read-only mode.<br/>To read this property, use the `/group/{groupId}/team` endpoint or the [Get team](../api/team-get.md) API. To update this property, use the [archiveTeam](../api/team-archive.md) and [unarchiveTeam](../api/team-unarchive.md) APIs. |-| isAssignableToRole | Boolean | Indicates whether this group can be assigned to a Microsoft Entra role. Optional. <br><br>This property can only be set while creating the group and is immutable. If set to `true`, the **securityEnabled** property must also be set to `true`, **visibility** must be `Hidden`, and the group cannot be a dynamic group (that is, **groupTypes** cannot contain `DynamicMembership`). <br/><br/>Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the _RoleManagement.ReadWrite.Directory_ permission to set this property or update the membership of such groups. For more, see [Using a group to manage Microsoft Entra role assignments](https://go.microsoft.com/fwlink/?linkid=2103037)<br><br>Using this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports `$filter` (`eq`, `ne`, `not`). | +| isAssignableToRole | Boolean | Indicates whether this group can be assigned to a Microsoft Entra role. Optional. <br><br>This property can only be set while creating the group and is immutable. If set to `true`, the **securityEnabled** property must also be set to `true`, **visibility** must be `Hidden`, and the group cannot be a dynamic group (that is, **groupTypes** cannot contain `DynamicMembership`). <br/><br/>Only callers with at least the Privileged Role Administrator role can set this property. The caller must also be assigned the _RoleManagement.ReadWrite.Directory_ permission to set this property or update the membership of such groups. For more, see [Using a group to manage Microsoft Entra role assignments](https://go.microsoft.com/fwlink/?linkid=2103037)<br><br>Using this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports `$filter` (`eq`, `ne`, `not`). | | isSubscribedByMail | Boolean | Indicates whether the signed-in user is subscribed to receive email conversations. The default value is `true`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). | | licenseProcessingState | String | Indicates the status of the group license assignment to all group members. The default value is `false`. Read-only. Possible values: `QueuedForProcessing`, `ProcessingInProgress`, and `ProcessingComplete`.<br><br>Returned only on `$select`. Read-only. | | mail | String | The SMTP address for the group, for example, "serviceadmins@contoso.com". <br><br>Returned by default. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). | This resource supports: | onPremisesSamAccountName | String | Contains the on-premises **SAM account name** 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.<br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`). Read-only. | | onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. <br><br>Returned by default. Supports `$filter` (`eq` including on `null` values). Read-only. | | onPremisesSyncEnabled | Boolean | `true` if this group is synced from an on-premises directory; `false` if this group was originally synced from an on-premises directory but is no longer synced; **null** if this object has never been synced from an on-premises directory (default). <br><br>Returned by default. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). |-| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling app must be granted the *Directory.ReadWrite.All* permission and the user be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): <br><ul><li> Global Administrator <li> User Account Administrator <li>Directory Writer <li> Exchange Administrator <li> SharePoint Administrator </ul><br/> For more information about this property, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction). <br><br>Nullable. Returned by default. | +| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling app must be granted the *Directory.ReadWrite.All* permission and the user be assigned at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): <br><ul>User Account Administrator <li>Directory Writer <li> Exchange Administrator <li> SharePoint Administrator </ul><br/> For more information about this property, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction). <br><br>Nullable. Returned by default. | | preferredLanguage | String | The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, `en-US`. <br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). | | proxyAddresses | String collection | Email addresses for the group that direct to the same group mailbox. For example: `["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]`. The **any** operator is required to filter expressions on multi-valued properties. <br><br>Returned by default. Read-only. Not nullable. Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`, `endsWith`, `/$count eq 0`, `/$count ne 0`). | | renewedDateTime | DateTimeOffset | Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the [renew service action](../api/group-renew.md). 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. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`). Read-only. | This resource supports: | securityIdentifier | String | Security identifier of the group, used in Windows scenarios. <br><br>Returned by default. | | serviceProvisioningErrors | [serviceProvisioningError](serviceprovisioningerror.md) collection | Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from a group object . <br><br> Supports `$filter` (`eq`, `not`, for isResolved and serviceInstance). | | theme | string | Specifies a Microsoft 365 group's color theme. Possible values are `Teal`, `Purple`, `Green`, `Blue`, `Pink`, `Orange` or `Red`. <br><br>Returned by default. |+| uniqueName | String | The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only. | +| unseenConversationsCount | Int32 | Count of conversations delivered one or more new posts since the signed-in user's last visit to the group. This property is the same as **unseenCount**. <br><br>Returned only on `$select`. | | unseenCount | Int32 | Count of conversations that have received new posts since the signed-in user last visited the group. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). | | visibility | String | Specifies the group join policy and group content visibility for groups. Possible values are: `Private`, `Public`, or `HiddenMembership`. `HiddenMembership` can be set only for Microsoft 365 groups when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation.<br> If visibility value is not specified during group creation on Microsoft Graph, a security group is created as `Private` by default, and the Microsoft 365 group is `Public`. Groups assignable to roles are always `Private`. To learn more, see [group visibility options](#group-visibility-options). <br><br>Returned by default. Nullable. | The following is a JSON representation of the resource. "hideFromAddressLists": false, "hideFromOutlookClients": false, "id": "String (identifier)",- "isAssignableRole": false, + "isAssignableToRole": false, "isSubscribedByMail": true, "licenseProcessingState": "String", "mail": "String", The following is a JSON representation of the resource. ], "sites": [{ "@odata.type": "microsoft.graph.site" }], "threads": [{ "@odata.type": "microsoft.graph.conversationThread" }],+ "uniqueName": "String", "unseenCount": 1024, "visibility": "String" } |
v1.0 | Grouplifecyclepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/grouplifecyclepolicy.md | None. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Groupsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/groupsetting.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Groupsettingtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/groupsettingtemplate.md | None. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Hashes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/hashes.md | The **hashes** resource groups available hashes into a single structure for an i ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Homerealmdiscoverypolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/homerealmdiscoverypolicy.md | The properties below form the JSON object that represents a token lifetime polic ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Horizontalsection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/horizontalsection.md | + + Title: "horizontalSection resource type" +description: Represents a horizontal section in a given SharePoint page ++ms.localizationpriority: medium +++# horizontalSection resource type ++Namespace: microsoft.graph ++++Represents a horizontal section in a given SharePoint page. ++Inherits from [entity](../resources/entity.md). ++## Methods ++| Method | Return type | Description | +| :- | :- | :-- | +| [List horizontalSections](../api/horizontalsection-list.md) | [horizontalSection](../resources/horizontalsection.md) collection | Get a list of the [horizontalSection](../resources/horizontalsection.md) objects and their properties. | +| [Create horizontalSection](../api/sitepage-post-horizontalsection.md) | [horizontalSection](../resources/horizontalsection.md) | Create a new [horizontalSection](../resources/horizontalsection.md) object. | +| [Get horizontalSection](../api/horizontalsection-get.md) | [horizontalSection](../resources/horizontalsection.md) | Read the properties and relationships of a [horizontalSection](../resources/horizontalsection.md) object. | +| [Update horizontalSection](../api/horizontalsection-update.md) | [horizontalSection](../resources/horizontalsection.md) | Update the properties of a [horizontalSection](../resources/horizontalsection.md) object. | +| [Delete horizontalSection](../api/horizontalsection-delete.md) | [horizontalSection](../resources/horizontalsection.md) | Delete a [horizontalSection](../resources/horizontalsection.md) object. | ++## Properties ++| Property | Type | Description | +| :- | :-- | :-- | +| emphasis | [sectionEmphasisType](../resources/horizontalsection.md#sectionemphasistype-values) | Enumeration value that indicates the emphasis of the section background. The possible values are: `none`, `netural`, `soft`, `strong`, `unknownFutureValue`. | +| id | String | Unique identifier of the resource. Inherited from [entity](../resources/entity.md). | +| layout | [horizontalSectionLayoutType](../resources/horizontalsection.md#horizontalsectionlayouttype-values) | Layout type of the section. The possible values are: `none`, `oneColumn`, `twoColumns`, `threeColumns`, `oneThirdLeftColumn`, `oneThirdRightColumn`, `fullWidth`, `unknownFutureValue`. | ++### sectionEmphasisType values ++| Member | Description | +| :-- | :- | +| none | The section has no background. | +| neutral | The section has a neutral emphasis in the background. | +| soft | The section has a soft emphasis in the background. | +| strong | The section has a strong emphasis in the background. | +| unknownFutureValue | Marker value for future compatibility. | ++### horizontalSectionLayoutType values ++| Member | Description | +| : | :-- | +| none | The section has no layout. | +| oneColumn | The section has only one column. | +| twoColumns | The section has two columns. | +| threeColumns | The section has three columns. | +| oneThirdLeftColumn | The section has a 1/3 column on the left and 2/3 column on the right. | +| oneThirdRightColumn | The section has a 2/3 column on the left and 1/3 column on the right. | +| fullWidth | The section has one full width column. | +| unknownFutureValue | Marker value for future compatibility. | ++## Relationships ++| Relationship | Type | Description | +| :-- | :- | :- | +| columns | [horizontalSectionColumn](../resources/horizontalsectioncolumn.md) collection | The set of vertical columns in this section. | ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.horizontalSection", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.horizontalSection", + "id": "String (identifier)", + "layout": "String", + "emphasis": "String" +} +``` |
v1.0 | Horizontalsectioncolumn | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/horizontalsectioncolumn.md | + + Title: "horizontalSectionColumn resource type" +description: Represents a vertical column in a given horizontal section ++ms.localizationpriority: medium +++# horizontalSectionColumn resource type ++Namespace: microsoft.graph ++++Represents a vertical column in a given horizontal section. ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List horizontalSectionColumns](../api/horizontalsectioncolumn-list.md)|[horizontalSectionColumn](../resources/horizontalsectioncolumn.md) collection|Get a list of the [horizontalSectionColumn](../resources/horizontalsectioncolumn.md) objects and their properties.| +|[Get horizontalSectionColumn](../api/horizontalsectioncolumn-get.md)|[horizontalSectionColumn](../resources/horizontalsectioncolumn.md)|Read the properties and relationships of a [horizontalSectionColumn](../resources/horizontalsectioncolumn.md) object.| +|[List webParts](../api/webpart-list.md)|[webPart](../resources/webPart.md) Collection |Get a list of webparts associated with a [horizontalSectionColumn](../resources/horizontalsectioncolumn.md) object.| ++++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|Unique identifier of the resource. Inherited from [entity](../resources/entity.md).| +|width|Int32|Width of the column. A horizontal section is divided into 12 grids. A column should have a value of 1-12 to represent its range spans. For example, there can be two columns both have a width of 6 in a section.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|webparts|[webPart](../resources/webpart.md) collection|The collection of WebParts in this column.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.horizontalSectionColumn", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.horizontalSectionColumn", + "id": "String (identifier)", + "width": "Integer" +} +``` + |
v1.0 | Hostsecuritystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/hostsecuritystate.md | Contains stateful information about the host (including devices, computers, and ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Httprequestendpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/httprequestendpoint.md | + + Title: "httpRequestEndpoint resource type" +description: "The HTTP endpoint that a custom extension calls." ++ms.localizationpriority: medium ++++# httpRequestEndpoint resource type ++Namespace: microsoft.graph ++The HTTP endpoint that a custom extension calls. ++Inherits from [customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|targetUrl|String|The HTTP endpoint that a custom extension calls.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.httpRequestEndpoint" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.httpRequestEndpoint", + "targetUrl": "String" +} +``` + |
v1.0 | Icon | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/icon.md | - Title: "Icon resource type" -description: "Represents a cell icon." ---doc_type: resourcePageType ---# Icon resource type --Namespace: microsoft.graph --Represents a cell icon. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get Icon](../api/icon-get.md) | [Icon](icon.md) |Read properties and relationships of icon object.| -|[Update](../api/icon-update.md) | [Icon](icon.md) |Update Icon object. | --## Properties -| Property | Type |Description| -|:|:--|:-| -|index|int|Represents the index of the icon in the given set.| -|set|string|Represents the set that the icon is part of. The possible values are: `Invalid`, `ThreeArrows`, `ThreeArrowsGray`, `ThreeFlags`, `ThreeTrafficLights1`, `ThreeTrafficLights2`, `ThreeSigns`, `ThreeSymbols`, `ThreeSymbols2`, `FourArrows`, `FourArrowsGray`, `FourRedToBlack`, `FourRating`, `FourTrafficLights`, `FiveArrows`, `FiveArrowsGray`, `FiveRating`, `FiveQuarters`, `ThreeStars`, `ThreeTriangles`, `FiveBoxes`.| --## Relationships -None ---## JSON representation --Here is a JSON representation of the resource. --<!-- { - "blockType": "resource", - "optionalProperties": [ -- ], - "@odata.type": "microsoft.graph.workbookIcon" -}--> --```json -{ - "index": 1024, - "set": "string" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "Icon resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Identity Network Access Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identity-network-access-overview.md | + + Title: "Manage Microsoft Entra identity and network access capabilities by using Microsoft Graph" +description: "Microsoft Graph provides REST APIs to help manage identity and network access capabilities, most of which are available through Microsoft Entra." +ms.localizationpriority: high ++++ Last updated : 04/30/2024+++# Manage Microsoft Entra identity and network access capabilities by using Microsoft Graph +++With Microsoft Graph, you can manage identity and network access capabilities, most of which are available through [Microsoft Entra](/entra/fundamentals/whatis). The APIs in Microsoft Graph help you to automate identity and network access management tasks and integrate with any application, and are the programmatic alternative to the administrator portals such as the Microsoft Entra admin center. ++Microsoft Entra is a family of identity and network access capabilities that are available in the following products. All these capabilities are available through Microsoft Graph APIs: +- Microsoft Entra ID that groups identity and access management (IAM) capabilities. +- Microsoft Entra ID Governance +- Microsoft Entra External ID +- Microsoft Entra Verified ID +- Microsoft Entra Permissions Management +- Microsoft Entra Internet Access and Network Access ++## Manage user identities ++Users are the main identities in any identity and access solution. You can manage the entire lifecycle of users in your organization, and their entitlements like licenses or group memberships, using Microsoft Graph APIs. For more information, see [Working with users in Microsoft Graph](/graph/api/resources/users). ++## Manage groups ++Groups are the containers that allow you to efficiently manage the entitlements for identities as a unit. For example, through a group, you can grant users access to a resource, such as a SharePoint site. Or you can grant them licenses to use a service. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview). ++## Manage applications ++You can use Microsoft Graph APIs to register and manage your applications programmatically, enabling you to use Microsoft's IAM capabilities. For more information, see [Manage Microsoft Entra applications and service principals by using Microsoft Graph](/graph/api/resources/applications-api-overview). ++++## Tenant administration or directory management ++A core functionality of identity and access management is managing your tenant configuration, administrative roles, and settings. Microsoft Graph provides APIs to manage your Microsoft Entra tenant for the following scenarios: ++| Use cases | API operations | +|--|--| +| Manage administrative units including the following operations: <li>Create administrative units <li> Create and manage members and membership rules of administrative units <li> Assign administrator roles that are scoped to administrative units | [administrativeUnit resource type](administrativeunit.md) and its associated APIs | +| Retrieve BitLocker recovery keys | [bitlockerRecoveryKey resource type](bitlockerrecoverykey.md) and its associated APIs | +| Monitor licenses and subscriptions for the tenant | [subscribedSku resource type](subscribedsku.md) and its associated APIs | +| Manage custom security attributes | See [Overview of custom security attributes using the Microsoft Graph API](custom-security-attributes-overview.md) | +| Manage deleted directory objects. The functionality to store deleted objects in a "recycle bin" is supported for the following objects: <li> Administrative units <li> Applications <li> External user profiles <li> Groups <li> Pending external user profiles <li> Service principals <li> Users | <li> [Get](../api/directory-deleteditems-get.md) or [List](../api/directory-deleteditems-list.md) deleted objects <li> [Permanently delete](../api/directory-deleteditems-delete.md) a deleted object <li> [Restore a deleted item](../api/directory-deleteditems-restore.md) <li> [List deleted items owned by user](../api/directory-deleteditems-getuserownedobjects.md) | +| Manage devices in the cloud | [device resource type](device.md) and its associated APIs | +| View local administrator credential information for all device objects in Microsoft Entra ID that are enabled with Local Admin Password Solution (LAPS). This feature is the cloud-based LAPS solution | [deviceLocalCredentialInfo resource type](devicelocalcredentialinfo.md) and its associated APIs | +| Directory objects are the core objects in Microsoft Entra ID, such as users, groups, and applications. You can use the directoryObject resource type and its associated APIs to check memberships of directory objects, track changes for multiple directory objects, or validate that a Microsoft 365 group's display name or mail nickname complies with naming policies | [directoryObject resource type](directoryobject.md) and its associated APIs | +| Administrator roles, including Microsoft Entra administrator roles, are one of the most sensitive resources in a tenant. You can manage the lifecycle of their assignment in the tenant, including creating custom roles, assigning roles, tracking changes to role assignments, and removing assignees from roles | [directoryRole resource type](directoryrole.md) and [directoryRoleTemplate resource type](directoryroletemplate.md)and their associated APIs <br/><br/> [roleManagement resource type](rolemanagement.md) and its associated APIs <br/><br/> These APIs allow you to make direct role assignments. Alternatively, you can use Privileged Identity Management APIs for [Microsoft Entra roles](privilegedidentitymanagementv3-overview.md) and [groups](privilegedidentitymanagement-for-groups-api-overview.md) to make just-in-time and time-bound role assignments, instead of direct forever active assignments. | +| Define the following configurations that can be used to customize the tenant-wide and object-specific restrictions and allowed behavior. <li> Settings for Microsoft 365 groups such as guest user access, classifications, and naming policies <li> Password rule settings such as banned password lists and lockout duration <li> Prohibited names for applications, reserved words, and blocking trademark violations <li> Custom conditional access policy URL <li> Consent policies such as user consent requests, group-specific consent, and consent for risky apps | [groupSetting resource type](groupsetting.md) and [groupSettingTemplate resource type](groupsettingtemplate.md) and their associated APIs <br/><br/> For more information, see [Overview of group settings](/graph/group-directory-settings). | +| Domain management operations such as: <li> associating a domain with your tenant <li> retrieving DNS records <li> verifying domain ownership <li> associating specific services with specific domains <li> deleting domains | [domain resource type](domain.md) and its associated APIs | +| Configure and manage staged rollout of specific Microsoft Entra ID features | [featureRolloutPolicy resource type](featurerolloutpolicy.md) and its associated APIs | +| Configure options that are available in Microsoft Entra Cloud Sync such as preventing accidental deletions and managing group writebacks | [onPremisesDirectorySynchronization resource type](onpremisesdirectorysynchronization.md) and its associated APIs | +| Manage the base settings for your Microsoft Entra tenant | [organization resource type](organization.md) and its associated APIs | +| Retrieve the organizational contacts that might be synchronized from on-premises directories or from Exchange Online | [orgContact resource type](orgcontact.md) and its associated APIs | +| Discover the basic details of other Microsoft Entra tenants by querying using the tenant ID or the domain name | [tenantInformation resource type](tenantinformation.md) and its associated APIs | +| Manage the delegated permissions and their assignments to service principals in the tenant | [oAuth2PermissionGrant resource type](oauth2permissiongrant.md) and its associated APIs | ++++## Identity and sign-in ++| Use cases | API operations | +|--|--| +| Configure listeners that monitor events that should trigger or invoke custom logic, typically defined outside Microsoft Entra ID | [authenticationEventListener resource type](authenticationeventlistener.md) and its associated APIs | +| Manage authentication methods that are supported in Microsoft Entra ID | See [Microsoft Entra authentication methods API overview](authenticationmethods-overview.md) and [Microsoft Entra authentication methods policies API overview](authenticationmethodspolicies-overview.md) | +| Manage the authentication methods or combinations of authentication methods that you can apply as grant control in Microsoft Entra Conditional Access | See [Microsoft Entra authentication strengths API overview](authenticationstrengths-overview.md) | +|Manage tenant-wide authorization policies such as: <li> enable SSPR for administrator accounts <li>enable self-service join for guests <li> limit who can invite guests <li> whether users can consent to risky apps <li> block the use of MSOL <li> customize the default user permissions <li> identity private preview features enabled <li>Customize the guest user permissions between *User*, *Guest User*, and *Restricted Guest User*| [authorizationPolicy resource type](authorizationpolicy.md) and its associated APIs| +| Manage the policies for certificate-based authentication in the tenant | [certificateBasedAuthConfiguration resource type](certificatebasedauthconfiguration.md) and its associated APIs | +| Manage Microsoft Entra conditional access policies | [conditionalAccessRoot resource type](conditionalaccessroot.md) and its associated APIs | +| Manage cross-tenant access settings and manage outbound restrictions, inbound restrictions, tenant restrictions, and cross-tenant synchronization of users in multitenant organizations | See [Cross-tenant access settings API overview](crosstenantaccesspolicy-overview.md) | +| Configure how and which external systems interact with Microsoft Entra ID during a user authentication session | [customAuthenticationExtension resource type](customauthenticationextension.md) and its associated APIs | +| Manage requests against user data in the organization, such as exporting personal data | [dataPolicyOperation resource type](datapolicyoperation.md) and its associated APIs | +|Force autoacceleration sign-in to skip the username entry screen and automatically forward users to federated sign-in endpoints |[homeRealmDiscoveryPolicy resource type](homerealmdiscoverypolicy.md) resource type and its associated APIs| +| Detect, investigate, and remediate identity-based risks using Microsoft Entra ID Protection and feed the data into security information and event management (SIEM) tools for further investigation and correlation | See [Use the Microsoft Graph identity protection APIs](identityprotection-overview.md) | +| Manage identity providers for Microsoft Entra ID, Microsoft Entra External ID, and Azure AD B2C tenants. You can perform the following operations: <li> Manage identity providers for external identities, including social identity providers, OIDC, Apple, SAML/WS-Fed, and built-in providers <li> Manage configuration for federated domains and token validation | [identityProviderBase resource type](identityproviderbase.md) and its associated APIs | +| Invite external users to collaborate with your tenant by using Microsoft Entra External ID | [invitation resource type](invitation.md) and its associated APIs | +| Define a group of tenants belonging to your organization and streamline intra-organization cross-tenant collaboration | See [Multitenant organization API overview](multitenantorganization-overview.md) | +| Customize sign-in UIs to match your company branding, including applying branding that's based on the browser language | [organizationalBranding resource type](organizationalbranding.md) and its associated APIs | +| User flows for Microsoft Entra External ID for workforce | The following resource types and their associated APIs: <li>[b2xIdentityUserFlow](b2xidentityuserflow.md) to configure the base user flow and its properties such as identity providers <li> [identityUserFlowAttribute](identityuserflowattribute.md) to manage built-in and custom user flow attributes <li> [identityUserFlowAttributeAssignment](identityuserflowattributeassignment.md) to manage user flow attribute assignments <li> [userFlowLanguageConfiguration resource type](userflowlanguageconfiguration.md) to configure custom languages for user flows | +|Manage app consent policies and condition sets|[permissionGrantPolicy resource type](permissiongrantpolicy.md)| +|Enable or disable security defaults in Microsoft Entra ID|[identitySecurityDefaultsEnforcementPolicy resource type](identitysecuritydefaultsenforcementpolicy.md)| ++++## Identity governance ++For more information, see [Overview of Microsoft Entra ID Governance using Microsoft Graph](identitygovernance-overview.md). ++## Microsoft Entra External ID for external tenants ++The following API use cases ar supported to customize how users interact with your customer-facing applications. For administrators, most of the features available in Microsoft Entra ID and also supported for Microsoft Entra External ID for external tenants. For example, domain management, application management, and conditional access. ++| Use cases | API operations | +|--|--| +| Manage identity providers for Microsoft Entra External ID. You can identify the identity providers that are supported or configured in the tenant | See [identityProviderBase resoruce type](identityproviderbase.md) and its associated APIs | +| Customize sign-in UIs to match your company branding, including applying branding that's based on the browser language | [organizationalBranding resource type](organizationalbranding.md) and its associated APIs | +| Manage identity providers for Microsoft Entra External ID, such as social identities | [identityProviderBase resoruce type](identityproviderbase.md) and its associated APIs | +| Manage user profiles in Microsoft Entra External ID for customers | For more information, see [Default user permissions in customer tenants](/graph/api/resources/users#default-user-permissions-in-customer-tenants) | +| Add your own business logic to the authentication experiences by integrating with systems that are external to Microsoft Entra ID| [authenticationEventListener resource type](authenticationeventlistener.md) and [customAuthenticationExtension resource type](customauthenticationextension.md) and their associated APIs | ++## Partner tenant management ++Microsoft Graph also provides the following identity and access capabilities for Microsoft partners in the Cloud Solution Provider (CSP), Value Added Reseller (VAR), or Advisor programs to help manage their customer tenants. +++| Use cases | API operations | +|--|| +| Manage contracts for the partner with its customers | [contract resource type](contract.md) and its associated APIs | +| Microsoft partners can empower their customers to ensure the partners have least privileged access to their customers' tenants. This feature gives extra control to customers over their security posture while allowing them to receive support from the Microsoft resellers | See [Granular delegated admin privileges (GDAP) API overview](delegatedadminrelationships-api-overview.md) | ++++## Licensing ++Microsoft Entra licenses include Microsoft Entra ID Free, P1, P2, and Governance; Microsoft Entra Permissions Management; and Microsoft Entra Workload ID. ++For detailed information about licensing for different features, see [Microsoft Entra ID licensing](/entra/fundamentals/licensing). ++## Related content ++- [Implement identity standards with Microsoft Entra ID](/entra/standards/) +- [Microsoft Entra ID Guide for independent software developers](/entra/architecture/guide-for-independent-software-developers) |
v1.0 | Identitybuiltinuserflowattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitybuiltinuserflowattribute.md | Title: "identityBuiltInUserFlowAttribute resource type" -description: "Represents a built-in user flow attribute in Microsoft Entra ID for workforce tenants, Microsoft Entra ID for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows." +description: "Represents a built-in user flow attribute that can be used in self-service sign-up user flows in Microsoft Entra External ID in workforce and external tenants, and in Azure AD B2C tenants." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph -Represents a built-in user flow attribute in Microsoft Entra ID for workforce tenants, Microsoft Entra ID for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows. These attributes can't be modified and are read-only. +Represents a built-in user flow attribute that can be used in self-service sign-up user flows in Microsoft Entra External ID in workforce and external tenants, and in Azure AD B2C tenants. These attributes can't be modified and are read-only. Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute |dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute, and can't be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.| |description|String|The description of the user flow attribute that's shown to the user at the time of sign up. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.| |displayName|String|The display name of the user flow attribute. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.|-|id|String|The identifier of the user flow attribute and is a read-only attribute that is automatically created. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| +|id|String|The identifier of the user flow attribute. Read-only. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| |userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute and is a read-only attribute that is automatically set. The value for this property is `builtIn`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.| None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Identitycontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitycontainer.md | None. | Relationship | Type | Description | |:-|:|:| |apiConnectors|[identityApiConnector](identityApiConnector.md) collection|Represents entry point for API connectors.|+|authenticationEventsFlows|[authenticationEventsFlow](../resources/authenticationeventsflow.md) collection|Represents the entry point for self-service sign-up and sign-in user flows in both Microsoft Entra workforce and external tenants.| +|authenticationEventListeners|[authenticationEventListener](authenticationeventlistener.md) collection| Represents listeners for custom authentication extension events in Azure AD for workforce and customers.| |b2xUserFlows|[b2xIdentityUserFlow](b2xIdentityUserFlow.md) collection| Represents entry point for B2X/self-service sign-up identity userflows.| |conditionalAccess|[conditionalAccessRoot](conditionalAccessRoot.md) collection| the entry point for the Conditional Access (CA) object model.|+|customAuthenticationExtensions|[customAuthenticationExtension](customauthenticationextension.md) collection| Represents custom extensions to authentication flows in Azure AD for workforce and customers.| |identityProvider|[identityProviderBase](identityProviderBase.md) collection| Represents entry point for identity provider base.| |userFlowAttributes|[identityUserFlowAttribute](identityUserFlowAttribute.md) collection| Represents entry point for identity userflow attributes.| ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.identityContainer", |
v1.0 | Identitycustomuserflowattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitycustomuserflowattribute.md | Title: "identityCustomUserFlowAttribute resource type" -description: "Represents a custom user flow attribute in Microsoft Entra ID for workforce tenants, Microsoft Entra ID for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows." +description: "Represents a custom user flow attribute that can be used in self-service sign-up user flows in Microsoft Entra External ID in workforce and external tenants, and in Azure AD B2C tenants." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph -Represents a custom user flow attribute in Microsoft Entra ID for workforce tenants, Microsoft Entra ID for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows. +Represents a custom user flow attribute that can be used in self-service sign-up user flows in Microsoft Entra External ID in workforce and external tenants, and in Azure AD B2C tenants. Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute |Property|Type|Description| |:|:|:| |dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute, and can't be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).|-|description|String|The description of the user flow attribute that's shown to the user at the time of sign-up. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| +|description|String|The description of the user flow attribute that's shown to the user at the time of sign up. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| |displayName|String|The display name of the user flow attribute. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)|-|id|String|The identifier of the user flow attribute. This is a read-only attribute that is automatically created. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| -|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute and is a read-only attribute that is automatically set. The value for this property is `custom`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).| +|id|String|The identifier of the user flow attribute. Read-only. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| +|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute and is a read-only attribute that is automatically set. The value for this attribute is `custom`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).| ## Relationships None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Identitygovernance Lifecycleworkflows Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-lifecycleworkflows-overview.md | Title: "Overview of Lifecycle Workflows APIs" description: "Use Lifecycle Workflows to manage the lifecycle of users in your organization." ms.localizationpriority: medium + doc_type: conceptualPageType Last updated 03/12/2024 Lifecycle Workflows is an Identity Governance service in Microsoft Entra ID that 1. **Joiner**: When an individual comes into scope of needing access; for example, a new employee joining a company or organization. 2. **Mover**: When an individual moves between boundaries within an organization; for example, a user who was in marketing is now a member of the sales organization. This movement might require more access or authorization, or revocation of other privileges.-3. **Leaver**: When an individual leaves the scope of needing access, access might need to be revoked, and the user deprovisioned. For example, an employee who is retiring or has been terminated. +3. **Leaver**: When an individual leaves the scope of needing access, access might need to be revoked, and the user deprovisioned. For example, an employee who is retiring or terminated. -For this reason, Lifecycle Workflows can be referred to as the **Joiner-Mover-Leaver** (JML) workflow. Only the *joiner* and *leaver* processes are currently implemented. +For this reason, lifecycle workflows can be referred to as the **Joiner-Mover-Leaver** (JML) workflow. -The lifecycle workflows APIs in Microsoft Graph allow you to automate the Lifecycle Workflows capabilities for your organization. This article introduced the set of APIs that enable the Lifecycle Workflows service in Microsoft Entra ID. +The lifecycle workflow APIs in Microsoft Graph allow you to automate the lifecycle workflows capabilities for your organization. This article introduced the set of APIs that enable the Lifecycle Workflows service in Microsoft Entra ID. The lifecycle workflows APIs are defined in the OData subnamespace, microsoft.graph.identityGovernance. Each workflow contains general descriptive information such as its identifier, n ### Workflow tasks -Workflow tasks are specific actions that run automatically when a workflow is triggered. Lifecycle Workflows defines the following preconfigured and read-only tasks that are allowed for the specified workflow categories. These task definitions show the settings for the task type, guiding you as you create tasks for your workflow. +Workflow tasks are specific actions that run automatically when a workflow is triggered. Lifecycle workflows define the following preconfigured and read-only tasks allowed for the specified workflow categories. These task definitions show the settings for the task type, guiding you as you create tasks for your workflow. [!INCLUDE [lifecycle-workflows-tasks-table](../includes/identitygovernance-lifecycleworkflows-tasks-table.md)] -Use the [taskDefinition resource type](identitygovernance-taskdefinition.md) and its associated methods to discover all the predefined tasks that you can configure for your workflow and the settings for the properties. The [task](identitygovernance-task.md) resource type and its associated GET methods allow you to view the tasks that are configured for your workflow. +Use the [taskDefinition resource type](identitygovernance-taskdefinition.md) and its associated methods to discover all the predefined tasks that can be configured for your workflow and the settings for the properties. The [task](identitygovernance-task.md) resource type and its associated GET methods allow you to view the tasks configured for your workflow. ### Execution conditions When creating or updating a workflow, use the [workflowExecutionConditions resou ### Create and manage workflows -After identifying the tasks and execution conditions that you want to define for your workflow, use the [workflow resource type](identitygovernance-workflow.md), and its associated methods to create and manage the workflow. You can create up to 50 workflows in a tenant. The category of the task must match the category of the workflow. Each workflow can have up to 25 tasks. Therefore: +After identifying the tasks and execution conditions that you want to define for your workflow, use the [workflow resource type](identitygovernance-workflow.md), and its associated methods to create and manage the workflow. You can create up to 100 workflows in a tenant. The category of the task must match the category of the workflow. Each workflow can have up to 25 tasks. Therefore: -+ A task supported for only the "leaver" workflow category can't be specified in a "joiner" workflow scenario, and vice versa. -+ A task supported for both "leaver" and "joiner" workflow categories can be specified in either a "joiner" or "leaver" workflow scenario. ++ A task supported for only the "leaver" workflow category can't be specified in a "joiner" or "mover" workflow scenario, and vice versa.++ A task supported for "joiner", "mover", and "leaver" workflow categories can be specified in either a "joiner", "mover" or "leaver" workflow scenario. -You can schedule a workflow to run based on the [tenant-wide schedule](#settings) or run it on-demand. The tenant schedule can take care of regular new hires and terminations, while you can run a workflow on-demand to immediately terminate an employee's access if there was a sensitive event. +You can schedule a workflow to run based on the [tenant-wide schedule](#settings) or run it on-demand. The tenant schedule can take care of scheduled new hires and terminations, while you can run a workflow on-demand immediately to terminate an employee's access if there is a sensitive event. ### Workflow versions While a workflow is in use, you might need to update execution conditions and tasks for a workflow. However, Lifecycle Workflows doesn't allow you to update these properties for an existing workflow. -Instead of creating new workflows, use the [workflowVersion resource type](identitygovernance-workflowversion.md) and its associated methods to create and manage a new workflow version, based off an existing workflow object. The workflow version can have similar or a different set of tasks and execution conditions. +Instead of creating new workflows, use the [workflowVersion resource type](identitygovernance-workflowversion.md) and its associated methods to create and manage a new workflow version, based on an existing workflow object. The workflow version can have a similar or different set of tasks and execution conditions. ## Reports -Lifecycle Workflows supports extensive reporting capabilities to track the status of workflow processing at the workflow run-level, task-level, and user-level. +Lifecycle workflows support extensive reporting capabilities to track the status of workflow processing at the workflow run-level, task-level, and user-level. For more information about the reporting capabilities for Lifecycle Workflows, see the [overview of Lifecycle Workflows reporting APIs](identitygovernance-lifecycleworkflows-reporting-overview.md). |
v1.0 | Identitygovernance Taskdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-taskdefinition.md | Inherits from [entity](../resources/entity.md). |Property|Type|Description| |:|:|:| |category|microsoft.graph.identityGovernance.lifecycleTaskCategory|The category of the HR function that the tasks created using this definition can be used with. The possible values are: `joiner`, `mover`, `leaver`, `unknownFutureValue`. This is a multi-valued enumeration whose allowed combinations are `joiner`, `joiner,leaver`, or `leaver`.<br><br>Supports `$filter`(`eq`, `ne`, `has`) and `$orderby`. |-|ContinueOnError|Boolean|Defines if the workflow will continue if the task has an error.| +|continueOnError|Boolean|Defines if the workflow will continue if the task has an error.| |description|String|The description of the taskDefinition.| |displayName|String|The display name of the taskDefinition.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.| |id|String|The unique identifier for the taskDefinition. Inherited from [entity](../resources/entity.md).| |
v1.0 | Identitygovernance Workflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-workflow.md | Namespace: microsoft.graph.identityGovernance Represents workflows created using Lifecycle Workflows. Workflows, when triggered by execution conditions, automate parts of the lifecycle management process using tasks. These tasks can either be built-in tasks, or a custom task can be called using the custom task extension which integrate with Azure Logic Apps. -You can create up to 50 workflows in a tenant. +You can create up to 100 workflows in a tenant. Inherits from [workflowBase](../resources/identitygovernance-workflowbase.md). |
v1.0 | Identitygovernance Workflowbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-workflowbase.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Identitygovernance Workflowexecutiontrigger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-workflowexecutiontrigger.md | 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.identityGovernance.workflowExecutionTrigger" |
v1.0 | Identitysecuritydefaultsenforcementpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitysecuritydefaultsenforcementpolicy.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Identitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitysource.md | None. ## 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.identitySource" |
v1.0 | Identityuserflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identityuserflow.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Identityuserflowattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identityuserflowattribute.md | Title: "identityUserFlowAttribute resource type" -description: "Represents attributes that can be added to a user flow in a Microsoft Entra workforce tenant, a Microsoft Entra ID for customers tenant, and an Azure AD B2C tenant." +description: "Represents attributes that can be added to a user flow in Microsoft Entra External ID in workforce and external tenants, and in Azure AD B2C tenants." ms.localizationpriority: medium doc_type: resourcePageType -Represents attributes that can be added to a user flow in a Microsoft Entra workforce tenant, a Microsoft Entra ID for customers tenant, and an Azure AD B2C tenant. +Represents attributes that can be added to a user flow in Microsoft Entra External ID in workforce and external tenants, and in Azure AD B2C tenants. -Configuring user flow attributes in your Microsoft Entra ID or Azure AD B2C tenant allows you to collect information about a user during sign-up. You can choose to collect a built-in set of attribute; for example, Given Name, Surname, City, and Postal Code; or you can configure custom user flow attributes. Custom user flow attributes are an abstraction over [directory extensions](/graph/extensibility-overview#directory-azure-ad-extensions). +Configuring user flow attributes in your tenant allows you to collect information about an external user during sign-up. You can choose to collect a built-in set of attribute; for example, Given Name, Surname, City, and Postal Code; or you can configure custom user flow attributes. Custom user flow attributes are an abstraction over [directory extensions](/graph/extensibility-overview#directory-azure-ad-extensions). [identityBuiltInUserFlowAttributes](../resources/identitybuiltinuserflowattribute.md) and [identityCustomUserFlowAttributes](../resources/identitycustomuserflowattribute.md) both inherit from this base type. Configuring user flow attributes in your Microsoft Entra ID or Azure AD B2C tena |Property|Type|Description| |:|:--|:-|-|dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute. This can't be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`).| +|dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute. Can't be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`).| |displayName|String|The display name of the user flow attribute. <br/><br/> Supports `$filter` (`eq`, `ne`). |-|description|String|The description of the user flow attribute that's shown to the user at the time of sign-up.| -|id|String|The identifier of the user flow attribute. This is a read-only attribute that is automatically created. <br/><br/> Supports `$filter` (`eq`, `ne`). | -|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute. This is a read-only attribute that is automatically set. Depending on the type of attribute, the values for this property are `builtIn`, `custom`, `required`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`). | +|description|String|The description of the user flow attribute that's shown to the user at the time of sign up.| +|id|String|The identifier of the user flow attribute. Read-only. <br/><br/> Supports `$filter` (`eq`, `ne`). | +|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute. Read-only. Depending on the type of attribute, the values for this property are `builtIn`, `custom`, `required`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`). | ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Identityuserflowattributeassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identityuserflowattributeassignment.md | Represents how attributes are collected in an identity user flow. and allows cus ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Implicitgrantsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/implicitgrantsettings.md | Specifies whether this web application can request tokens using the OAuth 2.0 im |enableIdTokenIssuance| Boolean | Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow.| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Inboundoutboundpolicyconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/inboundoutboundpolicyconfiguration.md | 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.inboundOutboundPolicyConfiguration" |
v1.0 | Inferenceclassification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/inferenceclassification.md | For more information, see [Manage Focused Inbox](manage-focused-inbox.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Inferenceclassificationoverride | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/inferenceclassificationoverride.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Informationalurl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/informationalurl.md | Basic profile information of the application. |termsOfServiceUrl|String| Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Initiator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/initiator.md | Describes who or what initiated the provisioning event. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Insights Insightidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-insightidentity.md | Title: "insightIdentity" + Title: insightIdentity complex type description: "Complex type containing properties of Shared items." ms.localizationpriority: medium-# insightIdentity +# insightIdentity complex type Namespace: microsoft.graph -Complex type containing properties of [sharedInsight](insights-shared.md) items. +Complex type containing properties of [sharedInsight](insights-shared.md) items. ## JSON representation-Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Insights Resourcereference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-resourcereference.md | Complex type containing properties of [officeGraphInsights](officegraphinsights. ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Insights Resourcevisualization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-resourcevisualization.md | Complex type containing properties of [officeGraphInsights](officegraphinsights. ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Insights Shared | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-shared.md | An insight representing files shared with or by a specific user. The following s | resource | entity collection | Used for navigating to the item that was shared. For file attachments, the type is *fileAttachment*. For linked attachments, the type is *driveItem*. | ## JSON representation-Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType":"resource", "keyProperty": "id", |
v1.0 | Insights Sharingdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-sharingdetail.md | Title: "sharingDetail resource type" -description: "Complex type containing properties of Shared items. " +description: "Contains properties of shared items. " ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph -Complex type containing properties of [sharedInsight](insights-shared.md) items. +Contains properties of [sharedInsight](insights-shared.md) items. ++## Properties ++| Property | Type | Description | +| - |-- | -| +| sharedBy | [insightIdentity](insights-insightidentity.md) | The user who shared the document. | +| sharedDateTime | DateTimeOffset| The date and time the file was last shared. 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. | +| sharingSubject | String | The subject with which the document was shared. | +| 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 | + ## JSON representation-Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ Here's a JSON representation of the resource } ``` -## Properties --| Property | Type | Description | -| - |-- | -| -| sharedBy | [insightIdentity](insights-insightidentity.md) | The user who shared the document. | -| sharedDateTime | DateTimeOffset| The date and time the file was last shared. 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. | -| sharingSubject | String | The subject with which the document was shared. | -| sharingType | String | Determines the way the document was shared, can be by a "Link", "Attachment", "Group", "Site". | -| sharingReference | [resourceReference](insights-resourcereference.md) | | - |
v1.0 | Insights Trending | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-trending.md | Rich relationship connecting a user to documents that are trending around the us | Property | Type | Description | | - | | -| | id | String | Unique identifier of the relationship. Read only. |-| lastModifiedDateTime | DateTimeOffset | | +| 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`| | resourceReference | [resourceReference](insights-resourcereference.md) | Reference properties of the trending document, such as the url and type of the document. | | resourceVisualization | [resourceVisualization](insights-resourcevisualization.md) | Properties that you can use to visualize the document in your experience. | | weight | Double | Value indicating how much the document is currently trending. The larger the number, the more the document is currently trending around the user (the more relevant it is). Returned documents are sorted by this value. | Rich relationship connecting a user to documents that are trending around the us ## JSON representation -Here is a JSON representation of the resource +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 | Complex type containing properties of [Used](insights-used.md) items. Informatio ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Insights Used | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-used.md | An insight representing documents used by a specific user. The insights return t | resource | [entity](entity.md) collection | Used for navigating to the item that was used. For file attachments, the type is *fileAttachment*. For linked attachments, the type is *driveItem*. | ## JSON representation-Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Internaldomainfederation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/internaldomainfederation.md | Title: "internalDomainFederation resource type" description: "Represents configurations of the domains in a tenant that are federated with Azure AD." ms.localizationpriority: medium-+ doc_type: resourcePageType Inherits from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md). |signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |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).| + ### federatedIdpMfaBehavior values | Member | Description | The following JSON representation shows the resource type. "federatedIdpMfaBehavior": "String" } ```++<!-- +{ + "type": "#page.annotation", + "description": "", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: /resources/internaldomainfederation.md: + Exception processing links. + Link Definition was null. Link text: !INCLUDE Azure AD PowerShell deprecation note (Parameter 'Definition')" + ] +} +--> |
v1.0 | Internalsponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/internalsponsors.md | None. ## 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.internalSponsors", |
v1.0 | Internetmessageheader | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/internetmessageheader.md | For examples of an Internet message header, see ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Intune Devices Manageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-devices-manageddevice.md | Devices that are managed or pre-enrolled through Intune |[Create managedDevice](../api/intune-devices-manageddevice-create.md)|[managedDevice](../resources/intune-devices-manageddevice.md)|Create a new [managedDevice](../resources/intune-devices-manageddevice.md) object.| |[Delete managedDevice](../api/intune-devices-manageddevice-delete.md)|None|Deletes a [managedDevice](../resources/intune-devices-manageddevice.md).| |[Update managedDevice](../api/intune-devices-manageddevice-update.md)|[managedDevice](../resources/intune-devices-manageddevice.md)|Update the properties of a [managedDevice](../resources/intune-devices-manageddevice.md) object.|-|[createDeviceLogCollectionRequest action](../api/intune-devices-manageddevice-createdevicelogcollectionrequest.md)|[deviceLogCollectionResponse](../resources/intune-devices-devicelogcollectionresponse.md)|Not yet documented| + |[retire action](../api/intune-devices-manageddevice-retire.md)|None|Retire a device| |[wipe action](../api/intune-devices-manageddevice-wipe.md)|None|Wipe a device| |[resetPasscode action](../api/intune-devices-manageddevice-resetpasscode.md)|None|Reset passcode| Devices that are managed or pre-enrolled through Intune |[cleanWindowsDevice action](../api/intune-devices-manageddevice-cleanwindowsdevice.md)|None|Clean Windows device| |[logoutSharedAppleDeviceActiveUser action](../api/intune-devices-manageddevice-logoutsharedappledeviceactiveuser.md)|None|Logout shared Apple device active user| |[deleteUserFromSharedAppleDevice action](../api/intune-devices-manageddevice-deleteuserfromsharedappledevice.md)|None|Delete user from shared Apple device|-|[syncDevice action](../api/intune-devices-manageddevice-syncdevice.md)|None|Not yet documented| -|[windowsDefenderScan action](../api/intune-devices-manageddevice-windowsdefenderscan.md)|None|Not yet documented| -|[windowsDefenderUpdateSignatures action](../api/intune-devices-manageddevice-windowsdefenderupdatesignatures.md)|None|Not yet documented| -|[updateWindowsDeviceAccount action](../api/intune-devices-manageddevice-updatewindowsdeviceaccount.md)|None|Not yet documented| +|[syncDevice action](../api/intune-devices-manageddevice-syncdevice.md)|None|| +|[windowsDefenderScan action](../api/intune-devices-manageddevice-windowsdefenderscan.md)|None|| +|[windowsDefenderUpdateSignatures action](../api/intune-devices-manageddevice-windowsdefenderupdatesignatures.md)|None|| +|[updateWindowsDeviceAccount action](../api/intune-devices-manageddevice-updatewindowsdeviceaccount.md)|None|| ## Properties |Property|Type|Description| Devices that are managed or pre-enrolled through Intune |notes|String|Notes on the device created by IT Admin. Default is null. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported.| |ethernetMacAddress|String|Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only.| |physicalMemoryInBytes|Int64|Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only.|+|enrollmentProfileName|String|Name of the enrollment profile assigned to the device. Default value is empty string, indicating no enrollment profile was assgined. This property is read-only.| ## Relationships |Relationship|Type|Description| Here is a JSON representation of the resource. "udid": "String", "notes": "String", "ethernetMacAddress": "String",- "physicalMemoryInBytes": 1024 + "physicalMemoryInBytes": 1024, + "enrollmentProfileName": "String" } ``` |
v1.0 | Intune Mstunnel Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-mstunnel-devicemanagement.md | - Title: "deviceManagement resource type" -description: "Singleton that acts as container for a collection of Resource Access entities." --localization_priority: Normal --doc_type: resourcePageType ---# deviceManagement resource type --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. --Singleton that acts as container for a collection of Resource Access entities. --## Methods -|Method|Return Type|Description| -|:|:|:| -|[Get deviceManagement](../api/intune-mstunnel-devicemanagement-get.md)|[deviceManagement](../resources/intune-mstunnel-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-mstunnel-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-mstunnel-devicemanagement-update.md)|[deviceManagement](../resources/intune-mstunnel-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-mstunnel-devicemanagement.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|Not yet documented| --## Relationships -|Relationship|Type|Description| -|:|:|:| -|microsoftTunnelConfigurations|[microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) collection|Collection of MicrosoftTunnelConfiguration settings associated with account.| -|microsoftTunnelSites|[microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) collection|Collection of MicrosoftTunnelSite settings associated with account.| -|microsoftTunnelHealthThresholds|[microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) collection|Collection of MicrosoftTunnelHealthThreshold settings associated with account.| -|microsoftTunnelServerLogCollectionResponses|[microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) collection|Collection of MicrosoftTunnelServerLogCollectionResponse settings 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 Mstunnel Microsofttunnelconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-mstunnel-microsofttunnelconfiguration.md | - Title: "microsoftTunnelConfiguration resource type" -description: "Entity that represents a collection of Microsoft Tunnel settings" --localization_priority: Normal --doc_type: resourcePageType ---# microsoftTunnelConfiguration resource type --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. --Entity that represents a collection of Microsoft Tunnel settings --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List microsoftTunnelConfigurations](../api/intune-mstunnel-microsofttunnelconfiguration-list.md)|[microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) collection|List properties and relationships of the [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) objects.| -|[Get microsoftTunnelConfiguration](../api/intune-mstunnel-microsofttunnelconfiguration-get.md)|[microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md)|Read properties and relationships of the [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) object.| -|[Create microsoftTunnelConfiguration](../api/intune-mstunnel-microsofttunnelconfiguration-create.md)|[microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md)|Create a new [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) object.| -|[Delete microsoftTunnelConfiguration](../api/intune-mstunnel-microsofttunnelconfiguration-delete.md)|None|Deletes a [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md).| -|[Update microsoftTunnelConfiguration](../api/intune-mstunnel-microsofttunnelconfiguration-update.md)|[microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md)|Update the properties of a [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the configuration id. Supports: $delete, $update. $Insert, $skip, $top is not supported. Read-only.| -|displayName|String|The display name for the server configuration. This property is required when a server is created.| -|description|String|The configuration's description (optional)| -|network|String|The subnet that will be used to allocate virtual address for the clients| -|dnsServers|String collection|The DNS servers that will be used by the clients| -|defaultDomainSuffix|String|The Default Domain appendix that will be used by the clients| -|routeIncludes|String collection|The routes that will be routed by the server| -|routeExcludes|String collection|Subsets of the routes that will not be routed by the server| -|splitDNS|String collection|The domains that will be resolved using the provided dns servers| -|listenPort|Int32|The port that both TCP and UPD will listen over on the server| -|advancedSettings|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|Additional settings that may be applied to the server| -|lastUpdateDateTime|DateTimeOffset|When the configuration was last updated| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance| -|disableUdpConnections|Boolean|When DisableUdpConnections is set, the clients and VPN server will not use DTLS connections to transfer data.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.microsoftTunnelConfiguration" -} >-``` json -{ - "@odata.type": "#microsoft.graph.microsoftTunnelConfiguration", - "id": "String (identifier)", - "displayName": "String", - "description": "String", - "network": "String", - "dnsServers": [ - "String" - ], - "defaultDomainSuffix": "String", - "routeIncludes": [ - "String" - ], - "routeExcludes": [ - "String" - ], - "splitDNS": [ - "String" - ], - "listenPort": 1024, - "advancedSettings": [ - { - "@odata.type": "microsoft.graph.keyValuePair", - "name": "String", - "value": "String" - } - ], - "lastUpdateDateTime": "String (timestamp)", - "roleScopeTagIds": [ - "String" - ], - "disableUdpConnections": true -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-mstunnel-microsofttunnelhealththreshold.md | - Title: "microsoftTunnelHealthThreshold resource type" -description: "Entity that represents the health thresholds of a health metric" --localization_priority: Normal --doc_type: resourcePageType ---# microsoftTunnelHealthThreshold resource type --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. --Entity that represents the health thresholds of a health metric --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List microsoftTunnelHealthThresholds](../api/intune-mstunnel-microsofttunnelhealththreshold-list.md)|[microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) collection|List properties and relationships of the [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) objects.| -|[Get microsoftTunnelHealthThreshold](../api/intune-mstunnel-microsofttunnelhealththreshold-get.md)|[microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md)|Read properties and relationships of the [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) object.| -|[Create microsoftTunnelHealthThreshold](../api/intune-mstunnel-microsofttunnelhealththreshold-create.md)|[microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md)|Create a new [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) object.| -|[Delete microsoftTunnelHealthThreshold](../api/intune-mstunnel-microsofttunnelhealththreshold-delete.md)|None|Deletes a [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md).| -|[Update microsoftTunnelHealthThreshold](../api/intune-mstunnel-microsofttunnelhealththreshold-update.md)|[microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md)|Update the properties of a [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the metric name. Supports: $delete, $update. $Insert, $skip, $top is not supported. Read-only.| -|healthyThreshold|Int64|The threshold for being healthy based on default health status metrics: CPU usage healthy < 50%, Memory usage healthy < 50%, Disk space healthy > 5GB, Latency healthy < 10ms, health metrics can be customized.| -|unhealthyThreshold|Int64|The threshold for being unhealthy based on default health status metrics: CPU usage unhealthy > 75%, Memory usage unhealthy > 75%, Disk space < 3GB, Latency Unhealthy > 20ms, health metrics can be customized.| -|defaultHealthyThreshold|Int64|The threshold for being healthy based on default health status metrics: CPU usage healthy < 50%, Memory usage healthy < 50%, Disk space healthy > 5GB, Latency healthy < 10ms, health metrics can be customized. Read-only.| -|defaultUnhealthyThreshold|Int64|The threshold for being unhealthy based on default health status metrics: CPU usage unhealthy > 75%, Memory usage unhealthy > 75%, Disk space < 3GB, Latency unhealthy > 20ms, health metrics can be customized. Read-only.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.microsoftTunnelHealthThreshold" -} >-``` json -{ - "@odata.type": "#microsoft.graph.microsoftTunnelHealthThreshold", - "id": "String (identifier)", - "healthyThreshold": 1024, - "unhealthyThreshold": 1024, - "defaultHealthyThreshold": 1024, - "defaultUnhealthyThreshold": 1024 -} -``` |
v1.0 | Intune Mstunnel Microsofttunnellogcollectionstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-mstunnel-microsofttunnellogcollectionstatus.md | - Title: "microsoftTunnelLogCollectionStatus enum type" -description: "Enum type that represent the status of log collection" --localization_priority: Normal --doc_type: enumPageType ---# microsoftTunnelLogCollectionStatus enum type --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. --Enum type that represent the status of log collection --## Members -|Member|Value|Description| -|:|:|:| -|pending|0|Indicates that the log collection is in progress| -|completed|1|Indicates that the log collection is completed| -|failed|2|Indicates that the log collection has failed| -|unknownFutureValue|3|Placeholder value for future expansion enums| |
v1.0 | Intune Mstunnel Microsofttunnelserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-mstunnel-microsofttunnelserver.md | - Title: "microsoftTunnelServer resource type" -description: "Entity that represents a single Microsoft Tunnel server" --localization_priority: Normal --doc_type: resourcePageType ---# microsoftTunnelServer resource type --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. --Entity that represents a single Microsoft Tunnel server --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List microsoftTunnelServers](../api/intune-mstunnel-microsofttunnelserver-list.md)|[microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) collection|List properties and relationships of the [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) objects.| -|[Get microsoftTunnelServer](../api/intune-mstunnel-microsofttunnelserver-get.md)|[microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md)|Read properties and relationships of the [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) object.| -|[Create microsoftTunnelServer](../api/intune-mstunnel-microsofttunnelserver-create.md)|[microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md)|Create a new [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) object.| -|[Delete microsoftTunnelServer](../api/intune-mstunnel-microsofttunnelserver-delete.md)|None|Deletes a [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md).| -|[Update microsoftTunnelServer](../api/intune-mstunnel-microsofttunnelserver-update.md)|[microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md)|Update the properties of a [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) object.| -|[generateServerLogCollectionRequest action](../api/intune-mstunnel-microsofttunnelserver-generateserverlogcollectionrequest.md)|[microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md)|Not yet documented| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the managed server. This id is assigned at enrollment time. Supports: $delete. $Update, $insert, $skip, $top is not supported. Read-only.| -|displayName|String|The display name for the server. This property is required when a server is created and cannot be cleared during updates.| -|tunnelServerHealthStatus|[microsoftTunnelServerHealthStatus](../resources/intune-mstunnel-microsofttunnelserverhealthstatus.md)|Indicates the server's health Status as of the last evaluation time. Health is evaluated every 60 seconds, and the possible values are: unknown, healthy, unhealthy, warning, offline, upgradeInProgress, upgradeFailed. Possible values are: `unknown`, `healthy`, `unhealthy`, `warning`, `offline`, `upgradeInProgress`, `upgradeFailed`, `unknownFutureValue`.| -|lastCheckinDateTime|DateTimeOffset|Indicates when the server last checked in| -|agentImageDigest|String|The digest of the current agent image running on this server| -|serverImageDigest|String|The digest of the current server image running on this server| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.microsoftTunnelServer" -} >-``` json -{ - "@odata.type": "#microsoft.graph.microsoftTunnelServer", - "id": "String (identifier)", - "displayName": "String", - "tunnelServerHealthStatus": "String", - "lastCheckinDateTime": "String (timestamp)", - "agentImageDigest": "String", - "serverImageDigest": "String" -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelserverhealthstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-mstunnel-microsofttunnelserverhealthstatus.md | - Title: "microsoftTunnelServerHealthStatus enum type" -description: "Enum of possible MicrosoftTunnelServer health status types" --localization_priority: Normal --doc_type: enumPageType ---# microsoftTunnelServerHealthStatus enum type --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. --Enum of possible MicrosoftTunnelServer health status types --## Members -|Member|Value|Description| -|:|:|:| -|unknown|0|Indicates that the health status of the server is unknown. This occurs when no health status has been reported, for example when the server is initialized, but has not yet been evaluated for its health.| -|healthy|1|Indicates that the health status of the server is healthy. This should be the normal operational health status.| -|unhealthy|2|Indicates that the health status of the server is unhealthy. This is normally a transient condition that will last up to 5 minutes. If the server cannot be remediated while reporting unhealthy state, the health state will change to 'warning'. If it can be remediated, the health state will return to 'healthy'.| -|warning|3|Indicates a warning based on the Tunnel Gateway server's CPU usage, memory usage, latency, TLS certificate, version| -|offline|4|Indicates the server state is offline| -|upgradeInProgress|5|Indicates the upgrade in progress during the upgrade cycle of when Intune begins upgrading servers, one server at a time| -|upgradeFailed|6|Indicates the failure of the upgrade during the upgrade cycle of when Intune begins upgrading servers, one server at a time| -|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use enums.| |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md | - Title: "microsoftTunnelServerLogCollectionResponse resource type" -description: "Entity that stores the server log collection status." --localization_priority: Normal --doc_type: resourcePageType ---# microsoftTunnelServerLogCollectionResponse resource type --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. --Entity that stores the server log collection status. --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List microsoftTunnelServerLogCollectionResponses](../api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-list.md)|[microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) collection|List properties and relationships of the [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) objects.| -|[Get microsoftTunnelServerLogCollectionResponse](../api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-get.md)|[microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md)|Read properties and relationships of the [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) object.| -|[Create microsoftTunnelServerLogCollectionResponse](../api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-create.md)|[microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md)|Create a new [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) object.| -|[Delete microsoftTunnelServerLogCollectionResponse](../api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-delete.md)|None|Deletes a [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md).| -|[Update microsoftTunnelServerLogCollectionResponse](../api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-update.md)|[microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md)|Update the properties of a [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) object.| -|[generateDownloadUrl action](../api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-generatedownloadurl.md)|String|Not yet documented| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for server log collection response. Read-only.| -|status|[microsoftTunnelLogCollectionStatus](../resources/intune-mstunnel-microsofttunnellogcollectionstatus.md)|The status of log collection. Possible values are: pending, completed, failed. Possible values are: `pending`, `completed`, `failed`, `unknownFutureValue`.| -|startDateTime|DateTimeOffset|The start time of the logs collected| -|endDateTime|DateTimeOffset|The end time of the logs collected| -|sizeInBytes|Int64|The size of the logs in bytes| -|serverId|String|ID of the server the log collection is requested upon| -|requestDateTime|DateTimeOffset|The time when the log collection was requested| -|expiryDateTime|DateTimeOffset|The time when the log collection is expired| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.microsoftTunnelServerLogCollectionResponse" -} >-``` json -{ - "@odata.type": "#microsoft.graph.microsoftTunnelServerLogCollectionResponse", - "id": "String (identifier)", - "status": "String", - "startDateTime": "String (timestamp)", - "endDateTime": "String (timestamp)", - "sizeInBytes": 1024, - "serverId": "String", - "requestDateTime": "String (timestamp)", - "expiryDateTime": "String (timestamp)" -} -``` |
v1.0 | Intune Mstunnel Microsofttunnelsite | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-mstunnel-microsofttunnelsite.md | - Title: "microsoftTunnelSite resource type" -description: "Entity that represents a Microsoft Tunnel site" --localization_priority: Normal --doc_type: resourcePageType ---# microsoftTunnelSite resource type --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. --Entity that represents a Microsoft Tunnel site --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List microsoftTunnelSites](../api/intune-mstunnel-microsofttunnelsite-list.md)|[microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) collection|List properties and relationships of the [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) objects.| -|[Get microsoftTunnelSite](../api/intune-mstunnel-microsofttunnelsite-get.md)|[microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md)|Read properties and relationships of the [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) object.| -|[Create microsoftTunnelSite](../api/intune-mstunnel-microsofttunnelsite-create.md)|[microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md)|Create a new [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) object.| -|[Delete microsoftTunnelSite](../api/intune-mstunnel-microsofttunnelsite-delete.md)|None|Deletes a [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md).| -|[Update microsoftTunnelSite](../api/intune-mstunnel-microsofttunnelsite-update.md)|[microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md)|Update the properties of a [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|The unique identifier for the site id. $Insert, $skip, $top is not supported. Read-only.| -|displayName|String|The display name for the site. This property is required when a site is created.| -|description|String|The site's description (optional)| -|publicAddress|String|The site's public domain name or IP address| -|upgradeWindowUtcOffsetInMinutes|Int32|The site's timezone represented as a minute offset from UTC| -|upgradeWindowStartTime|TimeOfDay|The site's upgrade window start time of day| -|upgradeWindowEndTime|TimeOfDay|The site's upgrade window end time of day| -|upgradeAutomatically|Boolean|The site's automatic upgrade setting. True for automatic upgrades, false for manual control| -|upgradeAvailable|Boolean|The site provides the state of when an upgrade is available| -|internalNetworkProbeUrl|String|The site's Internal Network Access Probe URL| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance| --## Relationships -|Relationship|Type|Description| -|:|:|:| -|microsoftTunnelConfiguration|[microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md)|The MicrosoftTunnelConfiguration that has been applied to this MicrosoftTunnelSite| -|microsoftTunnelServers|[microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) collection|A list of MicrosoftTunnelServers that are registered to this MicrosoftTunnelSite| --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.microsoftTunnelSite" -} >-``` json -{ - "@odata.type": "#microsoft.graph.microsoftTunnelSite", - "id": "String (identifier)", - "displayName": "String", - "description": "String", - "publicAddress": "String", - "upgradeWindowUtcOffsetInMinutes": 1024, - "upgradeWindowStartTime": "String (time of day)", - "upgradeWindowEndTime": "String (time of day)", - "upgradeAutomatically": true, - "upgradeAvailable": true, - "internalNetworkProbeUrl": "String", - "roleScopeTagIds": [ - "String" - ] -} -``` |
v1.0 | Invitation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/invitation.md | The invitation process uses the following flow: * The invited user clicks on the invitation link, signs in and redeems the invitation and creation of the user entity representing the invited user completes * The user is redirected to a specific page after redemption completes -Creating an invitation returns a redemption URL in the response (*inviteRedeemUrl*). The create invitation API can automatically send an email containing the redemption URL to the invited user, by setting the *sendInvitationMessage* to true. You can also customize the message that is sent to the invited user. Instead, if you wish to send the redemption URL through some other means, you can set the *sendInvitationMessage* to false and use the redeem URL from the response to craft your own communication. Currently, there's no API to perform the redemption process. The invited user has to click on the *inviteRedeemUrl* link sent in the communication in the step above, and go through the interactive redemption process in a browser. Once completed, the invited user becomes an external user in the organization. +Creating an invitation returns a redemption URL in the response (*inviteRedeemUrl*). The create invitation API can automatically send an email containing the redemption URL to the invited user, by setting the *sendInvitationMessage* to true. You can also customize the message that is sent to the invited user. Instead, if you wish to send the redemption URL through some other means, you can set the *sendInvitationMessage* to false and use the redeem URL from the response to craft your own communication. Currently, there's no API to perform the redemption process. The invited user has to click on the *inviteRedeemUrl* link sent in the communication step, and go through the interactive redemption process in a browser. Once completed, the invited user becomes an external user in the organization. ## Methods Creating an invitation returns a redemption URL in the response (*inviteRedeemUr | Property| Type|Description| |:|:|:| |invitedUserDisplayName|String|The display name of the user being invited.|-|invitedUserEmailAddress|String|The email address of the user being invited. Required. The following special characters aren't permitted in the email address:<br><ul><li>Tilde (`~`)</li><li>Exclamation point (`!`)</li><li>Number sign (`#`)</li><li>Dollar sign (`$`)</li><li>Percent (`%`)</li><li>Circumflex (`^`)</li><li>Ampersand (`&`)</li><li>Asterisk (`*`)</li><li>Parentheses (`( )`)</li><li>Plus sign (`+`)</li><li>Equal sign (`=`)</li><li>Brackets (`[ ]`)</li><li>Braces (`{ }`)</li><li>Backslash (`\`)</li><li>Slash mark (`/`)</li><li>Pipe (`\|`)</li><li>Semicolon (`;`)</li><li>Colon (`:`)</li><li>Quotation marks (`"`)</li><li>Angle brackets (`< >`)</li><li>Question mark (`?`)</li><li>Comma (`,`)</li></ul><br>However, the following exceptions apply:<br><ul><li>A period (`.`) or a hyphen (`-`) is permitted anywhere in the user name, except at the beginning or end of the name.</li><li>An underscore (`_`) is permitted anywhere in the user name. This includes at the beginning or end of the name.</li></ul>| -|invitedUserMessageInfo|[invitedUserMessageInfo](invitedusermessageinfo.md)|Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.| +|invitedUserEmailAddress|String|The email address of the user being invited. Required. The following special characters aren't permitted in the email address:<br><ul><li>Tilde (`~`)</li><li>Exclamation point (`!`)</li><li>Number sign (`#`)</li><li>Dollar sign (`$`)</li><li>Percent (`%`)</li><li>Circumflex (`^`)</li><li>Ampersand (`&`)</li><li>Asterisk (`*`)</li><li>Parentheses (`( )`)</li><li>Plus sign (`+`)</li><li>Equal sign (`=`)</li><li>Brackets (`[ ]`)</li><li>Braces (`{ }`)</li><li>Backslash (`\`)</li><li>Slash mark (`/`)</li><li>Pipe (`\|`)</li><li>Semicolon (`;`)</li><li>Colon (`:`)</li><li>Quotation marks (`"`)</li><li>Angle brackets (`< >`)</li><li>Question mark (`?`)</li><li>Comma (`,`)</li></ul><br>However, the following exceptions apply:<br><ul><li>A period (`.`) or a hyphen (`-`) is permitted anywhere in the user name, except at the beginning or end of the name.</li><li>An underscore (`_`) is permitted anywhere in the user name, including at the beginning or end of the name.</li></ul>| +|invitedUserMessageInfo|[invitedUserMessageInfo](invitedusermessageinfo.md)|Additional configuration for the message being sent to the invited user, including customizing message text, language, and cc recipient list.| |invitedUserType|String|The userType of the user being invited. By default, this is `Guest`. You can invite as `Member` if you're a company administrator. | |inviteRedirectUrl|String|The URL the user should be redirected to once the invitation is redeemed. Required.| |inviteRedeemUrl|String|The URL the user can use to redeem their invitation. Read-only.| Creating an invitation returns a redemption URL in the response (*inviteRedeemUr | Relationship | Type |Description| |:|:--|:-| |invitedUser|[User](user.md)|The user created as part of the invitation creation. Read-Only|+|invitedUserSponsors|[directoryObject](../resources/directoryobject.md) collection|The users or groups who are sponsors of the invited user. Sponsors are users and groups that are responsible for guest users' privileges in the tenant and for keeping the guest users' information and access up to date. | ## JSON representation-Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "baseType": "microsoft.graph.entity", "@odata.type": "microsoft.graph.invitation" } --> ```json |
v1.0 | Invitationredemptionidentityproviderconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/invitationredemptionidentityproviderconfiguration.md | + + Title: "invitationRedemptionIdentityProviderConfiguration resource type" +description: "Defines the invitation redemption provider configuration base type to set redemption flow settings for Microsoft Entra ID B2B collaboration." ++ms.localizationpriority: medium ++++# invitationRedemptionIdentityProviderConfiguration resource type ++Namespace: microsoft.graph ++Defines the invitation redemption provider configuration base type to set redemption flow settings for Microsoft Entra ID B2B collaboration. ++Two types of identity providers are in the precedence order: primary identity providers and fallback identity providers. Fallback identity providers are used when no primary identity provider is available and must always be specified. ++The primary identity providers are: ++- azureActiveDirectory: Any user located in another Microsoft Entra ID tenant. +- externalFederation: Any user located in an identity provider associated with a SAML or WS-Federation relationship. +- socialIdentityProviders: Any user using a gmail.com account when Google Federation is configured. ++The fallback identity providers are: ++- defaultConfiguredIdp: Check for an existing Microsoft account, then use a one-time email passcode (if enabled), and finally, create a new Microsoft account if no primary identity providers are available for the user. +- emailOneTimePasscode: Always use one-time email passcode if no primary identity providers are available for the user. +- microsoftAccount: Always use an existing Microsoft account or create a new Microsoft account if no primary identity providers are available for the user. ++## Properties ++|Property|Type|Description| +|:|:|:| +| primaryIdentityProviderPrecedenceOrder | b2bIdentityProvidersType collection | Collection of identity providers in priority order of preference to be used for guest invitation redemption. Possible values are: `azureActiveDirectory`, `externalFederation`, or `socialIdentityProviders`. | +| fallbackIdentityProvider | b2bIdentityProvidersType | The fallback identity provider to be used in case no primary identity provider can be used for guest invitation redemption. Possible values are: `defaultConfiguredIdp`, `emailOneTimePasscode`, or `microsoftAccount`. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.invitationRedemptionIdentityProviderConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.invitationRedemptionIdentityProviderConfiguration", + "primaryIdentityProviderPrecedenceOrder": [ + "String" + ], + "fallbackIdentityProvider": "String" +} +``` |
v1.0 | Invitedusermessageinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/invitedusermessageinfo.md | The invitedUserMessageInfo object allows you to configure the [invitation](invit |messageLanguage|String|The language you want to send the default message in. If the customizedMessageBody is specified, this property is ignored, and the message is sent using the customizedMessageBody. The language format should be in ISO 639. The default is en-US.| ## JSON representation-Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- {"blockType": "resource", "@odata.type": "microsoft.graph.invitedUserMessageInfo"} --> ```json |
v1.0 | Invitenewbotresponse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/invitenewbotresponse.md | Contains a response to a request to have a participant joining notification sent ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Inviteparticipantsoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/inviteparticipantsoperation.md | Represents the status of a long-running participant invitation operation, trigge ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Ipnamedlocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/ipnamedlocation.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Iprange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/iprange.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Ipv4cidrrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/ipv4cidrrange.md | Inherits from [ipRange](../resources/iprange.md) ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Ipv6cidrrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/ipv6cidrrange.md | Inherits from [ipRange](../resources/iprange.md) ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Itemattachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/itemattachment.md | Derived from [attachment](attachment.md). ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
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 ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Json | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/json.md | 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.Json" |
v1.0 | Keycredentialconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/keycredentialconfiguration.md | Key credential configuration object that contains properties to configure restri | 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. | +| 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. | ## Relationships |
v1.0 | Keyvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/keyvalue.md | Represents a key-value pair. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Learningcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/learningcontent.md | Inherits from [entity](../resources/entity.md). |duration|Duration|The duration of the learning content in seconds. The value is represented in ISO 8601 format for durations. Optional.| |externalId|String|Unique external content ID for the learning content. Required.| |format|String|The format of the learning content. For example, `Course`, `Video`, `Book`, `Book Summary`, `Audiobook Summary`. Optional.|+|level|Level|The difficulty level of the learning content. Possible values are: `Beginner`, `Intermediate`, `Advanced`, `unknownFutureValue`. Optional.| |id|String|The unique identifier for the learning content. Not nullable. Read-only. Inherited from [entity](../resources/entity.md).| |isActive|Boolean|Indicates whether the content is active or not. Inactive content doesn't show up in the UI. The default value is `true`. Optional.| |isPremium|Boolean|Indicates whether the learning content requires the user to sign-in on the learning provider platform or not. The default value is `false`. Optional.| Inherits from [entity](../resources/entity.md). |thumbnailWebUrl|String|The URL of learning content thumbnail image. Optional.| |title|String|The title of the learning content. Required.| +## Level values +|Member|Description| +|:|:| +|Beginner|For learning content at a beginner level.| +|Intermediate|For learning content at an intermediate level.| +|Advanced|For learning content at an advanced level.| +|UnknownFutureValue|Evolvable enumeration sentinel value. Do not use.| + ## Relationships None. The following is a JSON representation of the resource. "duration": "String (duration)", "externalId": "String", "format": "String",+ "level": "String", "id": "String (identifier)", "isActive": "Boolean", "isPremium": "Boolean", |
v1.0 | Learningcourseactivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/learningcourseactivity.md | Inherits from [entity](../resources/entity.md). |completedDateTime|DateTimeOffset|Date and time when the assignment was completed. Optional.| |completionPercentage|Int32|The percentage completion value of the course activity. Optional.| |dueDateTime|DateTimeTimeZone|Due date for the course activity. Optional.|-|externalcourseActivityId|String|A course activity ID generated by the provider. Optional.| +|externalCourseActivityId|String|A course activity ID generated by the provider. Optional.| |id|String|A generated ID that can be used with other course activity APIs.| |learnerUserId|String|The user ID of the learner to whom the activity is assigned. Required.| |learningContentId|String|The ID of the learning content created in Viva Learning. Required.| |
v1.0 | Licenseassignmentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/licenseassignmentstate.md | The **licenseAssignmentStates** property of the [user](user.md) entity is a coll ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. ```json { |
v1.0 | Licensedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/licensedetails.md | Title: "licenseDetails resource type" description: "Contains information about a license assigned to a user." ms.localizationpriority: medium + doc_type: resourcePageType Contains information about a license assigned to a user. | Method | Return Type |Description| |:|:--|:-| |[List licenseDetails](../api/user-list-licensedetails.md) | [licenseDetails](../resources/licensedetails.md) collection |Retrieve a list of [licenseDetails](../resources/licensedetails.md) objects for a user.|+|[getTeamsLicensingDetails](../api/licensedetails-getteamslicensingdetails.md)|[teamsLicensingDetails](../resources/teamsLicensingDetails.md) object|Get the Microsoft Teams license details for the specified user.| <!--|[Get licenseDetails](../api/licensedetails-get.md) | licenseDetails |Read properties and relationships of a licenseDetails object.|--> |
v1.0 | Licenseunitsdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/licenseunitsdetail.md | The **prepaidUnits** property of the [subscribedSku](subscribedsku.md) entity is ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/list.md | Title: "List resource" + Title: "List resource type" ms.localizationpriority: medium description: "Represents a list in a site." doc_type: resourcePageType -# List resource +# List resource type Namespace: microsoft.graph |
v1.0 | Listinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/listinfo.md | Last updated 09/11/2017 Title: ListInfo + Title: listInfo resource type ms.localizationpriority: medium description: "The listInfo complex type provides additional information about a list." doc_type: resourcePageType -# ListInfo resource +# listInfo resource type Namespace: microsoft.graph The **listInfo** complex type provides additional information about a [list][]. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Listitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/listitem.md | Title: listItem resource + Title: listItem resource type description: Represents an item in a sharepoint list. ms.localizationpriority: high doc_type: resourcePageType -# listItem resource +# listItem resource type Namespace: microsoft.graph All examples are relative to a **[list][]**: `https://graph.microsoft.com/v1.0/s | [List documentSetVersions](../api/listitem-list-documentsetversions.md) | [documentSetVersion][] collection | Get a list of the versions of a document set item in a list. | | [Create documentSetVersion](../api/listitem-post-documentsetversions.md) | [documentSetVersion][] | Create a new version of a document set item in a list. | | [Restore documentSetVersion](../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. | [Get]: ../api/listitem-get.md [Get analytics]: ../api/itemanalytics-get.md The following properties are inherited from **[baseItem][]**. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Localeinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/localeinfo.md | Information about the locale, including the preferred language and country/regio ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Locationconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/locationconstraint.md | The conditions stated by a client for the location of a meeting. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Locationconstraintitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/locationconstraintitem.md | Derived from [location](location.md). ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Loginpagelayoutconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/loginpagelayoutconfiguration.md | Contains details of the layout of the sign-in page for a tenant. 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.loginPageLayoutConfiguration" |
v1.0 | M365appsinstallationoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/m365appsinstallationoptions.md | Title: "m365AppsInstallationOptions resource type" description: "Represents the tenant-level installation options for Microsoft 365 apps." ms.localizationpriority: medium doc_type: resourcePageType+ +toc. Title: Installation options # m365AppsInstallationOptions resource type |
v1.0 | Mailassessmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/mailassessmentrequest.md | When you create a mail threat assessment request, the mail should be received by ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mailbox Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/mailbox-usage-reports.md | - Title: "Mailbox usage reports" -description: "Use the mailbox usage reports to get information about users with a mailbox and their level of activity which is primarily based on emails sent and received. You can also see how much storage each mailbox consumes and how many mailboxes are approaching storage quotas." ---doc_type: conceptualPageType ---# Mailbox usage reports --Namespace: microsoft.graph --Use the mailbox usage reports to get information about users with a mailbox and their level of activity which is primarily based on emails sent and received. You can also see how much storage each mailbox consumes and how many mailboxes are approaching storage quotas. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Mailbox usage](https://support.office.com/client/Mailbox-usage-beffbe01-ce2d-4614-9ae5-7898868e2729). --## Reports --| Function | 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. | - |
v1.0 | Mailboxsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/mailboxsettings.md | You can [get](../api/user-get-mailboxsettings.md) or [update](../api/user-update ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mailfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/mailfolder.md | By default, [listing mailFolders](../api/user-list-mailfolders.md) returns only ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Mailtips | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/mailtips.md | as an automatic reply for a message recipient. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mailtipserror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/mailtipserror.md | An error that occurs during an action. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Malwarestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/malwarestate.md | Contains stateful information about the malware entity. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mediainfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/mediainfo.md | The media information used in actions for prompts. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Mediastream | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/mediastream.md | This contains information about the media channel. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Meetingattendancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/meetingattendancereport.md | doc_type: resourcePageType Namespace: microsoft.graph -Contains information associated with a meeting attendance report. +Contains information associated with a meeting attendance report for an [onlineMeeting](../resources/onlinemeeting.md) or a [virtualEvent](../resources/virtualevent.md). Meeting attendance reports are online meeting artifacts. For details, see [Online meeting artifacts and permissions](/graph/cloud-communications-online-meeting-artifacts). |
v1.0 | Meetingparticipantinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/meetingparticipantinfo.md | The following table lists the members of an [evolvable enumeration](/graph/best- ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Meetingparticipants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/meetingparticipants.md | Title: "meetingParticipants resource type" -description: "Participants in a meeting." +description: "Represents participants in a meeting." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph -Participants in a meeting. +Represents participants in a meeting. ## Properties | Property | Type | Description| |:|:--|:-|-| attendees | [meetingParticipantInfo](meetingparticipantinfo.md) collection | | -| organizer | [meetingParticipantInfo](meetingparticipantinfo.md) | | +| attendees | [meetingParticipantInfo](meetingparticipantinfo.md) collection | Information about the meeting attendees. | +| organizer | [meetingParticipantInfo](meetingparticipantinfo.md) | Information about the meeting organizer.| ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Meetingtimesuggestion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/meetingtimesuggestion.md | availability, and available meeting locations. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Meetingtimesuggestionsresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/meetingtimesuggestionsresult.md | The following are the possible reasons that [findMeetingTimes](../api/user-findm ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Message | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/message.md | by providing a [delta](../api/message-delta.md) function. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource",- "baseType": "microsoft.graph.outlookItem", "openType": true, "optionalProperties": [ "attachments", Here is a JSON representation of the resource ], "keyProperty": "id", "@odata.type": "microsoft.graph.message",+ "baseType": "microsoft.graph.outlookItem", "@odata.annotations": [ { "property": "attachments", |
v1.0 | Messagerule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/messagerule.md | Title: "messageRule resource type" -description: "A rule that applies to messages in the Inbox of a user." +description: "Represents a rule that applies to messages in the Inbox of a user." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph -A rule that applies to messages in the Inbox of a user. +Represents a rule that applies to messages in the Inbox of a user. In Outlook, you can set up rules for incoming messages in the Inbox to carry out specific actions upon certain conditions. and available rule conditions and exceptions are represented by the [messageRule | Property | Type |Description| |:|:--|:-| | actions | [messageRuleActions](messageruleactions.md) | Actions to be taken on a message when the corresponding conditions are fulfilled. |-| conditions | [messageRulePredicates](messagerulepredicates.md) | Conditions that when fulfilled, will trigger the corresponding actions for that rule. | +| conditions | [messageRulePredicates](messagerulepredicates.md) | Conditions that when fulfilled trigger the corresponding actions for that rule. | | displayName | String | The display name of the rule. | | exceptions | [messageRulePredicates](messagerulepredicates.md) | Exception conditions for the rule. | | hasError | Boolean | Indicates whether the rule is in an error condition. Read-only. | and available rule conditions and exceptions are represented by the [messageRule ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Messageruleactions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/messageruleactions.md | Represents the set of actions that are available to a rule. | stopProcessingRules | Boolean | Indicates whether subsequent rules should be evaluated. | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Messagerulepredicates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/messagerulepredicates.md | Represents the set of conditions and exceptions that are available for a rule. | withinSizeRange | [sizeRange](sizerange.md) | Represents the minimum and maximum sizes (in kilobytes) that an incoming message must fall in between in order for the condition or exception to apply. | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Metadatakeystringpair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/metadatakeystringpair.md | + + Title: 'metaDataKeyStringPair resource type' +description: Represents a key-value (string) pair of the metadata. ++ms.localizationpriority: medium +++# metaDataKeyStringPair resource type ++Namespace: microsoft.graph ++++Represents a key-value (string) pair of the metadata. ++## Properties ++| Property | Type | Description | +| :- | :-- | : | +| key | String | Key of the meta data. | +| value | String | Value of the meta data. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.metaDataKeyStringPair" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.metaDataKeyStringPair", + "key": "String", + "value": "String" +} +``` |
v1.0 | Metadatakeyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/metadatakeyvaluepair.md | + + Title: 'metaDataKeyValuePair resource type' +description: Represents a key-value (object) pair of the metadata. ++ms.localizationpriority: medium +++# metaDataKeyValuePair resource type ++Namespace: microsoft.graph ++++Represents a key-value (object) pair of the metadata. ++## Properties ++| Property | Type | Description | +| :- | : | :- | +| key | String | Key of the metadata. | +| value | [Json](../resources/json.md) | Value of the metadata. Should be an object. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.metaDataKeyValuePair" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.metaDataKeyValuePair", + "key": "String", + "value": { + "@odata.type": "microsoft.graph.Json" + } +} +``` |
v1.0 | Microsoft 365 Apps Usage Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/microsoft-365-apps-usage-report.md | - Title: "Microsoft 365 Apps usage reports" -description: "Use the Microsoft 365 Apps usage reports to get insights into the usage of Microsoft 365 Apps in your organization." ---doc_type: conceptualPageType ---# Microsoft 365 Apps usage reports --Namespace: microsoft.graph --Use the Microsoft 365 Apps usage reports to get insights into the usage of Microsoft 365 Apps in your organization. --> **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). --## Methods -| Function | CSV return type | JSON return type | Description | -|:|:-|:--|:--| -| [Get user detail](../api/reportroot-getm365appuserdetail.md) | Stream | Stream | Get details about the usage of Microsoft 365 Apps by user. | -| [Get user counts](../api/reportroot-getm365appusercounts.md) | Stream | Stream | Get the number of daily unique users by app. | -| [Get platform user counts](../api/reportroot-getm365appplatformusercounts.md) | Stream | Stream | Get the number of daily unique users by platform. | |
v1.0 | Microsoft Teams Device Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/microsoft-teams-device-usage-reports.md | - Title: "Microsoft Teams device usage reports" -description: "Use the Microsoft Teams device usage reports to get information about Microsoft Teams device usage in your organization." ---doc_type: conceptualPageType ---# Microsoft Teams device usage reports --Namespace: microsoft.graph --Use the Microsoft Teams device usage reports to get information about Microsoft Teams device usage in your organization. --## Methods --| 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 distribution user counts](../api/reportroot-getteamsdeviceusagedistributionusercounts.md) | Stream | Get the number of unique users by device type over the selected time period. | - |
v1.0 | Microsoft Teams Team Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/microsoft-teams-team-usage-reports.md | - Title: "Microsoft Teams team usage reports" -description: "Use the Microsoft Teams team usage reports to get insights into the usage of teams in your organization." ---doc_type: conceptualPageType ---# Microsoft Teams team usage reports --Namespace: microsoft.graph ---Use the Microsoft Teams team usage reports to get insights into the usage of teams in your organization. --## Reports --| Function | CSV 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. | -| [Get team 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 counts](../api/reportroot-getteamsteamcounts.md) | Stream | Get the number of teams by type across Microsoft Teams. | -| [Get distribution team counts](../api/reportroot-getteamsteamactivitydistributioncounts.md) | Stream | Get the number of team activities across Microsoft Teams over a selected period. | |
v1.0 | Microsoft Teams User Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/microsoft-teams-user-activity-reports.md | - Title: "Microsoft Teams user activity reports" -description: "Use the Microsoft Teams activity reports to get insights into the Microsoft Teams user activity in your organization." ---doc_type: conceptualPageType ---# Microsoft Teams user activity reports --Namespace: microsoft.graph --Use the Microsoft Teams activity reports to get insights into the Microsoft Teams user activity in your organization. --## Methods --| 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 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. | - |
v1.0 | Microsoftauthenticatorauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/microsoftauthenticatorauthenticationmethod.md | This is a derived type that inherits from the [authenticationMethod](authenticat |device|[device](../resources/device.md)|The registered device on which Microsoft Authenticator resides. This property is null if the device isn't registered for passwordless Phone Sign-In.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Microsoftauthenticatorfeaturesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/microsoftauthenticatorfeaturesettings.md | Represents Microsoft Authenticator settings such as application context and loca 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.microsoftAuthenticatorFeatureSettings" |
v1.0 | Modifiedproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/modifiedproperty.md | Indicates all the properties on a Microsoft Entra resource that have been modifi ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Multitenantorganization Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/multitenantorganization-overview.md | + + Title: "Multitenant organization API overview" +description: "Multitenant organizations allow you to define an organization with more than one instance of Microsoft Entra ID." ++ms.localizationpriority: medium + Last updated : 04/23/2024+++# Multitenant organization API overview ++The multitenant organization feature allows you to define an organization with more than one instance of Microsoft Entra ID. A multitenant organization enables multiple tenants to collaborate like a single entity. ++## Multitenant organization setup ++In the directory, a multitenant organization represents a group of tenants that belong to your parent organization. This group of tenants is shared and agreed-upon between the tenant administrators through a collaborative setup process. ++One tenant creates the multitenant organization. The tenant that creates the multitenant organization is assigned the multitenant organization role of owner. A multitenant organization owner has permissions to add tenants into a pending state, remove tenants from the multitenant organization, and change the role of any multitenant organization tenant. ++To join the multitenant organization, pending tenants must submit a join request to join the multitenant organization and turn their multitenant organization status to active. Joined or active tenants typically start with the multitenant organization member role. Any multitenant organization member tenant has the permissions to leave the multitenant organization. ++## Cross-tenant access settings and templates ++Cross-tenant access [partner configurations](../resources/crosstenantaccesspolicyconfigurationpartner.md) and [user synchronization settings](../resources/crosstenantidentitysyncpolicypartner.md) are required between all tenant pairs in a multitenant organization. If they don't already exist at the time of any pending tenant joining a multitenant organization, partner configurations and user synchronization settings for any new tenant pairs will be autogenerated in an unconfigured state. ++Optional multitenant organization templates for partner configurations and user synchronization settings, if configured, allow for the automatic modification of existing or autogenerated partner configurations and user synchronization settings for any new tenant pairs, at the time of such joining. ++## Multitenant organization size limitation ++A multitenant organization has a default maximum of 100 active tenants, including owner tenants. If this maximum is exceeded by any submitted join request, the join request fails. ++If you need to increase this limit, you can submit a support request using the Azure portal or Microsoft Entra admin center. In your request, include the tenant ID of one owner tenant and a list of all tenant IDs that are intended to be part of the finalized multitenant organization. ++## Related content +++ [What is a multitenant organization in Microsoft Entra ID?](/entra/identity/multi-tenant-organizations/overview)++ [multiTenantOrganization resource type](../resources/multitenantorganization.md) |
v1.0 | Multitenantorganization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/multitenantorganization.md | + + Title: "multiTenantOrganization resource type" +description: "Defines an organization with more than one instance of Microsoft Entra ID." ++ms.localizationpriority: medium ++++# multiTenantOrganization resource type ++Namespace: microsoft.graph ++Defines an organization with more than one instance of Microsoft Entra ID. A multitenant organization enables multiple tenants to collaborate like a single entity. ++There can only be one multitenant organization per active tenant. It is not possible to be part of multiple multitenant organizations. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Create multiTenantOrganization](../api/tenantrelationship-put-multitenantorganization.md)|[multiTenantOrganization](../resources/multitenantorganization.md)|Create a new multitenant organization.| +|[Get multiTenantOrganization](../api/multitenantorganization-get.md)|[multiTenantOrganization](../resources/multitenantorganization.md)|Get properties of the multitenant organization.| +|[Update multiTenantOrganization](../api/multitenantorganization-update.md)|[multiTenantOrganization](../resources/multitenantorganization.md)|Update the properties of a multitenant organization.| ++## Properties +|Property|Type|Description| +|:|:|:| +|createdDateTime|DateTimeOffset|Date when multitenant organization was created. Read-only.| +|description|String|Description of the multitenant organization.| +|displayName|String|Display name of the multitenant organization.| +|id|String|Tenant-specific object ID for the multitenant organization object. It is automatically generated when a multitenant organization object is created and stored in the local tenant. This ID is tenant-specific and doesn't match the object IDs of the same multitenant organization in other tenants. Read-only. Inherited from [entity](../resources/entity.md).| +|state|multiTenantOrganizationState|State of the multitenant organization. The possible values are: `active`, `inactive`, `unknownFutureValue`. `active` indicates the multitenant organization is created. `inactive` indicates the multitenant organization isn't created. Read-only.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|joinRequest|[multiTenantOrganizationJoinRequestRecord](../resources/multitenantorganizationjoinrequestrecord.md)|Defines the status of a tenant joining a multitenant organization.| +|tenants|[multiTenantOrganizationMember](../resources/multitenantorganizationmember.md) collection|Defines tenants added to a multitenant organization.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.multiTenantOrganization", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.multiTenantOrganization", + "id": "String (identifier)", + "createdDateTime": "String (timestamp)", + "displayName": "String", + "description": "String", + "state": "String" +} +``` |
v1.0 | Multitenantorganizationidentitysyncpolicytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/multitenantorganizationidentitysyncpolicytemplate.md | + + Title: "multiTenantOrganizationIdentitySyncPolicyTemplate resource type" +description: "Defines an optional cross-tenant access policy template with user synchronization settings for multitenant organization tenants." ++ms.localizationpriority: medium ++++# multiTenantOrganizationIdentitySyncPolicyTemplate resource type ++Namespace: microsoft.graph ++Defines an optional cross-tenant access policy template with user synchronization settings for multitenant organization tenants. Each tenant has its own template. For more information, see [crossTenantIdentitySyncPolicyPartner resource type](crosstenantidentitysyncpolicypartner.md). ++* If your tenant is joining a multitenant organization, the template is applicable to the user synchronization settings for all multitenant organization tenants. +* If another tenant joins your multitenant organization, the template is applicable only to the user synchronization settings of the newly joined multitenant organization tenant. ++Whether the template is applied to the user synchronization settings of relevant tenants is configurable with the `templateApplicationLevel` property. ++* If the template is configured to apply, it is only applied to user synchronization properties where the corresponding template property has a non-null value. ++In its default and unconfigured state, where all template properties (other than `templateApplicationLevel`) are null, the template has no effect on user synchronization settings. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get multiTenantOrganizationIdentitySyncPolicyTemplate](../api/multitenantorganizationidentitysyncpolicytemplate-get.md)|[multiTenantOrganizationIdentitySyncPolicyTemplate](../resources/multitenantorganizationidentitysyncpolicytemplate.md)|Get the user synchronization settings of the template.| +|[Update multiTenantOrganizationIdentitySyncPolicyTemplate](../api/multitenantorganizationidentitysyncpolicytemplate-update.md)|[multiTenantOrganizationIdentitySyncPolicyTemplate](../resources/multitenantorganizationidentitysyncpolicytemplate.md)|Update the user synchronization settings of the template.| +|[resetToDefaultSettings](../api/multitenantorganizationidentitysyncpolicytemplate-resettodefaultsettings.md)|None|Reset the user synchronization settings of the template to the default values.| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|ID of the template. Key.| +|templateApplicationLevel|templateApplicationLevel|Specifies whether the template will be applied to user synchronization settings of certain tenants. The possible values are: `none`, `newPartners`, `existingPartners`, `unknownFutureValue`. You can also specify multiple values like `newPartners,existingPartners` (default). `none` indicates the template isn't applied to any new or existing partner tenants. `newPartners` indicates the template is applied to new partner tenants. `existingPartners` indicates the template is applied to existing partner tenants, those who already had partner-specific user synchronization settings in place.| +|userSyncInbound|[crossTenantUserSyncInbound](../resources/crosstenantusersyncinbound.md)|Defines whether users can be synchronized from the partner tenant.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate", + "templateApplicationLevel": "String", + "userSyncInbound": { + "@odata.type": "microsoft.graph.crossTenantUserSyncInbound" + } +} +``` + |
v1.0 | Multitenantorganizationjoinrequestrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/multitenantorganizationjoinrequestrecord.md | + + Title: "multiTenantOrganizationJoinRequestRecord resource type" +description: "Defines the status of a tenant joining a multitenant organization." ++ms.localizationpriority: medium ++++# multiTenantOrganizationJoinRequestRecord resource type ++Namespace: microsoft.graph ++Defines the status of a tenant joining a multitenant organization. Before a tenant added to a multitenant organization can participate in the multitenant organization, the administrator of the tenant must join the multitenant organization. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get multiTenantOrganizationJoinRequestRecord](../api/multitenantorganizationjoinrequestrecord-get.md)|[multiTenantOrganizationJoinRequestRecord](../resources/multitenantorganizationjoinrequestrecord.md)|Get the status of a tenant joining a multitenant organization.| +|[Update multiTenantOrganizationJoinRequestRecord](../api/multitenantorganizationjoinrequestrecord-update.md)|[multiTenantOrganizationJoinRequestRecord](../resources/multitenantorganizationjoinrequestrecord.md)|Join a multitenant organization.| ++## Properties +|Property|Type|Description| +|:|:|:| +|addedByTenantId|String|Tenant ID of the Microsoft Entra tenant that added a tenant to the multitenant organization. To reset a failed join request, set `addedByTenantId` to `00000000-0000-0000-0000-000000000000`. Required.| +|memberState|multiTenantOrganizationMemberState|State of the tenant in the multitenant organization. The possible values are: `pending`, `active`, `removed`, `unknownFutureValue`. Tenants in the pending state must [join the multitenant organization](../api/multitenantorganizationjoinrequestrecord-update.md) to participate in the multitenant organization. Tenants in the active state can participate in the multitenant organization. Tenants in the removed state are in the process of being removed from the multitenant organization. Read-only.| +|role|multiTenantOrganizationMemberRole|Role of the tenant in the multitenant organization. The possible values are: `owner`, `member` (default), `unknownFutureValue`. Tenants with the owner role can manage the multitenant organization. There can be multiple tenants with the owner role in a multitenant organization. Tenants with the member role can participate in a multitenant organization.| +|transitionDetails|[multiTenantOrganizationJoinRequestTransitionDetails](../resources/multitenantorganizationjoinrequesttransitiondetails.md)|Details of the processing status for a tenant joining a multitenant organization. Read-only.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.multiTenantOrganizationJoinRequestRecord", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.multiTenantOrganizationJoinRequestRecord", + "addedByTenantId": "String", + "memberState": "String", + "role": "String", + "transitionDetails": { + "@odata.type": "microsoft.graph.multiTenantOrganizationJoinRequestTransitionDetails" + } +} +``` |
v1.0 | Multitenantorganizationjoinrequesttransitiondetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/multitenantorganizationjoinrequesttransitiondetails.md | + + Title: "multiTenantOrganizationJoinRequestTransitionDetails resource type" +description: "Details of the processing status for a tenant joining a multitenant organization." ++ms.localizationpriority: medium ++++# multiTenantOrganizationJoinRequestTransitionDetails resource type ++Namespace: microsoft.graph ++Details of the processing status for a tenant joining a multitenant organization. ++## Properties +|Property|Type|Description| +|:|:|:| +|desiredMemberState|multiTenantOrganizationMemberState|State of the tenant in the multitenant organization currently being processed. The possible values are: `pending`, `active`, `removed`, `unknownFutureValue`. Read-only.| +|details|String|Details that explain the processing status if any. Read-only.| +|status|multiTenantOrganizationMemberProcessingStatus|Processing state of the asynchronous job. The possible values are: `notStarted`, `running`, `succeeded`, `failed`, `unknownFutureValue`. Read-only.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.multiTenantOrganizationJoinRequestTransitionDetails" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.multiTenantOrganizationJoinRequestTransitionDetails", + "desiredMemberState": "String", + "status": "String", + "details": "String" +} +``` + |
v1.0 | Multitenantorganizationmember | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/multitenantorganizationmember.md | + + Title: "multiTenantOrganizationMember resource type" +description: "Defines a tenant added to a multitenant organization." ++ms.localizationpriority: medium ++++# multiTenantOrganizationMember resource type ++Namespace: microsoft.graph ++Defines a tenant added to a multitenant organization. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List multiTenantOrganizationMembers](../api/multitenantorganization-list-tenants.md)|[multiTenantOrganizationMember](../resources/multitenantorganizationmember.md) collection|List the tenants and their properties in the multitenant organization.| +|[Add multiTenantOrganizationMember](../api/multitenantorganization-post-tenants.md)|[multiTenantOrganizationMember](../resources/multitenantorganizationmember.md)|Add a tenant to a multitenant organization.| +|[Get multiTenantOrganizationMember](../api/multitenantorganizationmember-get.md)|[multiTenantOrganizationMember](../resources/multitenantorganizationmember.md)|Get a tenant and its properties in the multitenant organization.| +|[Update multiTenantOrganizationMember](../api/multitenantorganizationmember-update.md)|[multiTenantOrganizationMember](../resources/multitenantorganizationmember.md)|Update the properties of a tenant in a multitenant organization.| +|[Remove multiTenantOrganizationMember](../api/multitenantorganization-delete-tenants.md)|None|Remove a tenant from a multitenant organization.| ++## Properties +|Property|Type|Description| +|:|:|:| +|addedByTenantId|String|Tenant ID of the tenant that added the tenant to the multitenant organization. Read-only.| +|addedDateTime|DateTimeOffset|Date and time when the tenant was added to the multitenant organization. Read-only.| +|displayName|String|Display name of the tenant added to the multitenant organization.| +|joinedDateTime|DateTimeOffset|Date and time when the tenant joined the multitenant organization. Read-only.| +|role|multiTenantOrganizationMemberRole|Role of the tenant in the multitenant organization. The possible values are: `owner`, `member` (default), `unknownFutureValue`. Tenants with the owner role can manage the multitenant organization but tenants with the member role can only participate in a multitenant organization. There can be multiple tenants with the owner role in a multitenant organization. | +|state|multiTenantOrganizationMemberState|State of the tenant in the multitenant organization. The possible values are: `pending`, `active`, `removed`, `unknownFutureValue`. Tenants in the pending state must [join the multitenant organization](../api/multitenantorganizationjoinrequestrecord-update.md) to participate in the multitenant organization. Tenants in the active state can participate in the multitenant organization. Tenants in the removed state are in the process of being removed from the multitenant organization. Read-only.| +|tenantId|String|Tenant ID of the Microsoft Entra tenant added to the multitenant organization. Set at the time tenant is added.<br><br>Supports `$filter`. Key.| +|transitionDetails|[multiTenantOrganizationMemberTransitionDetails](../resources/multitenantorganizationmembertransitiondetails.md)|Details of the processing status for a tenant in a multitenant organization. Read-only. Nullable.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "tenantId", + "@odata.type": "microsoft.graph.multiTenantOrganizationMember", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.multiTenantOrganizationMember", + "tenantId": "String (identifier)", + "displayName": "String", + "addedDateTime": "String (timestamp)", + "joinedDateTime": "String (timestamp)", + "addedByTenantId": "String", + "role": "String", + "state": "String", + "transitionDetails": { + "@odata.type": "microsoft.graph.multiTenantOrganizationMemberTransitionDetails" + } +} +``` |
v1.0 | Multitenantorganizationmembertransitiondetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/multitenantorganizationmembertransitiondetails.md | + + Title: "multiTenantOrganizationMemberTransitionDetails resource type" +description: "Details of the processing status for a tenant in a multitenant organization." ++ms.localizationpriority: medium ++++# multiTenantOrganizationMemberTransitionDetails resource type ++Namespace: microsoft.graph ++Details of the processing status for a tenant in a multitenant organization. ++## Properties +|Property|Type|Description| +|:|:|:| +|desiredRole|multiTenantOrganizationMemberRole|Role of the tenant in the multitenant organization. The possible values are: `owner`, `member`, `unknownFutureValue`.| +|desiredState|multiTenantOrganizationMemberState|State of the tenant in the multitenant organization currently being processed. The possible values are: `pending`, `active`, `removed`, `unknownFutureValue`. Read-only.| +|details|String|Details that explain the processing status if any. Read-only.| +|status|multiTenantOrganizationMemberProcessingStatus|Processing state of the asynchronous job. The possible values are: `notStarted`, `running`, `succeeded`, `failed`, `unknownFutureValue`. Read-only.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.multiTenantOrganizationMemberTransitionDetails" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.multiTenantOrganizationMemberTransitionDetails", + "desiredState": "String", + "desiredRole": "String", + "status": "String", + "details": "String" +} +``` + |
v1.0 | Multitenantorganizationpartnerconfigurationtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/multitenantorganizationpartnerconfigurationtemplate.md | + + Title: "multiTenantOrganizationPartnerConfigurationTemplate resource type" +description: "Defines an optional cross-tenant access policy template with inbound and outbound partner configuration settings for multitenant organization tenants." ++ms.localizationpriority: medium ++++# multiTenantOrganizationPartnerConfigurationTemplate resource type ++Namespace: microsoft.graph ++Defines an optional cross-tenant access policy template with inbound and outbound partner configuration settings for multitenant organization tenants. Each tenant has its own template. For more information, see [crossTenantAccessPolicyConfigurationPartner resource type](../resources/crosstenantaccesspolicyconfigurationpartner.md). ++* If your tenant is joining a multitenant organization, the template is applicable to the partner configuration settings for all multitenant organization tenants. +* If another tenant joins your multitenant organization, the template is applicable only to the partner configuration settings of the newly joined multitenant organization tenant. ++Whether the template is applied to the partner configuration settings of relevant tenants is configurable with the `templateApplicationLevel` property. ++* If the template is configured to apply, it's only applied to partner configuration properties where the corresponding template property has a non-null value. ++In its default and unconfigured state, where all template properties (other than `templateApplicationLevel`) are null, the template has no effect on partner configuration settings. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get multiTenantOrganizationPartnerConfigurationTemplate](../api/multitenantorganizationpartnerconfigurationtemplate-get.md)|[multiTenantOrganizationPartnerConfigurationTemplate](../resources/multitenantorganizationpartnerconfigurationtemplate.md)|Get the inbound and outbound partner configuration settings of the template.| +|[Update multiTenantOrganizationPartnerConfigurationTemplate](../api/multitenantorganizationpartnerconfigurationtemplate-update.md)|[multiTenantOrganizationPartnerConfigurationTemplate](../resources/multitenantorganizationpartnerconfigurationtemplate.md)|Update the inbound and outbound partner configuration settings of the template.| +|[resetToDefaultSettings](../api/multitenantorganizationpartnerconfigurationtemplate-resettodefaultsettings.md)|None|Reset the inbound and outbound partner configuration settings of the template to the default values.| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|ID of the template. Key.| +|automaticUserConsentSettings|[inboundOutboundPolicyConfiguration](../resources/inboundoutboundpolicyconfiguration.md)|Determines the partner-specific configuration for automatic user consent settings. Unless configured, the **inboundAllowed** and **outboundAllowed** properties are `null` and inherit from the default settings, which is always `false`.| +|b2bCollaborationInbound|[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md)|Defines your partner-specific configuration for users from other organizations accessing your resources via Microsoft Entra B2B collaboration.| +|b2bCollaborationOutbound|[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md)|Defines your partner-specific configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B collaboration.| +|b2bDirectConnectInbound|[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md)|Defines your partner-specific configuration for users from other organizations accessing your resources via Azure B2B direct connect.| +|b2bDirectConnectOutbound|[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md)|Defines your partner-specific configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B direct connect.| +|inboundTrust|[crossTenantAccessPolicyInboundTrust](../resources/crosstenantaccesspolicyinboundtrust.md)|Determines the partner-specific configuration for trusting other Conditional Access claims from external Microsoft Entra organizations.| +|templateApplicationLevel|templateApplicationLevel|Specifies whether the template will be applied to partner configuration settings of certain tenants. The possible values are: `none`, `newPartners`, `existingPartners`, `unknownFutureValue`. You can also specify multiple values like `newPartners,existingPartners` (default). `none` indicates the template isn't applied to any new or existing partner tenants. `newPartners` indicates the template is applied to new partner tenants. `existingPartners` indicates the template is applied to existing partner tenants, those who already had partner-specific partner configurations in place.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.multiTenantOrganizationPartnerConfigurationTemplate", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.multiTenantOrganizationPartnerConfigurationTemplate", + "inboundTrust": { + "@odata.type": "microsoft.graph.crossTenantAccessPolicyInboundTrust" + }, + "b2bCollaborationOutbound": { + "@odata.type": "microsoft.graph.crossTenantAccessPolicyB2BSetting" + }, + "b2bCollaborationInbound": { + "@odata.type": "microsoft.graph.crossTenantAccessPolicyB2BSetting" + }, + "b2bDirectConnectOutbound": { + "@odata.type": "microsoft.graph.crossTenantAccessPolicyB2BSetting" + }, + "b2bDirectConnectInbound": { + "@odata.type": "microsoft.graph.crossTenantAccessPolicyB2BSetting" + }, + "automaticUserConsentSettings": { + "@odata.type": "microsoft.graph.inboundOutboundPolicyConfiguration" + }, + "templateApplicationLevel": "String" +} +``` |
v1.0 | Multivaluelegacyextendedproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/multivaluelegacyextendedproperty.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Nameditem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/nameditem.md | - Title: "NamedItem resource type" -description: "Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, reference to a range. This object can be used to obtain range object associated with names." ---doc_type: resourcePageType ---# NamedItem resource type --Namespace: microsoft.graph --Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, reference to a range. This object can be used to obtain range object associated with names. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Add](../api/nameditem-add.md)|[WorkbookNamedItem](nameditem.md)|Adds a new name to the collection of the given scope.| -|[AddFormulaLocal](../api/nameditem-addformulalocal.md)|[WorkbookNamedItem](nameditem.md)|Adds a new name to the collection of the given scope using the user's locale for the formula.| -|[Get NamedItem](../api/nameditem-get.md) | [WorkbookNamedItem](nameditem.md) |Read properties and relationships of namedItem object.| -|[Update](../api/nameditem-update.md) | [WorkbookNamedItem](nameditem.md) |Update NamedItem object. | -|[Range](../api/nameditem-range.md)|[Range](range.md)|Returns the range object that is associated with the name. Throws an exception if the named item's type isn't a range.| -|[List](../api/nameditem-list.md) | [WorkbookNamedItem](nameditem.md) collection |Get namedItem object collection. | --## Properties -| Property | Type |Description| -|:|:--|:-| -|comment|string|Represents the comment associated with this name.| -|name|string|The name of the object. Read-only.| -|scope|string|Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only.| -|type|string|Indicates what type of reference is associated with the name. The possible values are: `String`, `Integer`, `Double`, `Boolean`, `Range`. Read-only.| -|value|Json|Represents the formula that the name is defined to refer to. for example, =Sheet14!$B$2:$H$12, =4.75, etc. Read-only.| -|visible|boolean|Specifies whether the object is visible or not.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|worksheet|[WorkbookWorksheet](worksheet.md)|Returns the worksheet on which the named item is scoped to. Available only if the item is scoped to the worksheet. Read-only.| --## JSON representation --Here's a JSON representation of the resource. --<!-- { - "blockType": "resource", - "optionalProperties": [ -- ], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookNamedItem" -}--> --```json -{ - "name": "string", - "comment": "string", - "scope": "string", - "type": "string", - "value": {"@odata.type": "microsoft.graph.Json"}, - "visible": true --} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "NamedItem resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Notebook | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/notebook.md | A OneNote notebook. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Notebooklinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/notebooklinks.md | Links for opening a OneNote notebook. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Objectidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/objectidentity.md | Title: "objectIdentity resource type" description: "Represents an identity used to sign in to a user account." ms.localizationpriority: medium doc_type: resourcePageType+ |
v1.0 | Office 365 Activations Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/office-365-activations-reports.md | - Title: "Microsoft 365 activations reports" -description: "The Microsoft 365 activation reports can give you a view of which users have activated their Microsoft 365 subscriptions on at least one device. These reports provide a breakdown of the Microsoft 365 ProPlus, Project, and Visio Pro for Office 365 subscription activations, as well as the breakdown of activations across desktop and devices. These reports could help you identify users who might need additional support to activate their Office subscription." ---doc_type: conceptualPageType ---# Microsoft 365 activations reports --Namespace: microsoft.graph --The Microsoft 365 activation reports can give you a view of which users have activated their Microsoft 365 subscriptions on at least one device. These reports provide a breakdown of the Microsoft 365 ProPlus, Project, and Visio Pro for Office 365 subscription activations, as well as the breakdown of activations across desktop and devices. These reports could help you identify users who might need additional support to activate their Office subscription. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Microsoft Office activations](https://support.office.com/client/Office-activations-87c24ae2-82e0-4d1e-be01-c3bcc3f18c60). --## Reports -| Function | 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. | - |
v1.0 | Office 365 Active Users Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/office-365-active-users-reports.md | - Title: "Microsoft 365 active users reports" -description: "You can use the Microsoft 365 active users reports to find out how many product licenses are being used by individuals in your organization, and drill down for information about which users are using what products. These reports can help administrators identify underutilized products or users that might need additional training or information." ---doc_type: conceptualPageType ---# Microsoft 365 active users reports --Namespace: microsoft.graph --You can use the Microsoft 365 active users reports to find out how many product licenses are being used by individuals in your organization, and drill down for information about which users are using what products. These reports can help administrators identify underutilized products or users that might need additional training or information. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Active Users](https://support.office.com/client/Active-Users-fc1cf1d0-cd84-43fd-adb7-a4c4dfa8112d). --## Reports -| Function | 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. | - |
v1.0 | Office 365 Groups Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/office-365-groups-activity-reports.md | - Title: "Microsoft 365 groups activity reports" -description: "You can use the Groups activity reports to gain insights into the activity of Microsoft 365 groups in your organization and see how many Microsoft 365 groups are being created and used." ---doc_type: conceptualPageType ---# Microsoft 365 groups activity reports --Namespace: microsoft.graph --You can use the Groups activity reports to gain insights into the activity of Microsoft 365 groups in your organization and see how many Microsoft 365 groups are being created and used. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Microsoft 365 groups](https://support.office.com/client/Office-365-groups-a27f1a99-3557-4f85-9560-a28e3d822a40). --## Reports --| Function | 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, Yammer 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. | - |
v1.0 | Officegraphinsights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/officegraphinsights.md | Each insight is returned with a **resourceVisualization** and **resourceReferenc ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty":"id", |
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" ++ms.localizationpriority: medium ++++# onAttributeCollectionExternalUsersSelfServiceSignUp resource type ++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. ++Inherits from [onAttributeCollectionHandler](../resources/onattributecollectionhandler.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.| +<!--|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 +|Relationship|Type|Description| +|:|:|:| +|attributes|[identityUserFlowAttribute](../resources/identityuserflowattribute.md) collection|A list of user attributes to collect.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp", + "attributeCollectionPage": { + "@odata.type": "microsoft.graph.authenticationAttributeCollectionPage" + } +} +``` |
v1.0 | Onattributecollectionhandler | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onattributecollectionhandler.md | + + Title: "onAttributeCollectionHandler resource type" +description: "A handler for when attributes are collected in the authentication flow" ++ms.localizationpriority: medium ++++# onAttributeCollectionHandler resource type ++Namespace: microsoft.graph ++A handler for the event when attributes are ready to be collected from the user in an authentication flow. May be part of an [authenticationEventsFlow](../resources/authenticationeventsflow.md). ++This is an abstract complex type from which the [onAttributeCollectionExternalUsersSelfServiceSignUp](../resources/onattributecollectionexternalusersselfservicesignup.md) subtype is derived. ++## Properties ++None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onAttributeCollectionHandler" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onAttributeCollectionHandler" +} +``` + |
v1.0 | Onattributecollectionlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onattributecollectionlistener.md | + + Title: "onAttributeCollectionListener resource type" +description: "A listener for when attributes are collected in the authentication flow" ++ms.localizationpriority: medium ++++# onAttributeCollectionListener resource type ++Namespace: microsoft.graph ++A listener for when attributes are collected in an authentication flow. ++Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ++## 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|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|Required. Configuration for what to invoke if the event resolves to this listener.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.onAttributeCollectionListener", + "baseType": "microsoft.graph.authenticationEventListener", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onAttributeCollectionListener", + "id": "String (identifier)", + "conditions": { + "@odata.type": "microsoft.graph.authenticationConditions" + }, + "authenticationEventsFlowId": "String", + "handler": { + "@odata.type": "microsoft.graph.onAttributeCollectionHandler" + } +} +``` + |
v1.0 | Onauthenticationmethodloadstartexternalusersselfservicesignup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onauthenticationmethodloadstartexternalusersselfservicesignup.md | + + Title: "onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp resource type" +description: "Managed handler that customizes the authentication methods an external user can select when authenticating to an application" ++ms.localizationpriority: medium ++++# onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp resource type ++Namespace: microsoft.graph ++This is a managed handler for the event when authentication methods are ready to be presented to an external user in a customized authentication flow for an application on a Microsoft Entra external tenant. This handler defines which identity providers and authentication methods the user can select for primary (first-factor) authentication, and is defined as part of a multi-event policy, [externalUsersSelfServiceSignUpEventsFlow](externalUsersSelfServiceSignUpEventsFlow.md). ++Inherits from [onAuthenticationMethodLoadStartHandler](../resources/onauthenticationmethodloadstarthandler.md). ++## Properties +None ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|identityProviders|[identityProviderBase](../resources/identityproviderbase.md) collection|Required. The list of identity providers that user can sign in or sign up with. At least one identity provider must be specified.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp" +} +``` |
v1.0 | Onauthenticationmethodloadstarthandler | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onauthenticationmethodloadstarthandler.md | + + Title: "onAuthenticationMethodLoadStartHandler resource type" +description: "A handler for when authentication methods are ready to be presented to the user in an authentication flow" ++ms.localizationpriority: medium ++++# onAuthenticationMethodLoadStartHandler resource type ++Namespace: microsoft.graph ++A handler for the event when authentication methods are ready to be presented to the user in an authentication flow. ++This is an abstract complex type from which the [onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp](../resources/onauthenticationmethodloadstartexternalusersselfservicesignup.md) subtype is derived. +++## Properties ++None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onAuthenticationMethodLoadStartHandler" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartHandler" +} +``` + |
v1.0 | Onauthenticationmethodloadstartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onauthenticationmethodloadstartlistener.md | + + Title: "onAuthenticationMethodLoadStartListener resource type" +description: "A listener for when authentication methods are ready to be presented to the user in an authentication flow" ++ms.localizationpriority: medium ++++# onAuthenticationMethodLoadStartListener resource type ++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). ++Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ++## 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.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.onAuthenticationMethodLoadStartListener", + "baseType": "microsoft.graph.authenticationEventListener", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartListener", + "id": "String (identifier)", + "conditions": { + "@odata.type": "microsoft.graph.authenticationConditions" + }, + "authenticationEventsFlowId": "String", + "handler": { + "@odata.type": "microsoft.graph.onAuthenticationMethodLoadStartHandler" + } +} +``` + |
v1.0 | Onedrive Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onedrive-activity-reports.md | - Title: "OneDrive activity reports" -description: "Use the OneDrive activity reports to get the activity of every user licensed to use OneDrive by looking at their interaction with files on OneDrive. These reports can help you to understand the level of collaboration going on by showing the number of files shared." ---doc_type: conceptualPageType ---# OneDrive activity reports --Namespace: microsoft.graph --Use the OneDrive activity reports to get the activity of every user licensed to use OneDrive by looking at their interaction with files on OneDrive. These reports can help you to understand the level of collaboration going on by showing the number of files shared. --> **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). --## Reports --| Function | 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. | -- |
v1.0 | Onedrive Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onedrive-usage-reports.md | - Title: "OneDrive usage reports" -description: "You can use the OneDrive usage reports to gain a high-level view of the value you are getting from OneDrive in terms of the total number of files and storage used across all the OneDrive accounts in your organization. You can then drill down to understand the trends of active OneDrive accounts, how many files users have interacted with, and how much storage is used. These reports can also give you the details per OneDrive account." ---doc_type: conceptualPageType ---# OneDrive usage reports --Namespace: microsoft.graph --You can use the OneDrive usage reports to gain a high-level view of the value you are getting from OneDrive in terms of the total number of files and storage used across all the OneDrive accounts in your organization. You can then drill down to understand the trends of active OneDrive accounts, how many files users have interacted with, and how much storage is used. These reports can also give you the details per OneDrive account. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - OneDrive for Business usage](https://support.office.com/client/OneDrive-for-Business-usage-0de3b312-c4e8-4e4b-a02d-32b2f726a680). --## Reports --| Function | 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. | - |
v1.0 | Onenote | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onenote.md | For information about the permissions required to work with OneNote APIs, see [N ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", "baseType": "microsoft.graph.entity", |
v1.0 | Onenotebasemodel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onenotebasemodel.md | Title: "onenoteEntityBaseModel resource" + Title: "onenoteEntityBaseModel resource type" description: "This is the base type for OneNote entities." ms.localizationpriority: medium-# onenoteEntityBaseModel resource +# onenoteEntityBaseModel resource type Namespace: microsoft.graph This is the base type for OneNote entities. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onenoteentityhierarchymodel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onenoteentityhierarchymodel.md | Title: "onenoteEntityHierarchyModel resource" + Title: "onenoteEntityHierarchyModel resource type" description: "A base type for OneNote entities." ms.localizationpriority: medium-# onenoteEntityHierarchyModel resource +# onenoteEntityHierarchyModel resource type Namespace: microsoft.graph A base type for OneNote entities. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onenoteentityschemaobjectmodel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onenoteentityschemaobjectmodel.md | Title: "onenoteEntitySchemaObjectModel resource" + Title: "onenoteEntitySchemaObjectModel resource type" description: "This is a base type for OneNote entities." ms.localizationpriority: medium-# onenoteEntitySchemaObjectModel resource +# onenoteEntitySchemaObjectModel resource type Namespace: microsoft.graph This is a base type for OneNote entities. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onenoteoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onenoteoperation.md | The status of certain long-running OneNote operations. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Onenoteoperationerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onenoteoperationerror.md | An error from a failed OneNote operation. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Oninteractiveauthflowstartexternalusersselfservicesignup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/oninteractiveauthflowstartexternalusersselfservicesignup.md | + + Title: "onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp resource type" +description: "Managed handler that customizes what happens when an external user initiates authenticating to an application." ++ms.localizationpriority: medium ++++# onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp resource type ++Namespace: microsoft.graph ++This is a managed handler for the initiation of a customized authentication flow for an application on a Microsoft Entra external tenant. It defines whether a user can register (sign-up) or just sign-in, and is defined as part of a multi-event policy, [externalUsersSelfServiceSignUpEventsFlow](externalUsersSelfServiceSignUpEventsFlow.md). ++Inherits from [onInteractiveAuthFlowStartHandler](../resources/oninteractiveauthflowstarthandler.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|isSignUpAllowed|Boolean|Optional. Specifies whether the authentication flow includes an option to sign up (create account) and sign in. Default value is `false` meaning only sign in is enabled.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp", + "isSignUpAllowed": "Boolean" +} +``` |
v1.0 | Oninteractiveauthflowstarthandler | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/oninteractiveauthflowstarthandler.md | + + Title: "onInteractiveAuthFlowStartHandler resource type" +description: "A handler for when an authentication flow is ready to be initiated." ++ms.localizationpriority: medium ++++# onInteractiveAuthFlowStartHandler resource type ++Namespace: microsoft.graph ++A handler for the event when an authentication flow is ready to be initiated. ++This is an abstract complex type from which the [onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp](../resources/oninteractiveauthflowstartexternalusersselfservicesignup.md) subtype is derived. ++## Properties ++None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onInteractiveAuthFlowStartHandler" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartHandler" +} +``` + |
v1.0 | Oninteractiveauthflowstartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/oninteractiveauthflowstartlistener.md | + + Title: "onInteractiveAuthFlowStartListener resource type" +description: "A listener for what to invoke when an authentication flow is ready to be initiated" ++ms.localizationpriority: medium ++++# onInteractiveAuthFlowStartListener resource type ++Namespace: microsoft.graph ++A listener for what to invoke when an authentication flow is ready to be initiated. May be part of an [authenticationEventsFlow](../resources/authenticationeventsflow.md). ++Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ++## 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|[onInteractiveAuthFlowStartHandler](../resources/oninteractiveauthflowstarthandler.md)|Required. Configuration for what to invoke if the event resolves to this listener. This lets us define potential handler configurations per-event.| +++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.onInteractiveAuthFlowStartListener", + "baseType": "microsoft.graph.authenticationEventListener", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartListener", + "id": "String (identifier)", + "conditions": { + "@odata.type": "microsoft.graph.authenticationConditions" + }, + "authenticationEventsFlowId": "String", + "handler": { + "@odata.type": "microsoft.graph.onInteractiveAuthFlowStartHandler" + } +} +``` + |
v1.0 | Onlinemeetingbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onlinemeetingbase.md | Inherits from [entity](../resources/entity.md). | joinWebUrl | String | The join URL of the online meeting. Read-only. | | 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`.| | 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. | The following JSON representation shows the resource type. "lobbyBypassSettings": {"@odata.type": "microsoft.graph.lobbyBypassSettings"}, "recordAutomatically": "Boolean", "shareMeetingChatHistoryDefault": "microsoft.graph.meetingChatHistoryDefaultMode",- "startDateTime": "String (timestamp)", "subject": "String", "videoTeleconferenceId": "String", "watermarkProtection": {"@odata.type": "microsoft.graph.watermarkProtectionValues"} |
v1.0 | Onlinemeetinginfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onlinemeetinginfo.md | Details for an attendee to join the meeting online. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onpremisesdirectorysynchronization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onpremisesdirectorysynchronization.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Onpremisesextensionattributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onpremisesextensionattributes.md | description: "The **onPremisesExtensionAttributes** property of the user entity ms.localizationpriority: medium + doc_type: resourcePageType The **extensionAttributes** property of the [device](device.md) entity is manage ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Onpremisesprovisioningerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onpremisesprovisioningerror.md | Represents directory synchronization errors for the [user](user.md), [group](gro |value|String| Value of the property causing the error. | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Ontokenissuancestartcustomextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/ontokenissuancestartcustomextension.md | + + Title: "onTokenIssuanceStartCustomExtension resource type" +description: "Custom extension to invoke when handling the event when a token is about to be issued to your application." ++ms.localizationpriority: medium ++++# onTokenIssuanceStartCustomExtension resource type ++Namespace: microsoft.graph ++Custom extension to invoke when handling the event when a token is about to be issued to your application. ++Inherits from [customAuthenticationExtension](../resources/customauthenticationextension.md). ++## Methods +None. ++For the list of API operations for managing this resource type, see the [customAuthenticationExtension](../resources/customauthenticationextension.md) resource type. ++## Properties +|Property|Type|Description| +|:|:|:| +|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|The authentication configuration for this custom authentication extension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).| +|claimsForTokenConfiguration|[onTokenIssuanceStartReturnClaim](../resources/ontokenissuancestartreturnclaim.md) collection|Collection of claims to be returned by the API called by this custom authentication extension. Used to populate claims mapping experience in Microsoft Entra admin center. Optional. | +|clientConfiguration|[customExtensionClientConfiguration](../resources/customextensionclientconfiguration.md)|The connection settings for the custom authentication extension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).| +|description|String|Description for the custom authentication extension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).| +|displayName|String|Display name for the custom authentication extension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).| +|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|Configuration for the API endpoint that the custom authentication extension will call. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).| +|id|String|Identifier for onTokenIssuanceStartCustomExtension. Inherited from [entity](../resources/entity.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.onTokenIssuanceStartCustomExtension", + "baseType": "microsoft.graph.customAuthenticationExtension", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension", + "id": "String (identifier)", + "authenticationConfiguration": { + "@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration" + }, + "clientConfiguration": { + "@odata.type": "microsoft.graph.customExtensionClientConfiguration" + }, + "description": "String", + "displayName": "String", + "endpointConfiguration": { + "@odata.type": "microsoft.graph.customExtensionEndpointConfiguration" + }, + "claimsForTokenConfiguration": [ + { + "@odata.type": "microsoft.graph.onTokenIssuanceStartReturnClaim" + } + ] +} +``` + |
v1.0 | Ontokenissuancestartcustomextensionhandler | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/ontokenissuancestartcustomextensionhandler.md | + + Title: "onTokenIssuanceStartCustomExtensionHandler resource type" +description: "Custom extension handler for the event when a token is about to be issued to your application." ++ms.localizationpriority: medium ++++# onTokenIssuanceStartCustomExtensionHandler resource type ++Namespace: microsoft.graph ++Custom extension handler for the event when a token is about to be issued to your application. ++Inherits from [onTokenIssuanceStartHandler](../resources/ontokenissuancestarthandler.md). ++## Properties +None. ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|customExtension|[onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md)|The custom extension to invoke to handle the event when a token is about to be issued to your application. This object is autoexpanded.| +|configuration|[customExtensionOverwriteConfiguration](../resources/customExtensionOverwriteConfiguration.md)|Configuration regarding properties of the custom extension which can be overwritten per event listener. If no values are provided, the properties on the custom extension are used.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onTokenIssuanceStartCustomExtensionHandler" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler", + "customExtension": { + "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension", + }, + "configuration": { + "@odata.type": "#microsoft.graph.customExtensionOverwriteConfiguration", + }, +} +``` + |
v1.0 | Ontokenissuancestarthandler | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/ontokenissuancestarthandler.md | + + Title: "onTokenIssuanceStartHandler resource type" +description: "Handler for the event when a token is about to be issued to your application." ++ms.localizationpriority: medium ++++# onTokenIssuanceStartHandler resource type ++Namespace: microsoft.graph ++Handler for the event when a token is about to be issued to your application. +This is an abstract type from which the [onTokenIssuanceStartCustomExtensionHandler](../resources/ontokenissuancestartcustomextensionhandler.md) resource type is derived. ++## Properties ++None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onTokenIssuanceStartHandler" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onTokenIssuanceStartHandler" +} +``` + |
v1.0 | Ontokenissuancestartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/ontokenissuancestartlistener.md | + + Title: "onTokenIssuanceStartListener resource type" +description: "A listener for when a token is about to be issued to your application." ++ms.localizationpriority: medium ++++# onTokenIssuanceStartListener resource type ++Namespace: microsoft.graph ++A listener for when a token is about to be issued to your application. ++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| +|:|:|:| +|conditions|[authenticationConditions](../resources/authenticationconditions.md)|The conditions on which onTokenIssuanceStartListener should trigger. Inherited from [authenticationEventListener](../resources/authenticationeventlistener.md).| +|handler|[onTokenIssuanceStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met for this onTokenIssuanceStartListener.| +|id|String|Identifier for the onTokenIssuanceStartListener. Inherited from [entity](../resources/entity.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.onTokenIssuanceStartListener", + "baseType": "microsoft.graph.authenticationEventListener", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener", + "id": "String (identifier)", + "conditions": { + "@odata.type": "microsoft.graph.authenticationConditions" + }, + "handler": { + "@odata.type": "microsoft.graph.onTokenIssuanceStartHandler" + } +} +``` + |
v1.0 | Ontokenissuancestartreturnclaim | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/ontokenissuancestartreturnclaim.md | + + Title: "onTokenIssuanceStartReturnClaim resource type" +description: "A claim returned by an API that is to be added to a token after the event when a token is about to be issued to your application." ++ms.localizationpriority: medium ++++# onTokenIssuanceStartReturnClaim resource type ++Namespace: microsoft.graph ++A claim returned by an API that is to be added to a token after the event when a token is about to be issued to your application. ++## Properties +|Property|Type|Description| +|:|:|:| +|claimIdInApiResponse|String|The identifier of the claim returned by an API that is to be add to a token being issued.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onTokenIssuanceStartReturnClaim" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onTokenIssuanceStartReturnClaim", + "claimIdInApiResponse": "String" +} +``` + |
v1.0 | Onusercreatestartexternalusersselfservicesignup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onusercreatestartexternalusersselfservicesignup.md | + + Title: "onUserCreateStartExternalUsersSelfServiceSignUp resource type" +description: "Managed handler that customizes how an external user is created during the provisioning flow" ++ms.localizationpriority: medium ++++# onUserCreateStartExternalUsersSelfServiceSignUp resource type ++Namespace: microsoft.graph ++This is a managed handler for the user creation step of a customized authentication flow for an application in a Microsoft Entra external tenant defined by a multi-event policy, [externalUsersSelfServiceSignUpEventsFlow](externalUsersSelfServiceSignUpEventsFlow.md). It defines what type of user is created. ++Inherits from [onUserCreateStartHandler](../resources/onusercreatestarthandler.md). Complex type. ++## Properties ++|Property|Type|Description| +|:|:|:| +|userTypeToCreate|String| The type of user to create. Maps to userType property of [user](user.md) object. The possible values are: `member`, `guest`, `unknownFutureValue`.| +<!-- +|accessPackages|[authenticationAccessPackageConfiguration](../resources/authenticationaccesspackageconfiguration.md) collection|Optional. Defines the access package attached to the user flow - for which a request will be submitted. Applicable only to user flows configured in Azure AD workforce tenant.**SHOULD BE HIDDEN**| +--> ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onUserCreateStartExternalUsersSelfServiceSignUp" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onUserCreateStartExternalUsersSelfServiceSignUp", + "userTypeToCreate": "String" +} +``` |
v1.0 | Onusercreatestarthandler | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onusercreatestarthandler.md | + + Title: "onUserCreateStartHandler resource type" +description: "A handler for when user is about to be created in a provisioning flow" ++ms.localizationpriority: medium ++++# onUserCreateStartHandler resource type ++Namespace: microsoft.graph ++A handler for the event when a user is about to be created in a provisioning flow. May be part of an [authenticationEventsFlow](../resources/authenticationeventsflow.md). ++This is an abstract complex type from which the [onUserCreateStartExternalUsersSelfServiceSignUp](../resources/onusercreatestartexternalusersselfservicesignup.md) subtype is derived. ++## Properties ++None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.onUserCreateStartHandler" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onUserCreateStartHandler" +} +``` + |
v1.0 | Onusercreatestartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onusercreatestartlistener.md | + + Title: "onUserCreateStartListener resource type" +description: "A listener for when user is about to be created in the authentication flow" ++ms.localizationpriority: medium ++++# onUserCreateStartListener resource type ++Namespace: microsoft.graph ++A listener for when the user is about to be created in an authentication flow. ++Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). ++## 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|[onUserCreateStartHandler](../resources/onusercreatestarthandler.md)|Required. Configuration for what to invoke if the event resolves to this listener. This lets us define potential handler configurations per-event.| +++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.onUserCreateStartListener", + "baseType": "microsoft.graph.authenticationEventListener", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.onUserCreateStartListener", + "id": "String (identifier)", + "conditions": { + "@odata.type": "microsoft.graph.authenticationConditions" + }, + "authenticationEventsFlowId": "String", + "handler": { + "@odata.type": "microsoft.graph.onUserCreateStartHandler" + } +} +``` + |
v1.0 | Opentypeextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/opentypeextension.md | Title: "openTypeExtension resource type (open extensions)" description: "Open extensions (formerly known as Office 365 data extensions) provide an easy way to directly add untyped properties to a resource in Microsoft Graph." ms.localizationpriority: high + doc_type: resourcePageType Namespace: microsoft.graph Represents open extensions (also known as open type extensions, and formerly known as Office 365 data extensions), an [extensibility option](/graph/extensibility-overview) that provides an easy way to directly add untyped properties to a resource in Microsoft Graph. -Any open extension added to a resource shows up in the **extensions** navigation property. Each extension has an **extensionName** property that is the only pre-defined, writable property for all extensions, along with your custom data. One way to help make sure extension names are unique is to use a reverse domain name system (DNS) format that is dependent on _your own domain_, for example, `com.contoso.ContactInfo`. **Don't use** the Microsoft domain (`com.microsoft` or `com.onmicrosoft`) in an extension name. +Any open extension added to a resource shows up in the **extensions** navigation property. Each extension has an **extensionName** property that is the only predefined, writable property for all extensions, along with your custom data. One way to help make sure extension names are unique is to use a reverse domain name system (DNS) format that is dependent on _your own domain_, for example, `com.contoso.ContactInfo`. **Don't use** the Microsoft domain (`com.microsoft` or `com.onmicrosoft`) in an extension name. Derives from the [extension](extension.md) abstract type. -Open extensions are supported by the following resources. +The following resources support open extension: + [user](/graph/api/resources/user) + [group](/graph/api/resources/group) For more information about Microsoft Graph extensibility including limits for op ### Outlook-specific considerations -Each open extension present on an Outlook resource (event, message, or personal contact) is stored in a [MAPI named property](/office/client-developer/outlook/mapi/mapi-named-properties). When you create open extensions for Outlook, consider that MAPI named properties are a finite resource in a user's mailbox. When a user's named property quota is exhausted, you can't create anymore named properties for that user. This can result in unexpected behavior from clients that rely on named properties to function. +Each open extension on an Outlook resource (event, message, or personal contact) is stored in a [MAPI named property](/office/client-developer/outlook/mapi/mapi-named-properties). When you create open extensions for Outlook, consider that MAPI named properties are a finite resource in a user's mailbox. When a user's named property quota is exhausted, you can't create anymore named properties for that user. This can result in unexpected behavior from clients that rely on named properties to function. Apply the following guidelines when you create open extensions on Outlook resources: -- Create the minimum number of extensions required. Most applications should require no more than one extension. Extensions have no set defined properties or structure, so you can store multiple values in a single extension.+- Create the minimum number of extensions required. Most applications should require no more than one extension. Extensions have no defined properties or structure, so you can store multiple values in a single extension. - Avoid naming extensions in a variable manner (such as based on user input, etc.). Each time an open extension is created with a new name that hasn't been used in a user's mailbox before, a new MAPI named property is created. Removing the extension doesn't remove the named property. ### Use open extensions (for Outlook resources) or extended properties exposes at https://graph.microsoft.com/v1.0/$metadata. | Method | Return Type | Description | |:|:--|:-|-|[Create](../api/opentypeextension-post-opentypeextension.md) | [openTypeExtension](../resources/opentypeextension.md)(in an existing resource instance), or a new [todoTask](todotask.md), [todotasklist](todotasklist.md)[contact](contact.md), [event](event.md), [message](message.md), [post](post.md), [todoTask](todotask.md), or [todoTaskList](todotasklist.md) that contains an openTypeExtension object. | Create an openTypeExtension object in an existing or new resource instance.| +|[Create](../api/opentypeextension-post-opentypeextension.md) | [openTypeExtension](../resources/opentypeextension.md)(in an existing resource instance), or a new [todoTask](todotask.md), [todoTaskList](todotasklist.md)[contact](contact.md), [event](event.md), [message](message.md), [post](post.md), [todoTask](todotask.md), or [todoTaskList](todotasklist.md) that contains an openTypeExtension object. | Create an openTypeExtension object in an existing or new resource instance.| |[Get](../api/opentypeextension-get.md) | [openTypeExtension](opentypeextension.md) |Read properties and relationships of openTypeExtension object.| |[Update](../api/opentypeextension-update.md) | [openTypeExtension](opentypeextension.md) |Update openTypeExtension object. | |[Delete](../api/opentypeextension-delete.md) | None |Delete openTypeExtension object. | exposes at https://graph.microsoft.com/v1.0/$metadata. | Property | Type | Description | |:|:--|:-| |extensionName|String|A unique text identifier for an open type data extension. Optional.|-|id|String| A fully qualified identifier that concatenates the extension type with the **extensionName**. Read-only. <br/><br/> The **id** must be defined during the Create operation via one of the following ways: <ul><li> Explicitly define the **id** property in the request body. <li> Define an **extensionName** property in the request body, and Microsoft Graph automatically assigns the same value to the **id** property. <ul><li> In subsequent updates, you can change the **extensionName** property value to one that's different from the **id** value. <li>In subsequent updates, specifying only the **id** property in the request body automatically deletes the **extensionName** property from the open extension.</ul></ul>| +|id|String| A fully qualified identifier that concatenates the extension type with the **extensionName**. Read-only. <br/><br/> The **id** must be defined during the *Create* operation via one of the following ways: <ul><li> Explicitly define the **id** property in the request body. <li> Define an **extensionName** property in the request body, and Microsoft Graph automatically assigns the same value to the **id** property. <ul><li> In subsequent updates, you can change the **extensionName** property value to one that's different from the **id** value. <li>In subsequent updates, specifying only the **id** property in the request body automatically deletes the **extensionName** property from the open extension.</ul></ul>| ## Relationships None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
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. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Optionalclaims | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/optionalclaims.md | Application developers can configure optional claims in their Microsoft Entra ap |saml2Token|[optionalClaim](optionalclaim.md) collection| The optional claims returned in the SAML token.| ## JSON Representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", "@odata.type": "microsoft.graph.optionalClaims" |
v1.0 | Orgcontact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/orgcontact.md | This resource supports using [delta query](/graph/delta-query-overview) to track ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Outlookgeocoordinates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/outlookgeocoordinates.md | The geographic coordinates, elevation, and their degree of accuracy for a physic ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Outlookitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/outlookitem.md | Title: "outlookItem resource type" -description: "Here's a JSON representation of the resource" +description: "The following JSON representation shows the resource type." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph +## Properties +| Property | Type |Description| +|:|:--|:-| +|categories|String collection|The categories associated with the item| +|changeKey|String|Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.| +|createdDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| +|id|String| Read-only.| +|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`| +## Relationships +None ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", Here's a JSON representation of the resource } ```-## Properties -| Property | Type |Description| -|:|:--|:-| -|categories|String collection|The categories associated with the item| -|changeKey|String|Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.| -|createdDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| -|id|String| Read-only.| -|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`| --## Relationships -None <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Page | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/page.md | Title: "page resource type" + Title: "onenotePage resource type" description: "A page in a OneNote notebook." ms.localizationpriority: medium -# page resource type +# onenotePage resource type Namespace: microsoft.graph A page in a OneNote notebook. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Pagelinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/pagelinks.md | Links for opening a OneNote page. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Parentalcontrolsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/parentalcontrolsettings.md | Specifies parental control settings for an application. These settings control t |legalAgeGroupRule| String | Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: <table><tr><th>Value</th><th>Description</th></tr><tr><td>Allow</td><td>Default. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.</td></tr><tr><td>RequireConsentForPrivacyServices</td><td>Enforces the user to specify date of birth to comply with COPPA rules. </td></tr><tr><td>RequireConsentForMinors</td><td>Requires parental consent for ages below 18, regardless of country minor rules.</td></tr><tr><td>RequireConsentForKids</td><td>Requires parental consent for ages below 14, regardless of country minor rules.</td></tr><tr><td>BlockMinors</td><td>Blocks minors from using the app.</td></tr></table> | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Participantinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/participantinfo.md | Contains additional properties about the participant identity ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Partners Billing Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/partners-billing-api-overview.md | Title: "Use the Microsoft Graph API to export partner billing data" description: "The partner billing API in Microsoft Graph offers Microsoft direct partners a faster, more efficient way to export their high-volume billed and unbilled Azure usage data." ms.localizationpriority: medium -doc_type: resourcePageType # Use the Microsoft Graph API to export partner billing data |
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 | 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`. | +| 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`. | ## Relationships |
v1.0 | Passwordprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/passwordprofile.md | description: "Contains the password profile associated with a user. The **passwo ms.localizationpriority: high + doc_type: resourcePageType |
v1.0 | Patchcontentcommand | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/patchcontentcommand.md | The changes to make to a OneNote page in a PATCH request. ## JSON representation -Here is a JSON representation of the resource, which is sent in the body of the [PATCH pages/{id}`](../api/page-update.md) request. +The following JSON representation shows the resource type., which is sent in the body of the [PATCH pages/{id}`](../api/page-update.md) request. <!-- { "blockType": "resource", |
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 ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Payloaddetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/payloaddetail.md | Base type of [emailPayloadDetail](../resources/emailpayloaddetail.md). |Property|Type|Description| |:|:|:|-|coachmarks|[payloadCoachmark](../resources/payloadcoachmark.md) collection|Payload coachmark details.| +|coachMarks|[payloadCoachmark](../resources/payloadcoachmark.md) collection|Payload coachmark details.| |content|String|Payload content details.| |phishingUrl|String|The phishing URL used to target a user.| |
v1.0 | Permission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/permission.md | OneDrive for Business and SharePoint document libraries don't return the **inher ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", property will contain the information about the account that redeemed the permis "description": "The permission object provides information about permissions and roles and sharing information.", "keywords": "sharing,permissions,read,write,acl", "section": "documentation",- "tocPath": "Resources/Permission" + "tocPath": "Resources/Permission", + "suppressions": [ + "Error: Property 'grantedTo' found in resource definition for 'microsoft.graph.permission', but not described in markdown table.", + "Error: Property 'grantedToIdentities' found in resource definition for 'microsoft.graph.permission', but not described in markdown table." + ] } --> |
v1.0 | Permissiongrantpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/permissiongrantpolicy.md | A permission grant policy is used to specify the conditions under which consent A permission grant policy consists of a list of **includes** condition sets, and a list of **excludes** condition sets. For an event to match a permission grant policy, it must match *at least one* of the **includes** conditions sets, and *none* of the **excludes** condition sets. +For more information, see [Manage app consent policies](/entra/identity/enterprise-apps/manage-app-consent-policies). + ## Methods | Method | Return Type | Description | A permission grant policy consists of a list of **includes** condition sets, and |[Get permission grant policy](../api/permissiongrantpolicy-get.md) | [permissionGrantPolicy](permissiongrantpolicy.md) |Read properties and relationships of permissionGrantPolicy object.| |[Update permission grant policy](../api/permissiongrantpolicy-update.md) | [permissionGrantPolicy](permissiongrantpolicy.md) |Update permissionGrantPolicy object. | |**Include condition sets**| | |-|[List include condition sets](../api/permissiongrantpolicy-list-includes.md) |[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Get the condition sets which are *included* in this permission grant policy.| -|[Add include condition set](../api/permissiongrantpolicy-post-includes.md) |[permissionGrantConditionSet](permissiongrantconditionset.md) | Add a condition set which is *included* from this permission grant policy. | -|[Remove include condition set](../api/permissiongrantpolicy-delete-includes.md) | None | Remove a condition set which is *excluded* from this permission grant policy.| +|[List include condition sets](../api/permissiongrantpolicy-list-includes.md) |[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Get the condition sets that are *included* in this permission grant policy.| +|[Add include condition set](../api/permissiongrantpolicy-post-includes.md) |[permissionGrantConditionSet](permissiongrantconditionset.md) | Add a condition set that is *included* from this permission grant policy. | +|[Remove include condition set](../api/permissiongrantpolicy-delete-includes.md) | None | Remove a condition set that is *excluded* from this permission grant policy.| |**Exclude condition sets**| | |-|[List exclude condition sets](../api/permissiongrantpolicy-list-excludes.md) |[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Get the condition sets which are *excluded* in this permission grant policy.| -|[Add exclude condition set](../api/permissiongrantpolicy-post-excludes.md) |[permissionGrantConditionSet](permissiongrantconditionset.md) | Add a condition set which is *excluded* from this permission grant policy. | -|[Remove exclude condition set](../api/permissiongrantpolicy-delete-excludes.md) | None | Remove a condition set which is *excluded* from this permission grant policy.| +|[List exclude condition sets](../api/permissiongrantpolicy-list-excludes.md) |[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Get the condition sets that are *excluded* in this permission grant policy.| +|[Add exclude condition set](../api/permissiongrantpolicy-post-excludes.md) |[permissionGrantConditionSet](permissiongrantconditionset.md) | Add a condition set that is *excluded* from this permission grant policy. | +|[Remove exclude condition set](../api/permissiongrantpolicy-delete-excludes.md) | None | Remove a condition set that is *excluded* from this permission grant policy.| ## Properties A permission grant policy consists of a list of **includes** condition sets, and |:|:--|:-| | displayName | String |The display name for the permission grant policy.| | description |String| The description for the permission grant policy.|-| excludes |[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Condition sets which are *excluded* in this permission grant policy. Automatically expanded on `GET`.| +| excludes |[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Condition sets that are *excluded* in this permission grant policy. Automatically expanded on `GET`.| | id | String | The unique identifier for the permission grant policy. The **id** prefix `microsoft-` is reserved for built-in permission grant policies, and may not be used in a custom permission grant policy. Only letters, numbers, hyphens (`-`) and underscores (`_`) are allowed. Key. Not nullable. Required on create. Immutable. |-| includes | [permissionGrantConditionSet](permissiongrantconditionset.md) collection| Condition sets which are *included* in this permission grant policy. Automatically expanded on `GET`.| +| includes | [permissionGrantConditionSet](permissiongrantconditionset.md) collection| Condition sets that are *included* in this permission grant policy. Automatically expanded on `GET`.| ## Relationships | Relationship | Type |Description| |:|:--|:-|-|excludes|[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Condition sets which are *excluded* in this permission grant policy. This navigation is automatically expanded on GET. | -|includes|[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Condition sets which are *included* in this permission grant policy. This navigation is automatically expanded on GET. | +|excludes|[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Condition sets that are *excluded* in this permission grant policy. This navigation is automatically expanded on GET. | +|includes|[permissionGrantConditionSet](permissiongrantconditionset.md) collection| Condition sets that are *included* in this permission grant policy. This navigation is automatically expanded on GET. | ## JSON representation +The following JSON representation shows the resource type. + <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Permissionscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/permissionscope.md | Delegated permissions can be requested by client applications needing an access ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Phone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/phone.md | Represents a phone number. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Phoneauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/phoneauthenticationmethod.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Physicalofficeaddress | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/physicalofficeaddress.md | Represents the business address of a resource such as an organizational contact. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Pkcs12certificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/pkcs12certificate.md | Inherits from [apiAuthenticationConfigurationBase](../resources/apiauthenticatio ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.pkcs12Certificate" |
v1.0 | Pkcs12certificateinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/pkcs12certificateinformation.md | Represents the public information of a Pkcs12 certificate. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.pkcs12CertificateInformation" |
v1.0 | Planner | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/planner.md | The **planner** resource is the entry point for the Planner object model. It ret |tasks|[plannerTask](plannertask.md) collection| Read-only. Nullable. Returns a collection of the specified tasks| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerappliedcategories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerappliedcategories.md | Properties of an Open Type can be defined by the client. In this case though, th ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerassignedtotaskboardtaskformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerassignedtotaskboardtaskformat.md | Represents the information used to render a task correctly in the **AssignedTo** None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Plannerassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerassignment.md | The **plannerAssignment** resource represents the assignment of a task to a user |orderHint|String|Hint used to order assignees in a task. The format is defined as outlined [here](planner-order-hint-format.md).| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerbucket | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerbucket.md | Represents a bucket (or "custom column") for tasks in a plan in Microsoft 365. I |tasks|[plannerTask](plannertask.md) collection| Read-only. Nullable. The collection of tasks in the bucket.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerbuckettaskboardtaskformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerbuckettaskboardtaskformat.md | None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Plannerchecklistitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerchecklistitem.md | The **plannerChecklistItem** resource represents an item in the checklist of a t |title|String|Title of the checklist item| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerchecklistitems | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerchecklistitems.md | Properties of an Open Type can be defined by the client. In this case, the clien ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerexternalreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerexternalreference.md | The **plannerExternalReference** resource represents the metadata of a reference |type|String|Used to describe the type of the reference. Types include: `PowerPoint`, `Word`, `Excel`, `Other`.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerexternalreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerexternalreferences.md | Properties of an Open Type can be defined by the client. In this case, the clien ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannergroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannergroup.md | The **plannerGroup** resource provides access to Planner resources for a [group] |plans|[plannerPlan](plannerplan.md) collection| Read-only. Nullable. Returns the [plannerPlans](plannerplan.md) owned by the group.| ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannerplandetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerplandetails.md | Represents the additional information about a plan. Each [plan](plannerplan.md) None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Plannerprogresstaskboardtaskformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerprogresstaskboardtaskformat.md | None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
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 |progressTaskBoardFormat|[plannerProgressTaskBoardTaskFormat](plannerprogresstaskboardtaskformat.md)| Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Plannertaskdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannertaskdetails.md | None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Planneruser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/planneruser.md | Provides access to Planner resources for a [user](user.md). It doesn't contain a |tasks|[plannerTask](plannertask.md) collection| Read-only. Nullable. Returns the [plannerPlans](plannerplan.md) shared with the user.| ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Planneruserids | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/planneruserids.md | The client defines the properties of an Open Type, and the client should provide ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Playpromptoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/playpromptoperation.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Policyroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/policyroot.md | Title: "policyRoot resource type" description: "Resource type exposing navigation properties for the policies singleton."-+ ms.localizationpriority: medium-+ doc_type: resourcePageType None ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Policytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/policytemplate.md | + + Title: "policyTemplate resource type" +description: "Represents the base policy in the directory for multitenant organization settings." ++ms.localizationpriority: medium ++++# policyTemplate resource type ++Namespace: microsoft.graph ++Represents the base policy in the directory for multitenant organization settings. ++Inherits from [entity](../resources/entity.md). ++## Methods ++None. ++## Properties ++|Property|Type|Description| +|:|:|:| +|id|String|ID of the template. Key. Inherited from [entity](../resources/entity.md).| ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|multiTenantOrganizationIdentitySynchronization|[multiTenantOrganizationIdentitySyncPolicyTemplate](../resources/multitenantorganizationidentitysyncpolicytemplate.md)|Defines an optional cross-tenant access policy template with user synchronization settings for a multitenant organization.| +|multiTenantOrganizationPartnerConfiguration|[multiTenantOrganizationPartnerConfigurationTemplate](../resources/multitenantorganizationpartnerconfigurationtemplate.md)|Defines an optional cross-tenant access policy template with inbound and outbound partner configuration settings for a multitenant organization.| ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.policyTemplate", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.policyTemplate" +} +``` + |
v1.0 | Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/post.md | This resource lets you add your own data to custom properties using [extensions] ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Preauthorizedapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/preauthorizedapplication.md | In some rare cases, an identifier listed in the `delegatedPermissionIds` propert |delegatedPermissionIds|String collection| The unique identifier for the [oauth2PermissionScopes](permissionscope.md) the application requires. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Presence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/presence.md | Contains information about a user's presence, including their availability and u > **Note:** This resource is currently only supported for Microsoft Teams users. -This resource supports subscribing to [change notifications](/graph/webhooks). +This resource supports subscribing to [change notifications](/graph/changenotifications-for-presence). ## Methods None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Principalresourcemembershipsscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/principalresourcemembershipsscope.md | You must also specify the **@odata.type** type property with the value `#microso 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.principalResourceMembershipsScope" |
v1.0 | Printerbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printerbase.md | Represents a base type for [printer](printer.md) and [printerShare](printerShare |jobs|[printJob](printjob.md) collection|The list of jobs that are queued for printing by the printer/printerShare.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Printerdefaults | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printerdefaults.md | Represents the printer's default settings. Check the printer's [capabilities](pr |duplexMode|[printDuplexMode](enums.md#printduplexmode-values)|The default duplex (double-sided) configuration to use when printing a document. Valid values are described in the following table.| |finishings|[printFinishing](enums.md#printfinishing-values) collection|The default set of finishings to apply to print jobs. Valid values are described in the following table.| |fitPdfToPage|Boolean|The default fitPdfToPage setting. True to fit each page of a PDF document to a physical sheet of media; false to let the printer decide how to lay out impressions.|+|inputBin|String|The default input bin that serves as the paper source.| |mediaColor|String|The default media (such as paper) color to print the document on.| |mediaSize|String|The default media size to use. Supports standard size names for ISO and ANSI media sizes. Valid values are listed in the [printerCapabilities](printercapabilities.md#mediasizes-values) topic.| |mediaType|String|The default media (such as paper) type to print the document on.| |
v1.0 | Printerlocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printerlocation.md | The following is a JSON representation of the resource. "longitude": "Double", "altitudeInMeters": "Integer", "streetAddress": "String",- "subunit": [ + "subUnit": [ "String" ], "city": "String", |
v1.0 | Printerstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printerstatus.md | Represents the processing status of the printer, including any errors. 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.printerStatus" |
v1.0 | Printjobconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printjobconfiguration.md | A group of settings that a printer should use to print a job. |duplexMode|[printDuplexMode](enums.md#printduplexmode-values)|The duplex mode the printer should use when printing the job. Valid values are described in the table below. Read-only.| |feedOrientation|printerFeedOrientation|The orientation to use when feeding media into the printer. Valid values are described in the following table. Read-only.| |finishings|[printFinishing](enums.md#printfinishing-values) collection|Finishing processes to use when printing.|+|fitPdfToPage|Boolean|True to fit each page of a PDF document to a physical sheet of media; false to let the printer decide how to lay out impressions.| |inputBin|String|The input bin (tray) to use when printing. See the printer's [capabilities](printercapabilities.md) for a list of supported input bins.| |margin|[printMargin](printmargin.md)|The margin settings to use when printing.|-|mediaSize|String|The media size to use when printing. Supports standard size names for ISO and ANSI media sizes. -Valid values listed in the [printerCapabilities](printercapabilities.md#mediasizes-values) topic.| +|mediaSize|String|The media size to use when printing. Supports standard size names for ISO and ANSI media sizes. Valid values listed in the [printerCapabilities](printercapabilities.md#mediasizes-values) topic.| |mediaType|String|The default media (such as paper) type to print the document on.| |multipageLayout|[printMultipageLayout](enums.md#printmultipagelayout-values)|The direction to lay out pages when multiple pages are being printed per sheet. Valid values are described in the following table.| |orientation|[printOrientation](enums.md#printorientation-values)|The orientation setting the printer should use when printing the job. Valid values are described in the following table.| |
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. |interpreting|6|Job is in 'processing' state, but more specifically, document payload is being interpreted.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.printJobStatus" |
v1.0 | Printservice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printservice.md | Represents a Microsoft Entra tenant-specific description of a print service inst |endpoints|[printServiceEndpoint](printserviceendpoint.md) collection| Endpoints that can be used to access the service. Read-only. Nullable.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Printtasktrigger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printtasktrigger.md | For details about how to use this resource to add pull printing support to Unive |definition|[printTaskDefinition](printtaskdefinition.md)|An abstract definition that is used to create a [printTask](printtask.md) when triggered by a print event. Read-only.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Printusagebyprinter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printusagebyprinter.md | Describes print activity for a printer during a specified time period (usageDate |incompleteJobCount|Int64|The number of print jobs that were queued for the printer, but not completed.| |mediaSheetCount|Int64|The estimated number of media sheets printed based on reporting by the printer.| |pageCount|Int64|The estimated number of pages printed based on reporting by the printer.|-|printerID|String|The ID of the printer represented by these statistics.| +|printerId|String|The ID of the printer represented by these statistics.| |printerName|String|The name of the printer represented by these statistics.| |singleSidedSheetCount|Int64|The estimated number of single-sided media sheets printed based on reporting by the printer.| |usageDate|Date|The date associated with these statistics.| |
v1.0 | Privacyprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/privacyprofile.md | Title: "privacyProfile resource type" description: "Represents a company's privacy profile, which includes a privacy statement URL and a contact person for questions regarding the privacy statement." ms.localizationpriority: medium-+ doc_type: resourcePageType doc_type: resourcePageType Namespace: microsoft.graph -Represents a company's privacy profile, which includes a privacy statement URL and a contact person for questions regarding the privacy statement. +Represents a [company's](organization.md) privacy profile, which includes a privacy statement URL and a contact person for questions regarding the privacy statement. ## Properties | Property | Type|Description| Represents a company's privacy profile, which includes a privacy statement URL a ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 mana 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." ms.localizationpriority: medium -doc_type: resourcePageType Last updated 10/03/2023 Only the approver of the request can call the `/approval` and `/approvalStep` en - [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)- + <!-- { "type": "#page.annotation", "description": "Govern membership and ownership of groups using privileged identity management (PIM) for groups", |
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 ma 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." ms.localizationpriority: medium -doc_type: resourcePageType Last updated 09/13/2023 Privileged Identity Management (PIM) is a feature of [Microsoft Entra ID Governa 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 (ARM) APIs for PIM](/rest/api/authorization/privileged-role-eligibility-rest-sample). +> 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). For more information about using Microsoft Graph to configure rules, see [Overvi [!INCLUDE [zero-trust](../../../includes/identity-zero-trust.md)] <!-- End of: Link to ZT guidance -->-<!-- -## Permissions and privileges --To call the [Create roleAssignmentScheduleRequests](../api/rbacapplication-post-roleassignmentschedulerequests.md) and [Create roleEligibilityScheduleRequests](../api/rbacapplication-post-roleeligibilityschedulerequests.md) APIs with admin actions, the calling app must: -+ Have a *Global Administrator* or *Privileged Role Administrator* role -+ Be granted one of the following permissions: - + RoleAssignmentSchedule.ReadWrite.Directory - + RoleEligibilitySchedule.ReadWrite.Directory - + RoleManagement.ReadWrite.Directory --The app must also be assigned the appropriate permissions to retrieve their role assignments and eligibilities, or call the [Create roleAssignmentScheduleRequests](../api/rbacapplication-post-roleassignmentschedulerequests.md) and [Create roleEligibilityScheduleRequests](../api/rbacapplication-post-roleeligibilityschedulerequests.md) APIs with user actions. --For more information about permissions to call PIM APIs, see the [Microsoft Graph permissions reference: Role management permissions](/graph/permissions-reference#role-management-permissions). -> ## Licensing |
v1.0 | Profilephoto | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/profilephoto.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Project Rome Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/project-rome-overview.md | doc_type: conceptualPageType [Project Rome](https://developer.microsoft.com/en-us/windows/project-rome) is a Microsoft initiative to build a cross-device experiences platform. Project Rome enables an app on a local client or service to interact with apps and services on a remote host when the user signs in with the same Microsoft account that they use to sign in on the client device. This allows you to program cross-device and cross-platform experiences that are centered around user tasks rather than devices. -A key component is exposed via Microsoft Graph to enable these experiences: activities. +The following key capabilities are exposed via Microsoft Graph to help you enable cross-device experiences. ## Activities You can use the following Microsoft Graph APIs to create and retrieve user activ - [Create or replace a history item](../api/projectrome-put-historyitem.md) - [Delete a history item](../api/projectrome-delete-historyitem.md) +## Roaming data ++Access Windows data stored in the cloud via the cloud clipboard and Windows settings APIs. ++The Cloud Clipboard feature in Windows enables users to copy and paste items such as text, images, and links across their applications and devices. You can use the cloud clipboard APIs in Microsoft Graph to: ++- [List cloud clipboard items for the signed-in user](/graph//api/cloudclipboardroot-list-items) +- [Get a cloud clipboard item for a user](/graph/api/cloudclipboarditem-get) ++The Windows setting API in Microsoft Graph enables users and authorized third parties acting on behalf of users to retrieve their Windows operating system settings data stored in the Microsoft cloud. For details about using the Windows setting API, see [Use the Windows settings API](/graph/api/resources/windows-setting-api-overview). |
v1.0 | Projectrome Activity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/projectrome-activity.md | Title: "activity resource type" + Title: "userActivity resource type" description: "Represents a single activity within an app - for example, a TV show, a document, or a current campaign in a video game. When a user engages with that activity, the engagement is captured as a history item that indicates the start and end time for that activity. As the user re-engages with that activity over time, multiple history items are recorded for a single user activity." ms.localizationpriority: medium -# activity resource type +# userActivity resource type Namespace: microsoft.graph Your user activities will be showcased in Cortana and Windows Timeline user expe |Method | Return Type | Description| |:|:|:--|-|[Create or replace activity](../api/projectrome-put-activity.md) | [activity](projectrome-activity.md) |Creates or replaces an existing activity (upsert). The appActivityId needs to be URL-safe (all characters except for RFC 2396 unreserved characters must be converted to their hexadecimal representation), but the original appActivityId does not have to be URL-safe. | +|[Create or replace activity](../api/projectrome-put-activity.md) | [userActivity](projectrome-activity.md) |Creates or replaces an existing activity (upsert). The appActivityId needs to be URL-safe (all characters except for RFC 2396 unreserved characters must be converted to their hexadecimal representation), but the original appActivityId does not have to be URL-safe. | |[Delete an activity](../api/projectrome-delete-activity.md) | No Content | Deletes the specified activity for that user from your app.|-|[Get activities](../api/projectrome-get-activities.md) | Collection of [activities](projectrome-activity.md) | Gets the activities for your app for a given user.| -|[Get recent activities](../api/projectrome-get-recent-activities.md) | Collection of [activities](projectrome-activity.md) | Gets the most recent activities for your app for a given user, sorted and based on the most recently created or updated [historyItems](projectrome-historyitem.md).| +|[Get activities](../api/projectrome-get-activities.md) | Collection of [userActivities](projectrome-activity.md) | Gets the activities for your app for a given user.| +|[Get recent activities](../api/projectrome-get-recent-activities.md) | Collection of [userActivities](projectrome-activity.md) | Gets the most recent activities for your app for a given user, sorted and based on the most recently created or updated [activityHistoryItems](projectrome-historyitem.md).| ## Properties Your user activities will be showcased in Cortana and Windows Timeline user expe ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Projectrome Historyitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/projectrome-historyitem.md | Title: "historyItem resource type" + Title: "activityHistoryItem resource type" description: "Represents a history item for an activity in an app. User activities represent a single destination within your app." ms.localizationpriority: medium -# historyItem resource type +# activityHistoryItem resource type Namespace: microsoft.graph Represents a history item for an [activity](projectrome-activity.md) in an app. User activities represent a single destination within your app; for example, a TV show, a document, or a current campaign in a video game. When a user engages with that activity, the engagement is captured as a history item that indicates the start and end time for that activity. As the user re-engages with that activity over time, multiple history items are recorded for a single user activity. -When an app creates a session, a **historyItem** object should be added to the **activity** object to reflect the period of user engagement. Each time a user re-engages with an activity, a new **historyItem** is added to the activity to accrue user engagement. +When an app creates a session, a **activityHistoryItem** object should be added to the **activity** object to reflect the period of user engagement. Each time a user re-engages with an activity, a new **activityHistoryItem** is added to the activity to accrue user engagement. ## Methods |Method | Return Type | Description| |:|:|:--|-|[Create or replace historyItem](../api/projectrome-put-historyitem.md) | [historyItem](projectrome-historyitem.md) | Create or replace an existing **historyItem** for that activity (upsert). The ID needs to be a GUID.| -|[Delete a historyItem](../api/projectrome-delete-historyitem.md) | No Content | Delete the specified **historyItem** for that activity.| +|[Create or replace activityHistoryItem](../api/projectrome-put-historyitem.md) | [activityHistoryItem](projectrome-historyitem.md) | Create or replace an existing **activityHistoryItem** for that activity (upsert). The ID needs to be a GUID.| +|[Delete a activityHistoryItem](../api/projectrome-delete-historyitem.md) | No Content | Delete the specified **activityHistoryItem** for that activity.| ## Properties When an app creates a session, a **historyItem** object should be added to the * |:-|:--|:--| |activeDurationSeconds | int | Optional. The duration of active user engagement. if not supplied, this is calculated from the **startedDateTime** and **lastActiveDateTime**.| |createdDateTime | DateTimeOffset | Set by the server. DateTime in UTC when the object was created on the server.|-|expirationDateTime | DateTimeOffset | Optional. UTC DateTime when the **historyItem** will undergo hard-delete. Can be set by the client.| -|id | String | Required. Client-set GUID for the **historyItem** object.| -|lastActiveDateTime | DateTimeOffset | Optional. UTC DateTime when the **historyItem** (activity session) was last understood as active or finished - if null, **historyItem** status should be Ongoing.| +|expirationDateTime | DateTimeOffset | Optional. UTC DateTime when the **activityHistoryItem** will undergo hard-delete. Can be set by the client.| +|id | String | Required. Client-set GUID for the **activityHistoryItem** object.| +|lastActiveDateTime | DateTimeOffset | Optional. UTC DateTime when the **activityHistoryItem** (activity session) was last understood as active or finished - if null, **activityHistoryItem** status should be Ongoing.| |lastModifiedDateTime | DateTimeOffset | Set by the server. DateTime in UTC when the object was modified on the server.|-|startedDateTime | DateTimeOffset | Required. UTC DateTime when the **historyItem** (activity session) was started. Required for timeline history.| +|startedDateTime | DateTimeOffset | Required. UTC DateTime when the **activityHistoryItem** (activity session) was started. Required for timeline history.| |status | status | Set by the server. A status code used to identify valid objects. Values: active, updated, deleted, ignored.| |userTimezone | String | Optional. The timezone in which the user's device used to generate the activity was located at activity creation time. Values supplied as Olson IDs in order to support cross-platform representation.| |
v1.0 | Projectrome Imageinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/projectrome-imageinfo.md | A complex type for representing the **attribution** property in the [visualInfo] ## JSON Representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Provisionedidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/provisionedidentity.md | Describes the identity associated with the provisioning object summary event. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Provisionedplan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/provisionedplan.md | Title: "provisionedPlan resource type" -description: "The **provisionedPlans** property of the user entity and the organization entity is a collection of **provisionedPlan**." +description: "The provisionedPlans property of the user entity and the organization entity is a collection of provisionedPlan objects." ms.localizationpriority: medium-+ doc_type: resourcePageType doc_type: resourcePageType Namespace: microsoft.graph -The **provisionedPlans** property of the [user](user.md) entity and the [organization](organization.md) entity is a collection of **provisionedPlan**. +Used by the **provisionedPlans** property of the [user](user.md) entity and the [organization](organization.md) entity. ## Properties The **provisionedPlans** property of the [user](user.md) entity and the [organiz ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Provisioningerrorinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/provisioningerrorInfo.md | Describes the status of the provisioning event and the associated errors. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Provisioningserviceprincipal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/provisioningserviceprincipal.md | Represents the service principal used for provisioning. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Provisioningstatusinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/provisioningstatusinfo.md | Describes the status of the provisioning summary event. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Publicclientapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/publicclientapplication.md | Specifies settings for nonweb app or nonweb API (for example, mobile or other pu |redirectUris|String collection| Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Quota | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/quota.md | The **quota** resource provides details about space constraints on a [drive](dri ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/range.md | - Title: "Range resource type" -description: "Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc." ---doc_type: resourcePageType ---# Range resource type --Namespace: microsoft.graph --Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get Range](../api/range-get.md) | [Range](range.md) |Read properties and relationships of range object.| -|[Update](../api/range-update.md) | [Range](range.md) |Update Range object. | -|[Boundingrect](../api/range-boundingrect.md)|[Range](range.md)|Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16".| -|[Cell](../api/range-cell.md)|[Range](range.md)|Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range.| -|[Column](../api/range-column.md)|[Range](range.md)|Gets a column contained in the range.| -|[Columnsafter](../api/workbookrange-columnsafter.md)|[workbookRangeView](workbookrangeview.md)|Gets some columns to the right of the given range.| -|[Columnsbefore](../api/workbookrange-columnsbefore.md)|[workbookRangeView](workbookrangeview.md)|Gets some columns to the left of the given range.| -|[Entirecolumn](../api/range-entirecolumn.md)|[Range](range.md)|Gets an object that represents the entire column of the range.| -|[Entirerow](../api/range-entirerow.md)|[Range](range.md)|Gets an object that represents the entire row of the range.| -|[Intersection](../api/range-intersection.md)|[Range](range.md)|Gets the range object that represents the rectangular intersection of the given ranges.| -|[Lastcell](../api/range-lastcell.md)|[Range](range.md)|Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5".| -|[Lastcolumn](../api/range-lastcolumn.md)|[Range](range.md)|Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5".| -|[Lastrow](../api/range-lastrow.md)|[Range](range.md)|Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5".| -|[Offsetrange](../api/range-offsetrange.md)|[Range](range.md)|Gets an object that represents a range that's offset from the specified range. The dimension of the returned range matches this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception is thrown.| -|[Row](../api/range-row.md)|[Range](range.md)|Gets a row contained in the range.| -|[Rowsabove](../api/workbookrange-rowsabove.md)|[workbookRangeView](workbookrangeview.md)|Gets some rows above a given range.| -|[Rowsbelow](../api/workbookrange-rowsbelow.md)|[workbookRangeView](workbookrangeview.md)|Gets some rows below a given range.| -|[Usedrange](../api/range-usedrange.md)|[Range](range.md)|Returns the used range of the given range object.| -|[Clear](../api/range-clear.md)|None|Clear range values, format, fill, border, etc.| -|[Delete](../api/range-delete.md)|None|Deletes the cells associated with the range.| -|[Insert](../api/range-insert.md)|[Range](range.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.| -|[Merge](../api/range-merge.md)|None|Merge the range cells into one region in the worksheet.| -|[Resizedrange](../api/workbookrange-resizedrange.md)|[workbookRangeView](workbookrangeview.md)|Gets a range object similar to the current range object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns.| -|[Unmerge](../api/range-unmerge.md)|None|Unmerge the range cells into separate cells.| -|[Visibleview](../api/workbookrange-visibleview.md)|[workbookRangeView](workbookrangeview.md)|Get the range visible from a filtered range.| --## Properties -| Property | Type |Description| -|:|:--|:-| -|address|string|Represents the range reference in A1-style. Address value contains the Sheet reference (for example, Sheet1!A1:B4). Read-only.| -|addressLocal|string|Represents range reference for the specified range in the language of the user. Read-only.| -|cellCount|int|Number of cells in the range. Read-only.| -|columnCount|int|Represents the total number of columns in the range. Read-only.| -|columnHidden|boolean|Represents if all columns of the current range are hidden.| -|columnIndex|int|Represents the column number of the first cell in the range. Zero-indexed. Read-only.| -|formulas|Json|Represents the formula in A1-style notation.| -|formulasLocal|Json|Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German.| -|formulasR1C1|Json|Represents the formula in R1C1-style notation.| -|hidden|boolean|Represents if all cells of the current range are hidden. Read-only.| -|numberFormat|Json|Represents Excel's number format code for the given cell.| -|rowCount|int|Returns the total number of rows in the range. Read-only.| -|rowHidden|boolean|Represents if all rows of the current range are hidden.| -|rowIndex|int|Returns the row number of the first cell in the range. Zero-indexed. Read-only.| -|text|Json|Text values of the specified range. The Text value doesn't depend on the cell width. The # sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only.| -|valueTypes|Json|Represents the type of data of each cell. The possible values are: `Unknown`, `Empty`, `String`, `Integer`, `Double`, `Boolean`, `Error`. Read-only.| -|values|Json|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|format|[WorkbookRangeFormat](rangeformat.md)|Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Read-only.| -|sort|[WorkbookRangeSort](rangesort.md)|The worksheet containing the current range. Read-only.| -|worksheet|[WorkbookWorksheet](worksheet.md)|The worksheet containing the current range. Read-only.| --## JSON representation --Here's a JSON representation of the resource. --<!-- { - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [ -- ], - "@odata.type": "microsoft.graph.workbookRange" -}--> --```json -{ - "address": "string", - "addressLocal": "string", - "cellCount": 1024, - "columnCount": 1024, - "columnHidden": true, - "columnIndex": 1024, - "formulas": "json", - "formulasLocal": "json", - "formulasR1C1": "json", - "hidden": true, - "numberFormat": "json", - "rowCount": 1024, - "rowHidden": true, - "rowIndex": 1024, - "text": "json", - "valueTypes": "string", - "values": "json" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "Range resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Rangeborder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/rangeborder.md | - Title: "RangeBorder resource type" -description: "Represents the border of an object." ---doc_type: resourcePageType ---# RangeBorder resource type --Namespace: microsoft.graph --Represents the border of an object. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get RangeBorder](../api/rangeborder-get.md) | [WorkbookRangeBorder](rangeborder.md) |Read properties and relationships of rangeBorder object.| -|[Update](../api/rangeborder-update.md) | [WorkbookRangeBorder](rangeborder.md) |Update RangeBorder object. | -|[List](../api/rangeborder-list.md) | [WorkbookRangeBorder](rangeborder.md) collection |Get rangeBorder object collection. | -|[Itemat](../api/rangebordercollection-itemat.md)|[WorkbookRangeBorder](rangeborder.md)|Gets a border object using its index| --## Properties -| Property | Type |Description| -|:|:--|:-| -|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (for example "FFA500") or as a named HTML color (for example "orange").| -|id|string|Represents border identifier. The possible values are: `EdgeTop`, `EdgeBottom`, `EdgeLeft`, `EdgeRight`, `InsideVertical`, `InsideHorizontal`, `DiagonalDown`, `DiagonalUp`. Read-only.| -|sideIndex|string|Constant value that indicates the specific side of the border. The possible values are: `EdgeTop`, `EdgeBottom`, `EdgeLeft`, `EdgeRight`, `InsideVertical`, `InsideHorizontal`, `DiagonalDown`, `DiagonalUp`. Read-only.| -|style|string|One of the constants of line style specifying the line style for the border. The possible values are: `None`, `Continuous`, `Dash`, `DashDot`, `DashDotDot`, `Dot`, `Double`, `SlantDashDot`.| -|weight|string|Specifies the weight of the border around a range. The possible values are: `Hairline`, `Thin`, `Medium`, `Thick`.| --## Relationships -None ---## JSON representation --Here's a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookRangeBorder" -}--> --```json -{ - "color": "string", - "id": "string", - "sideIndex": "string", - "style": "string", - "weight": "string" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "RangeBorder resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Rangefill | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/rangefill.md | - Title: "RangeFill resource type" -description: "Represents the background of a range object." ---doc_type: resourcePageType ---# RangeFill resource type --Namespace: microsoft.graph --Represents the background of a range object. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get RangeFill](../api/rangefill-get.md) | [WorkbookRangeFill](rangefill.md) |Read properties and relationships of rangeFill object.| -|[Update](../api/rangefill-update.md) | [WorkbookRangeFill](rangefill.md) |Update RangeFill object. | -|[Clear](../api/rangefill-clear.md)|None|Resets the range background.| --## Properties -| Property | Type |Description| -|:|:--|:-| -|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (for example "FFA500") or as a named HTML color (for example "orange")| --## Relationships -None ---## JSON representation --Here's a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookRangeFill" -}--> --```json -{ - "color": "string" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "RangeFill resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Rangefont | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/rangefont.md | - Title: "RangeFont resource type" -description: "This object represents the font attributes (font name, font size, color, etc.) for an object." ---doc_type: resourcePageType ---# RangeFont resource type --Namespace: microsoft.graph --This object represents the font attributes (font name, font size, color, etc.) for an object. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get RangeFont](../api/rangefont-get.md) | [WorkbookRangeFont](rangefont.md) |Read properties and relationships of rangeFont object.| -|[Update](../api/rangefont-update.md) | [WorkbookRangeFont](rangefont.md) |Update RangeFont object. | --## Properties -| Property | Type |Description| -|:|:--|:-| -|bold|boolean|Represents the bold status of font.| -|color|string|HTML color code representation of the text color. for example #FF0000 represents Red.| -|italic|boolean|Represents the italic status of the font.| -|name|string|Font name (for example "Calibri")| -|size|double|Font size.| -|underline|string|Type of underline applied to the font. The possible values are: `None`, `Single`, `Double`, `SingleAccountant`, `DoubleAccountant`.| --## Relationships -None ---## JSON representation --Here's a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookRangeFont" -}--> --```json -{ - "bold": true, - "color": "string", - "italic": true, - "name": "string", - "size": 1024, - "underline": "string" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "RangeFont resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Rangeformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/rangeformat.md | - Title: "RangeFormat resource type" -description: "A format object encapsulating the range's font, fill, borders, alignment, and other properties." ---doc_type: resourcePageType ---# RangeFormat resource type --Namespace: microsoft.graph --A format object encapsulating the range's font, fill, borders, alignment, and other properties. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get RangeFormat](../api/rangeformat-get.md) | [WorkbookRangeFormat](rangeformat.md) |Read properties and relationships of rangeFormat object.| -|[Create RangeBorder](../api/rangeformat-post-borders.md) |[WorkbookRangeBorder](rangeborder.md)| Create a new RangeBorder by posting to the borders collection.| -|[List borders](../api/rangeformat-list-borders.md) |[WorkbookRangeBorder](rangeborder.md) collection| Get a RangeBorder object collection.| -|[Update](../api/rangeformat-update.md) | [WorkbookRangeFormat](rangeformat.md) |Update RangeFormat object. | -|[Autofitcolumns](../api/rangeformat-autofitcolumns.md)|None|Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.| -|[Autofitrows](../api/rangeformat-autofitrows.md)|None|Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.| --## Properties -| Property | Type |Description| -|:|:--|:-| -|columnWidth|double|Gets or sets the width of all columns within the range. If the column widths aren't uniform, null will be returned.| -|horizontalAlignment|string|Represents the horizontal alignment for the specified object. The possible values are: `General`, `Left`, `Center`, `Right`, `Fill`, `Justify`, `CenterAcrossSelection`, `Distributed`.| -|rowHeight|double|Gets or sets the height of all rows in the range. If the row heights aren't uniform null will be returned.| -|verticalAlignment|string|Represents the vertical alignment for the specified object. The possible values are: `Top`, `Center`, `Bottom`, `Justify`, `Distributed`.| -|wrapText|boolean|Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|borders|[WorkbookRangeBorder](rangeborder.md) collection|Collection of border objects that apply to the overall range selected Read-only.| -|fill|[WorkbookRangeFill](rangefill.md)|Returns the fill object defined on the overall range. Read-only.| -|font|[WorkbookRangeFont](rangefont.md)|Returns the font object defined on the overall range selected Read-only.| -|protection|[WorkbookFormatProtection](formatprotection.md)|Returns the format protection object for a range. Read-only.| --## JSON representation --Here's a JSON representation of the resource. --<!-- { - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [ -- ], - "@odata.type": "microsoft.graph.workbookRangeFormat" -}--> --```json -{ - "columnWidth": 1024, - "horizontalAlignment": "string", - "rowHeight": 1024, - "verticalAlignment": "string", - "wrapText": true -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "RangeFormat resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Rangesort | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/rangesort.md | - Title: "RangeSort resource type" -description: "Manages sorting operations on Range objects." ---doc_type: resourcePageType ---# RangeSort resource type --Namespace: microsoft.graph --Manages sorting operations on Range objects. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Apply](../api/rangesort-apply.md)|None|Perform a sort operation.| --## Properties -None --## Relationships -None --## JSON representation --Here is a JSON representation of the resource. ---<!-- { - "blockType": "resource", - "baseType": "microsoft.graph.entity", - "optionalProperties": [ -- ], - "@odata.type": "microsoft.graph.workbookRangeSort" -}--> --```json -{ -} -``` --##### Request -The following example shows a request. ---<!--{ - "blockType": "request", - "name": "range_sort" -}--> -```msgraph-interactive -GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/sort -``` --##### Response -The following example shows the response. -<!-- { - "blockType": "response", - "truncated": true, - "@odata.type": "microsoft.graph.workbookRangeSort" -} --> -```http -HTTP/1.1 200 OK -Content-Type: application/json --{ -} -``` ---<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "RangeSort resource", - "keywords": "", - "section": "documentation", - "tocPath": "", - "suppressions": [ - ] -}--> - |
v1.0 | Reactionsfacet | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/reactionsfacet.md | + + Title: 'reactionsFacet resource type' +description: Provides counts of user reactions (likes, comments, and shares). ++ms.localizationpriority: medium +++# reactionsFacet resource type ++Namespace: microsoft.graph ++++Provides counts of user reactions (likes, comments, and shares). ++## Properties ++| Property | Type | Description | +| :-- | :- | :-- | +| commentCount | Int32 | Count of comments. | +| likeCount | Int32 | Count of likes. | +| shareCount | Int32 | Count of shares. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.reactionsFacet" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.reactionsFacet", + "likeCount": "Integer", + "commentCount": "Integer", + "shareCount": "Integer" +} +``` |
v1.0 | Recipient | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/recipient.md | Represents information about a user in the sending or receiving end of an event, ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Recordoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/recordoperation.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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**. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Referenceattachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/referenceattachment.md | None ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Relyingpartydetailedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/relyingpartydetailedsummary.md | + + Title: "relyingPartyDetailedSummary resource type" +description: "Represents the summary of AD FS relying parties' information on daily, weekly, or monthly frequency." ++ms.localizationpriority: medium ++++# relyingPartyDetailedSummary resource type ++Namespace: microsoft.graph ++Represents the summary of AD FS relying parties' information on daily, weekly, or monthly frequency. +++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List relyingPartyDetailedSummary](../api/reportroot-getrelyingpartydetailedsummary.md)| [relyingPartyDetailedSummary](../resources/relyingpartydetailedsummary.md) collection|Get a summary of AD FS relying parties information.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|failedSignInCount|Int64|Number of failed sign ins on AD FS in the period specified.<br/><br/> Supports `$orderby`, `$filter` (`eq`).| +|id|String|Unique identifier for the report. Inherited from [entity](../resources/entity.md).| +|migrationStatus|migrationStatus|Indicates whether the app can be easily moved to Entra ID. The possible values are: `ready`, `needsReview`, `additionalStepsRequired`, `unknownFutureValue`.<br/><br/> Supports `$orderby`, `$filter` (`eq`).| +|migrationValidationDetails|[keyValuePair](../resources/keyvaluepair.md) collection|Specifies all the validations checks done on applications config details.| +|relyingPartyId|String|Identifies the relying party to this federation service. It's used when issuing claims to the relying party.<br/><br/> Supports `$orderby`, `$filter` (`eq`).| +|relyingPartyName|String|Name of the relying party's website or other entity on the Internet that uses an identity provider to authenticate a user who wants to log in.<br/><br/> Supports `$orderby`, `$filter` (`eq`).| +|replyUrls|String collection|Specifies where the relying party expects to receive the token.| +|serviceId|String|Uniquely identifies the Active Directory forest.<br/><br/> Supports `$orderby`, `$filter` (`eq`).| +|signInSuccessRate|Double|Calculated as `Number of successful / (Number of successful + Number of failed sign ins)` or `successfulSignInCount / totalSignInCount` on AD FS in the period specified.<br/><br/> Supports `$orderby`, `$filter` (`eq`).| +|successfulSignInCount|Int64|Number of successful sign ins on AD FS.<br/><br/> Supports `$orderby`, `$filter` (`eq`).| +|totalSignInCount|Int64|Number of successful + failed sign ins on AD FS in the period specified.<br/><br/> Supports `$orderby`, `$filter` (`eq`).| +|uniqueUserCount|Int64|Number of unique users that signed into the application.<br/><br/> Supports `$orderby`, `$filter` (`eq`).| +++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.relyingPartyDetailedSummary", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.relyingPartyDetailedSummary", + "id": "String (identifier)", + "relyingPartyId": "String", + "serviceId": "String", + "relyingPartyName": "String", + "successfulSignInCount": "Integer", + "failedSignInCount": "Integer", + "totalSignInCount": "Integer", + "signInSuccessRate": "Double", + "uniqueUserCount": "Integer", + "migrationStatus": "String", + "migrationValidationDetails": [ + { + "@odata.type": "microsoft.graph.keyValuePair" + } + ], + "replyUrls": [ + "String" + ] +} +``` + |
v1.0 | Reminder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/reminder.md | A reminder for an [event](event.md) in a user [calendar](calendar.md). ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Removeaccessapplyaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/removeaccessapplyaction.md | None. 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.removeAccessApplyAction" |
v1.0 | Report M365defender Reports Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/report-m365defender-reports-overview.md | Title: "Reports API overview for attack simulation training as part of Microsoft description: "This section describes reporting capabilities of Microsoft Defender for Office 365, specifically APIs that access reports on a tenant's participation in attack simulation training." ms.localizationpriority: high -doc_type: resourcePageType # Reports API overview for attack simulation training as part of Microsoft Defender for Office 365 |
v1.0 | Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/report.md | doc_type: conceptualPageType # Working with Microsoft 365 usage reports in Microsoft Graph -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 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 365 activations](/graph/api/resources/office-365-activations-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Microsoft 365 active users](/graph/api/resources/office-365-active-users-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Microsoft 365 Apps usage](/graph/api/resources/microsoft-365-apps-usage-report?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Microsoft 365 groups activity](/graph/api/resources/office-365-groups-activity-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Microsoft Teams device usage](/graph/api/resources/microsoft-teams-device-usage-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Microsoft Teams team usage](/graph/api/resources/microsoft-teams-team-usage-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Microsoft Teams user activity](/graph/api/resources/microsoft-teams-user-activity-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Outlook activity](/graph/api/resources/email-activity-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Outlook app usage](/graph/api/resources/email-app-usage-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Outlook mailbox usage](/graph/api/resources/mailbox-usage-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [OneDrive activity](/graph/api/resources/onedrive-activity-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [OneDrive usage](/graph/api/resources/onedrive-usage-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [SharePoint activity](/graph/api/resources/sharepoint-activity-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [SharePoint site usage](/graph/api/resources/sharepoint-site-usage-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Skype for Business activity](/graph/api/resources/skype-for-business-activity-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Skype for Business device usage](/graph/api/resources/skype-for-business-device-usage-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Skype for Business organizer activity](/graph/api/resources/skype-for-business-organizer-activity-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Skype for Business participant activity](/graph/api/resources/skype-for-business-participant-activity-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Skype for Business peer-to-peer activity](/graph/api/resources/skype-for-business-peer-to-peer-activity?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Yammer activity](/graph/api/resources/yammer-activity-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Yammer device usage](/graph/api/resources/yammer-device-usage-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | -| [Yammer groups activity](/graph/api/resources/yammer-groups-activity-reports?view=graph-rest-1.0&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | +| APIs | Microsoft Graph global service | Microsoft Cloud for US Government | Microsoft Cloud China operated by 21Vianet | +| - | | -| | +| [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) | Γ£ö | Γ₧û | Γ₧û | +| [Microsoft 365 groups activity](reportroot.md#microsoft-365-groups-activity) | Γ£ö | Γ₧û | Γ₧û | +| [Microsoft Teams device usage](reportroot.md#microsoft-teams-device-usage) | Γ£ö | Γ₧û | Γ₧û | +| [Microsoft Teams team activity](reportroot.md#microsoft-teams-team-activity) | Γ£ö | Γ₧û | Γ₧û | +| [Microsoft Teams user activity](reportroot.md#microsoft-teams-user-activity) | Γ£ö | Γ₧û | Γ₧û | +| [Outlook activity](reportroot.md#outlook-activity) | Γ£ö | Γ₧û | Γ₧û | +| [Outlook app usage](reportroot.md#outlook-app-usage) | Γ£ö | Γ₧û | Γ₧û | +| [Outlook mailbox usage](reportroot.md#outlook-mailbox-usage) | Γ£ö | Γ₧û | Γ₧û | +| [OneDrive activity](reportroot.md#onedrive-activity) | Γ£ö | Γ₧û | Γ₧û | +| [OneDrive usage](reportroot.md#onedrive-usage) | Γ£ö | Γ₧û | Γ₧û | +| [SharePoint activity](reportroot.md#sharepoint-activity) | Γ£ö | Γ₧û | Γ₧û | +| [SharePoint site usage](reportroot.md#sharepoint-site-usage) | Γ£ö | Γ₧û | Γ₧û | +| [Skype for Business activity](reportroot.md#skype-for-business-activity) | Γ£ö | Γ₧û | Γ₧û | +| [Skype for Business device usage](reportroot.md#skype-for-business-device-usage) | Γ£ö | Γ₧û | Γ₧û | +| [Skype for Business organizer activity](reportroot.md#skype-for-business-organizer-activity) | Γ£ö | Γ₧û | Γ₧û | +| [Skype for Business participant activity](reportroot.md#skype-for-business-participant-activity) | Γ£ö | Γ₧û | Γ₧û | +| [Skype for Business peer-to-peer activity](reportroot.md#skype-for-business-peer-to-peer-activity) | Γ£ö | Γ₧û | Γ₧û | +| [Viva Engage activity](reportroot.md#viva-engage-activity) | Γ£ö | Γ₧û | Γ₧û | +| [Viva Engage device usage](reportroot.md#viva-engage-device-usage) | Γ£ö | Γ₧û | Γ₧û | +| [Viva Engage groups activity](reportroot.md#viva-engage-groups-activity) | Γ£ö | Γ₧û | Γ₧û | ## Next steps |
v1.0 | Reportroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/reportroot.md | Title: "reportRoot resource type" -description: "Represents a container for Microsoft Entra reporting resources." -+ Title: reportRoot resource type +description: Represents a container for Microsoft Entra and Microsoft 365 reporting resources. + doc_type: resourcePageType doc_type: resourcePageType Namespace: microsoft.graph -Represents a container for Microsoft Entra reporting resources. +Represents a container for Microsoft Entra and Microsoft 365 reporting resources. ## Methods -| Method | Return type | Description | -| :- | : | : | -| [List userRegistrationDetails](../api/authenticationmethodsroot-list-userregistrationdetails.md) | [userRegistrationDetails](../resources/userregistrationdetails.md) collection | Get the state of authentication methods of all users in the tenant. | -| [Get userRegistrationDetails](../api/userregistrationdetails-get.md) | [userRegistrationDetails](../resources/userregistrationdetails.md) collection | Get the state of authentication methods of a user in the tenant. | +### 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 distribution user counts](../api/reportroot-getteamsdeviceusagedistributionusercounts.md) | Stream | Get the number of unique users by device type over 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 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. | ++### 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. | +| [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. | ++### 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. | +| [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. | +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | +| [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. | ++### 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 | +|:|:|:--| +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | +| [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. | +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | ++### 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. | +| [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. | ++### 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 | +|:|:|:--| +| [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. | ++### 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. | +| [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. | ## Properties None. ## Relationships -| Relationship | Type | Description | -|:|:|:-| -| authenticationMethods | [authenticationMethodsRoot](../resources/authenticationmethodsroot.md) | Container for navigation properties for Microsoft Entra authentication methods resources. | -| dailyPrintUsageByPrinter | [printUsageByPrinter](../resources/printusagebyprinter.md) collection | Retrieve a list of daily print usage summaries, grouped by printer. | -| dailyPrintUsageByUser | [printUsageByUser](../resources/printusagebyuser.md) collection | Retrieve a list of daily print usage summaries, grouped by user. | -| monthlyPrintUsageByPrinter | [printUsageByPrinter](../resources/printusagebyprinter.md) collection | Retrieve a list of monthly print usage summaries, grouped by printer. | -| monthlyPrintUsageByUser | [printUsageByUser](../resources/printusagebyuser.md) collection | Retrieve a list of monthly print usage summaries, grouped by user. | -| security | [securityReportsRoot](../resources/securityreportsroot.md) | Represents an abstract type that contains resources for attack simulation and training reports. | -| partners | [partners](../resources/partners.md) | Represents billing details for a Microsoft direct partner. | +| Relationship | Type | Description | +|:|:-|:-| +| authenticationMethods | [authenticationMethodsRoot](authenticationmethodsroot.md) | Container for navigation properties for Microsoft Entra authentication methods resources. | +| 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. | +| security | [securityReportsRoot](securityreportsroot.md) | Represents an abstract type that contains resources for attack simulation and training reports. | ## JSON representation |
v1.0 | Requestormanager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/requestormanager.md | It's a subtype of [subjectSet](subjectset.md), in which the `@odata.type` value ## 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.requestorManager", |
v1.0 | Requestschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/requestschedule.md | In [PIM for Microsoft Entra roles](privilegedidentitymanagementv3-overview.md) a 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.requestSchedule" |
v1.0 | Requiredresourceaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/requiredresourceaccess.md | Specifies the set of OAuth 2.0 permission scopes and app roles under the specifi ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Resourcedata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/resourcedata.md | description: "Represents the resouce data attached to the change notification se ms.localizationpriority: medium doc_type: resourcePageType+ # resourceData resource type |
v1.0 | Resultinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/resultinfo.md | The subcodes provide supplementary information related to the type of success or ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Resulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/resulttemplate.md | The following is a JSON representation of the resource. ```json {- "resultTemplateId": { - "displayName": "String", - "body":{ + "displayName": "String", + "body":{ "@odata.type":"microsoft.graph.Json" }- } } ``` |
v1.0 | Riskdetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/riskdetection.md | Title: "riskDetection resource type" -description: "risk detections" +description: "Represents all risk detections in a Microsoft Entra tenant." ms.localizationpriority: medium For more information about risk detection, see [Microsoft Entra ID Protection](/ |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`.|-|riskEventType|String|The type of risk event detected. The possible values are `adminConfirmedUserCompromised`, `anomalousToken`, `anomalousUserActivity`, `anonymizedIPAddress`, `generic`, `impossibleTravel`, `investigationsThreatIntelligence`, `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).| +|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`.| |source|String|Source of the risk detection. For example, `activeDirectory`. | |
v1.0 | Riskserviceprincipalactivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/riskserviceprincipalactivity.md | Represents the risk activity of a Microsoft Entra service principal as determine | Property | Type |Description| |:|:--|:-| | detail | 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 collection|The type of risk event detected. The possible values are: `investigationsThreatIntelligence`, `generic`, `adminConfirmedServicePrincipalCompromised`, `suspiciousSignins`, `leakedCredentials`, `anomalousServicePrincipalActivity`, `maliciousApplication`, `suspiciousApplication`.| +| riskEventTypes|String collection|The type of risk event detected. The possible values are: `investigationsThreatIntelligence`, `generic`, `adminConfirmedServicePrincipalCompromised`, `suspiciousSignins`, `leakedCredentials`, `anomalousServicePrincipalActivity`, `maliciousApplication`, `suspiciousApplication`.| ## JSON representation |
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 ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Samlsinglesignonsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/samlsinglesignonsettings.md | Represents a container for settings related to SAML single sign-on. ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Schemaextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/schemaextension.md | Title: "schemaExtension resource type (schema extensions)" description: "Schema extensions allow you to define a schema to extend and add strongly-typed custom data to a resource type. The custom data appears as a complex type on the extended resource. " ms.localizationpriority: high + doc_type: resourcePageType The owner app can move the extension through different states of a lifecycle, us ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
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. 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." ms.localizationpriority: medium doc_type: resourcePageType None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ ],- "@odata.type": "microsoft.graph.scopedRoleMembership" + "@odata.type": "microsoft.graph.scopedRoleMembership", + "baseType": "microsoft.graph.entity" }--> ```json |
v1.0 | Scoredemailaddress | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/scoredemailaddress.md | Represents a scored email address. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Search Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/search-api-overview.md | Title: "Use the Microsoft Search API to query data" description: "Using the search API, apps can search Microsoft 365 data in the context of the authenticated user" ms.localizationpriority: high -doc_type: resourcePageType # Use the Microsoft Search API to query data Control pagination of the search results by specifying the following two propert Note the following limits if you're searching the **event** or **message** entity: - **from** must start at zero in the first page request; otherwise, the request results in an HTTP 400 `Bad request`.-- The maximum number of results per page (**size**) is 25 for **message** and **event**. +- The maximum number of results per page (**size**) is 25 for **message** and **event**. The upper limit for SharePoint or OneDrive items is 1000. A reasonable page size is 200. A larger page size generally incurs higher latency. Note that collapsing results is currently supported for the following entity typ To use the collapse clause effectively, the properties you apply it to must be queryable, and either sortable or refinable. When using multi-level collapse, it's important to note that each subsequent property's limit size specified in a multi-level request should be equal to or smaller than the previous one. If a subsequent property's limit size exceeds the previous one, the server will respond with an `HTTP 400 Bad Request` error. -See [collapse search results](/graph/search-concept-collapse) for more collapse results examples. +See [collapse search results](/graph/search-concept-collapse) for more collapse results examples. ## Sort search results The search API has the following limitations: | externalItem | - | - | - | - | True | True | - | True | True | True | - | - | True | | list | - | - | - | - | True | True | - | True | True | True | - | - | True | | listItem | - | - | - | - | True | True | - | True | True | True | - | - | True |- | message | - | - | True | - | - | - | - | - | - | - | - | - | - | + | message | - | - | True | - | - | - | - | - | - | - | - | - | - | | person | - | - | - | - | - | - | - | - | - | - | True | - | - | | qna | True | True | - | - | - | - | - | - | - | - | - | True | - | | site | - | - | - | - | True | True | - | True | True | True | - | - | True | |
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. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Section | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/section.md | Title: "section resource type" + Title: "onenoteSection resource type" description: "A section in a OneNote notebook. Sections can contain pages." ms.localizationpriority: medium -# section resource type +# onenoteSection resource type Namespace: microsoft.graph A section in a OneNote notebook. Sections can contain pages. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sectiongroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sectiongroup.md | A section group in a OneNote notebook. Section groups can contain sections and s ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sectionlinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sectionlinks.md | Links for opening a OneNote section. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Securescorecontrolprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/securescorecontrolprofile.md | Represents a tenant's secure score per control data. By default, this resource r |remediation|String|Description of what the control will help remediate.| |remediationImpact|String|Description of the impact on users of the remediation.| |service|String|Service that owns the control (Exchange, Sharepoint, Microsoft Entra ID).|-|threats|String collection|List of threats the control mitigates (accountBreach, dataDeletion, dataExfiltration, dataSpillage, -elevationOfPrivilege, maliciousInsider, passwordCracking, phishingOrWhaling, spoofing).| +|threats|String collection|List of threats the control mitigates (accountBreach, dataDeletion, dataExfiltration, dataSpillage, elevationOfPrivilege, maliciousInsider, passwordCracking, phishingOrWhaling, spoofing).| |tier|String|Control tier (Core, Defense in Depth, Advanced.) | |title|String|Title of the control.| |userImpact|String|User impact of implementing control (low, moderate, high). | |
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 |actorDisplayName|String| The adversary or activity group that is associated with this alert.| |additionalData|microsoft.graph.security.dictionary| A collection of other alert properties, including user-defined properties. Any custom details defined in the alert, and any dynamic content in the alert details, are stored here.| |alertWebUrl|String| URL for the Microsoft 365 Defender portal alert page.| |alertPolicyId|String| The ID of the policy that generated the alert, and populated when there is a specific policy that generated the alert, whether configured by a customer or a built-in policy.|+|alertWebUrl|String|URL for the Microsoft 365 Defender portal alert page.| |assignedTo|String| Owner of the **alert**, or null if no owner is assigned.| |category|String| The attack kill-chain category that the alert belongs to. Aligned with the MITRE ATT&CK framework.| |classification|[microsoft.graph.security.alertClassification](#alertclassification-values)| Specifies whether the alert represents a true threat. Possible values are: `unknown`, `falsePositive`, `truePositive`, `informationalExpectedActivity`, `unknownFutureValue`.| When a security provider detects a threat, it creates an alert in the system. Mi |lastActivityDateTime|DateTimeOffset| The oldest activity associated with the alert.| |lastUpdateDateTime|DateTimeOffset| Time when the alert was last updated at Microsoft 365 Defender.| |mitreTechniques|Collection(Edm.String)| The attack techniques, as aligned with the MITRE ATT&CK framework.|+|productName|String|The name of the product which published this alert.| |providerAlertId|String| The ID of the alert as it appears in the security provider product that generated the alert.| |recommendedActions|String| Recommended response and remediation actions to take in the event this alert was generated.| |resolvedDateTime|DateTimeOffset| Time when the alert was resolved.| When a security provider detects a threat, it creates an alert in the system. Mi None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Alertevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-alertevidence.md | This resource is the base type for the following evidence types: 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.security.alertEvidence" |
v1.0 | Security Analyzedmessageevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-analyzedmessageevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.analyzedMessageEvidence" + "@odata.type": "microsoft.graph.security.analyzedMessageEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-api-overview.md | Alerts from the following security providers are available via these rich alerts ### Legacy alerts -These [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. +> [!NOTE] +> The legacy alerts API is deprecated and will be removed by April 2026. We recommend that you migrate to the new [alerts and incidents](/graph/api/resources/security-alert) API. ++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. 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 this **alert** resource. Support for GET alerts, PATCH alerts, and subscribe (via webhooks) is indicated in the following table. +Alerts from the following providers are available via the **alert** resource. Support for GET alerts, PATCH alerts, and subscribe (via webhooks) is indicated in the following table. | Security provider | <p align="center">GET alert</p>| <p align="center">PATCH alert</p>| <p align="center">Subscribe to alert</p>| |:|:|:--|:| Alerts from the following providers are available via this **alert** resource. S \*\* 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 Identity alerts are available via the Microsoft Defender for Cloud Apps integration. This means you will 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). +\*\*\* 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). ## Attack simulation and training TheΓÇ» [incident](security-incident.md) resource and its APIs allow you to sort 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. ++ ## Secure Score [Microsoft Secure Score](https://techcommunity.microsoft.com/t5/Security-Privacy-and-Compliance/A-new-home-and-an-all-new-look-for-Microsoft-Secure-Score/ba-p/529641) is a security analytics solution that gives you visibility into your security portfolio and how to improve it. With a single score, you can better understand what you did to reduce your risk in Microsoft solutions. You can also compare your score with other organizations and see how your score has been trending over time. The Microsoft Graph security [secureScore](securescore.md) and [secureScoreControlProfile](securescorecontrolprofile.md) entities help you balance your organization's security and productivity needs while enabling the appropriate mix of security features. You can also project what your score would be after you adopt security features. The threat intelligence APIs allow you to operationalize intelligence found with ## Common use cases -The following are some of the most popular requests for working with the Microsoft Graph security API: +The following are some of the most popular requests for working with the Microsoft Graph security API. | **Use cases** | **REST resources** | **Try it in Graph Explorer** | |:|:--|:-| |
v1.0 | Security Authoritytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-authoritytemplate.md | + + Title: "authorityTemplate resource type" +description: "Specifies the underlying authority that describes the type of content to be retained and its retention schedule." ++ms.localizationpriority: medium +++# authorityTemplate resource type ++Namespace: microsoft.graph.security ++Specifies the underlying authority that describes the type of content to be retained and its retention schedule. This resource supports CRUD operations to apply and manage the [filePlanAuthority](security-fileplanauthority.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **authority** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. ++Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List authorities](../api/security-labelsroot-list-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Get a list of the [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) objects and their properties.| +|[Create authorities](../api/security-labelsroot-post-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Create a new [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.| +|[Get authorities](../api/security-authoritytemplate-get.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.| +|[Delete authorities](../api/security-labelsroot-delete-authorities.md)|None|Delete a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the authority descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the authority descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the authority. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.authorityTemplate", + "baseType": "microsoft.graph.security.filePlanDescriptor", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + |
v1.0 | Security Azureresourceevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-azureresourceevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.azureResourceEvidence" + "@odata.type": "microsoft.graph.security.azureResourceEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json The following is a JSON representation of the resource. "resourceType": "String", "roles": ["String"], "tags": ["String"],- "type": "String", "verdict": "String" } ``` |
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). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Categorytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-categorytemplate.md | + + Title: "categoryTemplate resource type" +description: "Specifies a group of similar types of content in a particular department." ++ms.localizationpriority: medium +++# categoryTemplate resource type ++Namespace: microsoft.graph.security ++Specifies a group of similar types of content in a particular department. This resource supports CRUD operations to apply and manage the [filePlanAppliedCategory](security-fileplanappliedcategory.md) descriptor, and any [filePlanSubcategory](security-fileplansubcategory.md) descriptor for a [retentionLabel](security-retentionlabel.md). These file plan descriptors supplement a retention label to improve the manageability and organization of Microsoft 365 content. ++Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List categories](../api/security-labelsroot-list-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Get a list of the [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) objects and their properties.| +|[Create categories](../api/security-labelsroot-post-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Create a new [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.| +|[Get categories](../api/security-categorytemplate-get.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.| +|[Delete categories](../api/security-labelsroot-delete-categories.md)|None|Delete a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.| +|[List subcategories](../api/security-categorytemplate-list-subcategories.md)|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) collection|Get the subcategoryTemplate resources from the subcategories navigation property.| +|[Create subcategories](../api/security-categorytemplate-post-subcategories.md)|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md)|Create a new subcategoryTemplate object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the category descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the category descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines a category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the category. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|subcategories|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) collection|Represents all subcategories under a particular category.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.categoryTemplate", + "baseType": "microsoft.graph.security.filePlanDescriptor", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + |
v1.0 | Security Citationtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-citationtemplate.md | + + Title: "citationTemplate resource type" +description: "The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted." ++ms.localizationpriority: medium +++# citationTemplate resource type ++Namespace: microsoft.graph.security ++Represents the specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted. This resource supports CRUD operations to apply and manage the [filePlanCitation](security-fileplancitation.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **citation** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. ++Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List citations](../api/security-labelsroot-list-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|Get a list of the [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) objects and their properties.| +|[Create citations](../api/security-labelsroot-post-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Create a new [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.| +|[Get citations](../api/security-citationtemplate-get.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Read the properties and relationships of a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.| +|[Delete citations](../api/security-labelsroot-delete-citations.md)|None|Delete a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|citationJurisdiction|String|Represents the jurisdiction or agency that published the citation.| +|citationUrl|String|Represents the URL to the published citation.| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the citation descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the citation descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the citation. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.citationTemplate", + "baseType": "microsoft.graph.security.filePlanDescriptor", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.citationTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "citationUrl": "String", + "citationJurisdiction": "String" +} +``` + |
v1.0 | Security Cloudapplicationevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-cloudapplicationevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.cloudApplicationEvidence" + "@odata.type": "microsoft.graph.security.cloudApplicationEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Datasource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-datasource.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Datasourcecontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-datasourcecontainer.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Departmenttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-departmenttemplate.md | + + Title: "departmentTemplate resource type" +description: "Specifies the department or business unit of an organization to which a label belongs." ++ms.localizationpriority: medium +++# departmentTemplate resource type ++Namespace: microsoft.graph.security ++Specifies the department or business unit of an organization to which a label belongs. This resource supports CRUD operations to apply and manage the [filePlanDepartment](security-fileplandepartment.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **department** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. ++Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List departments](../api/security-labelsroot-list-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Get a list of the [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) objects and their properties.| +|[Create departments](../api/security-labelsroot-post-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Create a new [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.| +|[Get departments](../api/security-departmenttemplate-get.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Read the properties and relationships of a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.| +|[Delete departments](../api/security-labelsroot-delete-departments.md)|None|Delete a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the department descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the department descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the department. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.departmentTemplate", + "baseType": "microsoft.graph.security.filePlanDescriptor", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.departmentTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + |
v1.0 | Security Deviceevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-deviceevidence.md | Inherits from [alertEvidence](../resources/security-alertevidence.md). 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.security.deviceEvidence" + "@odata.type": "microsoft.graph.security.deviceEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Dispositionreviewstage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-dispositionreviewstage.md | + + Title: "dispositionReviewStage resource type" +description: "Represents a multi-level review process where the reviewers indicate at each stage of the disposition whether to delete or further retain the content item.." ++ms.localizationpriority: medium +++# dispositionReviewStage resource type ++Namespace: microsoft.graph.security ++Represents a multi-level review process where the reviewers indicate at each stage of the disposition whether to delete or further retain the content item. +For details, see [Disposition of content](/microsoft-365/compliance/disposition). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Create retentionLabel](../api/security-labelsroot-post-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object. | +|[Update retentionLabel](../api/security-retentionlabel-update.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Update the [retentionLabel](../resources/security-retentionlabel.md) object. | +++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|Unique ID for each stage. | +|name|String|Name representing each stage within a collection. | +|reviewersEmailAddresses|String collection|A collection of reviewers at each stage. | +|stageNumber|String|The unique sequence number for each stage of the disposition review. | +++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.dispositionReviewStage", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.dispositionReviewStage", + "id": "String (identifier)", + "stageNumber": "String", + "name": "String", + "reviewersEmailAddresses": [ + "String" + ] +} +``` |
v1.0 | Security Ediscoverycasesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoverycasesettings.md | Inherits from [entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
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). |createdBy|[identitySet](../resources/identityset.md)| The user who initiated the export operation.| |createdDateTime|DateTimeOffset| The date and time the export was created.| |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**. | +|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. | Inherits from [caseOperation](../resources/security-caseoperation.md). ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Ediscoveryholdoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoveryholdoperation.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Ediscoveryindexoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoveryindexoperation.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Ediscoverynoncustodialdatasource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoverynoncustodialdatasource.md | Inherits from [dataSourceContainer](../resources/security-datasourcecontainer.md |lastIndexOperation|[microsoft.graph.security.ediscoveryIndexOperation](../resources/security-ediscoveryindexoperation.md)|Operation entity that represents the latest indexing for the noncustodial data source.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Ediscoveryreviewsetquery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoveryreviewsetquery.md | doc_type: resourcePageType Namespace: microsoft.graph.security -- Represents a review set query, which is used to query and cull data stored in a Microsoft Purview eDiscovery [reviewSet](security-ediscoveryreviewset.md). ## Methods Represents a review set query, which is used to query and cull data stored in a ## Properties |Property|Type|Description| |:|:|:|+| contentQuery | String | The query string in KQL (Keyword Query Language) query. For details, see [Document metadata fields in eDiscovery (Premium)](/microsoft-365/compliance/document-metadata-fields-in-advanced-ediscovery). This field maps directly to the keywords condition. You can refine searches by using fields listed in the *searchable field name* paired with values; for example, *subject:"Quarterly Financials" AND Date>=06/01/2016 AND Date<=07/01/2016*. | | createdBy | [identitySet](/graph/api/resources/identityset) | The user who created the query. | | createdDateTime |DateTimeOffset| The time and date when the query 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`|+| description|String|The description of the **eDiscovery search**.| | displayName | String | The name of the query.| | id |String| The unique identifier of the query. Read-only.| | lastModifiedBy | [identitySet](/graph/api/resources/identityset) | The user who last modified the query. | | lastModifiedDateTime |DateTimeOffset | The date and time the query 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`|-| query | String | The query string in KQL (Keyword Query Language) query. For details, see [Document metadata fields in eDiscovery (Premium)](/microsoft-365/compliance/document-metadata-fields-in-advanced-ediscovery). This field maps directly to the keywords condition. You can refine searches by using fields listed in the *searchable field name* paired with values; for example, *subject:"Quarterly Financials" AND Date>=06/01/2016 AND Date<=07/01/2016*. | ## Relationships |
v1.0 | Security Ediscoveryreviewtag | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoveryreviewtag.md | Represents an eDiscovery tag, which is used to mark documents during review to s |childTags|[microsoft.graph.security.ediscoveryReviewTag](../resources/security-ediscoveryreviewtag.md) collection|Returns the tags that are a child of a tag.| |parent|[microsoft.graph.security.ediscoveryReviewTag](../resources/security-ediscoveryreviewtag.md)|Returns the parent tag of the specified tag.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Eventpropagationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-eventpropagationresult.md | The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.security.eventPropagationResult",- "workload": "String", + "serviceName": "String", "location": "String", "status": "String", "statusInformation": "String" |
v1.0 | Security Fileevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.fileEvidence" + "@odata.type": "microsoft.graph.security.fileEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Filehash | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-filehash.md | 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.security.fileHash" |
v1.0 | Security Fileplanappliedcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplanappliedcategory.md | + + Title: "filePlanAppliedCategory resource type" +description: "Represents the file plan descriptor of type category applied to a particular retention label." ++ms.localizationpriority: medium +++# filePlanAppliedCategory resource type ++Namespace: microsoft.graph.security ++Represents a file plan descriptor that specifies a group of similar types of content in a department. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete an **filePlanAppliedCategory** descriptor, use the [categoryTemplate](security-categorytemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a file plan category name applied to the label. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|subcategory|[microsoft.graph.security.filePlanSubcategory](../resources/security-fileplansubcategory.md)|Represents the file plan descriptor for a subcategory under a specific category, which has been assigned to a particular retention label.| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanAppliedCategory" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanAppliedCategory", + "displayName": "String", + "subcategory": { + "@odata.type": "microsoft.graph.security.filePlanSubcategory" + } +} +``` + |
v1.0 | Security Fileplanauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplanauthority.md | + + Title: "filePlanAuthority resource type" +description: "Represents the file plan descriptor of type authority applied to a particular retention label." ++ms.localizationpriority: medium +++# filePlanAuthority resource type ++Namespace: microsoft.graph.security ++Represents a file plan descriptor that specifies the type of the underlying authority which determines the content to be retained and its retention schedule. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete a **filePlanAuthority** descriptor, use the [authorityTemplate](security-authoritytemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a filePlanAuthority name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanAuthority" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanAuthority", + "displayName": "String" +} +``` + |
v1.0 | Security Fileplancitation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplancitation.md | + + Title: "filePlanCitation resource type" +description: "Represents the file plan descriptor of type citation applied to a particular retention label." ++ms.localizationpriority: medium +++# filePlanCitation resource type ++Namespace: microsoft.graph.security ++Represents a file plan descriptor that specifies a rule or regulation created by a jurisdiction to determine whether certain content should be retained or deleted. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete a **filePlanCitation** descriptor, use the [citationTemplate](security-citationtemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|citationJurisdiction|String|Represents the jurisdiction or agency that published the filePlanCitation.| +|citationUrl|String|Represents the URL to the published filePlanCitation.| +|displayName|String|Unique string that defines a filePlanCitation name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanCitation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanCitation", + "displayName": "String", + "citationUrl": "String", + "citationJurisdiction": "String" +} +``` + |
v1.0 | Security Fileplandepartment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplandepartment.md | + + Title: "filePlanDepartment resource type" +description: "Represents the file plan descriptor of type department applied to a particular retention label." ++ms.localizationpriority: medium +++# filePlanDepartment resource type ++Namespace: microsoft.graph.security ++Represents a file plan descriptor that specifies the department or business unit of an organization to which a [retention label](security-retentionlabel.md) applies. Used to supplement a retention label for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete a **filePlanDepartment** descriptor, use the [departmentTemplate](security-departmenttemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a filePlanDepartment name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanDepartment" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanDepartment", + "displayName": "String" +} +``` + |
v1.0 | Security Fileplandescriptor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplandescriptor.md | + + Title: "filePlanDescriptor resource type" +description: "Represents a set of optional descriptors to supplement a retention label and improve the manageability and organization of content in Microsoft 365 for an organization." ++ms.localizationpriority: medium +++# filePlanDescriptor resource type ++Namespace: microsoft.graph.security ++Represents a _set_ of optional descriptors to supplement a [retention label](security-retentionlabel.md) and improve the manageability and organization of Microsoft 365 content. ++You can add a descriptor by using the POST operation of the corresponding file plan descriptor _template_, and specifying data for the descriptor. For example, to include a [filePlanCitation](security-fileplancitation.md) descriptor, use the [create citationTemplate](../api/security-labelsroot-post-citations.md) operation. Similarly, you can use the GET or DELETE operations on the template resource for the descriptor. ++To list the descriptors that supplement a retention label, use the [GET](../api/security-retentionlabel-get.md) operation on that [retentionLabel](security-retentionlabel.md) resource and apply `$expand` on the **descriptors** relationship. ++For information on how retention labels and file plan descriptors work in the [Microsoft Purview compliance portal](https://compliance.microsoft.com/), see [Use file plan to create and manage retention labels](/purview/file-plan-manager). ++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods +None. +++## Properties +|Property|Type|Description| +|:|:|:| +|authority|[microsoft.graph.security.filePlanAuthority](../resources/security-fileplanauthority.md)|Represents the file plan descriptor of type authority applied to a particular retention label.| +|appliedCategory|[microsoft.graph.security.filePlanAppliedCategory](../resources/security-fileplanappliedcategory.md)|Represents the file plan descriptor of type category applied to a particular retention label.| +|citation|[microsoft.graph.security.filePlanCitation](../resources/security-fileplancitation.md)|Represents the file plan descriptor of type citation applied to a particular retention label.| +|department|[microsoft.graph.security.filePlanDepartment](../resources/security-fileplandepartment.md)|Represents the file plan descriptor of type department applied to a particular retention label.| +|filePlanReference|[microsoft.graph.security.filePlanReference](../resources/security-fileplanreference.md)|Represents the file plan descriptor of type filePlanReference applied to a particular retention label. ΓÇ»| +++## Relationships +|Relationship|Type|Description| +|:|:|:| +|authorityTemplate|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)| Specifies the underlying authority that describes the type of content to be retained and its retention schedule.| +|categoryTemplate|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Specifies a group of similar types of content in a particular department.| +|citationTemplate|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted. | +|departmentTemplate|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Specifies the department or business unit of an organization to which a label belongs.| +|filePlanReferenceTemplate|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule.| ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.filePlanDescriptor", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanDescriptor", + "id": "String (identifier)", + "authority": { + "@odata.type": "microsoft.graph.security.filePlanAuthority" + }, + "category": { + "@odata.type": "microsoft.graph.security.filePlanAppliedCategory" + }, + "citation": { + "@odata.type": "microsoft.graph.security.filePlanCitation" + }, + "department": { + "@odata.type": "microsoft.graph.security.filePlanDepartment" + }, + "filePlanReference": { + "@odata.type": "microsoft.graph.security.filePlanReference" + } +} +``` + |
v1.0 | Security Fileplandescriptorbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplandescriptorbase.md | + + Title: "filePlanDescriptorBase resource type" +description: "Specifies properties common to file plan descriptor resources." ++ms.localizationpriority: medium +++# filePlanDescriptorBase resource type ++Namespace: microsoft.graph.security ++Specifies properties common to file plan descriptor resources. Base type for each of the descriptors: [filePlanAppliedCategory](security-fileplanappliedcategory.md), [filePlanAuthority](security-fileplanauthority.md), [filePlanCitation](security-fileplancitation.md), [filePlanDepartment](security-fileplandepartment.md), [filePlanReference](security-fileplanreference.md), and [filePlanSubcategory](security-fileplansubcategory.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines the name for the file plan descriptor associated with a particular retention label.| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanDescriptorBase" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanDescriptorBase", + "displayName": "String" +} +``` + |
v1.0 | Security Fileplandescriptortemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplandescriptortemplate.md | + + Title: "filePlanDescriptorTemplate resource type" +description: "Specifies the properties common to the template resources for file plan descriptors." ++ms.localizationpriority: medium +++# filePlanDescriptorTemplate resource type ++Namespace: microsoft.graph.security ++Specifies the properties common to the template resources for file plan descriptors. Base type for each of the template resources: [authorityTemplate](security-authoritytemplate.md), [categoryTemplate](security-categorytemplate.md), [citationTemplate](security-citationtemplate.md), [departmentTemplate](security-departmenttemplate.md), [filePlanReferenceTemplate](security-fileplanreferencetemplate.md), and [subcategoryTemplate](security-subcategorytemplate.md). ++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods +None. ++## Properties +|Property|Type|Description| +|:|:|:| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the filePlanDescriptorTemplate column.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanDescriptorTemplate is created.| +|displayName|String|Unique string that defines a filePlanDescriptorTemplate name.| +|id|String|Unique ID of the filePlanDecriptorTemplate column. Read-only.| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.filePlanDescriptorTemplate", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanDescriptorTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + |
v1.0 | Security Fileplanreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplanreference.md | + + Title: "filePlanReference resource type" +description: "Represents the file plan descriptor of a reference ID, supplementing a specified retention label." ++ms.localizationpriority: medium +++# filePlanReference resource type ++Namespace: microsoft.graph.security ++Represents a file plan descriptor that specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete a **filePlanReference** descriptor, use the [filePlanReferenceTemplate](security-fileplanreferencetemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a reference ID. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanReference" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanReference", + "displayName": "String" +} +``` + |
v1.0 | Security Fileplanreferencetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplanreferencetemplate.md | + + Title: "filePlanReferenceTemplate resource type" +description: "Specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule." ++ms.localizationpriority: medium +++# filePlanReferenceTemplate resource type ++Namespace: microsoft.graph.security ++Supports CRUD operations to apply and manage the [filePlanReference](security-fileplanreference.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **filePlanReference** descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. ++Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List filePlanReferences](../api/security-labelsroot-list-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Get a list of the [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) objects and their properties.| +|[Create filePlanReferences](../api/security-labelsroot-post-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Create a new [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.| +|[Get filePlanReferences](../api/security-fileplanreferencetemplate-get.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Read the properties and relationships of a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.| +|[Delete filePlanReferences](../api/security-labelsroot-delete-fileplanreferences.md)|None|Delete a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the file plan reference descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanReference descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines a filePlanReference name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the filePlanReference. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.filePlanReferenceTemplate", + "baseType": "microsoft.graph.security.filePlanDescriptor", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + |
v1.0 | Security Fileplansubcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplansubcategory.md | + + Title: "filePlanSubcategory resource type" +description: "Represents a unique filePlanSubcategory applied to a retention label." ++ms.localizationpriority: medium +++# filePlanSubcategory resource type ++Namespace: microsoft.graph.security ++Represents a unique subcategory applied to a [retention label](security-retentionlabel.md). Used to supplement a retention label for [record management purposes](security-recordsmanagement-overview.md). ++To create, get, or delete a **filePlanSubcategory** descriptor, use the [subcategoryTemplate](security-subcategorytemplate.md) resource. ++This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md). ++Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Unique string that defines a filePlanSubcategory name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.filePlanSubcategory" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanSubcategory", + "displayName": "String" +} +``` + |
v1.0 | Security Hostcomponent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-hostcomponent.md | Inherits from [artifact](../resources/security-artifact.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Security Incident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-incident.md | Because piecing the individual alerts together to gain insight into an attack ca |status|[microsoft.graph.security.incidentStatus](#incidentstatus-values)|The status of the incident. Possible values are: `active`, `resolved`, `inProgress`, `redirected`, `unknownFutureValue`, and `awaitingAction`.| |tenantId|String|The Microsoft Entra tenant in which the alert was created.| |systemTags|String collection|The system tags associated with the incident.|+|resolvingComment|String|User input that explains the resolution of the incident and the classification choice. This property contains free editable text.| ### incidentStatus values |
v1.0 | Security Indicator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-indicator.md | This resource isn't directly addressable. You can interact with this resource th ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Security Ipevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ipevidence.md | Inherits from [alertEvidence](../resources/security-alertevidence.md). 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.security.ipEvidence" + "@odata.type": "microsoft.graph.security.ipEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Labelsroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-labelsroot.md | + + Title: "labelsRoot resource type" +description: "A root resource for capabilities that support records management for Microsoft 365 data in an organization." ++ms.localizationpriority: medium +++# labelsRoot resource type ++Namespace: microsoft.graph.security ++A root resource for capabilities that support records management for Microsoft 365 data in an organization. ++Those capabilities include using a [retention label](security-retentionlabel.md) to configure retention and deletion settings for a type of content in the Microsoft 365 data, and using one or more [file plan descriptors](security-fileplandescriptor.md) to supplement the retention label and provide additional options to better manage and organize the content. ++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List retentionLabels](../api/security-labelsroot-list-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) collection |Get a list of the [retentionLabel](../resources/security-retentionlabel.md) objects and their properties.| +|[Create retentionLabel](../api/security-labelsroot-post-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object.| +|[List authorities](../api/security-labelsroot-list-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Get the authorityTemplate resources from the authorities navigation property.| +|[Create authorities](../api/security-labelsroot-post-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Create a new authorityTemplate object.| +|[List categories](../api/security-labelsroot-list-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Get the categoryTemplate resources from the categories navigation property.| +|[Create categories](../api/security-labelsroot-post-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Create a new categoryTemplate object.| +|[List citations](../api/security-labelsroot-list-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|Get the citationTemplate resources from the citations navigation property.| +|[Create citations](../api/security-labelsroot-post-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Create a new citationTemplate object.| +|[List departments](../api/security-labelsroot-list-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Get the departmentTemplate resources from the departments navigation property.| +|[Create departments](../api/security-labelsroot-post-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Create a new departmentTemplate object.| +|[List filePlanReferences](../api/security-labelsroot-list-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Get the filePlanReferenceTemplate resources from the filePlanReferences navigation property.| +|[Create filePlanReferences](../api/security-labelsroot-post-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Create a new filePlanReferenceTemplate object.| ++## Properties +None. ++++## Relationships +|Relationship|Type|Description| +|:|:|:| +|authorities|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Specifies the underlying authority that describes the type of content to be retained and its retention schedule.| +|categories|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Specifies a group of similar types of content in a particular department.| +|citations|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted.| +|departments|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Specifies the department or business unit of an organization to which a label belongs.| +|filePlanReferences|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule.| +|retentionLabels|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) collection|Represents how customers can manage their data, whether and for how long to retain or delete it.| +++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.labelsRoot", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.labelsRoot", + "id": "String (identifier)" +} +``` + |
v1.0 | Security Loggedonuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-loggedonuser.md | User that was loggen on the machine during the time of the alert. 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.security.loggedOnUser" |
v1.0 | Security Mailboxevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-mailboxevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.mailboxEvidence" + "@odata.type": "microsoft.graph.security.mailboxEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Mailclusterevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-mailclusterevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.mailClusterEvidence" + "@odata.type": "microsoft.graph.security.mailClusterEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Oauthapplicationevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-oauthapplicationevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.oauthApplicationEvidence" + "@odata.type": "microsoft.graph.security.oauthApplicationEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Processevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-processevidence.md | The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.processEvidence" + "@odata.type": "microsoft.graph.security.processEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Recordsmanagement Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-recordsmanagement-overview.md | doc_type: conceptualPageType # Use the Microsoft Graph records management APIs +The Microsoft Purview records management APIs help organizations manage retention and deletion of data to meet their legal obligations and compliance regulations, and increases efficiency by enabling the regular disposition of items that no longer have to be retained. -The Microsoft Purview Records Management APIs help organizations manage retention and deletion of data to meet their legal obligations and compliance regulations. The APIs increase efficiency by enabling the regular disposition of items that no longer have to be retained. +## Manage retention labels +Many organizations need to manage their data to comply with industry regulations and internal policies, reduce risks of litigation or security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. Managing data commonly involves appropriately retaining or deleting different types of content. -The records management solution is a part of the Microsoft Purview compliance portal. +You can use [retention labels](security-retentionlabel.md) to configure retention and deletion settings for Microsoft 365 content. For example, you can set retention periods from when the content was labeled and you can set disposition review as the action at the end of the retention period. ++In addition, you can use [file plan descriptors](security-fileplandescriptor.md) to supplement a retention label and improve the manageability and organization of Microsoft 365 content. Examples of file plan descriptors include [authority](security-fileplanauthority.md), [citation](security-fileplancitation.md), and [department](security-fileplandepartment.md). ## Trigger events for an existing label-When an employee leaves a company, information is updated in the HR management system. From the leave date, confidential documents need to be retained for a period for seven years. These documents have the label `Employee_departure` applied. +Some scenarios require starting a retention period for certain documents upon a specific event, such as an employee leaving an organization, a contract expiring, or the fiscal year ending. ++You can use the [retentionLabel](security-retentionlabel.md) resource to support event-based retention, by setting the **retentionTrigger** property as `dateOfEvent` and associating the label with a [retentionEventType](security-retentioneventtype.md) resource. A [retentionEvent](security-retentionevent.md) is associated with a **retentionEventType** as well. When a triggering event happens, only content with that retention label applied is retained for the specified retention period. -Developers and compliance administrators can use records management APIs to read the label `Employee_departure` and look up the associated event type `Event-employee_departure`. +As an example: in an organization, when an employee leaves, employment records must be retained for 5 years. Use the **retentionLabel** and **retentionEvent** APIs to do the following for each employee record when the employee starts: +1. Apply a **retentionLabel** configured as follows: + - A display name of "Personnel information" + - A **retentionDuration** of 1827 days (5 years) + - Listening to the **retentionEventType** named "Employee departure" +2. Define a **retentionEvent** with the same **retentionEventType** named "Employee departure", and as part of its [eventQuery](security-eventquery.md) collection, an `Asset ID` with an employee ID value as the ID information associated with the event. -Compliance admins can use records management APIs to create an event for the associated event type. The retention period for the confidential documents starts after the creation of this event. +When an employee with an ID of 1234 leaves Contoso, the information is updated in the HR management system. The employee departure can trigger a new instance of **retentionEvent** with the "Employee departure" event type, and as part of its **eventQueries** property, an [eventQuery](security-eventquery.md) with a query string of 'AssetID:1234'. This way, employee record items using the "Personnel information" retention label and associated with the employee ID of 1234 get their 5 year retention period started from the date of the employee departure event. ## Entities The records management API includes the following key entities. | Name | Type | Use case | |:-|:-|:-|+| Label | [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) | Contains retention settings and actions that can be applied to an item at the end of a period. | +| File plan descriptors |[microsoft.graph.securty.fileplandescriptor](../resources/security-fileplandescriptor.md) | Represents a set of optional descriptors to supplement a retention label and improve their manageability for an organization. | | Retention event | [microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md) | Represents a trigger for event-based retention, where a retention period starts after the event occurs. | | Retention event type | [microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) | Represents a single group for the same type of retention events. | |
v1.0 | Security Registrykeyevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-registrykeyevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.registryKeyEvidence" + "@odata.type": "microsoft.graph.security.registryKeyEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Registryvalueevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-registryvalueevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.registryValueEvidence" + "@odata.type": "microsoft.graph.security.registryValueEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Retentionduration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentionduration.md | + + Title: "retentionDuration resource type" +description: "An abstract type that represents how long an item will be retained before it can be deleted." ++ms.localizationpriority: medium +++# retentionDuration resource type ++Namespace: microsoft.graph.security ++An abstract type that represents how long an item will be retained before it can be deleted. ++Base type of +[retentionDurationForever](../resources/security-retentiondurationforever.md) and [retentionDurationInDays](../resources/security-retentiondurationindays.md). ++## Properties +None. ++## Relationships +None. ++## JSON representation for retentionDuration +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.retentionDuration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionDuration" +} +``` ++ |
v1.0 | Security Retentiondurationforever | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentiondurationforever.md | + + Title: "retentionDurationForever resource type" +description: "Represents that content will be retained permanently and will not be deleted." ++ms.localizationpriority: medium +++# retentionDurationForever resource type ++Namespace: microsoft.graph.security ++Indicates that content will be retained permanently and will not be deleted. +++Inherits from [retentionDuration](../resources/security-retentionduration.md). ++## Properties +None. ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.retentionDurationForever" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionDurationForever" +} +``` |
v1.0 | Security Retentiondurationindays | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentiondurationindays.md | + + Title: "retentionDurationInDays resource type" +description: "Represents the number of days an item will be retained before it can be deleted" ++ms.localizationpriority: medium +++# retentionDurationInDays resource type ++Namespace: microsoft.graph.security ++Represents the number of days an item will be retained before it can be deleted. +++Inherits from [retentionDuration](../resources/security-retentionduration.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|days|Int32|Specifies the time period in days for which an item with the applied retention label will be retained for.| ++## Relationships +None. ++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.retentionDurationInDays" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionDurationInDays", + "days": "Integer" +} +``` |
v1.0 | Security Retentionevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentionevent.md | To learn more about it, see [Start retention when an event occurs](/microsoft-36 |createdDateTime|DateTimeOffset|The date time when the retentionEvent was created.| |description|String|Optional information about the event.| |displayName|String|Name of the event.|-|eventPropagationResult|[microsoft.graph.security.eventPropagationResult](../resources/security-eventpropagationresult.md)|Represents the success status of a created event and additional information.| +|eventPropagationResults|[microsoft.graph.security.eventPropagationResult](../resources/security-eventpropagationresult.md) collection|Represents the success status of a created event and additional information.| |eventQueries|[microsoft.graph.security.eventQuery](../resources/security-eventquery.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.|-|retentionEventStatus|[microsoft.graph.security.retentionEventStatus](../resources/security-retentioneventstatus.md) collection|Status of event propogation to the scoped locations after the event has been created.| +|eventStatus|[microsoft.graph.security.retentionEventStatus](../resources/security-retentioneventstatus.md)|Status of event propogation to the scoped locations after the event has been created.| |eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| |id|String|Represents the unique ID of the user who created the retentionEvent. [entity](/graph/api/resources/entity).| |lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionEvent.| |
v1.0 | Security Retentioneventstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentioneventstatus.md | For event-based retention, this attribute provides the status of event propagati 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.security.retentionEventStatus" |
v1.0 | Security Retentioneventtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentioneventtype.md | For details, see [Start retention when an event occurs](/microsoft-365/complianc None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Retentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentionlabel.md | + + Title: "retentionLabel resource type" +description: "Represents how customers can manage their data at an item level (email or document), including whether and for how long to retain or delete the item." ++ms.localizationpriority: medium +++# retentionLabel resource type ++Namespace: microsoft.graph.security ++Represents how organizations, for compliance and governance purposes, can manage their data at an item level (email or document), including whether and for how long to retain or delete the item. ++Organizations can use retention labels for different types of content that require different retention settings. For example, they can apply a retention label to tax forms and supporting documents to retain them for the period required by law. ++Organizations can configure retention labels with the retention periods and actions based on factors such as the date last modified or created. They can also start different retention periods by specifying an [event that can trigger retention](security-retentionevent.md) when the event occurs. ++For more information on how retention labels work, when to use them, and how Microsoft Purview supports retention labels to let you configure retention and deletion settings, see [Learn about retention policies and retention labels](/purview/retention). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List retentionLabels](../api/security-labelsroot-list-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) collection|Get a list of the [retentionLabel](../resources/security-retentionlabel.md) objects and their properties.| +|[Create retentionLabel](../api/security-labelsroot-post-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object.| +|[Get retentionLabel](../api/security-retentionlabel-get.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Read the properties and relationships of a [retentionLabel](../resources/security-retentionlabel.md) object.| +|[Update retentionLabel](../api/security-retentionlabel-update.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Update the properties of a [retentionLabel](../resources/security-retentionlabel.md) object.| +|[Delete retentionLabel](../api/security-retentionlabel-delete.md)|None|Delete a [retentionLabel](../resources/security-retentionlabel.md) object.| +|[List retentionEventType](../api/security-retentioneventtype-list.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) collection|Get the retentionEventType resources from the exapnd eventType navigation property.| +|[Add retentionEventType](../api/security-retentioneventtype-post.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Add eventType by adding the relevant odata property when creating a label.| +++## Properties +|Property|Type|Description| +|:|:|:| +|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to take on the labeled document after the period specified by the retentionDuration property expires. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`.| +|behaviorDuringRetentionPeriod|microsoft.graph.security.behaviorDuringRetentionPeriod|Specifies how the behavior of a document with this label should be during the retention period. The possible values are: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`, `unknownFutureValue`.| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the retentionLabel.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the retentionLabel is created.| +|descriptionForAdmins|String|Provides label information for the admin. Optional.| +|descriptionForUsers|String|Provides the label information for the user. Optional.| +|displayName|String|Unique string that defines a label name.| +|id|String|Unique ID of the retentionLabel.| +|isInUse|Boolean|Specifies whether the label is currently being used.| +|lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionLabel.| +|lastModifiedDateTime|DateTimeOffset|The latest date time when the retentionLabel was modified.| +|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content.| +|retentionTrigger|microsoft.graph.security.retentionTrigger|Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`, `unknownFutureValue`.| +|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created.The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`.| +|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. | +++## Relationships +|Relationship|Type|Description| +|:|:|:| +|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|When action at the end of retention is chosen as 'dispositionReview', dispositionReviewStages specifies a sequential set of stages with at least one reviewer in each stage.| +|retentionEventType|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Represents the type associated with a retention event.| +|descriptors|[microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md)|Represents out-of-the-box values that provide more options to improve the manageability and organization of the content you need to label.| ++++## JSON representation +Here's a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.retentionLabel", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "String (identifier)", + "displayName": "String", + "behaviorDuringRetentionPeriod": "String", + "actionAfterRetentionPeriod": "String", + "retentionTrigger": "String", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration" + }, + "isInUse": "Boolean", + "descriptionForAdmins": "String", + "descriptionForUsers": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "labelToBeApplied": "String", + "defaultRecordBehavior": "String" +} +``` |
v1.0 | Security Securitygroupevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-securitygroupevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.securityGroupEvidence" + "@odata.type": "microsoft.graph.security.securityGroupEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Singlepropertyschema | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-singlepropertyschema.md | The following is a JSON representation of the resource. --> ``` json {- "Name": "Timestamp", - "Type": "DateTime" + "name": "Timestamp", + "type": "DateTime" } ``` |
v1.0 | Security Sitesource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-sitesource.md | None. |site|[site](../resources/site.md)|The SharePoint site associated with the **siteSource**.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Subcategorytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-subcategorytemplate.md | + + Title: "subcategoryTemplate resource type" +description: "Represents the file plan descriptor of type subcategory for retention labels." ++ms.localizationpriority: medium +++# subcategoryTemplate resource type ++Namespace: microsoft.graph.security ++Supports CRUD operations to apply and manage the [filePlanSubcategory](security-fileplansubcategory.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **subcategory** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. ++Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List subcategories](../api/security-categorytemplate-list-subcategories.md)|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) collection|Get a list of the [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) objects and their properties.| +|[Create subcategories](../api/security-categorytemplate-post-subcategories.md)|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md)|Create a new [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object.| +|[Get subcategories](../api/security-subcategorytemplate-get.md)|[microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object.| +|[Delete subcategories](../api/security-categorytemplate-delete-subcategories.md)|None|Delete a [microsoft.graph.security.subcategoryTemplate](../resources/security-subcategorytemplate.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the subcategory descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the subcategory descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.| +|displayName|String|Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).| +|id|String|Unique ID of the subcategory. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.| ++## Relationships +None. ++## JSON representation +Here's JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.subcategoryTemplate", + "baseType": "microsoft.graph.security.filePlanDescriptor", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.subcategoryTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + |
v1.0 | Security Threatintelligence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-threatintelligence.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Security Unclassifiedartifact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-unclassifiedartifact.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Security Unifiedgroupsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-unifiedgroupsource.md | None. |group|[group](../resources/group.md)|Represents a group.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Urlevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-urlevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.urlEvidence" + "@odata.type": "microsoft.graph.security.urlEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Userevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-userevidence.md | None. The following is a JSON representation of the resource. <!-- { "blockType": "resource",- "@odata.type": "microsoft.graph.security.userEvidence" + "@odata.type": "microsoft.graph.security.userEvidence", + "baseType": "microsoft.graph.security.alertEvidence" } --> ``` json |
v1.0 | Security Usersource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-usersource.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Security Vmmetadata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-vmmetadata.md | Metadata of the virtual machine (VM) Microsoft Defender for Endpoint is running 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.security.vmMetadata" |
v1.0 | Security | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security.md | None ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Securityvendorinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/securityvendorinformation.md | Contains details about the security product/service vendor, provider, and subpro ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Selfservicesignupauthenticationflowconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/selfservicesignupauthenticationflowconfiguration.md | 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.selfServiceSignUpAuthenticationFlowConfiguration" |
v1.0 | Selfsignedcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/selfsignedcertificate.md | Contains the public part of a signing certificate. This resource type is the return type of the [addSelfSignedSigningCertificate](../api/serviceprincipal-addtokensigningcertificate.md) action. Service providers use the public part of the signing certificate to validate the issuer of the token. ## Properties-Property|Type|Description --|--|+|Property|Type|Description +|:|:|:| |customKeyIdentifier|Binary| Custom key identifier. |-| displayName | String | The friendly name for the key. | +|displayName | String | The friendly name for the key. | |endDateTime|DateTimeOffset|The date and time at which the credential expires. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is `2014-01-01T00:00:00Z`.| |key|Binary| The value for the key credential. Should be a Base-64 encoded value. | |keyId|Guid|The unique identifier (GUID) for the key.| |
v1.0 | Sensitivitylabelassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sensitivitylabelassignment.md | Provides details about a sensitivity label assigned to a [file](./driveitem.md) |labels|[extractSensitivityLabelsResult](./extractsensitivitylabelsresult.md)|List of sensitivity labels assigned to a file.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.sensitivityLabelAssignment" |
v1.0 | Serverprocessedcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/serverprocessedcontent.md | + + Title: "serverProcessedContent resource type" +description: Represents the server processed content of a given web part. ++ms.localizationpriority: medium +++# serverProcessedContent resource type ++Namespace: microsoft.graph ++++Represents the server processed content of a given web part. ++## Properties +|Property|Type|Description| +|:|:|:| +|componentDependencies|[metaDataKeyStringPair](../resources/metadatakeystringpair.md) collection|A key-value map where keys are string identifiers and values are component ids. SharePoint servers might decide to use this hint to preload the script for corresponding components for performance boost.| +|customMetadata|[metaDataKeyValuePair](../resources/metadatakeyvaluepair.md) collection|A key-value map where keys are string identifier and values are object of custom key-value pair. | +|htmlStrings|[metaDataKeyStringPair](../resources/metadatakeystringpair.md) collection|A key-value map where keys are string identifiers and values are rich text with HTML format. SharePoint servers treat the values as HTML content and run services like safety checks, search index and link fixup on them.| +|imageSources|[metaDataKeyStringPair](../resources/metadatakeystringpair.md) collection|A key-value map where keys are string identifiers and values are image sources. SharePoint servers treat the values as image sources and run services like search index and link fixup on them.| +|links|[metaDataKeyStringPair](../resources/metadatakeystringpair.md) collection|A key-value map where keys are string identifiers and values are links. SharePoint servers treat the values as links and run services like link fixup on them.| +|searchablePlainTexts|[metaDataKeyStringPair](../resources/metadatakeystringpair.md) collection|A key-value map where keys are string identifiers and values are strings that should be search indexed.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.serverProcessedContent" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.serverProcessedContent", + "htmlStrings": [ + { + "@odata.type": "microsoft.graph.metaDataKeyStringPair" + } + ], + "searchablePlainTexts": [ + { + "@odata.type": "microsoft.graph.metaDataKeyStringPair" + } + ], + "links": [ + { + "@odata.type": "microsoft.graph.metaDataKeyStringPair" + } + ], + "imageSources": [ + { + "@odata.type": "microsoft.graph.metaDataKeyStringPair" + } + ], + "componentDependencies": [ + { + "@odata.type": "microsoft.graph.metaDataKeyStringPair" + } + ], + "customMetadata": [ + { + "@odata.type": "microsoft.graph.metaDataKeyValuePair" + } + ] +} +``` + |
v1.0 | Service Communications Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/service-communications-api-overview.md | Title: "Working with service communications APIs in Microsoft Graph" description: You can use the service communications API in Microsoft Graph to access the health status and message center posts about Microsoft services." ms.localizationpriority: medium -doc_type: resourcePageType # Working with service communications API in Microsoft Graph The service communications API provides service health and message center posts pertaining to the Microsoft cloud services subscribed by your tenant. You can get current and historical health data of a Microsoft service (for example, the Exchange Online service is down). You can check the service health to determine if an issue is tracked and a resolution is in progress before calling support or spending time troubleshooting. Message center posts let you keep track of upcoming changes, including new features, updates, and other important announcements (for example, Exchange Online is getting a new feature). ## Authorization-Microsoft Graph enables applications get authorized access to health and change communications about a Microsoft cloud service subscribed by a tenant. +Microsoft Graph enables applications get authorized access to health and change communications about a Microsoft cloud service subscribed by a tenant. With the appropriate delegated or application [permissions](/graph/permissions-reference#service-communications-permissions), your app can access the communications data on behalf of a signed-in user, or without any signed-in user in the tenant. Both delegated and application types of these permissions are granted by only an administrator. For more information about access tokens, app registration, and delegated and application permissions, see [Authentication and authorization basics](/graph/auth/auth-concepts). ### Access service communications API on behalf of signed-in user -Delegated permissions are needed to access the service communications API on behalf of a signed-in user. Customer-facing canvas applications, such as the [Microsoft 365 admin center](https://admin.microsoft.com/Adminportal/Home?source=applauncher#/homepage) (accessible only to admin roles), can call the service communications API to get the service health and service announcements data for the signed-in user's tenant, _on behalf of the signed-in user_. Users can find out whether their subscribed servies are healthy or have issues. They can also learn about any current service issues affecting their tenants. +Delegated permissions are needed to access the service communications API on behalf of a signed-in user. Customer-facing canvas applications, such as the [Microsoft 365 admin center](https://admin.microsoft.com/Adminportal/Home?source=applauncher#/homepage) (accessible only to admin roles), can call the service communications API to get the service health and service announcements data for the signed-in user's tenant, _on behalf of the signed-in user_. Users can find out whether their subscribed servies are healthy or have issues. They can also learn about any current service issues affecting their tenants. #### Role-based access control for delegation access Service communications API also apply the role-based access control (RBAC) to id For more information about the Microsoft Entra administrator roles, see: * [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles) * [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json)-* [Roles in Microsoft 365, including Microsoft Entra ID, service-specific and cross-service roles](/azure/active-directory/roles/concept-understand-roles#how-azure-ad-roles-are-different-from-other-microsoft-365-roles) +* [Roles in Microsoft 365, including Microsoft Entra ID, service-specific and cross-service roles](/azure/active-directory/roles/concept-understand-roles#how-azure-ad-roles-are-different-from-other-microsoft-365-roles) ### Access service communications API without user -Application permissions are needed to access the service communications API without a signed-in user. Applications that run as backend services, such as monitoring or alert services, can call the service communications API with their own identity and not on behalf of a user. These backend services can build custom monitoring/alert pipelines and call the service communications API to get service health and service announcements data. +Application permissions are needed to access the service communications API without a signed-in user. Applications that run as backend services, such as monitoring or alert services, can call the service communications API with their own identity and not on behalf of a user. These backend services can build custom monitoring/alert pipelines and call the service communications API to get service health and service announcements data. ## Common use cases and required permissions |Use cases|API requests| Required permissions| Supported permission types| |:--|:--|:--|:--|-| List health overviews for tenant | [List healthOverviews](/graph/api/serviceannouncement-list-healthoverviews?view=graph-rest-1.0&preserve-view=true) | _ServiceHealth.Read.All_ | Delegated and application | +| List health overviews for tenant | [List healthOverviews](/graph/api/serviceannouncement-list-healthoverviews?view=graph-rest-1.0&preserve-view=true) | _ServiceHealth.Read.All_ | Delegated and application | | Get specific service health information for tenant | [Get serviceHealth](/graph/api/servicehealth-get?view=graph-rest-1.0&preserve-view=true) | _ServiceHealth.Read.All_ | Delegated and application | | List all service issues for tenant | [List issues](/graph/api/serviceannouncement-list-issues?view=graph-rest-1.0&preserve-view=true) | _ServiceHealth.Read.All_ | Delegated and application | | Get a specific service issue for tenant | [Get issue](/graph/api/servicehealthissue-get?view=graph-rest-1.0&preserve-view=true) | _ServiceHealth.Read.All_ | Delegated and application | Application permissions are needed to access the service communications API with | Update service message status for signed in user | For a list of status operations, see [serviceUpdateMessage](/graph/api/resources/serviceupdatemessage?view=graph-rest-1.0&preserve-view=true).| _ServiceMessageViewpoint.Write_ | Delegated | ## Microsoft Graph national cloud availability-The service communications API is available on Microsoft Graph national clouds. You can get service health and communications data for your national clouds tenants. +The service communications API is available on Microsoft Graph national clouds. You can get service health and communications data for your national clouds tenants. |National clouds|API URL (partial)| |:--|:--| |
v1.0 | Serviceannouncementbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/serviceannouncementbase.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Servicehealth | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/servicehealth.md | Represents the health information of a service subscribed by a tenant. |issues|Collection([serviceHealthIssue](../resources/servicehealthissue.md))|A collection of issues that happened on the service, with detailed information for each issue.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Servicehostedmediaconfig | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/servicehostedmediaconfig.md | The media that's hosted remotely and is inherited from [mediaConfig](mediaconfig ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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 |[Create servicePrincipal](../api/serviceprincipal-post-serviceprincipals.md)| [servicePrincipal](serviceprincipal.md) | Creates a new servicePrincipal object. | |[Get servicePrincipal](../api/serviceprincipal-get.md) | [servicePrincipal](serviceprincipal.md) |Read properties and relationships of servicePrincipal object.| |[Update servicePrincipal](../api/serviceprincipal-update.md) | [servicePrincipal](serviceprincipal.md) |Update servicePrincipal object. |+|[Upsert servicePrincipal](../api/serviceprincipal-upsert.md) | [servicePrincipal](serviceprincipal.md) | Create a new servicePrincipal if it doesn't exist, or update the properties of an existing servicePrincipal.| |[Delete servicePrincipal](../api/serviceprincipal-delete.md) | None |Delete servicePrincipal object.| |[List deleted servicePrincipals](../api/directory-deleteditems-list.md) | [directoryObject](directoryobject.md) collection | Retrieve a list of recently deleted servicePrincipal objects. | |[Get deleted servicePrincipal](../api/directory-deleteditems-get.md) | [directoryObject](directoryobject.md) | Retrieve the properties of a recently deleted servicePrincipal object. | |
v1.0 | Serviceprincipalidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/serviceprincipalidentity.md | Inherits from [identity](../resources/identity.md). 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.servicePrincipalIdentity" |
v1.0 | Serviceprincipallockconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/serviceprincipallockconfiguration.md | For more information about managing this object, see [Lock sensitive properties | tokenEncryptionKeyId | Boolean | Locks the tokenEncryptionKeyId property for modification on the service principal. | ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Settingtemplatevalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/settingtemplatevalue.md | Represents an individual template setting definition, including the default valu ### JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Settingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/settingvalue.md | A setting represented by a name/value pair. ### JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sharepoint Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sharepoint-activity-reports.md | - Title: "SharePoint activity reports" -description: "You can use the SharePoint activity reports to get the activity of every user licensed to use SharePoint by looking at their interaction with files. You can also look at the level of collaboration going on based on the number of files shared." ---doc_type: conceptualPageType ---# SharePoint activity reports --Namespace: microsoft.graph --You can use the SharePoint activity reports to get the activity of every user licensed to use SharePoint by looking at their interaction with files. You can also look at the level of collaboration going on based on the number of files shared. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - SharePoint activity](https://support.office.com/client/SharePoint-activity-a91c958f-1279-499d-9959-12f0de08dc8f). --## Reports --| Function | 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. | - |
v1.0 | Sharepoint Site Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sharepoint-site-usage-reports.md | - Title: "SharePoint site usage reports" -description: "You can use the SharePoint site usage reports to gain a high level view of the value you are getting from SharePoint in terms of the total number of files that users store in SharePoint sites, how many files are actively being used, and the storage consumed across all these sites. Then, you can drill into these reports to understand the trends and per site level details for all sites." ---doc_type: conceptualPageType ---# SharePoint site usage reports --Namespace: microsoft.graph --You can use the SharePoint site usage reports to gain a high level view of the value you are getting from SharePoint in terms of the total number of files that users store in SharePoint sites, how many files are actively being used, and the storage consumed across all these sites. Then, you can drill into these reports to understand the trends and per site level details for all sites. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - SharePoint site usage](https://support.office.com/client/SharePoint-site-usage-4ecfb843-e5d5-464d-8bf6-7ed512a9b213). --## Reports --| Function | 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. | - |
v1.0 | Sharepointids | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sharepointids.md | The **SharePointIds** resource groups the various identifiers for an item stored ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sharepointonedriveoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sharepointonedriveoptions.md | Provides the search content options when a search is performed using application ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", The following is a JSON representation of the resource. ```json {- "includeContent": "string" + "includeContent": "String" } ``` |
v1.0 | Sharinginvitation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sharinginvitation.md | Groups invitation-related data items into a single structure. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Sharinglink | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sharinglink.md | If a [**permission**](permission.md) resource has a non-null **sharingLink** fac ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Shiftactivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/shiftactivity.md | Represents an activity in a [shift](shift.md). ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Shiftitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/shiftitem.md | Represents a version of a [shift](shift.md). ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Signin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/signin.md | The following JSON representation shows the resource type. "clientAppUsed": "String", "correlationId": "String", "conditionalAccessStatus": "string",- "appliedConditionalAccessPolicy": [{"@odata.type": "microsoft.graph.appliedConditionalAccessPolicy"}], + "appliedConditionalAccessPolicies": [{"@odata.type": "microsoft.graph.appliedConditionalAccessPolicy"}], "isInteractive": true, "deviceDetail": {"@odata.type": "microsoft.graph.deviceDetail"}, "location": {"@odata.type": "microsoft.graph.signInLocation"}, |
v1.0 | Signinfrequencysessioncontrol | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/signinfrequencysessioncontrol.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Signinlocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/signinlocation.md | Provides the city, state and country/region from where the sign-in happened. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Simulationautomation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/simulationautomation.md | Inherits from [entity](../resources/entity.md). |runs|[simulationAutomationRun](../resources/simulationautomationrun.md) collection|A collection of simulation automation runs. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Singlevaluelegacyextendedproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/singlevaluelegacyextendedproperty.md | None ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Site | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/site.md | The **site** resource provides metadata and relationships for a SharePoint site. | [Delete permission][] | DELETE /sites/{site-id}/permissions/{permission-id} | [Update permission][] | PATCH /sites/{site-id}/permissions/{permission-id} | [List operations](../api/site-list-operations.md)|[richLongRunningOperation](../resources/richlongrunningoperation.md) collection|Get a list of [rich long-running operations](../resources/richlongrunningoperation.md) associated with a [site](../resources/site.md).+| [List pages][] | GET /sites/{site-id}/pages | [Get site]: ../api/site-get.md [Get root site]: ../api/site-get.md The **site** resource provides metadata and relationships for a SharePoint site. [Create permissions]: ../api/site-post-permissions.md [Delete permission]: ../api/site-delete-permission.md [Update permission]: ../api/site-update-permission.md+[List pages]: ../api/baseSitePage-list.md ## Properties The `root` identifier always references the root site for a given target, as fol | **lists** | Collection([list][]) | The collection of lists under this site. | **onenote** | [onenote][] | Calls the OneNote service for notebook related operations. | **operations** | [richLongRunningOperation](../resources/richlongrunningoperation.md) collection | The collection of long-running operations on the site.+| **pages** | Collection([baseSitePage][]) | The collection of pages in the baseSitePages list in this site. | | **permissions** | Collection([permission][]) | The permissions associated with the site. Nullable. | **sites** | Collection([site][]) | The collection of the sub-sites under this site. | **termStore** | [microsoft.graph.termStore.store] | The default termStore under this site. The `root` identifier always references the root site for a given target, as fol [columnDefinition]: columndefinition.md [baseItem]: baseitem.md [contentType]: contenttype.md+[baseSitePage]: baseSitePage.md [drive]: drive.md [identitySet]: identityset.md [itemAnalytics]: itemanalytics.md |
v1.0 | Sitecollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sitecollection.md | Last updated 09/10/2017 Title: SiteCollection + Title: siteCollection resource type ms.localizationpriority: medium description: "Provides more information about a site collection." doc_type: resourcePageType -# siteCollection resource +# siteCollection resource type Namespace: microsoft.graph |
v1.0 | Sitepage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sitepage.md | + + Title: "sitePage resource type" +description: Represents a site page in the sitePages list. ++ms.localizationpriority: medium +++# sitePage resource type ++Namespace: microsoft.graph ++++This resource represents a page in the sitePages [list](../resources/list.md). +It contains the title, layout, and a collection of [webPart](../resources/webpart.md)s. ++Inherits from [baseSitePage](../resources/basesitepage.md). ++## Methods ++| Method | Return type | Description | +| :-- | :- | :- | +| [List sitePages](../api/sitepage-list.md) | [sitePage](../resources/sitepage.md) collection | Get a list of the [sitePage](../resources/sitepage.md) objects and their properties. | +| [Create sitePage](../api/sitepage-create.md) | [sitePage](../resources/sitepage.md) | Create a new [sitePage](../resources/sitepage.md) object. | +| [Get sitePage](../api/sitepage-get.md) | [sitePage](../resources/sitepage.md) | Read the properties and relationships of a [sitePage](../resources/sitepage.md) object. | +| [Update sitePage](../api/sitepage-update.md) | [sitePage](../resources/sitepage.md) | Update the properties of a [sitePage](../resources/sitepage.md) object. | +| [Delete sitePage](../api/basesitepage-delete.md) | None | Deletes a [sitePage](../resources/sitepage.md) object. | +| [Publish sitePage](../api/sitepage-publish.md) | None | Publish a [sitePage](../resources/sitepage.md) object. | +| [Get a collection of WebParts by position information](../api/sitepage-getwebpartsbyposition.md) | [webPart](../resources/webpart.md) collection | Get a collection of [WebPart](../resources/webpart.md) by providing [webPartPosition](../resources/webpartposition.md) information. | ++## Properties ++| Property | Type | Description | +| :- | : | : | +| contentType | [contentTypeInfo](../resources/contentTypeInfo.md) | The content type of this item. Inherited from [baseSitePage](../resources/basesitepage.md). | +| createdBy | [identitySet](../resources/identityset.md) | Identity of the creator of this item. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md). | +| createdDateTime | DateTimeOffset | The date and time the item was created. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md). | +| description | String | The descriptive text for the item. Inherited from [baseSitePage](../resources/basesitepage.md). | +| eTag | String | ETag for the item. Inherited from [baseSitePage](../resources/basesitepage.md). | +| id | String | The unique identifier of the item. Inherited from [baseSitePage](../resources/basesitepage.md). | +| lastModifiedBy | [identitySet](../resources/identityset.md) | TIdentity of the last modifier of this item. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md). | +| lastModifiedDateTime | DateTimeOffset | The date and time the item was last modified. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md). | +| name | String | The name of the item. Inherited from [baseSitePage](../resources/basesitepage.md). | +| pageLayout | [pageLayoutType](../resources/basesitepage.md#pagelayouttype-values) | The name of the page layout of the page. The possible values are: `microsoftReserved`, `article`, `home`, `unknownFutureValue`. Inherited from [baseSitePage](../resources/basesitepage.md). | +| parentReference | [itemReference](../resources/itemreference.md) | Parent information, if the item has a parent. Inherited from [baseSitePage](../resources/basesitepage.md). | +| promotionKind | [pagePromotionType](../resources/sitepage.md#pagepromotiontype-values) | Indicates the promotion kind of the sitePage. The possible values are: `microsoftReserved`, `page`, `newsPost`, `unknownFutureValue`. | +| publishingState | [publicationFacet](../resources/publicationfacet.md) | The publishing status and the MM.mm version of the page. Inherited from [baseSitePage](../resources/basesitepage.md). | +| reactions | [reactionsFacet](../resources/reactionsfacet.md) | Reactions information for the page. | +| showComments | Boolean | Determines whether or not to show comments at the bottom of the page. | +| showRecommendedPages | Boolean | Determines whether or not to show recommended pages at the bottom of the page. | +| thumbnailWebUrl | String | Url of the sitePage's thumbnail image | +| title | String | Title of the sitePage. Inherited from [baseSitePage](../resources/basesitepage.md). | +| titleArea | [titleArea](../resources/titlearea.md) | Title area on the SharePoint page. | +| webUrl | String | URL that displays the resource in the browser. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md). | ++### pagePromotionType values ++| Value | Description | +| -- | -- | +| `microsoftReserved` | The page is a special type, reserved for use by Microsoft only. This value cannot be used when creating the page with [Create sitePage](../api/sitepage-create.md) method. | +| `page` | The page is promoted as a normal page | +| `newsPost` | The page is promoted as a news post | +| `unknownFutureValue` | Marker value for future compatibility. | ++## Relationships ++| Relationship | Type | Description | +| :-- | :-- | :-- | +| canvasLayout | [canvasLayout](../resources/canvaslayout.md) | Indicates the layout of the content in a given SharePoint page, including horizontal sections and vertical sections. | +| createdByUser | [user](../resources/user.md) | Identity of the creator of this item. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md). | +| lastModifiedByUser | [user](../resources/user.md) | Identity of the last modifier of this item. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md). | +| webParts | [webPart](../resources/webpart.md) collection | Collection of webparts on the SharePoint page. | ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.sitePage", + "baseType": "microsoft.graph.baseSitePage", + "openType": true +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.sitePage", + "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", + "promotionKind": "String", + "publishingState": { + "@odata.type": "microsoft.graph.publicationFacet" + }, + "reactions": { + "@odata.type": "microsoft.graph.reactionsFacet" + }, + "showComments": "Boolean", + "showRecommendedPages": "Boolean", + "thumbnailWebUrl": "String", + "titleArea": { + "@odata.type": "microsoft.graph.titleArea" + } +} +``` |
v1.0 | Sizerange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sizerange.md | Specifies the maximum and minimum sizes (in kilobytes) that an incoming message ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Skype For Business Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/skype-for-business-activity-reports.md | - Title: "Skype for Business activity reports" -description: "You can use the Skype for Business activity reports to get details on activity across your organization. These details can help you investigate, plan, and make other business decisions for your organization." ---doc_type: conceptualPageType ---# Skype for Business activity reports --Namespace: microsoft.graph --You can use the Skype for Business activity reports to get details on activity across your organization. These details can help you investigate, plan, and make other business decisions for your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Skype for Business activity](https://support.office.com/client/Skype-for-Business-Online-activity-8cbe2eb2-1194-4fd7-b1ee-9f9287c82424). --## Reports --| Function | 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. | - |
v1.0 | Skype For Business Device Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/skype-for-business-device-usage-reports.md | - Title: "Skype for Business device usage reports" -description: "You can use the Skype for Business device usage reports to get details on the types of clients and devices that are used across your organization. These details are helpful when you are investigating, planning, and making other business decisions for your organization." ---doc_type: conceptualPageType ---# Skype for Business device usage reports --Namespace: microsoft.graph --You can use the Skype for Business device usage reports to get details on the types of clients and devices that are used across your organization. These details are helpful when you are investigating, planning, and making other business decisions for your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Skype for Business clients used](https://support.office.com/client/Skype-for-Business-clients-used-b9019c36-034f-40c7-acb0-c2a0400b03c3). --## Reports --| Function | 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. | - |
v1.0 | Skype For Business Organizer Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/skype-for-business-organizer-activity-reports.md | - Title: "Skype for Business organizer activity reports" -description: "You can use the Skype for Business organizer activity reports to get details on organized conferences activity across your organization. These details are helpful when you're investigating, planning, and making other business decisions for your organization." ---doc_type: conceptualPageType ---# Skype for Business organizer activity reports --Namespace: microsoft.graph --You can use the Skype for Business organizer activity reports to get details on organized conferences activity across your organization. These details are helpful when you're investigating, planning, and making other business decisions for your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Skype for Business conference organizer activity](https://support.office.com/client/Skype-for-Business-Online-conference-organized-activity-03a255d4-0e1d-4b24-b73d-7a62fae36254). --## Reports --| Function | 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. | - |
v1.0 | Skype For Business Participant Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/skype-for-business-participant-activity-reports.md | - Title: "Skype for Business participant activity reports" -description: "You can use the Skype for Business participant activity reports to get details on conferencing activity across your organization. These details are helpful when you're investigating, planning, and making other business decisions for your organization." ---doc_type: conceptualPageType ---# Skype for Business participant activity reports --Namespace: microsoft.graph --You can use the Skype for Business participant activity reports to get details on conferencing activity across your organization. These details are helpful when you're investigating, planning, and making other business decisions for your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Skype for Business conference participant activity](https://support.office.com/client/Skype-for-Business-Online-conference-participant-activity-c3c89995-65dd-4715-9e38-bb244c742c6b). --## Reports --| Function | 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. | - |
v1.0 | Skype For Business Peer To Peer Activity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/skype-for-business-peer-to-peer-activity.md | - Title: "Skype for Business peer-to-peer activity reports" -description: "You can use the Skype for Business peer-to-peer activity reports to get details on peer-to-peer activity across your organization. These details are very helpful when you are investigating, planning, and making other business decisions for your organization." ---doc_type: conceptualPageType ---# Skype for Business peer-to-peer activity reports --Namespace: microsoft.graph --You can use the Skype for Business peer-to-peer activity reports to get details on peer-to-peer activity across your organization. These details are very helpful when you are investigating, planning, and making other business decisions for your organization. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Skype for Business peer-to-peer activity](https://support.office.com/client/Skype-for-Business-Online-peertopeer-activity-d3b2d569-4ee9-44b8-92bf-d518142f0713). --## Reports --| Function | 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. | -- |
v1.0 | Smsauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/smsauthenticationmethodconfiguration.md | Inherits from [authenticationMethodConfiguration](../resources/authenticationmet |includeTargets|[smsAuthenticationMethodTarget](../resources/smsauthenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Smsauthenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/smsauthenticationmethodtarget.md | Inherits from [authenticationMethodConfiguration](../resources/authenticationmet None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Softwareoathauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/softwareoathauthenticationmethod.md | This resource type is a derived type that inherits from the [authenticationMetho None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Sortfield | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sortfield.md | Title: "SortField resource type" + Title: workbookSortField resource type description: "Represents a condition in a sorting operation." ms.localizationpriority: medium -# SortField resource type +# workbookSortField resource type Namespace: microsoft.graph Represents a condition in a sorting operation. ## Properties | Property | Type |Description| |:|:--|:-|-|ascending|boolean|Represents whether the sorting is done in an ascending fashion.| +|ascending|Boolean|Represents whether the sorting is done in an ascending fashion.| |color|string|Represents the color that is the target of the condition if the sorting is on font or cell color.| |dataOption|string|Represents additional sorting options for this field. The possible values are: `Normal`, `TextAsNumber`.|-|icon|[WorkbookIcon](icon.md)|Represents the icon that is the target of the condition if the sorting is on the cell's icon.| +|icon|[workbookIcon](workbookicon.md)|Represents the icon that is the target of the condition if the sorting is on the cell's icon.| |key|int|Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).| |sortOn|string|Represents the type of sorting of this condition. The possible values are: `Value`, `CellColor`, `FontColor`, `Icon`.| ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Standardtimezoneoffset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/standardtimezoneoffset.md | That means the transition from daylight saving time to standard occurs at 2 AM o ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Standardwebpart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/standardwebpart.md | + + Title: 'standardWebPart resource type' +description: Represents a standard web part instance on a SharePoint page. ++ms.localizationpriority: medium +++# standardWebPart resource type ++Namespace: microsoft.graph ++++Represents a standard web part instance on a SharePoint page. ++Inherits from [webPart](../resources/webpart.md). ++## Properties ++| Property | Type | Description | +| : | :-- | :-- | +| containerTextWebPartId | string | The instance identifier of the container text webPart. It only works for inline standard webPart in rich text webParts. | +| data | [webPartData](../resources/webpartdata.md) | Data of the webPart. | +| id | String | Instance identifier of the webPart. Inherited from [entity](../resources/entity.md). | +| webPartType | String | A Guid that indicates the webPart type. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.standardWebPart", + "baseType": "microsoft.graph.webPart", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.standardWebPart", + "containerTextWebPartId": "String", + "id": "String (identifier)", + "webPartType": "String", + "data": { + "@odata.type": "microsoft.graph.webPartData" + } +} +``` |
v1.0 | Subjectset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/subjectset.md | This object is an abstract base type from which the following resources are deri + [singleServicePrincipal](singleserviceprincipal.md) + [targetManager](targetmanager.md) + [targetApplicationOwners](targetapplicationowners.md)++ [targetUserSponsors](targetusersponsors.md) ## Properties |
v1.0 | Subscribedsku | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/subscribedsku.md | Only the read operation is supported on subscribed SKUs; create, update, and del | servicePlans | [servicePlanInfo](serviceplaninfo.md) collection | Information about the service plans that are available with the SKU. Not nullable. | | skuId | Guid | The unique identifier (GUID) for the service SKU. | | skuPartNumber | String | The SKU part number; for example: "AAD_PREMIUM" or "RMSBASIC". To get a list of commercial subscriptions that an organization has acquired, see [List subscribedSkus](../api/subscribedsku-list.md). |-| subscriptionsIds | String collection | A list of all subscription IDs associated with this SKU. | +| subscriptionIds | String collection | A list of all subscription IDs associated with this SKU. | ## Relationships None ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Subscribetotoneoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/subscribetotoneoperation.md | None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Subscription | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/subscription.md | Title: "subscription resource type" description: "Represents a subscription that allows a client app to receive change notifications about changes to data in Microsoft Graph." ms.localizationpriority: high +ms.sbservice: change-notifications doc_type: resourcePageType For more information about subscriptions and change notifications, including res | [List subscriptions](../api/subscription-list.md) | [subscription](subscription.md) | Lists active subscriptions. | | [Create subscription](../api/subscription-post-subscriptions.md) | [subscription](subscription.md) | Subscribes a listener application to receive change notifications when Microsoft Graph data changes. | | [Get subscription](../api/subscription-get.md) | [subscription](subscription.md) | Reads properties and relationships of subscription object. |-| [Update subscription](../api/subscription-update.md) | [subscription](subscription.md) | Renews a subscription by updating its expiration time. | +| [Update subscription](../api/subscription-update.md) | [subscription](subscription.md) | Updates a subscription expiration time for renewal and/or updates the notificationUrl for delivery. | | [Delete subscription](../api/subscription-delete.md) | None | Deletes a subscription object. | |[Reauthorize](../api/subscription-reauthorize.md)|None|Reauthorize a subscription when you receive a **reauthorizationRequired** challenge. | |
v1.0 | Synchronization Attributedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-attributedefinition.md | Describes an attribute of an object. |:--|:-|:| |anchor |Boolean | `true` if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is `false`. One, and only one, of the object's attributes must be designated as the anchor to support synchronization. | |caseExact |Boolean |`true` if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.|+|defaultValue |String |The default value of the attribute.| |flowNullValues |Boolean |'true' to allow null values for attributes.| |metadata |[attributeDefinitionMetadataEntry](../resources/synchronization-attributedefinitionmetadataentry.md) collection |Metadata for the given object.| |multivalued |Boolean |`true` if an attribute can have multiple values. Default is `false`.| |
v1.0 | Synchronization Attributemappingsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-attributemappingsource.md | Expression extracting first eight characters from the source attribute. ``` ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.attributeMappingSource" |
v1.0 | Synchronization Bulkupload | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-bulkupload.md | doc_type: resourcePageType Namespace: microsoft.graph -Represents the capability of the Microsoft Entra synchronization service to process bulk uploads. +Represents the capability of the Microsoft Entra synchronization service to process bulk uploads. For more information, see [API-driven inbound provisioning concepts](/entra/identity/app-provisioning/inbound-provisioning-api-concepts). ## Methods |
v1.0 | Synchronization Directorydefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-directorydefinition.md | Inherits from [entity](../resources/entity.md). ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", Here's a JSON representation of the resource. "discoverabilities": "String", "discoveryDateTime": "DateTimeOffset", "id": "String",- "metadata": [ - { - "@odata.type": "microsoft.graph.stringKeyStringValuePair" - } - ], "name": "String", "objects": [ { |
v1.0 | Synchronization Filter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-filter.md | For more information, see [Attribute-based application provisioning with scoping ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Synchronization Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-overview.md | To work with the Microsoft Entra ID synchronization APIs, Microsoft Graph suppor - Application.Read.All - Application.ReadWrite.All -And the following [Microsoft Entra directory roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): +And the following least privileged [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): - Application Administrator - Cloud Application Administrator - Hybrid Identity Administrator-- Global Administrator For more information about the privileges you need to call each API, visit the respective API reference documentation. |
v1.0 | Synchronization Synchronization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-synchronization.md | Represents the capability for Microsoft Entra identity synchronization through t |templates|[synchronizationTemplate](../resources/synchronization-synchronizationtemplate.md) collection| Preconfigured synchronization settings for a particular application.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.synchronization", |
v1.0 | Synchronization Synchronizationjobrestartcriteria | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-synchronizationjobrestartcriteria.md | Defines the scope of the [synchronizationJob: restart](../api/synchronization-sy ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Synchronization Synchronizationrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-synchronizationrule.md | Synchronization rules are updated as part of the [synchronization schema](synchr ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Synchronization Synchronizationschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-synchronizationschedule.md | Defines the schedule used to run a [synchronizationJob](synchronization-synchron ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Synchronization Synchronizationschema | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-synchronizationschema.md | The following sections describe the high-level components of the synchronization |directories|[directoryDefinition](../resources/synchronization-directorydefinition.md) collection|Contains the collection of directories and all of their objects.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Synchronization Synchronizationsecretkeystringvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-synchronizationsecretkeystringvaluepair.md | Represents a single secret value. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Synchronization Synchronizationtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/synchronization-synchronizationtemplate.md | You can provide multiple templates for an application, and designate a default t ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Table | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/table.md | - Title: "Table resource type" -description: "Represents an Excel table." ---doc_type: resourcePageType ---# Table resource type --Namespace: microsoft.graph --Represents an Excel table. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get Table](../api/table-get.md) | [WorkbookTable](table.md) |Read properties and relationships of table object.| -|[Create TableColumn](../api/table-post-columns.md) |[WorkbookTableColumn](workbooktablecolumn.md)| Create a new TableColumn by posting to the columns collection.| -|[List columns](../api/table-list-columns.md) |[WorkbookTableColumn](workbooktablecolumn.md) collection| Get a TableColumn object collection.| -|[Create TableRow](../api/table-post-rows.md) |[WorkbookTableRow]( workbooktablerow.md)| Create a new TableRow by posting to the rows collection.| -|[List rows](../api/table-list-rows.md) |[WorkbookTableRow]( workbooktablerow.md) collection| Get a TableRow object collection.| -|[Update](../api/table-update.md) | [WorkbookTable](table.md) |Update Table object. | -|[Databodyrange](../api/table-databodyrange.md)|[Range](range.md)|Gets the range object associated with the data body of the table.| -|[Headerrowrange](../api/table-headerrowrange.md)|[Range](range.md)|Gets the range object associated with header row of the table.| -|[Range](../api/table-range.md)|[Range](range.md)|Gets the range object associated with the entire table.| -|[Totalrowrange](../api/table-totalrowrange.md)|[Range](range.md)|Gets the range object associated with totals row of the table.| -|[Clearfilters](../api/table-clearfilters.md)|None|Clears all the filters currently applied on the table.| -|[Converttorange](../api/table-converttorange.md)|[Range](range.md)|Converts the table into a normal range of cells. All data is preserved.| -|[Delete](../api/table-delete.md)|None|Deletes the table.| -|[Reapplyfilters](../api/table-reapplyfilters.md)|None|Reapplies all the filters currently on the table.| -|[List](../api/table-list.md) | [WorkbookTable](table.md) collection |Get table object collection. | -|[Add](../api/tablecollection-add.md)|[WorkbookTable](table.md)|Create a new table. The range source address determines the worksheet under which the table will be added. If the table can't be added (for example, because the address is invalid, or the table would overlap with another table), an error is thrown.| --## Properties -| Property | Type |Description| -|:|:--|:-| -|highlightFirstColumn|Boolean|Indicates whether the first column contains special formatting. | -|highlightLastColumn|Boolean|Indicates whether the last column contains special formatting. | -|id|string|Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. This property should be interpreted as an opaque string value and shouldn't be parsed to any other type. Read-only.| -|legacyId|String|Legacy ID used in older Excel clients. The value of the identifier remains the same even when the table is renamed. This property should be interpreted as an opaque string value and shouldn't be parsed to any other type. Read-only. -|name|string|Name of the table.| -|showBandedRows|Boolean|Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier. | -|showBandedColumns|Boolean|Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier. | -|showFilterButton|Boolean|Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. | -|showHeaders|boolean|Indicates whether the header row is visible or not. This value can be set to show or remove the header row.| -|showTotals|boolean|Indicates whether the total row is visible or not. This value can be set to show or remove the total row.| -|style|string|Constant value that represents the Table style. The possible values are: TableStyleLight1 through TableStyleLight21, TableStyleMedium1 through TableStyleMedium28, TableStyleStyleDark1 through TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|columns|[WorkbookTableColumn](workbooktablecolumn.md) collection|Represents a collection of all the columns in the table. Read-only.| -|rows|[WorkbookTableRow]( workbooktablerow.md) collection|Represents a collection of all the rows in the table. Read-only.| -|sort|[WorkbookTableSort](tablesort.md)|Represents the sorting for the table. Read-only.| -|worksheet|[WorkbookWorksheet](worksheet.md)|The worksheet containing the current table. Read-only.| --## JSON representation --Here's a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [ - "legacyId" - ], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookTable" -}--> --```json -{ - "highlightFirstColumn": true, - "highlightLastColumn": true, - "id": "String (identifier)", - "name": "String", - "showBandedColumns": true, - "showBandedRows": true, - "showFilterButton": true, - "showHeaders": true, - "showTotals": true, - "style": "String", - "legacyId": "String" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "Table resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Tablesort | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/tablesort.md | - Title: "TableSort resource type" -description: "Manages sorting operations on Table objects." ---doc_type: resourcePageType ---# TableSort resource type --Namespace: microsoft.graph --Manages sorting operations on Table objects. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get TableSort](../api/tablesort-get.md) | [WorkbookTableSort](tablesort.md) |Read properties and relationships of tableSort object.| -|[Apply](../api/tablesort-apply.md)|None|Perform a sort operation.| -|[Clear](../api/tablesort-clear.md)|None|Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the state of the header buttons.| -|[Reapply](../api/tablesort-reapply.md)|None|Reapplies the current sorting parameters to the table.| --## Properties -| Property | Type |Description| -|:|:--|:-| -|fields|[WorkbookSortField](sortfield.md) collection|Represents the current conditions used to last sort the table. Read-only.| -|matchCase|boolean|Represents whether the casing impacted the last sort of the table. Read-only.| -|method|string|Represents Chinese character ordering method last used to sort the table. The possible values are: `PinYin`, `StrokeCount`. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!-- { - "blockType": "resource", - "optionalProperties": [ -- ], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookTableSort" -}--> --```json -{ - "matchCase": true, - "method": "string", - "fields": [{ "@odata.type": "microsoft.graph.workbookSortField" }] -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "TableSort resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Targetapplicationowners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/targetapplicationowners.md | None. ## 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.targetApplicationOwners" |
v1.0 | Targetresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/targetresource.md | Represents target resource types associated with audit activity. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
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." ++ms.localizationpriority: medium ++++# targetUserSponsors complex 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). +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). ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.targetUserSponsors" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.targetUserSponsors", +} +``` |
v1.0 | Teaminfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teaminfo.md | Base type of [associatedTeamInfo](associatedteaminfo.md) and [sharedWithChannelT ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Teamslicensingdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamslicensingdetails.md | + + Title: "teamsLicensingDetails resource type" +description: "A container where you can find all the different Microsoft Teams license details for each user in the tenant." ++ms.localizationpriority: high ++++# teamsLicensingDetails resource type ++Namespace: microsoft.graph ++A container where you can find all the different Microsoft Teams license details for each user in the tenant. ++## Properties ++| Property | Type | Description | +|:|:--|:-| +|hasTeamsLicense|Boolean|Indicates whether the user has a valid license to use Microsoft Teams.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.teamsLicensingDetails", + "baseType": "microsoft.graph.entity" +}--> ++```json +{ + "hasTeamsLicense": "Boolean", +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "teamslicensingdetails resource", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [] +} +--> ++## Related content ++- [teamwork resource type](teamwork.md) +- [userTeamwork resource type](userteamwork.md) |
v1.0 | Teamstab | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamstab.md | Title: "teamsTab resource type" -description: "A teamsTab is a tab that's pinned (attached) to a channel within a team. " +description: "Represents a tab pinned (attached) to a channel or a chat." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph +Represents a tab pinned (attached) to a [channel](channel.md) or a [chat](chat.md). --A teamsTab is a [tab](../resources/teamstab.md) that's pinned (attached) to a [channel](channel.md) within a [team](team.md). +For more information about tabs, see [Build tabs for Teams](/microsoftteams/platform/tabs/what-are-tabs). ## Methods A teamsTab is a [tab](../resources/teamstab.md) that's pinned (attached) to a [c ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { |
v1.0 | Teamstemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamstemplate.md | A team template is a blueprint for creating a [team](../resources/team.md) in Mi <!-- { "blockType": "resource",+ "keyProperty": "id", "@odata.type": "microsoft.graph.teamsTemplate", "baseType": "microsoft.graph.entity" }--> |
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 |Method|Return type|Description| |:|:|:| |[List deletedTeams](../api/teamwork-list-deletedteams.md)|[deletedTeam](../resources/deletedteam.md) collection|Get a list of the [deletedTeam](../resources/deletedteam.md) objects and their properties.|+|[Get teamwork](../api/teamwork-get.md)|[teamwork](../resources/teamwork.md)|Get the properties and relationships of a teamwork object, such as the region of the organization and whether Microsoft Teams is enabled.| ## Properties | Property | Type | Description | |:|:--|:-|-|id|string| A unique identifier. | +|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. [!INCLUDE [supported-regions](../../includes/teamwork-supported-regions.md)]| ## Relationships The following JSON representation shows the resource type. ```json {- "id": "string" + "@odata.type": "#microsoft.graph.teamwork", + "id": "String", + "isTeamsEnabled": "boolean", + "region": "String" } ``` |
v1.0 | Teamworkactivitytopic | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamworkactivitytopic.md | Represents the topic of an activity feed notification. 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.teamworkActivityTopic" |
v1.0 | Teamworkconversationidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamworkconversationidentity.md | Inherits from [identity](../resources/identity.md). 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.teamworkConversationIdentity" |
v1.0 | Teamworkhostedcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamworkhostedcontent.md | Represents rich content like images and code snippets in Microsoft Teams. For ri None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Temporaryaccesspassauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/temporaryaccesspassauthenticationmethod.md | +toc.keywords: [ TAP ] # temporaryAccessPassAuthenticationMethod resource type |
v1.0 | Tenantinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/tenantinformation.md | Namespace: microsoft.graph Information about your Microsoft Entra tenant that is publicly displayed to users in other Microsoft Entra tenants. +## Methods ++| Method | Return Type | Description | +|:-|:|:| +| [Find tenant by domain name](../api/tenantrelationship-findtenantinformationbydomainname.md) | tenantInformation | Given a domain name, search for a tenant and read its information. | +| [Find tenant by tenant ID](../api/tenantrelationship-findtenantinformationbytenantid.md) | tenantInformation | Given a tenant ID, search for a tenant and read its information. | + ## Properties |Property|Type|Description| |
v1.0 | Tenantrelationship | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/tenantrelationship.md | None. |:|:|:| |delegatedAdminCustomers|[delegatedAdminCustomer](../resources/delegatedadmincustomer.md) collection|The customer who has a delegated admin relationship with a Microsoft partner.| |delegatedAdminRelationships|[delegatedAdminRelationship](../resources/delegatedadminrelationship.md) collection|The details of the delegated administrative privileges that a Microsoft partner has in a customer tenant.|+|multiTenantOrganization|[multiTenantOrganization](../resources/multitenantorganization.md)|Defines an organization with more than one instance of Microsoft Entra ID.| ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Tenantrelationshipaccesspolicybase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/tenantrelationshipaccesspolicybase.md | The following is a JSON representation of the resource. "displayName": "String" } ```++<!-- +{ + "type": "#page.annotation", + "description": "tenantRelationshipAccessPolicyBase resource type", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: Property 'definition' found in resource definition for 'microsoft.graph.tenantRelationshipAccessPolicyBase', but not described in markdown table." + ] +} +--> |
v1.0 | Textwebpart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/textwebpart.md | + + Title: 'textWebPart resource type' +description: Represents a text web part instance on a SharePoint page. ++ms.localizationpriority: medium +++# textWebPart resource type ++Namespace: microsoft.graph ++++Represents a text web part instance on a SharePoint page. ++Inherits from [webPart](../resources/webpart.md). ++## Properties ++| Property | Type | Description | +| :-- | :-- | :-- | +| id | String | Instance identifier of the web part. Inherited from [entity](../resources/entity.md). | +| innerHtml | String | The HTML string in text web part. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.textWebPart", + "baseType": "microsoft.graph.webPart", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.textWebPart", + "id": "String (identifier)", + "innerHtml": "String" +} +``` |
v1.0 | Threatassessment Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/threatassessment-api-overview.md | Title: "Use the Microsoft Graph threat assessment API" description: "Microsoft Graph lets your app get authorized access to organization's threat assessment data." ms.localizationpriority: high -doc_type: resourcePageType # Use the Microsoft Graph threat assessment API |
v1.0 | Thumbnailset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/thumbnailset.md | It's used to represent a set of thumbnails associated with a DriveItem. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Timeconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/timeconstraint.md | Restricts meeting time suggestions to certain hours and days of the week accordi ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timeoffitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/timeoffitem.md | Represents a version of the [timeOff](timeoff.md). ## JSON representation -Here is a JSON representation of the 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 | Represents a time slot for a meeting. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timestamp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/timestamp.md | Date and time information for a point in time. ## JSON representation -Here is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timezonebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/timezonebase.md | The basic representation of a time zone. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timezoneinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/timezoneinformation.md | format as well when the current known problem is fixed. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Titlearea | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/titlearea.md | + + Title: 'titleArea resource type' +description: Represents the title area of a given SharePoint page. ++ms.localizationpriority: medium +++# titleArea resource type ++Namespace: microsoft.graph ++++Represents the title area of a given SharePoint page. ++## Properties ++| Property | Type | Description | +| :- | :- | : | +| alternativeText | String | Alternative text on the title area. | +| enableGradientEffect | Boolean | Indicates whether the title area has a gradient effect enabled. | +| imageWebUrl | String | URL of the image in the title area. | +| layout | [titleAreaLayoutType](../resources/titlearea.md#titlearealayouttype-values) | Enumeration value that indicates the layout of the title area. The possible values are: `imageAndTitle`, `plain`, `colorBlock`, `overlap`, `unknownFutureValue`. | +| serverProcessedContent | [serverProcessedContent](../resources/serverprocessedcontent.md) | Contains collections of data that can be processed by server side services like search index and link fixup. | +| showAuthor | Boolean | Indicates whether the author should be shown in title area. | +| showPublishedDate | Boolean | Indicates whether the published date should be shown in title area. | +| showTextBlockAboveTitle | Boolean | Indicates whether the text block above title should be shown in title area. | +| textAboveTitle | String | The text above title line. | +| textAlignment | [titleAreaTextAlignmentType](../resources/titlearea.md#titleareatextalignmenttype-values) | Enumeration value that indicates the text alignment of the title area. The possible values are: `left`, `center`, `unknownFutureValue`. | ++### titleAreaLayoutType values ++| Member | Description | +| :-- | :-- | +| imageAndTitle | The title area has an image and title layout. | +| plain | The title area has a plain layout. | +| colorBlock | The title area has a color block layout. | +| overlap | The title area has an overlap layout. | +| unknownFutureValue | Marker value for future compatibility. | ++### titleAreaTextAlignmentType values ++| Member | Description | +| :-- | :- | +| left | The text in title area is left-aligned. | +| center | The text in title area is center-aligned. | +| unknownFutureValue | Marker value for future compatibility. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.titleArea" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.titleArea", + "alternativeText": "String", + "enableGradientEffect": "Boolean", + "imageWebUrl": "String", + "layout": "String", + "serverProcessedContent": { + "@odata.type": "microsoft.graph.serverProcessedContent" + }, + "showAuthor": "Boolean", + "showPublishedDate": "Boolean", + "showTextBlockAboveTitle": "Boolean", + "textAboveTitle": "String", + "textAlignment": "String" +} +``` |
v1.0 | Unifiedroleassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/unifiedroleassignment.md | Title: "unifiedRoleAssignment resource type" -description: "A role assignment is the link between a role definition and a principal at a particular scope for the purpose of granting access." +description: "A role assignment is the link between a role definition and a principal at a particular scope for access." ms.localizationpriority: medium Inherits from [entity](entity.md). | Property | Type | Description | |:-|:|:|-|appScopeId|String|Identifier of the app specific scope when the assignment scope is app specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by a resource application only. For the entitlement management provider, use this property to specify a catalog, for example `/AccessPackageCatalog/beedadfe-01d5-4025-910b-84abb9369997`. Supports `$filter` (`eq`, `in`). For example `/roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/AccessPackageCatalog/{catalog id}'`.| +|appScopeId|String|Identifier of the app specific scope when the assignment scope is app specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by a resource application only. For the entitlement management provider, use this property to specify a catalog. For example, `/AccessPackageCatalog/beedadfe-01d5-4025-910b-84abb9369997`. Supports `$filter` (`eq`, `in`). For example, `/roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/AccessPackageCatalog/{catalog id}'`.| |directoryScopeId|String|Identifier of the [directory object](directoryobject.md) representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications, unlike app scopes that are defined and understood by a resource application only. Supports `$filter` (`eq`, `in`).| |id|String| The unique identifier for the unifiedRoleAssignment. Key, not nullable, Read-only. | |principalId|String| Identifier of the principal to which the assignment is granted. Supported principals are users, role-assignable groups, and service principals. Supports `$filter` (`eq`, `in`). | Inherits from [entity](entity.md). | Relationship | Type | Description | |:-|:|:|-|appScope|[appScope](appscope.md)|Read-only property with details of the app specific scope when the assignment scope is app specific. Containment entity. Supports `$expand`.| +|appScope|[appScope](appscope.md)|Read-only property with details of the app specific scope when the assignment scope is app specific. Containment entity. Supports `$expand` for the entitlement provider only.| |directoryScope|[directoryObject](directoryobject.md)|The directory object that is the scope of the assignment. Read-only. Supports `$expand`.| |principal|[directoryObject](directoryobject.md)| Referencing the assigned principal. Read-only. Supports `$expand`.| |roleDefinition|[unifiedRoleDefinition](unifiedroledefinition.md)|The roleDefinition the assignment is for. Supports `$expand`.| Inherits from [entity](entity.md). ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Unifiedrolemanagementpolicyauthenticationcontextrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/unifiedrolemanagementpolicyauthenticationcontextrule.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Unifiedrolemanagementpolicyexpirationrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/unifiedrolemanagementpolicyexpirationrule.md | None. None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Unifiedrolemanagementpolicyrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/unifiedrolemanagementpolicyrule.md | Inherits from [entity](../resources/entity.md). None. ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Updaterecordingstatusoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/updaterecordingstatusoperation.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Uploadsession | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/uploadsession.md | The **uploadSession** resource provides information about how to upload large fi ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Urlassessmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/urlassessmentrequest.md | Used to create and retrieve a URL threat assessment, derived from [threatAssessm ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/user.md | description: "Represents a Microsoft Entra user account. Inherits from directory ms.localizationpriority: high+ doc_type: resourcePageType This resource supports: | [List tasks](../api/planneruser-list-tasks.md) | [plannerTask](plannertask.md) collection | Get plannerTasks assigned to the user. | | **Schema extensions** | | | | [Add schema extension values](/graph/extensibility-schema-groups) | None | Create a schema extension definition and then use it to add custom typed data to a resource. |+| **Sponsors** | | | +| [Assign sponsors](../api/user-post-sponsors.md) | None | Assign a user a sponsor. | +| [List sponsors](../api/user-list-sponsors.md) | [directoryObject](../resources/directoryobject.md) collection | Get the users and groups who are this user's sponsors. | +| [Remove sponsors](../api/user-delete-sponsors.md) | None | Remove a user's sponsor. | | **Teamwork** | | | | [List apps installed for user](../api/userteamwork-list-installedapps.md) | [userScopeTeamsAppInstallation](userscopeteamsappinstallation.md) collection | Lists apps installed in the personal scope of a user. | | [Gets the installed app for user](../api/userteamwork-get-installedapps.md) | [userScopeTeamsAppInstallation](userscopeteamsappinstallation.md) | Lists the specified app installed in the personal scope of a user. | This resource supports: |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 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>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 one of the following Microsoft Entra roles: *Lifecycle Workflows Administrator*, *Global Reader*, or *Global Administrator*. 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><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).| | 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: |surname|String|The user's surname (family name or last name). Maximum length is 64 characters. <br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| |usageLocation|String|A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: `US`, `JP`, and `GB`. Not nullable. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| |userPrincipalName|String|The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the **verifiedDomains** property of [organization](organization.md).<br>NOTE: This property can't contain accent characters. Only the following characters are allowed `A - Z`, `a - z`, `0 - 9`, ` ' . - _ ! # ^ ~`. For the complete list of allowed characters, see [username policies](/azure/active-directory/authentication/concept-sspr-policy#userprincipalname-policies-that-apply-to-all-user-accounts). <br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`) and `$orderby`.-|userType|String|A string value that can be used to classify user types in your directory, such as `Member` and `Guest`. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). **NOTE:** For more information about the permissions for member and guest users, see [What are the default user permissions in Microsoft Entra ID?](/azure/active-directory/fundamentals/users-default-permissions?context=graph/context#member-and-guest-users) | +|userType|String|A string value that can be used to classify user types in your directory. The possible values are `Member` and `Guest`. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). **NOTE:** For more information about the permissions for member and guest users, see [What are the default user permissions in Microsoft Entra ID?](/azure/active-directory/fundamentals/users-default-permissions?context=graph/context#member-and-guest-users) | > [!TIP] > Directory and schema extensions and their associated data are returned only on `$select`; Open extensions and their associated data are returned only on `$expand`. 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.|+|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. | |transitiveMemberOf| [directoryObject](directoryobject.md) collection | The groups, including nested groups, and directory roles that a user is a member of. Nullable.| |
v1.0 | Userflowlanguageconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/userflowlanguageconfiguration.md | For [Microsoft Entra user flows](/azure/active-directory/external-identities/use ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Useridentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/useridentity.md | Title: "userIdentity resource type" description: "In the context of a Microsoft Entra audit log, the resource represents the user information that initiated or was affected by an audit activity." ms.localizationpriority: medium + doc_type: resourcePageType |
v1.0 | Userregistrationfeaturecount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/userregistrationfeaturecount.md | None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Userregistrationfeaturesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/userregistrationfeaturesummary.md | Represents the summary of users capable of multi-factor authentication, self-ser |userRoles|includedUserRoles|The role type of the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`, `unknownFutureValue`.| |userTypes|includedUserTypes|User type. Possible values are: `all`, `member`, `guest`, `unknownFutureValue`.| -The value `privilegedAdmin` consists of the following privileged admin roles: +The value `privilegedAdmin` consists of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).: * Global Administrator * Security Administrator None. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Userregistrationmethodsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/userregistrationmethodsummary.md | Represents the summary of number of users registered for each authentication met |userRoles|includedUserRoles|The role type of the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`, `unknownFutureValue`.| |userTypes|includedUserTypes|User type. Possible values are: `all`, `member`, `guest`, `unknownFutureValue`.| -The value `privilegedAdmin` consists of the following privileged admin roles: +The value `privilegedAdmin` consists of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). * Global Administrator * Security Administrator |
v1.0 | Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/users.md | description: "Build compelling app experiences based on users, their relationshi ms.localizationpriority: high + doc_type: conceptualPageType Last updated 03/01/2024 |
v1.0 | Usersecuritystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/usersecuritystate.md | description: "Contains stateful information about the user account." ms.localizationpriority: medium+ doc_type: resourcePageType |
v1.0 | Usersettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/usersettings.md | description: "The current user settings for content discovery. " ms.localizationpriority: high+ doc_type: resourcePageType This resource supports: ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.userSettings" |
v1.0 | Userteamwork | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/userteamwork.md | Namespace: microsoft.graph Represents a container for the range of Microsoft Teams functionalities that are available per user in the tenant. +## Methods ++|Method|Return type|Description| +|:|:|:| +|[Get userTeamwork](../api/userteamwork-get.md)|[userTeamwork](../resources/userteamwork.md)|Get userTeamwork settings for the specified [user](../resources/user.md), which includes the Microsoft Teams region and the locale chosen by the user.| + ## Properties | Property | Type | Description | |:|:--|:-|-|id|string| The unique identifier for the **userTeamwork** object. | +|id| String|The unique identifier for the **userTeamwork** object.| +|locale|String |The chosen locale of a user in Microsoft Teams.| +|region |String|The region of the user in Microsoft Teams.| ## Relationships The following JSON representation shows the resource type. ```json {- "id": "String (identifier)" + "id": "String (identifier)", + "locale" : "String", + "region" : "String" } ``` The following JSON representation shows the resource type. } --> +## Related content ++- [teamwork resource type](teamwork.md) |
v1.0 | Verifieddomain | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/verifieddomain.md | Title: "verifiedDomain resource type" description: "Specifies a domain for a tenant. The verifiedDomains property of the organization entity is a collection of verifiedDomain objects." ms.localizationpriority: medium-+ doc_type: resourcePageType Specifies a domain for a tenant. The **verifiedDomains** property of the [organi ## Properties-| Property | Type | Description | -|:-|:--|:-| -| capabilities | String | For example, `Email`, `OfficeCommunicationsOnline`. | -| isDefault | Boolean | `true` if this is the default domain associated with the tenant; otherwise, `false`. | -| isInitial | Boolean | `true` if this is the initial domain associated with the tenant; otherwise, `false`. | -| name | String | The domain name; for example, contoso.com`. | -| type | String | For example, `Managed`. | +| Property | Type | Description| +|||| +| capabilities | String | For example, `Email`, `OfficeCommunicationsOnline`. | +| isDefault | Boolean | `true` if this is the default domain associated with the tenant; otherwise, `false`. | +| isInitial | Boolean | `true` if this is the initial domain associated with the tenant; otherwise, `false`. | +| name | String | The domain name; for example, `contoso.com`. | +| type | String | For example, `Managed`. | ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Verifiedpublisher | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/verifiedpublisher.md | Represents the verified publisher of the [application](application.md). For more ## JSON representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Verticalsection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/verticalsection.md | + + Title: 'verticalSection resource type' +description: Represents the vertical section in a given SharePoint page. ++ms.localizationpriority: medium +++# verticalSection resource type ++Namespace: microsoft.graph ++++Represents the vertical section in a given SharePoint page. ++Inherits from [entity](../resources/entity.md). ++## Methods ++| Method | Return type | Description | +| : | :- | :- | +| [List webParts](../api/webpart-list.md) | [webPart](../resources/webPart.md) Collection | Get a list of web parts associated with a [verticalSection](../resources/verticalSection.md) object. | +| [Create verticalSection](../api/sitepage-post-verticalsection.md) | [verticalSection](../resources/verticalsection.md) | Create a new [verticalSection](../resources/verticalsection.md) object. | +| [Get verticalSection](../api/verticalsection-get.md) | [verticalSection](../resources/verticalsection.md) | Read the properties and relationships of a [verticalSection](../resources/verticalsection.md) object. | +| [Update verticalSection](../api/verticalsection-update.md) | [verticalSection](../resources/verticalsection.md) | Update the properties of a [verticalSection](../resources/verticalsection.md) object. | +| [Delete verticalSection](../api/verticalsection-delete.md) | [verticalSection](../resources/verticalsection.md) | Delete a [verticalSection](../resources/verticalsection.md) object. | ++## Properties ++| Property | Type | Description | +| :- | :- | :-- | +| emphasis | [sectionEmphasisType](../resources/horizontalsection.md#sectionemphasistype-values) | Enumeration value that indicates the emphasis of the section background. The possible values are: `none`, `netural`, `soft`, `strong`, `unknownFutureValue`. | +| id | String | Unique identifier of the resource. Inherited from [entity](../resources/entity.md). | ++## Relationships ++| Relationship | Type | Description | +| :-- | :-- | : | +| webparts | [webPart](../resources/webpart.md) collection | The set of web parts in this section. | ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.verticalSection", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.verticalSection", + "id": "String (identifier)", + "emphasis": "String" +} +``` |
v1.0 | Virtualevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/virtualevent.md | Inherits from [entity](../resources/entity.md). |createdBy|[communicationsIdentitySet](communicationsidentityset.md)|Identity information for the creator of the virtual event. Inherited from [virtualEvent](../resources/virtualevent.md).| |description|[itemBody](../resources/itembody.md)|Description of the virtual event.| |displayName|String|Display name of the virtual event.|-|endDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|End time of the virtual event. The **timeZone** property _can_ be set to any of the [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones).| +|endDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|End time of the virtual event. 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).| |id|String|Unique identifier of the virtual event. Inherited from [entity](../resources/entity.md).|-|startDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|Start time of the virtual event. The **timeZone** property _can_ be set to any of the [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones).| +|startDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|Start time of the virtual event. 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).| |status|virtualEventStatus|Status of the virtual event. The possible values are: `draft`, `published`, `canceled`, `unknownFutureValue`.| ## Relationships |
v1.0 | Virtualeventsession | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/virtualeventsession.md | The following JSON representation shows the resource type. "blockType": "resource", "keyProperty": "id", "@odata.type": "microsoft.graph.virtualEventSession",- "openType": false + "openType": false, + "baseType": "microsoft.graph.onlineMeetingBase" } --> ``` json |
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). | createdBy | [communicationsIdentitySet](communicationsidentityset.md) | Identity information for the creator of the webinar. Inherited from [virtualEvent](../resources/virtualevent.md). | | description | [itemBody](../resources/itembody.md) | Description of the webinar. Inherited from [virtualEvent](../resources/virtualevent.md). | | displayName | String | Display name of the webinar. Inherited from [virtualEvent](../resources/virtualevent.md). |-| endDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | End time of the webinar. The **timeZone** property _can_ be set to any of the [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones). Inherited from [virtualEvent](../resources/virtualevent.md). | -| startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Start time of the webinar. The **timeZone** property _can_ be set to any of the [time zones currently supported by Windows](/windows-hardware/manufacture/desktop/default-time-zones). Inherited from [virtualEvent](../resources/virtualevent.md). | +| endDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | End time of the webinar. 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).| +| startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Start time of the webinar. 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).| | id | String | Unique identifier of the webinar. Inherited from [entity](../resources/entity.md).| | status | [virtualEventStatus](#virtualeventstatus-values) | Status of the webinar. | The following JSON representation shows the resource type. } ``` +## Related content ++[List meetingAttendanceReports](../api/meetingattendancereport-list.md) |
v1.0 | Viva Learning Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/viva-learning-api-overview.md | The employee learning API in Microsoft Graph enables apps to make content from a ## How do integrations work? As administrators, you can integrate your content and learner records (employee assignments and completed course records) from your LMS or learning provider with Viva Learning, by using out-of-the-box integrations where Viva Learning can pull content metadata and learning records from your LMS or learning provider. You can also [use the employee learning API](#use-cases-for-the-employee-learning-api-in-microsoft-graph) in Microsoft Graph to push content metadata from your LMS or learning provider into Viva Learning. -When the content metadata, employee assignments, and their completed course records are uploaded to Viva Learning, they appear in Viva Learning at the following locations: -- The content appears on the home page under the **Browse courses** ΓÇô **Providers** section.-- Assignments and completed course records appear on the **My Learning** page under the **Assigned to you** and **Completed** sections, respectively.+When the content metadata, employee assignments, and their completed course records are uploaded to Viva Learning, they appear in Viva Learning in the following locations: ++- When the content metadata is synchronized, the content appears on the home page under the **Browse courses** ΓÇô **Providers** section. +- When the learning course activities are synchronized, assignments, recommendations, and self-learning course records appear on the **My Learning** tab. Based on progression, the status will move from **In Progress** to **Completed**. ++The learning course activities for the learners can be discovered outside of Viva Learning via APIs. ## Authorization With the appropriate delegated or application [employee learning permissions](/graph/permissions-reference#employee-learning-permissions), your app can use the employee learning API to manage learning providers and their content for a learning hub in a tenant. For more information about access tokens, app registration, and delegated and application permissions, see [Authentication and authorization basics](/graph/auth/auth-concepts). |
v1.0 | Voiceauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/voiceauthenticationmethodconfiguration.md | Title: "voiceAuthenticationMethodConfiguration resource type" -description: "Represents a voice call authenticaiton methods policy" +description: "Represents a voice call authentication methods policy." ms.localizationpriority: medium Inherits from [authenticationMethodConfiguration](../resources/authenticationmet ## Relationships |Relationship|Type|Description| |:|:|:|-|includeTargets|[voiceAuthenticationMethodTarget](../resources/voiceauthenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method. Expanded by default.| +|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method. Expanded by default.| ## JSON representation-The following is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "keyProperty": "id", |
v1.0 | Voiceauthenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/voiceauthenticationmethodtarget.md | - Title: "voiceAuthenticationMethodTarget resource type" -description: "A collection of groups enabled to use voice call authentication method via policy." ----doc_type: resourcePageType ---# voiceAuthenticationMethodTarget resource type --Namespace: microsoft.graph --A collection of groups enabled to use voice call authentication via the [voice call authentication methods policy](../resources/voiceAuthenticationMethodConfiguration.md) in Microsoft Entra ID. --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|Object ID of a Microsoft Entra group.| -|isRegistrationRequired|Boolean|Determines whether the user is enforced to register the authentication method. **Not supported**.| -|targetType|authenticationMethodTargetType|Possible values are: `group`, and `unknownFutureValue`. From December 2022, targeting individual users using `user` is no longer recommended. Existing targets remain but we recommend moving the individual users to a targeted group. Inherited from [authenticationMethodTarget](authenticationMethodTarget.md).| --## Relationships -None. --## JSON representation -Here's a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.voiceAuthenticationMethodTarget", - "baseType": "microsoft.graph.authenticationMethodTarget", - "openType": false -} >-``` json -{ - "@odata.type": "#microsoft.graph.voiceAuthenticationMethodTarget", - "id": "String (identifier)", - "targetType": "String", - "isRegistrationRequired": "Boolean" -} -``` |
v1.0 | Vulnerabilitystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/vulnerabilitystate.md | Contains stateful information about the vulnerability. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Webapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/webapplication.md | Specifies settings for a web application. | redirectUris | String collection | Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Webpart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/webpart.md | + + Title: 'webPart resource type' +description: Represents a specific web part instance on a SharePoint page. ++ms.localizationpriority: medium +++# webPart resource type ++Namespace: microsoft.graph ++++Represents a specific web part instance on a SharePoint page. ++This is an abstract type. ++Inherits from [entity](../resources/entity.md). ++## Methods ++| Method | Return type | Description | +| :-- | :- | : | +| [List webParts](../api/webpart-list.md) | [webPart](../resources/webpart.md) collection | Get a list of the [webPart](../resources/webpart.md) objects and their properties. | +| [Get webPart](../api/webpart-get.md) | [webPart](../resources/webpart.md) | Read the properties and relationships of a [webPart](../resources/webpart.md) object. | +| [Delete webPart](../api/webpart-delete.md) | [webPart](../resources/webpart.md) | Deletes a [webPart](../resources/webpart.md) object. | +| [Create webPart](../api/sitepage-create-webpart.md) | [webPart](../resources/webpart.md) | Create a new [webPart](../resources/webpart.md) object. | +| [Update webPart](../api/webpart-update.md) | [webPart](../resources/webpart.md) | Update the properties of a [webPart](../resources/webpart.md) object. | +| [Get webPart position](../api/webpart-getposition.md) | [webPartPosition](../resources/webpartposition.md) | Get the [webPartPosition](../resources/webpartposition.md) information of a [WebPart](../resources/webpart.md). | +| [Get webPart collection by position](../api/sitePage-getwebpartsbyposition.md) | [webPart](../resources/webpart.md) collection | Get a list of the [webPart](../resources/webpart.md) objects filtered by [webPartPosition](../resources/webpartposition.md) information. | ++## Properties ++| Property | Type | Description | +| :- | :-- | : | +| id | String | Unique instance identifier of the web part. Inherited from [entity](../resources/entity.md). | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.webPart", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.webPart", + "id": "String (identifier)" +} +``` |
v1.0 | Webpartdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/webpartdata.md | + + Title: "webPartData resource type" +description: Represents the data of a given web part. ++ms.localizationpriority: medium +++# webPartData resource type ++Namespace: microsoft.graph ++++Represents the data of a given web part. ++## Properties ++| Property | Type | Description | +| : | : | :-- | +| audiences | String collection | Audience information of the web part. By using this property, specific content will be prioritized to specific audiences. | +| dataVersion | String | Data version of the web part. The value is defined by the web part developer. Different dataVersions usually refers to a different property structure. | +| description | String | Description of the web part. | +| properties | [Json](../resources/json.md) | Properties bag of the web part. | +| serverProcessedContent | [serverProcessedContent](../resources/serverprocessedcontent.md) | Contains collections of data that can be processed by server side services like search index and link fixup. | +| title | String | Title of the web part. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.webPartData" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.webPartData", + "audiences": ["String"], + "dataVersion": "String", + "description": "String", + "properties": { + "@odata.type": "microsoft.graph.Json" + }, + "serverProcessedContent": { + "@odata.type": "microsoft.graph.serverProcessedContent" + }, + "title": "String" +} +``` |
v1.0 | Webpartposition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/webpartposition.md | + + Title: 'webPartPosition resource type' +description: Represents the position information of the given web part to the current page. ++ms.localizationpriority: medium +++# webPartPosition resource type ++Namespace: microsoft.graph ++++Represents the position information of the given web part to the current page. ++## Properties ++| Property | Type | Description | +| : | : | : | +| columnId | Double | Indicates the identifier of the column where the web part is located. | +| horizontalSectionId | Double | Indicates the horizontal section where the web part is located. | +| isInVerticalSection | boolean | Indicates whether the web part is located in the vertical section. | +| webPartIndex | Double | Index of the current web part. Represents the order of the web part in this column or section. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.webPartPosition" +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.webPartPosition", + "webPartIndex": "Double", + "horizontalSectionId": "Double", + "isInVerticalSection": "Boolean", + "columnId": "Double" +} +``` |
v1.0 | Windows Setting Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/windows-setting-api-overview.md | + + Title: "Use the Windows settings API in Microsoft Graph" +description: "The Windows setting API enables users and authorized third parties acting on behalf of users to retrieve their Windows operating system settings data stored in the Microsoft cloud." +ms.localizationpriority: medium ++++# Use the Windows settings API in Microsoft Graph ++The Windows setting API enables users and authorized third parties acting on behalf of users to retrieve their Windows operating system settings data stored in the Microsoft cloud. The Windows settings data is available in the Microsoft cloud only when users activate the feature. The scope of data available for each user depends on their backup settings selections. The default values for any settings remain local and aren't transferred to the cloud. The Windows settings API only shares settings data that the user uploads to the cloud. ++## Windows settings ++The [**windowsSetting**](windowssetting.md) resource represents various Windows operating system settings that are stored in the cloud for a given user. Windows settings are of two types: `roaming` and `backup`. The **settingType** property of a [windowsSetting](../resources/windowssetting.md) object indicates the type of the setting. ++| Setting type | Description | +| :-- | : | +| roaming | The Windows setting is associated with a user's account. The setting is consistent across all devices and any changes to the setting value are synced or applied to all Windows devices that the user owns.| +| backup | The Windows setting doesn't roam or sync across devices. This type of setting is used in device backup and restore scenarios.| ++ A [windowsSetting](../resources/windowssetting.md) object of type `backup` might have a **windowsDeviceId** property that links the setting to a specific device. ++ The [List Windows settings](../api/usersettings-list-windows.md) API returns a collection of [windowsSetting](../resources/windowssetting.md) objects and their properties. You can filter the results by the **windowsDeviceId** and **settingType** properties. ++The [Get windowsSetting](../api/windowssetting-get.md) API allows you to pass the ID of a [windowsSetting](../resources/windowssetting.md) in the URL to read a specific Windows setting object. ++The following JSON representation shows an example of a **windowsSetting** resource type. The instances collection represents **windowsSettingInstance** objects. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.windowsSetting", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.windowsSetting", + "id": "{67585f9f-ee4b-4dd8-808e-d88375d66ef7}$windows.data.apps.devicemetadata", + "windowsDeviceId": "67585f9f-ee4b-4dd8-808e-d88375d66ef7", + "settingType": "backup", + "payloadType": "windows.data.apps.devicemetadata", + "instances": [ + { + "id": "14b50191-10e5-4da5-9099-8c909b8458bd", + "payload": "VGhpcyBpcyBqdXN0IGFuIGV4YW1wbGUh", + "lastModifiedDateTime": "2024-10-31T23:30:41Z", + "createdDateTime": "2024-02-12T19:34:35.223Z", + "expirationDateTime": "2034-02-09T19:34:33.771Z" + } + ] +} +``` ++> [!Warning] +> The structure of the ID of a [**windowsSetting**](../resources/windowssetting.md) object is not guaranteed and the caller should not take any dependency on it. The ID should be treated as an opaque string. ++## Windows setting instances ++A [**windowsSettingInstance**](../resources/windowssettinginstance.md) represents a setting instance from the Windows operating system that is stored in the cloud for a given user. A [windowsSettingInstance](../resources/windowssettinginstance.md) belongs to a [windowsSetting](../resources/windowssetting.md). ++The following JSON representation shows an example of a **windowsSettingInstance** resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.windowsSettingInstance", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.windowsSettingInstance", + "id": "6984732f-86b0-8e31-dc02-37fce0df6d61", + "payload": "VGhpcyBpcyBhbm90aGVyIGp1c3QgYW4gZXhhbXBsZSE=", + "lastModifiedDateTime": "2024-10-31T23:30:41Z", + "createdDateTime": "2024-02-12T19:34:35.223Z", + "expirationDateTime": "2034-02-09T19:34:33.771Z" +} +``` ++The [List Windows setting instances](../api/windowssetting-list-instances.md) API returns a collection of [windowsSettingInstance](../resources/windowssettinginstance.md) objects and their properties. The API requires the ID of a [windowsSetting](../resources/windowssetting.md) in the URL to read the setting instances. ++The [Get Windows setting instance](../api/windowssettinginstance-get.md) API allows you to pass the ID of a [windowsSetting](../resources/windowssetting.md) and [windowsSettingInstance](../resources/windowssettinginstance.md) in the URL to read a specific windows setting instance object. ++The **payload** property of a [**windowsSettingInstance**](../resources/windowssettinginstance.md) contains the actual setting value. The **payload** is a string in Base64-encoded format. The **payloadType** property of the [**windowsSetting**](../resources/windowssetting.md) object indicates the type of the setting value. The **payload** when decoded is a JSON object, which differs from setting to setting and is specific to the **payloadType**. ++### payloadType property +The **payloadType** defines the structure of a [windowsSettingInstance](./windowssettinginstance.md) payload. Windows includes a number of payload types that represent distinct setting structures used by different operating system experiences. As Windows evolves, more payload types are created and onboarded to the cloud. Querying the API and exploring the settings that are available is the best way to learn about the various payload types. The users and admins have control over which settings are uploaded to the cloud and most components don't upload default settings that the user hasn't customized. ++The following example shows a **windowsSettingsInstance** object returned by the API. ++```json +{ + "id": "default$windows.data.fileexplorerclassic.advancedsettings", + "settingType": "roaming", + "payloadType": "windows.data.fileexplorerclassic.advancedsettings", + "instances": [ + { + "id": "d9a7f6e2-8c4b-4e3a-bf7c-1e5a9d8c6f4b", + "payload": "eyJtaWdyYXRlZEZyb21TU0YiOmZhbHNlLCJhbHdheXNTaG93TWVudXMiOmZhbHNlLCJmb2xkZXJDb250ZW50c0luZm9UaXAiOmZhbHNlLCJoaWRlRHJpdmVzV2l0aE5vTWVkaWEiOmZhbHNlLCJuYXZQYW5lRXhwYW5kVG9DdXJyZW50Rm9sZGVyIjpmYWxzZSwibmF2UGFuZVNob3dBbGxGb2xkZXJzIjpmYWxzZSwibmF2UGFuZVNob3dGYXZvcml0ZXMiOmZhbHNlLCJwZXJzaXN0QnJvd3NlcnMiOmZhbHNlLCJzaGFyaW5nV2l6YXJkT24iOmZhbHNlLCJzaG93RHJpdmVMZXR0ZXJzIjpmYWxzZSwic2hvd1ByZXZpZXdIYW5kbGVycyI6ZmFsc2UsInR5cGVBaGVhZCI6ZmFsc2UsInNob3dTdGF0dXNCYXIiOmZhbHNlLCJzaG93TGlicmFyaWVzIjpmYWxzZSwic2hvd0NvbXBDb2xvciI6ZmFsc2V9", + "lastModifiedDateTime": "2022-06-27T00:53:00Z", + "createdDateTime": "2024-02-13T19:51:15.8217101Z", + "expirationDateTime": "2034-02-10T19:51:14.813Z" + } + ] +} +``` ++In this example, the **payloadType** `windows.data.fileexplorerclassic.advancedsettings` represents some of the settings that the File Explorer backs up to the cloud. The Base64 payload can be decoded to a UTF-8 string to see the JSON representation of this object. ++The following example shows the payload decoded. ++```json +{ + "migratedFromSSF": false, + "alwaysShowMenus": false, + "folderContentsInfoTip": false, + "hideDrivesWithNoMedia": false, + "navPaneExpandToCurrentFolder": false, + "navPaneShowAllFolders": false, + "navPaneShowFavorites": false, + "persistBrowsers": false, + "sharingWizardOn": false, + "showDriveLetters": false, + "showPreviewHandlers": false, + "typeAhead": false, + "showStatusBar": false, + "showLibraries": false, + "showCompColor": false +} +``` ++Properties in the object are commonly a subset of those that are available in the user experience of the component because component owners decide which settings provide the most value when uploaded to the cloud. ++#### Payload types ++The payload types described in this section have a special role in the Windows settings backup process. ++#### windows.data.platform.backuprestore.deviceprofile ++The windows.data.platform.backuprestore.deviceprofile payload type is not a setting the user applied; this type records information about devices that have opted into settings backup features. The following properties on this object are useful for understanding the rest of the settings: ++- **deviceDisplayName** - The name of the computer. This setting is found in Windows system settings at "**Start** > **Settings** > **System**". +- **profileId** - An identifier used to link [**windowsSetting**](../resources/windowssetting.md) items to the device that uploaded them. This property corresponds to **windowsSetting.windowsDeviceId** and can be used as a filter to get settings for a specific device from the [List Windows settings](../api/usersettings-list-windows.md) API. ++The following example shows this resource type. ++```json +{ + "id": "default$windows.data.platform.backuprestore.deviceprofile$deviceprofiles", + "settingType": "backup", + "payloadType": "windows.data.platform.backuprestore.deviceprofile", + "instances": [ + { + "id": "73b1a0b8-262a-4804-592a-b82a3a2a0c0d", + "payload": "ewogICAgInByb2ZpbGVJZCI6ICJ7OTViM2EyYzgtNDgyYS00YTA2LTdiM2EtZGEyYTVhNGIyYzBmfSIsCiAgICAiZGV2aWNlRGlzcGxheU5hbWUiOiAiRVhBTVBMRVVTRVJERVNLVE9QIiwKICAgICJjcmVhdGVkQnkiOiAid2luZG93cyIsCiAgICAic291cmNlUHJvZmlsZUlkIjogIiIsCiAgICAiY3JlYXRlZFRpbWUiOiAxNjY0NjgwNTg5LAogICAgIm1vZGlmaWVkVGltZSI6IDE2OTg3OTUwNDAsCiAgICAiaXNBY3RpdmUiOiB0cnVlLAogICAgImxhc3RGdWxsQmFja3VwQ29tcGxldGVkVGltZSI6IDE2OTgzMzIxMzcsCiAgICAib3NWZXJzaW9uIjogIjE4MDQ1LjM3NTAudmJfcmVsZWFzZSIKfQ==", + "lastModifiedDateTime": "2023-10-31T23:30:40Z", + "createdDateTime": "2024-02-13T22:49:02.376Z", + "expirationDateTime": "2034-02-10T22:49:03.365Z" + } + ] +} +``` +The following example shows the payload decoded. ++```json +{ + "profileId": "{95b3a2c8-482a-4a06-7b3a-da2a5a4b2c0f}", + "deviceDisplayName": "EXAMPLEUSERDESKTOP", + "createdBy": "windows", + "sourceProfileId": "", + "createdTime": 1664680589, + "modifiedTime": 1698795040, + "isActive": true, + "lastFullBackupCompletedTime": 1698332137, + "osVersion": "18045.3750.vb_release" +} +``` ++#### windows.data.platform.settingsbackup.backupunitstore ++The **backupUnitStore** payload type settings are unique in that the actual settings value is a **blob** in the data property. This is because **backupUnitStore** settings are collected directly from the Windows registry, on disk files, or other at rest locations throughout Windows. These settings weren't designed to be interoperable with experiences other than the components that created them. They are exposed in this API for comprehensive coverage of all Windows settings that are stored in the cloud. |
v1.0 | Workbook | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbook.md | None. | Relationship | Type |Description| |:|:--|:-| |comments|[workbookComment](workbookcomment.md) collection|Represents a collection of comments in a workbook.|-|names|[workbookNamedItem](nameditem.md) collection|Represents a collection of workbooks scoped named items (named ranges and constants). Read-only.| +|names|[workbookNamedItem](workbooknameditem.md) collection|Represents a collection of workbooks scoped named items (named ranges and constants). Read-only.| |operations|[workbookOperation](workbookoperation.md) collection|The status of workbook operations. Getting an operation collection is not supported, but you can get the status of a long-running operation if the `Location` header is returned in the response. Read-only.|-|tables|[workbookTable](table.md) collection|Represents a collection of tables associated with the workbook. Read-only.| -|worksheets|[workbookWorksheet](worksheet.md) collection|Represents a collection of worksheets associated with the workbook. Read-only.| +|tables|[workbookTable](workbooktable.md) collection|Represents a collection of tables associated with the workbook. Read-only.| +|worksheets|[workbookWorksheet](workbookworksheet.md) collection|Represents a collection of worksheets associated with the workbook. Read-only.| ## Functions |
v1.0 | Workbookchart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchart.md | + + Title: "workbookChart resource type" +description: "Represents a chart object in a workbook." ++ms.localizationpriority: medium ++++# workbookChart resource type ++Namespace: microsoft.graph ++Represents a chart object in a workbook. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get Chart](../api/chart-get.md) | [workbookChart](workbookchart.md) |Read properties and relationships of chart object.| +|[Create ChartSeries](../api/chart-post-series.md) |[workbookChartSeries](workbookchartseries.md)| Create a new ChartSeries by posting to the series collection.| +|[List series](../api/chart-list-series.md) |[workbookChartSeries](workbookchartseries.md) collection| Get a ChartSeries object collection.| +|[Update](../api/chart-update.md) | [workbookChart](workbookchart.md) |Update Chart object. | +|[Image](../api/chart-image.md)|Image base64 encoded string|Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.| +|[Delete](../api/chart-delete.md)|None|Deletes the chart object.| +|[Set data](../api/chart-setdata.md)|None|Resets the source data for the chart.| +|[Set position](../api/chart-setposition.md)|None|Positions the chart relative to cells on the worksheet.| +|[List](../api/chart-list.md) | [workbookChart](workbookchart.md) collection |Get chart object collection. | +|[Item at](../api/chartcollection-itemat.md)|[workbookChart](workbookchart.md)|Gets a chart based on its position in the collection.| +|[Add](../api/chartcollection-add.md)|[workbookChart](workbookchart.md)|Creates a new chart.| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|height|double|Represents the height, in points, of the chart object.| +|id|string|Gets a chart based on its position in the collection. Read-only.| +|left|double|The distance, in points, from the left side of the chart to the worksheet origin.| +|name|string|Represents the name of a chart object.| +|top|double|Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).| +|width|double|Represents the width, in points, of the chart object.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|axes|[workbookChartAxes](workbookchartaxes.md)|Represents chart axes. Read-only.| +|dataLabels|[workbookChartDataLabels](workbookchartdatalabels.md)|Represents the data labels on the chart. Read-only.| +|format|[workbookChartAreaFormat](workbookchartareaformat.md)|Encapsulates the format properties for the chart area. Read-only.| +|legend|[workbookChartLegend](workbookchartlegend.md)|Represents the legend for the chart. Read-only.| +|series|[workbookChartSeries](workbookchartseries.md) collection|Represents either a single series or collection of series in the chart. Read-only.| +|title|[workbookChartTitle](workbookcharttitle.md)|Represents the title of the specified chart, including the text, visibility, position and formatting of the title. Read-only.| +|worksheet|[workbookWorksheet](workbookworksheet.md)|The worksheet containing the current chart. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "keyProperty": "id", + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChart" +}--> ++```json +{ + "height": 1024, + "id": "string", + "left": 1024, + "name": "string", + "top": 1024, + "width": 1024 +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "Chart resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartareaformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartareaformat.md | + + Title: "workbookChartAreaFormat resource type" +description: "Encapsulates the format properties for the overall chart area." ++ms.localizationpriority: medium ++++# workbookChartAreaFormat resource type ++Namespace: microsoft.graph ++Encapsulates the format properties for the overall chart area. +++## Methods +None ++## Properties +None ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|fill|[workbookChartFill](workbookchartfill.md)|Represents the fill format of an object, which includes background formatting information. Read-only.| +|font|[workbookChartFont](workbookchartfont.md)|Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartAreaFormat" +}--> ++```json +{ + "fill": {"@odata.type": "microsoft.graph.workbookChartFill"}, + "font": {"@odata.type": "microsoft.graph.workbookChartFont"} +} +``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartAreaFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartaxes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartaxes.md | + + Title: "workbookChartAxes resource type" +description: "Represents the chart axes." ++ms.localizationpriority: medium ++++# workbookChartAxes resource type ++Namespace: microsoft.graph ++Represents the chart axes. +++## Methods +None ++## Properties +None ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|categoryAxis|[workbookChartAxis](workbookchartaxis.md)|Represents the category axis in a chart. Read-only.| +|seriesAxis|[workbookChartAxis](workbookchartaxis.md)|Represents the series axis of a 3-dimensional chart. Read-only.| +|valueAxis|[workbookChartAxis](workbookchartaxis.md)|Represents the value axis in an axis. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartAxes" +}--> ++```json +{ + "categoryAxis": {"@odata.type": "microsoft.graph.workbookChartAxis"}, + "seriesAxis": {"@odata.type": "microsoft.graph.workbookChartAxis"}, + "valueAxis": {"@odata.type": "microsoft.graph.workbookChartAxis"} +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartAxes resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartaxis | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartaxis.md | + + Title: "workbookChartAxis resource type" +description: "Represents a single axis in a chart." ++ms.localizationpriority: medium ++++# workbookChartAxis resource type ++Namespace: microsoft.graph ++Represents a single axis in a chart. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get ChartAxis](../api/chartaxis-get.md) | [workbookChartAxis](workbookchartaxis.md) |Read properties and relationships of chartAxis object.| +|[Update](../api/chartaxis-update.md) | [workbookChartAxis](workbookchartaxis.md) |Update ChartAxis object. | ++## Properties +| Property | Type |Description| +|:|:--|:-| +| id |string | Unique identifier. Read-only.| +|majorUnit|Json|Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number.| +|maximum|Json|Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.| +|minimum|Json|Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.| +|minorUnit|Json|Represents the interval between two minor tick marks. "Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|format|[workbookChartAxisFormat](workbookchartaxisformat.md)|Represents the formatting of a chart object, which includes line and font formatting. Read-only.| +|majorGridlines|[workbookChartGridlines](workbookchartgridlines.md)|Returns a gridlines object that represents the major gridlines for the specified axis. Read-only.| +|minorGridlines|[workbookChartGridlines](workbookchartgridlines.md)|Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only.| +|title|[workbookChartAxisTitle](workbookchartaxistitle.md)|Represents the axis title. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "keyProperty": "id", + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartAxis" +}--> ++```json +{ + "format": {"@odata.type": "microsoft.graph.workbookChartAxisFormat"}, + "id": "string", + "majorGridlines": {"@odata.type": "microsoft.graph.workbookChartGridlines"}, + "majorUnit": "string", + "maximum": "string", + "minimum": "string", + "minorGridlines": {"@odata.type": "microsoft.graph.workbookChartGridlines"}, + "minorUnit": "string", + "title": {"@odata.type": "microsoft.graph.workbookChartAxisTitle"} +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartAxis resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartaxisformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartaxisformat.md | + + Title: "workbookChartAxisFormat resource type" +description: "Encapsulates the format properties for the chart axis." ++ms.localizationpriority: medium ++++# workbookChartAxisFormat resource type ++Namespace: microsoft.graph ++Encapsulates the format properties for the chart axis. +++## Methods +None +## Properties +None ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|font|[workbookChartFont](workbookchartfont.md)|Represents the font attributes (font name, font size, color, etc.) for a chart axis element. Read-only.| +|line|[workbookChartLineFormat](workbookchartlineformat.md)|Represents chart line formatting. Read-only.| +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartAxisFormat" +}--> ++```json +{ + "font": {"@odata.type": "microsoft.graph.workbookChartFont"}, + "line": {"@odata.type": "microsoft.graph.workbookChartLineFormat"} +} +``` +++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartAxisFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartaxistitle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartaxistitle.md | + + Title: "workbookChartAxisTitle resource type" +description: "Represents the title of a chart axis." ++ms.localizationpriority: medium ++++# workbookChartAxisTitle resource type ++Namespace: microsoft.graph ++Represents the title of a chart axis. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get ChartAxisTitle](../api/chartaxistitle-get.md) | [workbookChartAxisTitle](workbookchartaxistitle.md) |Read properties and relationships of chartAxisTitle object.| +|[Update](../api/chartaxistitle-update.md) | [workbookChartAxisTitle](workbookchartaxistitle.md) |Update ChartAxisTitle object. | ++## Properties +| Property | Type |Description| +|:|:--|:-| +|text|string|Represents the axis title.| +|visible|boolean|A boolean that specifies the visibility of an axis title.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|format|[workbookChartAxisTitleFormat](workbookchartaxistitleformat.md)|Represents the formatting of chart axis title. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [], + "@odata.type": "microsoft.graph.workbookChartAxisTitle" +}--> ++```json +{ + "format": {"@odata.type":"microsoft.graph.workbookChartAxisTitleFormat"}, + "text": "string", + "visible": true +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartAxisTitle resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartaxistitleformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartaxistitleformat.md | + + Title: "workbookChartAxisTitleFormat resource type" +description: "Represents the chart axis title formatting." ++ms.localizationpriority: medium ++++# workbookChartAxisTitleFormat resource type ++Namespace: microsoft.graph ++Represents the chart axis title formatting. +++## Methods +None ++## Properties +None ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|font|[workbookChartFont](workbookchartfont.md)|Represents the font attributes, such as font name, font size, color, etc. of chart axis title object. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartAxisTitleFormat" +}--> ++```json +{ + "font": {"@odata.type": "microsoft.graph.workbookChartFont"} +} +``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartAxisTitleFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartdatalabelformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartdatalabelformat.md | + + Title: "workbookChartDataLabelFormat resource type" +description: "Encapsulates the format properties for the chart data labels." ++ms.localizationpriority: medium ++++# workbookChartDataLabelFormat resource type ++Namespace: microsoft.graph ++Encapsulates the format properties for the chart data labels. +++## Methods +None ++## Properties +None ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|fill|[workbookChartFill](workbookchartfill.md)|Represents the fill format of the current chart data label. Read-only.| +|font|[workbookChartFont](workbookchartfont.md)|Represents the font attributes (font name, font size, color, etc.) for a chart data label. Read-only.| +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartDataLabelFormat" +}--> ++```json +{ + "fill": {"@odata.type": "microsoft.graph.workbookChartFill"}, + "font": {"@odata.type": "microsoft.graph.workbookChartFont"} +} +``` +++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartDataLabelFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartdatalabels | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartdatalabels.md | + + Title: "workbookChartDataLabels resource type" +description: "Represents a collection of all the data labels on a chart point." ++ms.localizationpriority: medium ++++# workbookChartDataLabels resource type ++Namespace: microsoft.graph ++Represents a collection of all the data labels on a chart point. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get ChartDataLabels](../api/chartdatalabels-get.md) | [workbookChartDataLabels](workbookchartdatalabels.md) |Read properties and relationships of chartDataLabels object.| +|[Update](../api/chartdatalabels-update.md) | [workbookChartDataLabels](workbookchartdatalabels.md) |Update ChartDataLabels object. | ++## Properties +| Property | Type |Description| +|:|:--|:-| +|position|string|DataLabelPosition value that represents the position of the data label. The possible values are: `None`, `Center`, `InsideEnd`, `InsideBase`, `OutsideEnd`, `Left`, `Right`, `Top`, `Bottom`, `BestFit`, `Callout`.| +|separator|string|String representing the separator used for the data labels on a chart.| +|showBubbleSize|boolean|Boolean value representing if the data label bubble size is visible or not.| +|showCategoryName|boolean|Boolean value representing if the data label category name is visible or not.| +|showLegendKey|boolean|Boolean value representing if the data label legend key is visible or not.| +|showPercentage|boolean|Boolean value representing if the data label percentage is visible or not.| +|showSeriesName|boolean|Boolean value representing if the data label series name is visible or not.| +|showValue|boolean|Boolean value representing if the data label value is visible or not.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|format|[workbookChartDataLabelFormat](workbookchartdatalabelformat.md)|Represents the format of chart data labels, which includes fill and font formatting. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [], + "@odata.type": "microsoft.graph.workbookChartDataLabels" +}--> ++```json +{ + "position": "string", + "separator": "string", + "showBubbleSize": true, + "showCategoryName": true, + "showLegendKey": true, + "showPercentage": true, + "showSeriesName": true, + "showValue": true +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartDataLabels resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartfill | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartfill.md | + + Title: "workbookChartFill resource type" +description: "Represents the fill formatting for a chart element." ++ms.localizationpriority: medium ++++# workbookChartFill resource type ++Namespace: microsoft.graph ++Represents the fill formatting for a chart element. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Clear](../api/chartfill-clear.md)|None|Clear the fill color of a chart element.| +|[Setsolidcolor](../api/chartfill-setsolidcolor.md)|None|Sets the fill formatting of a chart element to a uniform color.| ++## Properties +None ++## Relationships +None +++## JSON representation ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartFill" +}--> ++```json +{ +} +``` +++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartFill resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartfont | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartfont.md | + + Title: "workbookChartFont resource type" +description: "This object represents the font attributes (font name, font size, color, etc.) for a chart object." +ms.localizationpriority: medium +++++# workbookChartFont resource type ++Namespace: microsoft.graph ++This object represents the font attributes (font name, font size, color, etc.) for a chart object. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get ChartFont](../api/chartfont-get.md) | [workbookChartFont](workbookchartfont.md) |Read properties and relationships of chartFont object.| +|[Update](../api/chartfont-update.md) | [workbookChartFont](workbookchartfont.md) |Update ChartFont object. | ++## Properties +| Property | Type |Description| +|:|:--|:-| +|bold|boolean|Represents the bold status of font.| +|color|string|HTML color code representation of the text color. for example #FF0000 represents Red.| +|italic|boolean|Represents the italic status of the font.| +|name|string|Font name (for example "Calibri")| +|size|double|Size of the font (for example 11)| +|underline|string|Type of underline applied to the font. The possible values are: `None`, `Single`.| ++## Relationships +None +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [], + "@odata.type": "microsoft.graph.workbookChartFont" +}--> ++```json +{ + "bold": true, + "color": "string", + "italic": true, + "name": "string", + "size": 1024, + "underline": "string" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartFont resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartgridlines | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartgridlines.md | + + Title: "workbookChartGridlines resource type" +description: "Represents major or minor gridlines on a chart axis." ++ms.localizationpriority: medium ++++# workbookChartGridlines resource type ++Namespace: microsoft.graph ++Represents major or minor gridlines on a chart axis. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get ChartGridlines](../api/chartgridlines-get.md) | [workbookChartGridlines](workbookchartgridlines.md) |Read properties and relationships of chartGridlines object.| +|[Update](../api/chartgridlines-update.md) | [workbookChartGridlines](workbookchartgridlines.md) |Update ChartGridlines object. | ++## Properties +| Property | Type |Description| +|:|:--|:-| +|visible|boolean|Boolean value representing if the axis gridlines are visible or not.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|format|[workbookChartGridlinesFormat](workbookchartgridlinesformat.md)|Represents the formatting of chart gridlines. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.workbookChartGridlines" +}--> ++```json +{ + "visible": true +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartGridlines resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartgridlinesformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartgridlinesformat.md | + + Title: "workbookChartGridlinesFormat resource type" +description: "Encapsulates the format properties for chart gridlines." ++ms.localizationpriority: medium ++++# workbookChartGridlinesFormat resource type ++Namespace: microsoft.graph ++Encapsulates the format properties for chart gridlines. +++## Methods +None ++## Properties +None ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|line|[workbookChartLineFormat](workbookchartlineformat.md)|Represents chart line formatting. Read-only.| +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartGridlinesFormat" +}--> ++```json +{ + "line": {"@odata.type": "microsoft.graph.workbookChartLineFormat"} +} +``` +++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartGridlinesFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartlegend | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartlegend.md | + + Title: "workbookChartLegend resource type" +description: "Represents the legend in a chart." ++ms.localizationpriority: medium ++++# workbookChartLegend resource type ++Namespace: microsoft.graph ++Represents the legend in a chart. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get ChartLegend](../api/chartlegend-get.md) | [workbookChartLegend](workbookchartlegend.md) |Read properties and relationships of chartLegend object.| +|[Update](../api/chartlegend-update.md) | [workbookChartLegend](workbookchartlegend.md) |Update ChartLegend object. | ++## Properties +| Property | Type |Description| +|:|:--|:-| +|overlay|boolean|Boolean value for whether the chart legend should overlap with the main body of the chart.| +|position|string|Represents the position of the legend on the chart. The possible values are: `Top`, `Bottom`, `Left`, `Right`, `Corner`, `Custom`.| +|visible|boolean|A boolean value the represents the visibility of a ChartLegend object.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|format|[workbookChartLegendFormat](workbookchartlegendformat.md)|Represents the formatting of a chart legend, which includes fill and font formatting. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.workbookChartLegend" +}--> ++```json +{ + "format": {"@odata.type":"microsoft.graph.workbookChartLegendFormat"}, + "overlay": true, + "position": "string", + "visible": true +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartLegend resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartlegendformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartlegendformat.md | + + Title: "workbookChartLegendFormat resource type" +description: "Encapsulates the format properties of a chart legend." ++ms.localizationpriority: medium ++++# workbookChartLegendFormat resource type ++Namespace: microsoft.graph ++Encapsulates the format properties of a chart legend. +++## Methods +None ++## Properties +None ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|fill|[workbookChartFill](workbookchartfill.md)|Represents the fill format of an object, which includes background formating information. Read-only.| +|font|[workbookChartFont](workbookchartfont.md)|Represents the font attributes such as font name, font size, color, etc. of a chart legend. Read-only.| +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartLegendFormat" +}--> ++```json +{ + "fill": {"@odata.type": "microsoft.graph.workbookChartFill"}, + "font": {"@odata.type": "microsoft.graph.workbookChartFont"} +} +``` +++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartLegendFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartlineformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartlineformat.md | + + Title: "workbookChartLineFormat resource type" +description: "Encapsulates the formatting options for line elements." ++ms.localizationpriority: medium ++++# workbookChartLineFormat resource type ++Namespace: microsoft.graph ++Enapsulates the formatting options for line elements. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get ChartLineFormat](../api/chartlineformat-get.md) | [workbookChartLineFormat](workbookchartlineformat.md) |Read properties and relationships of chartLineFormat object.| +|[Update](../api/chartlineformat-update.md) | [workbookChartLineFormat](workbookchartlineformat.md) |Update ChartLineFormat object. | +|[Clear](../api/chartlineformat-clear.md)|None|Clear the line format of a chart element.| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|color|string|HTML color code representing the color of lines in the chart.| ++## Relationships +None +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [], + "@odata.type": "microsoft.graph.workbookChartLineFormat" +}--> ++```json +{ + "color": "string" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartLineFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartpoint.md | + + Title: "workbookChartPoint resource type" +description: "Represents a point of a series in a chart." ++ms.localizationpriority: medium ++++# workbookChartPoint resource type ++Namespace: microsoft.graph ++Represents a point of a series in a chart. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get ChartPoint](../api/chartpoint-get.md) | [workbookChartPoint](workbookchartpoint.md) |Read properties and relationships of chartPoint object.| +|[List](../api/chartpoint-list.md) | [workbookChartPoint](workbookchartpoint.md) collection |Get chartPoint object collection. | +|[ItemAt](../api/chartpointscollection-itemat.md)|[workbookChartPoint](workbookchartpoint.md)|Retrieve a point based on its position within the series.| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|ID|string|unique identifier| +|value|Json|Returns the value of a chart point. Read-only.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|format|[workbookChartPointFormat](workbookchartpointformat.md)|Encapsulates the format properties chart point. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "keyProperty": "id", + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartPoint" +}--> ++```json +{ + "id": "string", + "value": "string" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartPoint resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartpointformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartpointformat.md | + + Title: "workbookChartPointFormat resource type" +description: "Represents formatting object for chart points." ++ms.localizationpriority: medium ++++# workbookChartPointFormat resource type ++Namespace: microsoft.graph ++Represents formatting object for chart points. +++## Methods +None ++## Properties +None ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|fill|[workbookChartFill](workbookchartfill.md)|Represents the fill format of a chart, which includes background formatting information. Read-only.| +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartPointFormat" +}--> ++```json +{ + "fill": {"@odata.type": "microsoft.graph.workbookChartFill"} +} +``` +++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartPointFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartseries | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartseries.md | + + Title: "workbookChartSeries resource type" +description: "Represents a series in a chart." ++ms.localizationpriority: medium ++++# workbookChartSeries resource type ++Namespace: microsoft.graph ++Represents a series in a chart. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get ChartSeries](../api/chartseries-get.md) | [workbookChartSeries](workbookchartseries.md) |Read properties and relationships of chartSeries object.| +|[Create ChartPoints](../api/chartseries-post-points.md) |[ChartPoints](workbookchartpoint.md)| Create a new ChartPoints by posting to the points collection.| +|[List points](../api/chartseries-list-points.md) |[ChartPoints](workbookchartpoint.md) collection| Get a ChartPoints object collection.| +|[Update](../api/chartseries-update.md) | [workbookChartSeries](workbookchartseries.md) |Update ChartSeries object. | +|[List](../api/chartseries-list.md) | [workbookChartSeries](workbookchartseries.md) collection |Get chartSeries object collection. | +|[ItemAt](../api/chartseriescollection-itemat.md)|[workbookChartSeries](workbookchartseries.md)|Retrieves a series based on its position in the collection| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|name|string|Represents the name of a series in a chart.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|format|[workbookChartSeriesFormat](workbookchartseriesformat.md)|Represents the formatting of a chart series, which includes fill and line formatting. Read-only.| +|points|[workbookChartPoint](workbookchartpoint.md) collection|Represents a collection of all points in the series. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.workbookChartSeries" +}--> ++```json +{ + "name": "string" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartSeries resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookchartseriesformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookchartseriesformat.md | + + Title: "workbookChartSeriesFormat resource type" +description: "encapsulates the format properties for the chart series" ++ms.localizationpriority: medium ++++# workbookChartSeriesFormat resource type ++Namespace: microsoft.graph ++encapsulates the format properties for the chart series +++## Methods +None ++## Properties +None ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|fill|[workbookChartFill](workbookchartfill.md)|Represents the fill format of a chart series, which includes background formatting information. Read-only.| +|line|[workbookChartLineFormat](workbookchartlineformat.md)|Represents line formatting. Read-only.| +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartSeriesFormat" +}--> ++```json +{ + "fill": {"@odata.type": "microsoft.graph.workbookChartFill"}, + "line": {"@odata.type": "microsoft.graph.workbookChartLineFormat"} +} +``` +++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartSeriesFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookcharttitle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookcharttitle.md | + + Title: "workbookChartTitle resource type" +description: "Represents a chart title object of a chart." ++ms.localizationpriority: medium ++++# workbookChartTitle resource type ++Namespace: microsoft.graph ++Represents a chart title object of a chart. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get ChartTitle](../api/charttitle-get.md) | [workbookChartTitle](workbookcharttitle.md) |Read properties and relationships of chartTitle object.| +|[Update](../api/charttitle-update.md) | [workbookChartTitle](workbookcharttitle.md) |Update ChartTitle object. | ++## Properties +| Property | Type |Description| +|:|:--|:-| +|overlay|boolean|Boolean value representing if the chart title will overlay the chart or not.| +|text|string|Represents the title text of a chart.| +|visible|boolean|A boolean value that represents the visibility of a chart title object.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|format|[workbookChartTitleFormat](workbookcharttitleformat.md)|Represents the formatting of a chart title, which includes fill and font formatting. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.workbookChartTitle" +}--> ++```json +{ + "overlay": true, + "text": "string", + "visible": true +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartTitle resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookcharttitleformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookcharttitleformat.md | + + Title: "workbookChartTitleFormat resource type" +description: "Encapsulates the format properties for the chart title." ++ms.localizationpriority: medium ++++# workbookChartTitleFormat resource type ++Namespace: microsoft.graph ++Encapsulates the format properties for the chart title. +++## Methods +None ++## Properties +None ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|fill|[workbookChartFill](workbookchartfill.md)|Represents the fill format of an object, which includes background formatting information. Read-only.| +|font|[workbookChartFont](workbookchartfont.md)|Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only.| ++++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookChartTitleFormat" +}--> ++```json +{ + "fill": {"@odata.type": "microsoft.graph.workbookChartFill"}, + "font": {"@odata.type": "microsoft.graph.workbookChartFont"} +} +``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "ChartAreaFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookfilter.md | + + Title: "workbookFilter resource type" +description: "Manages the filtering of a table's column." +ms.localizationpriority: medium +++++# workbookFilter resource type ++Namespace: microsoft.graph ++Manages the filtering of a table's column. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Apply](../api/filter-apply.md)|None|Apply the given filter criteria on the given column.| +|[Clear](../api/filter-clear.md)|None|Clear the filter on the given column.| ++## Properties ++| Name | Type |Description| +|:|:--|:-| +|criteria|[workbookFilterCriteria](filtercriteria.md)|The currently applied filter on the given column. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.workbookFilter" +}--> ++```json +{ + "criteria": {"@odata.type": "microsoft.graph.workbookFilterCriteria" } +} +``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "Filter resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookicon | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookicon.md | + + Title: "workbookIcon resource type" +description: "Represents a cell icon." +ms.localizationpriority: medium +++++# workbookIcon resource type ++Namespace: microsoft.graph ++Represents an icon in a cell in an Excel workbook. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get](../api/icon-get.md) | [workbookIcon](workbookicon.md) |Read properties and relationships of a workbookIcon object.| +|[Update](../api/icon-update.md) | [workbookIcon](workbookicon.md) |Update a workbookIcon object. | ++## Properties +| Property | Type |Description| +|:|:--|:-| +|index|int|Represents the index of the icon in the given set.| +|set|string|Represents the set that the icon is part of. The possible values are: `Invalid`, `ThreeArrows`, `ThreeArrowsGray`, `ThreeFlags`, `ThreeTrafficLights1`, `ThreeTrafficLights2`, `ThreeSigns`, `ThreeSymbols`, `ThreeSymbols2`, `FourArrows`, `FourArrowsGray`, `FourRedToBlack`, `FourRating`, `FourTrafficLights`, `FiveArrows`, `FiveArrowsGray`, `FiveRating`, `FiveQuarters`, `ThreeStars`, `ThreeTriangles`, `FiveBoxes`.| ++## Relationships +None. +++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.workbookIcon" +}--> ++```json +{ + "index": "int", + "set": "string" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "Icon resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbooknameditem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbooknameditem.md | + + Title: "workbookNamedItem resource type" +description: "Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, reference to a range. This object can be used to obtain range object associated with names." +ms.localizationpriority: medium +++++# workbookNamedItem resource type ++Namespace: microsoft.graph ++Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, reference to a range. This object can be used to obtain range object associated with names. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Add](../api/nameditem-add.md)|[workbookNamedItem](workbooknameditem.md)|Adds a new name to the collection of the given scope.| +|[AddFormulaLocal](../api/nameditem-addformulalocal.md)|[workbookNamedItem](workbooknameditem.md)|Adds a new name to the collection of the given scope using the user's locale for the formula.| +|[Get NamedItem](../api/nameditem-get.md) | [workbookNamedItem](workbooknameditem.md) |Read properties and relationships of namedItem object.| +|[Update](../api/nameditem-update.md) | [workbookNamedItem](workbooknameditem.md) |Update NamedItem object. | +|[Range](../api/nameditem-range.md)|[Range](workbookrange.md)|Returns the range object that is associated with the name. Throws an exception if the named item's type isn't a range.| +|[List](../api/nameditem-list.md) | [workbookNamedItem](workbooknameditem.md) collection |Get namedItem object collection. | ++## Properties +| Property | Type |Description| +|:|:--|:-| +|comment|string|Represents the comment associated with this name.| +|name|string|The name of the object. Read-only.| +|scope|string|Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only.| +|type|string|Indicates what type of reference is associated with the name. The possible values are: `String`, `Integer`, `Double`, `Boolean`, `Range`. Read-only.| +|value|Json|Represents the formula that the name is defined to refer to. for example, =Sheet14!$B$2:$H$12, =4.75, etc. Read-only.| +|visible|boolean|Specifies whether the object is visible or not.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|worksheet|[workbookWorksheet](workbookworksheet.md)|Returns the worksheet on which the named item is scoped to. Available only if the item is scoped to the worksheet. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "optionalProperties": [ ++ ], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookNamedItem" +}--> ++```json +{ + "name": "string", + "comment": "string", + "scope": "string", + "type": "string", + "value": {"@odata.type": "microsoft.graph.Json"}, + "visible": true ++} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "NamedItem resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookoperation.md | Represents the status of a long-running workbook operation. |id|String| The operation ID. Read-only.| |resourceLocation|String| The resource URI for the result.| |status|String| The current status of the operation. Possible values are: `NotStarted`, `Running`, `Completed`, `Failed`.|-|StatusCode| integer| Status code of the operation. | +|statusCode| integer| Status code of the operation. | ## Relationships None ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookoperationerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookoperationerror.md | Represents an error from a failed workbook operation. ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookpivottable | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookpivottable.md | Title: "pivotTable resource type" + Title: "workbookPivotTable resource type" description: "Represents an Excel PivotTable." ms.localizationpriority: medium-# pivotTable resource type +# workbookPivotTable resource type Namespace: microsoft.graph Represents an Excel PivotTable. ## Relationships | Relationship | Type |Description| |:|:--|:-|-|worksheet|[WorkbookWorksheet](worksheet.md)| The worksheet containing the current PivotTable. Read-only. | +|worksheet|[workbookWorksheet](workbookworksheet.md)| The worksheet containing the current PivotTable. Read-only. | ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbookrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookrange.md | + + Title: "workbookRange resource type" +description: "Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc." +ms.localizationpriority: high +++++# workbookRange resource type ++Namespace: microsoft.graph ++Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get Range](../api/range-get.md) | [Range](workbookrange.md) |Read properties and relationships of range object.| +|[Update](../api/range-update.md) | [Range](workbookrange.md) |Update Range object. | +|[Boundingrect](../api/range-boundingrect.md)|[Range](workbookrange.md)|Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16".| +|[Cell](../api/range-cell.md)|[Range](workbookrange.md)|Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range.| +|[Column](../api/range-column.md)|[Range](workbookrange.md)|Gets a column contained in the range.| +|[Columnsafter](../api/workbookrange-columnsafter.md)|[workbookRangeView](workbookrangeview.md)|Gets some columns to the right of the given range.| +|[Columnsbefore](../api/workbookrange-columnsbefore.md)|[workbookRangeView](workbookrangeview.md)|Gets some columns to the left of the given range.| +|[Entirecolumn](../api/range-entirecolumn.md)|[Range](workbookrange.md)|Gets an object that represents the entire column of the range.| +|[Entirerow](../api/range-entirerow.md)|[Range](workbookrange.md)|Gets an object that represents the entire row of the range.| +|[Intersection](../api/range-intersection.md)|[Range](workbookrange.md)|Gets the range object that represents the rectangular intersection of the given ranges.| +|[Lastcell](../api/range-lastcell.md)|[Range](workbookrange.md)|Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5".| +|[Lastcolumn](../api/range-lastcolumn.md)|[Range](workbookrange.md)|Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5".| +|[Lastrow](../api/range-lastrow.md)|[Range](workbookrange.md)|Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5".| +|[Offsetrange](../api/range-offsetrange.md)|[Range](workbookrange.md)|Gets an object that represents a range that's offset from the specified range. The dimension of the returned range matches this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception is thrown.| +|[Row](../api/range-row.md)|[Range](workbookrange.md)|Gets a row contained in the range.| +|[Rowsabove](../api/workbookrange-rowsabove.md)|[workbookRangeView](workbookrangeview.md)|Gets some rows above a given range.| +|[Rowsbelow](../api/workbookrange-rowsbelow.md)|[workbookRangeView](workbookrangeview.md)|Gets some rows below a given range.| +|[Usedrange](../api/range-usedrange.md)|[Range](workbookrange.md)|Returns the used range of the given range object.| +|[Clear](../api/range-clear.md)|None|Clear range values, format, fill, border, etc.| +|[Delete](../api/range-delete.md)|None|Deletes the cells associated with the range.| +|[Insert](../api/range-insert.md)|[Range](workbookrange.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.| +|[Merge](../api/range-merge.md)|None|Merge the range cells into one region in the worksheet.| +|[Resizedrange](../api/workbookrange-resizedrange.md)|[workbookRangeView](workbookrangeview.md)|Gets a range object similar to the current range object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns.| +|[Unmerge](../api/range-unmerge.md)|None|Unmerge the range cells into separate cells.| +|[Visibleview](../api/workbookrange-visibleview.md)|[workbookRangeView](workbookrangeview.md)|Get the range visible from a filtered range.| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|address|string|Represents the range reference in A1-style. Address value contains the Sheet reference (for example, Sheet1!A1:B4). Read-only.| +|addressLocal|string|Represents range reference for the specified range in the language of the user. Read-only.| +|cellCount|int|Number of cells in the range. Read-only.| +|columnCount|int|Represents the total number of columns in the range. Read-only.| +|columnHidden|boolean|Represents if all columns of the current range are hidden.| +|columnIndex|int|Represents the column number of the first cell in the range. Zero-indexed. Read-only.| +|formulas|Json|Represents the formula in A1-style notation.| +|formulasLocal|Json|Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German.| +|formulasR1C1|Json|Represents the formula in R1C1-style notation.| +|hidden|boolean|Represents if all cells of the current range are hidden. Read-only.| +|numberFormat|Json|Represents Excel's number format code for the given cell.| +|rowCount|int|Returns the total number of rows in the range. Read-only.| +|rowHidden|boolean|Represents if all rows of the current range are hidden.| +|rowIndex|int|Returns the row number of the first cell in the range. Zero-indexed. Read-only.| +|text|Json|Text values of the specified range. The Text value doesn't depend on the cell width. The # sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only.| +|valueTypes|Json|Represents the type of data of each cell. The possible values are: `Unknown`, `Empty`, `String`, `Integer`, `Double`, `Boolean`, `Error`. Read-only.| +|values|Json|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|format|[workbookRangeFormat](workbookrangeformat.md)|Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Read-only.| +|sort|[workbookRangeSort](workbookrangesort.md)|The worksheet containing the current range. Read-only.| +|worksheet|[workbookWorksheet](workbookworksheet.md)|The worksheet containing the current range. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.workbookRange" +}--> ++```json +{ + "address": "string", + "addressLocal": "string", + "cellCount": 1024, + "columnCount": 1024, + "columnHidden": true, + "columnIndex": 1024, + "formulas": "json", + "formulasLocal": "json", + "formulasR1C1": "json", + "hidden": true, + "numberFormat": "json", + "rowCount": 1024, + "rowHidden": true, + "rowIndex": 1024, + "text": "json", + "valueTypes": "string", + "values": "json" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "Range resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookrangeborder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookrangeborder.md | + + Title: "workbookRangeBorder resource type" +description: "Represents the border of an object." ++ms.localizationpriority: medium ++++# workbookRangeBorder resource type ++Namespace: microsoft.graph ++Represents the border of an object. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get RangeBorder](../api/rangeborder-get.md) | [workbookRangeBorder](workbookrangeborder.md) |Read properties and relationships of rangeBorder object.| +|[Update](../api/rangeborder-update.md) | [workbookRangeBorder](workbookrangeborder.md) |Update RangeBorder object. | +|[List](../api/rangeborder-list.md) | [workbookRangeBorder](workbookrangeborder.md) collection |Get rangeBorder object collection. | +|[Itemat](../api/rangebordercollection-itemat.md)|[workbookRangeBorder](workbookrangeborder.md)|Gets a border object using its index| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (for example "FFA500") or as a named HTML color (for example "orange").| +|id|string|Represents border identifier. The possible values are: `EdgeTop`, `EdgeBottom`, `EdgeLeft`, `EdgeRight`, `InsideVertical`, `InsideHorizontal`, `DiagonalDown`, `DiagonalUp`. Read-only.| +|sideIndex|string|Constant value that indicates the specific side of the border. The possible values are: `EdgeTop`, `EdgeBottom`, `EdgeLeft`, `EdgeRight`, `InsideVertical`, `InsideHorizontal`, `DiagonalDown`, `DiagonalUp`. Read-only.| +|style|string|One of the constants of line style specifying the line style for the border. The possible values are: `None`, `Continuous`, `Dash`, `DashDot`, `DashDotDot`, `Dot`, `Double`, `SlantDashDot`.| +|weight|string|Specifies the weight of the border around a range. The possible values are: `Hairline`, `Thin`, `Medium`, `Thick`.| ++## Relationships +None +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookRangeBorder" +}--> ++```json +{ + "color": "string", + "id": "string", + "sideIndex": "string", + "style": "string", + "weight": "string" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "RangeBorder resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookrangefill | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookrangefill.md | + + Title: "workbookRangeFill resource type" +description: "Represents the background of a range object." ++ms.localizationpriority: medium ++++# workbookRangeFill resource type ++Namespace: microsoft.graph ++Represents the background of a range object. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get RangeFill](../api/rangefill-get.md) | [workbookRangeFill](workbookrangefill.md) |Read properties and relationships of rangeFill object.| +|[Update](../api/rangefill-update.md) | [workbookRangeFill](workbookrangefill.md) |Update RangeFill object. | +|[Clear](../api/rangefill-clear.md)|None|Resets the range background.| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (for example "FFA500") or as a named HTML color (for example "orange")| ++## Relationships +None +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookRangeFill" +}--> ++```json +{ + "color": "string" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "RangeFill resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookrangefont | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookrangefont.md | + + Title: "workbookRangeFont resource type" +description: "This object represents the font attributes (font name, font size, color, etc.) for an object." +ms.localizationpriority: medium +++++# workbookRangeFont resource type ++Namespace: microsoft.graph ++This object represents the font attributes (font name, font size, color, etc.) for an object. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get RangeFont](../api/rangefont-get.md) | [workbookRangeFont](workbookrangefont.md) |Read properties and relationships of rangeFont object.| +|[Update](../api/rangefont-update.md) | [workbookRangeFont](workbookrangefont.md) |Update RangeFont object. | ++## Properties +| Property | Type |Description| +|:|:--|:-| +|bold|boolean|Represents the bold status of font.| +|color|string|HTML color code representation of the text color. for example #FF0000 represents Red.| +|italic|boolean|Represents the italic status of the font.| +|name|string|Font name (for example "Calibri")| +|size|double|Font size.| +|underline|string|Type of underline applied to the font. The possible values are: `None`, `Single`, `Double`, `SingleAccountant`, `DoubleAccountant`.| ++## Relationships +None +++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookRangeFont" +}--> ++```json +{ + "bold": true, + "color": "string", + "italic": true, + "name": "string", + "size": 1024, + "underline": "string" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "RangeFont resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookrangeformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookrangeformat.md | + + Title: "workbookRangeFormat resource type" +description: "A format object encapsulating the range's font, fill, borders, alignment, and other properties." +ms.localizationpriority: medium +++++# workbookRangeFormat resource type ++Namespace: microsoft.graph ++A format object encapsulating the range's font, fill, borders, alignment, and other properties. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get RangeFormat](../api/rangeformat-get.md) | [workbookRangeFormat](workbookrangeformat.md) |Read properties and relationships of rangeFormat object.| +|[Create RangeBorder](../api/rangeformat-post-borders.md) |[workbookRangeBorder](workbookrangeborder.md)| Create a new RangeBorder by posting to the borders collection.| +|[List borders](../api/rangeformat-list-borders.md) |[workbookRangeBorder](workbookrangeborder.md) collection| Get a RangeBorder object collection.| +|[Update](../api/rangeformat-update.md) | [workbookRangeFormat](workbookrangeformat.md) |Update RangeFormat object. | +|[Autofitcolumns](../api/rangeformat-autofitcolumns.md)|None|Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.| +|[Autofitrows](../api/rangeformat-autofitrows.md)|None|Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|columnWidth|double|Gets or sets the width of all columns within the range. If the column widths aren't uniform, null will be returned.| +|horizontalAlignment|string|Represents the horizontal alignment for the specified object. The possible values are: `General`, `Left`, `Center`, `Right`, `Fill`, `Justify`, `CenterAcrossSelection`, `Distributed`.| +|rowHeight|double|Gets or sets the height of all rows in the range. If the row heights aren't uniform null will be returned.| +|verticalAlignment|string|Represents the vertical alignment for the specified object. The possible values are: `Top`, `Center`, `Bottom`, `Justify`, `Distributed`.| +|wrapText|boolean|Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|borders|[workbookRangeBorder](workbookrangeborder.md) collection|Collection of border objects that apply to the overall range selected Read-only.| +|fill|[workbookRangeFill](workbookrangefill.md)|Returns the fill object defined on the overall range. Read-only.| +|font|[workbookRangeFont](workbookrangefont.md)|Returns the font object defined on the overall range selected Read-only.| +|protection|[workbookFormatProtection](formatprotection.md)|Returns the format protection object for a range. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.workbookRangeFormat" +}--> ++```json +{ + "columnWidth": 1024, + "horizontalAlignment": "string", + "rowHeight": 1024, + "verticalAlignment": "string", + "wrapText": true +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "RangeFormat resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookrangesort | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookrangesort.md | + + Title: "workbookRangeSort resource type" +description: "Manages sorting operations on Range objects." ++ms.localizationpriority: medium ++++# workbookRangeSort resource type ++Namespace: microsoft.graph ++Manages sorting operations on Range objects. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Apply](../api/rangesort-apply.md)|None|Perform a sort operation.| ++## Properties +None ++## Relationships +None ++## JSON representation ++The following JSON representation shows the resource type. +++<!-- { + "blockType": "resource", + "baseType": "microsoft.graph.entity", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.workbookRangeSort" +}--> ++```json +{ +} +``` ++##### Request +The following example shows a request. +++<!--{ + "blockType": "request", + "name": "range_sort" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/sort +``` ++##### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.workbookRangeSort" +} --> +```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ +} +``` +++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "RangeSort resource", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + ] +}--> + |
v1.0 | Workbookrangeview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookrangeview.md | Title: "rangeView resource type" + Title: "workbookRangeView resource type" description: "RangeView represents a set of visible cells of the parent range." ms.localizationpriority: medium-# rangeView resource type +# workbookRangeView resource type Namespace: microsoft.graph RangeView represents a set of visible cells of the parent range. RangeView represents a set of visible cells of the parent range. |:|:--|:-| |[List rows](../api/workbookrangeview-list-rows.md) |[workbookRangeView](workbookrangeview.md) collection| Get a workbookRangeView object collection.| |[Itemat](../api/workbookrangeview-itemat.md)|[workbookRangeView](workbookrangeview.md)|Get a range view item based in index.|-|[Range](../api/workbookrangeview-range.md)|[workbookRange](range.md)|Return the range object associated with the range view| +|[Range](../api/workbookrangeview-range.md)|[workbookRange](workbookrange.md)|Return the range object associated with the range view| ## Properties | Property | Type |Description| |:|:--|:-|-|cellAddresses|Json|Represents the cell addresses +|cellAddresses|Json|Represents the cell addresses| |columnCount|Int32|Returns the number of visible columns. Read-only.| |formulas|Json|Represents the formula in A1-style notation. | |formulasLocal|Json|Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. | RangeView represents a set of visible cells of the parent range. |rows|[workbookRangeView](workbookrangeview.md) collection| Represents a collection of range views associated with the range. Read-only. Read-only.| ## JSON representation-Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "baseType": "microsoft.graph.entity", |
v1.0 | Workbooksessioninfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbooksessioninfo.md | Provides information about workbook session. ## JSON representation -Here's a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workbooktable | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbooktable.md | + + Title: "workbookTable resource type" +description: "Represents an Excel table." ++ms.localizationpriority: high ++++# workbookTable resource type ++Namespace: microsoft.graph ++Represents an Excel table. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get Table](../api/table-get.md) | [workbookTable](workbooktable.md) |Read properties and relationships of table object.| +|[Create TableColumn](../api/table-post-columns.md) |[workbookTableColumn](workbooktablecolumn.md)| Create a new TableColumn by posting to the columns collection.| +|[List columns](../api/table-list-columns.md) |[workbookTableColumn](workbooktablecolumn.md) collection| Get a TableColumn object collection.| +|[Create TableRow](../api/table-post-rows.md) |[workbookTableRow]( workbooktablerow.md)| Create a new TableRow by posting to the rows collection.| +|[List rows](../api/table-list-rows.md) |[workbookTableRow]( workbooktablerow.md) collection| Get a TableRow object collection.| +|[Update](../api/table-update.md) | [workbookTable](workbooktable.md) |Update Table object. | +|[Databodyrange](../api/table-databodyrange.md)|[Range](workbookrange.md)|Gets the range object associated with the data body of the table.| +|[Headerrowrange](../api/table-headerrowrange.md)|[Range](workbookrange.md)|Gets the range object associated with header row of the table.| +|[Range](../api/table-range.md)|[Range](workbookrange.md)|Gets the range object associated with the entire table.| +|[Totalrowrange](../api/table-totalrowrange.md)|[Range](workbookrange.md)|Gets the range object associated with totals row of the table.| +|[Clearfilters](../api/table-clearfilters.md)|None|Clears all the filters currently applied on the table.| +|[Converttorange](../api/table-converttorange.md)|[Range](workbookrange.md)|Converts the table into a normal range of cells. All data is preserved.| +|[Delete](../api/table-delete.md)|None|Deletes the table.| +|[Reapplyfilters](../api/table-reapplyfilters.md)|None|Reapplies all the filters currently on the table.| +|[List](../api/table-list.md) | [workbookTable](workbooktable.md) collection |Get table object collection. | +|[Add](../api/tablecollection-add.md)|[workbookTable](workbooktable.md)|Create a new table. The range source address determines the worksheet under which the table will be added. If the table can't be added (for example, because the address is invalid, or the table would overlap with another table), an error is thrown.| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|highlightFirstColumn|Boolean|Indicates whether the first column contains special formatting. | +|highlightLastColumn|Boolean|Indicates whether the last column contains special formatting. | +|id|string|Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. This property should be interpreted as an opaque string value and shouldn't be parsed to any other type. Read-only.| +|legacyId|String|Legacy ID used in older Excel clients. The value of the identifier remains the same even when the table is renamed. This property should be interpreted as an opaque string value and shouldn't be parsed to any other type. Read-only. +|name|string|Name of the table.| +|showBandedRows|Boolean|Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier. | +|showBandedColumns|Boolean|Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier. | +|showFilterButton|Boolean|Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. | +|showHeaders|boolean|Indicates whether the header row is visible or not. This value can be set to show or remove the header row.| +|showTotals|boolean|Indicates whether the total row is visible or not. This value can be set to show or remove the total row.| +|style|string|Constant value that represents the Table style. The possible values are: TableStyleLight1 through TableStyleLight21, TableStyleMedium1 through TableStyleMedium28, TableStyleStyleDark1 through TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|columns|[workbookTableColumn](workbooktablecolumn.md) collection|Represents a collection of all the columns in the table. Read-only.| +|rows|[workbookTableRow]( workbooktablerow.md) collection|Represents a collection of all the rows in the table. Read-only.| +|sort|[workbookTableSort](workbooktablesort.md)|Represents the sorting for the table. Read-only.| +|worksheet|[workbookWorksheet](workbookworksheet.md)|The worksheet containing the current table. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [ + "legacyId" + ], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookTable" +}--> ++```json +{ + "highlightFirstColumn": true, + "highlightLastColumn": true, + "id": "String (identifier)", + "name": "String", + "showBandedColumns": true, + "showBandedRows": true, + "showFilterButton": true, + "showHeaders": true, + "showTotals": true, + "style": "String", + "legacyId": "String" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "Table resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbooktablecolumn | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbooktablecolumn.md | Represents a column in a table. | Method | Return Type |Description| |:|:--|:-|-|[Get TableColumn](../api/tablecolumn-get.md) | [WorkbookTableColumn](workbooktablecolumn.md) |Read properties and relationships of tableColumn object.| -|[Update](../api/tablecolumn-update.md) | [WorkbookTableColumn](workbooktablecolumn.md) |Update TableColumn object. | -|[Databodyrange](../api/tablecolumn-databodyrange.md)|[Range](range.md)|Gets the range object associated with the data body of the column.| -|[Headerrowrange](../api/tablecolumn-headerrowrange.md)|[Range](range.md)|Gets the range object associated with the header row of the column.| -|[Range](../api/tablecolumn-range.md)|[Range](range.md)|Gets the range object associated with the entire column.| -|[Totalrowrange](../api/tablecolumn-totalrowrange.md)|[Range](range.md)|Gets the range object associated with the totals row of the column.| +|[Get TableColumn](../api/tablecolumn-get.md) | [workbookTableColumn](workbooktablecolumn.md) |Read properties and relationships of tableColumn object.| +|[Update](../api/tablecolumn-update.md) | [workbookTableColumn](workbooktablecolumn.md) |Update TableColumn object. | +|[Databodyrange](../api/tablecolumn-databodyrange.md)|[Range](workbookrange.md)|Gets the range object associated with the data body of the column.| +|[Headerrowrange](../api/tablecolumn-headerrowrange.md)|[Range](workbookrange.md)|Gets the range object associated with the header row of the column.| +|[Range](../api/tablecolumn-range.md)|[Range](workbookrange.md)|Gets the range object associated with the entire column.| +|[Totalrowrange](../api/tablecolumn-totalrowrange.md)|[Range](workbookrange.md)|Gets the range object associated with the totals row of the column.| |[Delete](../api/tablecolumn-delete.md)|None|Deletes the column from the table.|-|[List](../api/tablecolumn-list.md) | [WorkbookTableColumn](workbooktablecolumn.md) collection |Get tableColumn object collection. | -|[Itemat](../api/tablecolumncollection-itemat.md)|[WorkbookTableColumn](workbooktablecolumn.md)|Gets a column based on its position in the collection.| -|[Add](../api/tablecolumncollection-add.md)|[WorkbookTableColumn](workbooktablecolumn.md)|Adds a new column to the table.| +|[List](../api/tablecolumn-list.md) | [workbookTableColumn](workbooktablecolumn.md) collection |Get tableColumn object collection. | +|[Itemat](../api/tablecolumncollection-itemat.md)|[workbookTableColumn](workbooktablecolumn.md)|Gets a column based on its position in the collection.| +|[Add](../api/tablecolumncollection-add.md)|[workbookTableColumn](workbooktablecolumn.md)|Adds a new column to the table.| ## Properties | Property | Type |Description| Represents a column in a table. ## Relationships | Relationship | Type |Description| |:|:--|:-|-|filter|[WorkbookFilter](filter.md)|Retrieve the filter applied to the column. Read-only.| +|filter|[workbookFilter](workbookfilter.md)|Retrieve the filter applied to the column. Read-only.| ## JSON representation -Here's a JSON representation of the resource. +The following JSON representation shows the resource type. <!--{ "blockType": "resource", |
v1.0 | Workbooktablerow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbooktablerow.md | Represents a row in a table. |[Get](../api/tablerow-get.md) | [workbookTableRow]( workbooktablerow.md) |Read the properties and relationships of a tableRow object.| |[Update](../api/tablerow-update.md) | [workbookTableRow]( workbooktablerow.md) |Update a workbookTableRow object. | |[Delete](../api/tablerow-delete.md)|None|Delete a row from the table.|-|[Range](../api/tablerow-range.md)|[Range](range.md)|Return the range object associated with the entire row.| +|[Range](../api/tablerow-range.md)|[Range](workbookrange.md)|Return the range object associated with the entire row.| |[Itemat](../api/tablerowcollection-itemat.md)|[workbookTableRow]( workbooktablerow.md)|Get a row based on its position in the collection.| |[Add](../api/tablerowcollection-add.md)|[workbookTableRow]( workbooktablerow.md)|Add a new row to the table.| |
v1.0 | Workbooktablesort | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbooktablesort.md | + + Title: "workbookTableSort resource type" +description: "Manages sorting operations on Table objects." ++ms.localizationpriority: medium ++++# workbookTableSort resource type ++Namespace: microsoft.graph ++Manages sorting operations on Table objects. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get TableSort](../api/tablesort-get.md) | [workbookTableSort](workbooktablesort.md) |Read properties and relationships of tableSort object.| +|[Apply](../api/tablesort-apply.md)|None|Perform a sort operation.| +|[Clear](../api/tablesort-clear.md)|None|Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the state of the header buttons.| +|[Reapply](../api/tablesort-reapply.md)|None|Reapplies the current sorting parameters to the table.| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|fields|[workbookSortField](sortfield.md) collection|Represents the current conditions used to last sort the table. Read-only.| +|matchCase|boolean|Represents whether the casing impacted the last sort of the table. Read-only.| +|method|string|Represents Chinese character ordering method last used to sort the table. The possible values are: `PinYin`, `StrokeCount`. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "optionalProperties": [ ++ ], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookTableSort" +}--> ++```json +{ + "matchCase": true, + "method": "string", + "fields": [{ "@odata.type": "microsoft.graph.workbookSortField" }] +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "TableSort resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookworksheet | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookworksheet.md | + + Title: "workbookWorksheet resource type" +description: "An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc." +ms.localizationpriority: high +++++# workbookWorksheet resource type ++Namespace: microsoft.graph ++An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get Worksheet](../api/worksheet-get.md) | [workbookWorksheet](workbookworksheet.md) |Read properties and relationships of worksheet object.| +|[Create Chart](../api/worksheet-post-charts.md) |[workbookChart](workbookchart.md)| Create a new Chart by posting to the charts collection.| +|[List names](../api/worksheet-list-names.md) |[workbookNamedItem](workbooknameditem.md) collection| Get named item collection associated with the worksheet.| +|[List charts](../api/worksheet-list-charts.md) |[workbookChart](workbookchart.md) collection| Get a Chart object collection.| +|[Create Table](../api/worksheet-post-tables.md) |[workbookTable](workbooktable.md)| Create a new Table by posting to the tables collection.| +|[List tables](../api/worksheet-list-tables.md) |[workbookTable](workbooktable.md) collection| Get a Table object collection.| +|[Update](../api/worksheet-update.md) | [workbookWorksheet](workbookworksheet.md) |Update Worksheet object. | +|[Cell](../api/worksheet-cell.md)|[Range](workbookrange.md)|Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid.| +|[Range](../api/worksheet-range.md)|[Range](workbookrange.md)|Gets the range object specified by the address or name.| +|[Usedrange](../api/worksheet-usedrange.md)|[Range](workbookrange.md)|The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the worksheet is blank, this function will return the top left cell.| +|[Delete](../api/worksheet-delete.md)|None|Deletes the worksheet from the workbook.| +|[List](../api/worksheet-list.md) | [workbookWorksheet](workbookworksheet.md) collection |Get worksheet object collection. | +|[Add](../api/worksheetcollection-add.md)|[workbookWorksheet](workbookworksheet.md)|Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. | +|[List pivotTables](../api/workbookworksheet-list-pivottables.md) |[workbookPivotTable](workbookpivottable.md) collection| Get a workbookPivotTable object collection.| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|id|string|Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only.| +|name|string|The display name of the worksheet.| +|position|int|The zero-based position of the worksheet within the workbook.| +|visibility|string|The Visibility of the worksheet. The possible values are: `Visible`, `Hidden`, `VeryHidden`.| ++## Relationships +| Relationship | Type |Description| +|:|:--|:-| +|charts|[workbookChart](workbookchart.md) collection|Returns collection of charts that are part of the worksheet. Read-only.| +|names|[workbookNamedItem](workbooknameditem.md) collection|Returns collection of names that are associated with the worksheet. Read-only.| +|pivotTables|[workbookPivotTable](workbookpivottable.md) collection| Collection of PivotTables that are part of the worksheet. | +|protection|[workbookWorksheetProtection](workbookworksheetprotection.md)|Returns sheet protection object for a worksheet. Read-only.| +|tables|[workbookTable](workbooktable.md) collection|Collection of tables that are part of the worksheet. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "keyProperty": "id", + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookWorksheet" +}--> ++```json +{ + "id": "string", + "name": "string", + "position": 1024, + "visibility": "string" +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "Worksheet resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workbookworksheetprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookworksheetprotection.md | + + Title: "workbookWorksheetProtection resource type" +description: "Represents the protection of a sheet object." ++ms.localizationpriority: medium ++++# workbookWorksheetProtection resource type ++Namespace: microsoft.graph ++Represents the protection of a sheet object. +++## Methods ++| Method | Return Type |Description| +|:|:--|:-| +|[Get WorksheetProtection](../api/worksheetprotection-get.md) | [workbookWorksheetProtection](workbookworksheetprotection.md) |Read properties and relationships of worksheetProtection object.| +|[Protect](../api/worksheetprotection-protect.md)|None|Protect a worksheet. It throws if the worksheet has been protected.| +|[Unprotect](../api/worksheetprotection-unprotect.md)|None|Unprotect a worksheet| ++## Properties +| Property | Type |Description| +|:|:--|:-| +|options|[workbookWorksheetProtectionOptions](worksheetprotectionoptions.md)|Sheet protection options. Read-only.| +|protected|boolean|Indicates if the worksheet is protected. Read-only.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!--{ + "blockType": "resource", + "optionalProperties": [], + "baseType": "microsoft.graph.entity", + "@odata.type": "microsoft.graph.workbookWorksheetProtection" +}--> ++```json +{ + "options": { "@odata.type": "microsoft.graph.workbookWorksheetProtectionOptions" }, + "protected": true +} ++``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "WorksheetProtection resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> + |
v1.0 | Workforceintegrationencryption | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workforceintegrationencryption.md | An encryption entity defining the protocol and secret for a [workforceintegratio ## 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/v1.0/resources/workinghours.md | appropriate time zone. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Worksheet | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/worksheet.md | - Title: "Worksheet resource type" -description: "An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc." ---doc_type: resourcePageType ---# Worksheet resource type --Namespace: microsoft.graph --An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get Worksheet](../api/worksheet-get.md) | [WorkbookWorksheet](worksheet.md) |Read properties and relationships of worksheet object.| -|[Create Chart](../api/worksheet-post-charts.md) |[WorkbookChart](chart.md)| Create a new Chart by posting to the charts collection.| -|[List names](../api/worksheet-list-names.md) |[WorkbookNamedItem](nameditem.md) collection| Get named item collection associated with the worksheet.| -|[List charts](../api/worksheet-list-charts.md) |[WorkbookChart](chart.md) collection| Get a Chart object collection.| -|[Create Table](../api/worksheet-post-tables.md) |[WorkbookTable](table.md)| Create a new Table by posting to the tables collection.| -|[List tables](../api/worksheet-list-tables.md) |[WorkbookTable](table.md) collection| Get a Table object collection.| -|[Update](../api/worksheet-update.md) | [WorkbookWorksheet](worksheet.md) |Update Worksheet object. | -|[Cell](../api/worksheet-cell.md)|[Range](range.md)|Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid.| -|[Range](../api/worksheet-range.md)|[Range](range.md)|Gets the range object specified by the address or name.| -|[Usedrange](../api/worksheet-usedrange.md)|[Range](range.md)|The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the worksheet is blank, this function will return the top left cell.| -|[Delete](../api/worksheet-delete.md)|None|Deletes the worksheet from the workbook.| -|[List](../api/worksheet-list.md) | [WorkbookWorksheet](worksheet.md) collection |Get worksheet object collection. | -|[Add](../api/worksheetcollection-add.md)|[WorkbookWorksheet](worksheet.md)|Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. | -|[List pivotTables](../api/workbookworksheet-list-pivottables.md) |[workbookPivotTable](workbookpivottable.md) collection| Get a workbookPivotTable object collection.| --## Properties -| Property | Type |Description| -|:|:--|:-| -|id|string|Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only.| -|name|string|The display name of the worksheet.| -|position|int|The zero-based position of the worksheet within the workbook.| -|visibility|string|The Visibility of the worksheet. The possible values are: `Visible`, `Hidden`, `VeryHidden`.| --## Relationships -| Relationship | Type |Description| -|:|:--|:-| -|charts|[WorkbookChart](chart.md) collection|Returns collection of charts that are part of the worksheet. Read-only.| -|names|[WorkbookNamedItem](nameditem.md) collection|Returns collection of names that are associated with the worksheet. Read-only.| -|pivotTables|[workbookPivotTable](workbookpivottable.md) collection| Collection of PivotTables that are part of the worksheet. | -|protection|[WorkbookWorksheetProtection](worksheetprotection.md)|Returns sheet protection object for a worksheet. Read-only.| -|tables|[WorkbookTable](table.md) collection|Collection of tables that are part of the worksheet. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "keyProperty": "id", - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookWorksheet" -}--> --```json -{ - "id": "string", - "name": "string", - "position": 1024, - "visibility": "string" -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "Worksheet resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Worksheetprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/worksheetprotection.md | - Title: "WorksheetProtection resource type" -description: "Represents the protection of a sheet object." ---doc_type: resourcePageType ---# WorksheetProtection resource type --Namespace: microsoft.graph --Represents the protection of a sheet object. ---## Methods --| Method | Return Type |Description| -|:|:--|:-| -|[Get WorksheetProtection](../api/worksheetprotection-get.md) | [WorkbookWorksheetProtection](worksheetprotection.md) |Read properties and relationships of worksheetProtection object.| -|[Protect](../api/worksheetprotection-protect.md)|None|Protect a worksheet. It throws if the worksheet has been protected.| -|[Unprotect](../api/worksheetprotection-unprotect.md)|None|Unprotect a worksheet| --## Properties -| Property | Type |Description| -|:|:--|:-| -|options|[workbookWorksheetProtectionOptions](worksheetprotectionoptions.md)|Sheet protection options. Read-only.| -|protected|boolean|Indicates if the worksheet is protected. Read-only.| --## JSON representation --Here is a JSON representation of the resource. --<!--{ - "blockType": "resource", - "optionalProperties": [], - "baseType": "microsoft.graph.entity", - "@odata.type": "microsoft.graph.workbookWorksheetProtection" -}--> --```json -{ - "options": { "@odata.type": "microsoft.graph.workbookWorksheetProtectionOptions" }, - "protected": true -} --``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- { - "type": "#page.annotation", - "description": "WorksheetProtection resource", - "keywords": "", - "section": "documentation", - "tocPath": "" -}--> - |
v1.0 | Worksheetprotectionoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/worksheetprotectionoptions.md | Title: "WorksheetProtectionOptions resource type" + Title: "workbookWorksheetProtectionOptions resource type" description: "Represents the options in sheet protection." ms.localizationpriority: medium-# WorksheetProtectionOptions resource type +# workbookWorksheetProtectionOptions resource type Namespace: microsoft.graph Represents the options in sheet protection. ## JSON representation -Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | X509certificateauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/x509certificateauthenticationmethodconfiguration.md | +toc.keywords: [ certificate-based authentication, CBA ] # x509CertificateAuthenticationMethodConfiguration resource type Inherits from [authenticationMethodConfiguration](../resources/authenticationmet |authenticationModeConfiguration|[x509CertificateAuthenticationModeConfiguration](../resources/x509certificateauthenticationmodeconfiguration.md)|Defines strong authentication configurations. This configuration includes the default authentication mode and the different rules for strong authentication bindings. | |certificateUserBindings|[x509CertificateUserBinding](../resources/x509certificateuserbinding.md) collection|Defines fields in the X.509 certificate that map to attributes of the Microsoft Entra user object in order to bind the certificate to the user. The **priority** of the object determines the order in which the binding is carried out. The first binding that matches will be used and the rest ignored. | |excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.|-|id|String|The identifier for the authentication method policy. The value is always `X509Certificate`. Inherited from +|id|String|The identifier for the authentication method policy. The value is always `X509Certificate`. Inherited from |state|authenticationMethodState|The possible values are: `enabled`, `disabled`. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).| |
v1.0 | Yammer Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/yammer-activity-reports.md | - Title: "Yammer activity reports" -description: "You can use the Yammer activity reports to understand the level of your organization's engagement with Yammer by seeing how much activity is generated across the organization and the number of unique users who post, like, and read messages on Yammer." ---doc_type: conceptualPageType ---# Yammer activity reports --Namespace: microsoft.graph --You can use the Yammer activity reports to understand the level of your organization's engagement with Yammer by seeing how much activity is generated across the organization and the number of unique users who post, like, and read messages on Yammer. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Yammer Activity](https://support.office.com/client/Yammer-activity-c7c9f938-5b8e-4d52-b1a2-c7c32cb2312a). --## Reports --| Function | Return Type | Description | -| : | :- | : | -| [Get user detail](../api/reportroot-getyammeractivityuserdetail.md) | Stream | Get details about Yammer activity by user. | -| [Get activity counts](../api/reportroot-getyammeractivitycounts.md) | Stream | Get the trends on the amount of Yammer 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 Yammer messages. | - |
v1.0 | Yammer Device Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/yammer-device-usage-reports.md | - Title: "Yammer device usage reports" -description: "The device usage reports for Yammer give you information about which devices your users utilize to engage on Yammer. You can view the number of users by device type over a selected time period and view details by user." ---doc_type: conceptualPageType ---# Yammer device usage reports --Namespace: microsoft.graph --The device usage reports for Yammer give you information about which devices your users utilize to engage on Yammer. You can view the number of users by device type over a selected time period and view details by user. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Yammer device usage](https://support.office.com/client/Yammer-device-usage-b793ffdd-effa-43d0-849a-b1ca2e899f38). --## Reports --| Function | Return Type | Description | -| : | :- | : | -| [Get user detail](../api/reportroot-getyammerdeviceusageuserdetail.md) | Stream | Get details about Yammer 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. | - |
v1.0 | Yammer Groups Activity Reports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/yammer-groups-activity-reports.md | - Title: "Yammer groups activity reports" -description: "You can use the Yammer groups activity reports to gain insights into the activity of Yammer groups in your organization and see how many Yammer groups are being created and used." ---doc_type: conceptualPageType ---# Yammer groups activity reports --Namespace: microsoft.graph --You can use the Yammer groups activity reports to gain insights into the activity of Yammer groups in your organization and see how many Yammer groups are being created and used. --> **Note:** For details about different report views and names, see [Microsoft 365 reports - Yammer groups activity](https://support.office.com/client/Yammer-groups-activity-report-94dd92ec-ea73-43c6-b51f-2a11fd78aa31). --## Reports --| Function | Return Type | Description | -| : | :- | : | -| [Get group detail](../api/reportroot-getyammergroupsactivitydetail.md) | Stream | Get details about Yammer 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 Yammer messages posted, read, and liked in groups. | - |
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: /graph/sdks/sdks-overview?context=graph/api/1.0 - name: Use the toolkit href: /graph/toolkit/overview?context=graph/api/1.0+ - name: Deploy with Bicep + href: /graph/templates?context=graph/api/1.0 - name: Known issues href: https://developer.microsoft.com/graph/known-issues - name: Errors items: href: resources/plannertask.md - name: List tasks href: api/planneruser-list-tasks.md+ - name: Sponsors + items: + - name: Add sponsor + href: api/user-post-sponsors.md + - name: List sponsors + href: api/user-list-sponsors.md + - name: Remove sponsor + href: api/user-delete-sponsors.md - name: Teamwork and communications items: - name: Installed app items: href: api/group-get.md - name: Update group href: api/group-update.md+ - name: Upsert group + href: api/group-upsert.md - name: Delete group href: api/group-delete.md - name: Renew group items: href: api/user-list-joinedteams.md - name: List associated teams href: api/associatedteaminfo-list.md- - name: Group setting - href: resources/groupsetting.md - items: - - name: Create - href: api/group-post-settings.md - - name: Get - href: api/groupsetting-get.md - - name: List - href: api/group-list-settings.md - - name: Update - href: api/groupsetting-update.md - - name: Delete - href: api/groupsetting-delete.md - - name: Group setting template - href: resources/groupsettingtemplate.md - items: - - name: List group setting templates - href: api/groupsettingtemplate-list.md - - name: Get group setting template - href: api/groupsettingtemplate-get.md - name: List lifecycle policies href: api/group-list-grouplifecyclepolicies.md - name: List photos items: href: api/application-get.md - name: Update application href: api/application-update.md+ - name: Upsert application + href: api/application-upsert.md - name: Delete application href: api/application-delete.md - name: Get delta items: href: api/federatedidentitycredential-get.md - name: Update href: api/federatedidentitycredential-update.md+ - name: Upsert + href: api/federatedidentitycredential-upsert.md - name: Delete href: api/federatedidentitycredential-delete.md - name: Owners items: href: api/serviceprincipal-get.md - name: Update href: api/serviceprincipal-update.md+ - name: Upsert + href: api/serviceprincipal-upsert.md - name: Delete href: api/serviceprincipal-delete.md - name: List deleted service principals items: - name: Get href: api/cloudclipboarditem-get.md - name: Windows settings- href: resources/windowssetting.md - items: - - name: List - href: api/usersettings-list-windows.md - - name: Get - href: api/windowssetting-get.md - - name: Windows setting instance - href: resources/windowssettinginstance.md items:- - name: List - href: api/windowssetting-list-instances.md - - name: Get - href: api/windowssettinginstance-get.md + - name: Overview + href: resources/windows-setting-api-overview.md + - name: Windows setting + href: resources/windowssetting.md + items: + - name: List + href: api/usersettings-list-windows.md + - name: Get + href: api/windowssetting-get.md + - name: Windows setting instance + href: resources/windowssettinginstance.md + items: + - name: List + href: api/windowssetting-list-instances.md + - name: Get + href: api/windowssettinginstance-get.md - name: Customer booking displayName: Bookings, Microsoft Bookings items: items: - name: Assignment href: resources/educationassignment.md items:- - name: Create assignment + - name: Create href: api/educationclass-post-assignment.md- - name: Get assignment + - name: Get href: api/educationassignment-get.md- - name: Update assignment + - name: Update href: api/educationassignment-update.md- - name: Delete assignment + - name: Delete href: api/educationassignment-delete.md+ - name: Publish + href: api/educationassignment-publish.md - name: Set up assignment resources folder href: api/educationassignment-setupresourcesfolder.md - name: Set up assignment feedback resources folder href: api/educationassignment-setupfeedbackresourcesfolder.md- - name: Publish assignment - href: api/educationassignment-publish.md - - name: List assignment resources - href: api/educationassignment-list-resources.md - - name: Create assignment resource - href: api/educationassignment-post-resource.md - - name: Get assignment resource - href: api/educationassignmentresource-get.md - - name: Delete resource from assignment - href: api/educationassignmentresource-delete.md - name: List submissions for assignment href: api/educationassignment-list-submissions.md - name: Get rubric attached to assignment href: api/educationassignment-get-rubric.md - name: List categories href: api/educationassignment-list-categories.md- - name: Add category + - name: Attach category to assignment href: api/educationassignment-post-categories.md- - name: Remove category + - name: Remove category from assignment href: api/educationassignment-remove-category.md - name: Attach rubric to assignment href: api/educationassignment-put-rubric.md items: href: api/educationassignment-delete-rubric.md - name: Get delta href: api/educationassignment-delta.md- - name: Add grading category + - name: Attach grading category to assignment href: api/educationassignment-post-gradingcategory.md- - name: Update grading category - href: api/educationgradingcategory-update.md - - name: Remove grading category + - name: Remove grading category from assignment href: api/educationassignment-delete-gradingcategory.md - name: Activate assignment href: api/educationassignment-activate.md - name: Deactivate assignment href: api/educationassignment-deactivate.md+ - name: Assignment resource + href: resources/educationassignmentresource.md + items: + - name: List + href: api/educationassignment-list-resources.md + - name: Create + href: api/educationassignment-post-resource.md + - name: Get + href: api/educationassignmentresource-get.md + - name: Delete from assignment + href: api/educationassignmentresource-delete.md - name: Assignment settings href: resources/educationassignmentsettings.md items: items: href: api/educationsubmission-return.md - name: Reassign submission href: api/educationsubmission-reassign.md+ - name: Excuse submission + href: api/educationsubmission-excuse.md - name: Outcome items: - name: Outcome items: items: - name: Overview displayName: Azure AD, Microsoft identity platform, Identity and access- href: resources/azure-ad-overview.md + href: resources/identity-network-access-overview.md - name: Directory management items: - name: Administrative unit items: href: api/domain-verify.md - name: Promote domain href: api/domain-promote.md+ - name: Group setting + href: resources/groupsetting.md + items: + - name: Create + href: api/group-post-settings.md + - name: Get + href: api/groupsetting-get.md + - name: List + href: api/group-list-settings.md + - name: Update + href: api/groupsetting-update.md + - name: Delete + href: api/groupsetting-delete.md + - name: Group setting template + href: resources/groupsettingtemplate.md + items: + - name: List group setting templates + href: api/groupsettingtemplate-list.md + - name: Get group setting template + href: api/groupsettingtemplate-get.md - name: On-premises directory synchronization href: resources/onpremisesdirectorysynchronization.md items: items: href: api/authenticationstrengthroot-list-authenticationmethodmodes.md - name: Get authentication method modes href: api/authenticationmethodmodedetail-get.md+ - name: Authentication event listeners + href: resources/authenticationeventlistener.md + items: + - 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: Custom authentication extension + href: resources/customauthenticationextension.md + items: + - name: On token issuance start + href: resources/ontokenissuancestartcustomextension.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: Certificate-based auth configuration displayName: CBA href: resources/certificatebasedauthconfiguration.md items: items: - name: Create invitation href: api/invitation-post.md+ - name: Multitenant organization + items: + - name: Overview + displayName: Multitenant organization, MTO + href: resources/multitenantorganization-overview.md + - name: Multitenant organization + items: + - name: Multitenant organization + href: resources/multitenantorganization.md + - name: Create + href: api/tenantrelationship-put-multitenantorganization.md + - name: Get + href: api/multitenantorganization-get.md + - name: Update + href: api/multitenantorganization-update.md + - name: Tenant + items: + - name: Tenant + href: resources/multitenantorganizationmember.md + - name: List + href: api/multitenantorganization-list-tenants.md + - name: Add + href: api/multitenantorganization-post-tenants.md + - name: Get + href: api/multitenantorganizationmember-get.md + - name: Update + href: api/multitenantorganizationmember-update.md + - name: Remove + href: api/multitenantorganization-delete-tenants.md + - name: Join request + items: + - name: Join request + href: resources/multitenantorganizationjoinrequestrecord.md + - name: Get + href: api/multitenantorganizationjoinrequestrecord-get.md + - name: Update + href: api/multitenantorganizationjoinrequestrecord-update.md + - name: Partner configuration template + items: + - name: Partner configuration template + href: resources/multitenantorganizationpartnerconfigurationtemplate.md + - name: Get + href: api/multitenantorganizationpartnerconfigurationtemplate-get.md + - name: Update + href: api/multitenantorganizationpartnerconfigurationtemplate-update.md + - name: Reset + href: api/multitenantorganizationpartnerconfigurationtemplate-resettodefaultsettings.md + - name: Identity sync policy template + items: + - name: Identity sync policy template + href: resources/multitenantorganizationidentitysyncpolicytemplate.md + - name: Get + href: api/multitenantorganizationidentitysyncpolicytemplate-get.md + - name: Update + href: api/multitenantorganizationidentitysyncpolicytemplate-update.md + - name: Reset + href: api/multitenantorganizationidentitysyncpolicytemplate-resettodefaultsettings.md - name: Organizational branding href: resources/organizationalbranding.md items: items: href: api/identitysecuritydefaultsenforcementpolicy-update.md - name: User flows items:- - name: Self-service sign up user flows in Microsoft Entra ID - items: + - name: User flows in workforce tenants + items: - name: Self-service sign up user flow- href: resources/b2xidentityuserflow.md - - name: List - href: api/identitycontainer-list-b2xuserflows.md - - name: Create - href: api/identitycontainer-post-b2xuserflows.md - - name: Get - href: api/b2xidentityuserflow-get.md - - name: Delete - href: api/b2xidentityuserflow-delete.md - - name: List identity providers - href: api/b2xidentityuserflow-list-identityproviders.md - - name: Add identity provider - href: api/b2xidentityuserflow-post-identityproviders.md - - name: Remove identity provider - href: api/b2xidentityuserflow-delete-identityproviders.md - - name: List user attribute assignments - href: api/b2xidentityuserflow-list-userattributeassignments.md - - name: Create user attribute assignment - href: api/b2xidentityuserflow-post-userattributeassignments.md - - name: List languages - href: api/b2xidentityuserflow-list-languages.md - - name: Get API connectors configuration - href: api/b2xidentityuserflow-get-apiConnectorConfiguration.md - - name: Configure an API connector - href: api/b2xidentityuserflow-put-apiConnectorConfiguration.md - - name: User flow attributes - items: - - name: User flow attribute - href: resources/identityuserflowattribute.md - - name: List - href: api/identityuserflowattribute-list.md - - name: Create - href: api/identityuserflowattribute-post.md - - name: Get - href: api/identityuserflowattribute-get.md - - name: Update - href: api/identityuserflowattribute-update.md - - name: Delete - href: api/identityuserflowattribute-delete.md - - name: User flow attribute assignment - items: + items: + - name: Self-service sign up user flow + href: resources/b2xidentityuserflow.md + - name: List + href: api/identitycontainer-list-b2xuserflows.md + - name: Create + href: api/identitycontainer-post-b2xuserflows.md + - name: Get + href: api/b2xidentityuserflow-get.md + - name: Delete + href: api/b2xidentityuserflow-delete.md + - name: List identity providers + href: api/b2xidentityuserflow-list-identityproviders.md + - name: Add identity provider + href: api/b2xidentityuserflow-post-identityproviders.md + - name: Remove identity provider + href: api/b2xidentityuserflow-delete-identityproviders.md + - name: List user attribute assignments + href: api/b2xidentityuserflow-list-userattributeassignments.md + - name: Create user attribute assignment + href: api/b2xidentityuserflow-post-userattributeassignments.md + - name: List languages + href: api/b2xidentityuserflow-list-languages.md + - name: Get API connectors configuration + href: api/b2xidentityuserflow-get-apiConnectorConfiguration.md + - name: Configure an API connector + href: api/b2xidentityuserflow-put-apiConnectorConfiguration.md + - name: User flow attributes + items: + - name: User flow attribute + href: resources/identityuserflowattribute.md + - name: List + href: api/identityuserflowattribute-list.md + - name: Create + href: api/identityuserflowattribute-post.md + - name: Get + href: api/identityuserflowattribute-get.md + - name: Update + href: api/identityuserflowattribute-update.md + - name: Delete + href: api/identityuserflowattribute-delete.md - name: User flow attribute assignment- href: resources/identityuserflowattributeassignment.md - - name: Get - href: api/identityuserflowattributeassignment-get.md - - name: Update - href: api/identityuserflowattributeassignment-update.md - - name: Delete - href: api/identityuserflowattributeassignment-delete.md - - name: User flow language configuration - items: + items: + - name: User flow attribute assignment + href: resources/identityuserflowattributeassignment.md + - name: Get + href: api/identityuserflowattributeassignment-get.md + - name: Update + href: api/identityuserflowattributeassignment-update.md + - name: Delete + href: api/identityuserflowattributeassignment-delete.md - name: User flow language configuration- href: resources/userflowlanguageconfiguration.md - - name: Get - href: api/userflowlanguageconfiguration-get.md - - name: List default pages - href: api/userflowlanguageconfiguration-list-defaultpages.md - - name: List overrides pages - href: api/userflowlanguageconfiguration-list-overridespages.md - - name: User flow language page - href: resources/userflowlanguagepage.md - - name: Get - href: api/userflowlanguagepage-get.md - - name: Update - href: api/userflowlanguagepage-put.md - - name: Delete - href: api/userflowlanguagepage-delete.md - - name: API connectors + items: + - name: User flow language configuration + href: resources/userflowlanguageconfiguration.md + - name: Get + href: api/userflowlanguageconfiguration-get.md + - name: List default pages + href: api/userflowlanguageconfiguration-list-defaultpages.md + - name: List overrides pages + href: api/userflowlanguageconfiguration-list-overridespages.md + - name: User flow language page + href: resources/userflowlanguagepage.md + - name: Get + href: api/userflowlanguagepage-get.md + - name: Update + href: api/userflowlanguagepage-put.md + - name: Delete + href: api/userflowlanguagepage-delete.md + - name: API connectors + items: + - name: API connector + href: resources/identityapiconnector.md + - name: List + href: api/identityapiconnector-list.md + - name: Create + href: api/identityapiconnector-create.md + - name: Get + href: api/identityapiconnector-get.md + - name: Update + href: api/identityapiconnector-update.md + - name: Upload a client certificate + href: api/identityapiconnector-uploadclientcertificate.md + - name: Delete + href: api/identityapiconnector-delete.md + - name: User flows in external tenants items:- - name: API connector - href: resources/identityapiconnector.md - - name: List - href: api/identityapiconnector-list.md - - name: Create - href: api/identityapiconnector-create.md - - name: Get - href: api/identityapiconnector-get.md - - name: Update - href: api/identityapiconnector-update.md - - name: Upload a client certificate - href: api/identityapiconnector-uploadclientcertificate.md - - name: Delete - href: api/identityapiconnector-delete.md + - name: Authentication events flow + href: resources/authenticationeventsflow.md + - name: Self-service sign up user flow + href: resources/externalusersselfservicesignupeventsflow.md + - name: List user flows + href: api/identitycontainer-list-authenticationeventsflows.md + - name: Create user flow + href: api/identitycontainer-post-authenticationeventsflows.md + - name: Get user flow + href: api/authenticationeventsflow-get.md + - name: Update user flow + href: api/authenticationeventsflow-update.md + - name: Delete user flow + href: api/authenticationeventsflow-delete.md + - name: Identity providers + items: + - name: List identity providers in a user flow + href: api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders.md + - name: Add identity provider to a user flow + href: api/onauthenticationmethodloadstartexternalusersselfservicesignup-post-identityproviders.md + - name: Remove identity provider from a user flow + href: api/onauthenticationmethodloadstartexternalusersselfservicesignup-delete-identityproviders.md + - name: User flow attributes + items: + - name: User flow attribute + href: resources/identityuserflowattribute.md + - name: List + href: api/identityuserflowattribute-list.md + - name: Create + href: api/identityuserflowattribute-post.md + - name: Get + href: api/identityuserflowattribute-get.md + - name: Update + href: api/identityuserflowattribute-update.md + - name: Delete + href: api/identityuserflowattribute-delete.md + - name: List attributes in a user flow + href: api/onattributecollectionexternalusersselfservicesignup-list-attributes.md + - name: Add attributes to a user flow + href: api/onattributecollectionexternalusersselfservicesignup-post-attributes.md + - name: Remove attributes from a user flow + href: api/onattributecollectionexternalusersselfservicesignup-delete-attributes.md + - name: Authentication condition applications + href: resources/authenticationconditionapplication.md + items: + - name: List applications + href: api/authenticationconditionsapplications-list-includeapplications.md + - name: Add applications + href: api/authenticationconditionsapplications-post-includeapplications.md + - name: Remove applications + href: api/authenticationconditionapplication-delete.md - name: Partner customer administration items: - name: Granular delegated admin privileges items: items: - name: Microsoft Entra activity reports items:+ - name: AD FS application activity + items: + - name: Relying party detailed summary + href: resources/relyingpartydetailedsummary.md + items: + - name: Get relying party detailed summary + href: api/reportroot-getrelyingpartydetailedsummary.md - name: Registration and usage items: - name: Overview items: href: api/informationprotection-post-threatassessmentrequests.md - name: Get href: api/threatassessmentrequest-get.md- - name: Legacy alert + - name: Legacy alert (deprecated) items: - name: Alert href: resources/alert.md items: href: api/alert-update.md - name: Records management items:- - name: Overview - href: resources/security-recordsManagement-overview.md - - name: Retention event - href: resources/security-retentionevent.md - items: + - name: Overview + href: resources/security-recordsmanagement-overview.md + - name: Retention label + href: resources/security-retentionlabel.md + items: + - name: List + href: api/security-labelsroot-list-retentionlabel.md + - name: Create + href: api/security-labelsroot-post-retentionlabel.md + - name: Get + href: api/security-retentionlabel-get.md + - name: Update + href: api/security-retentionlabel-update.md + - name: Delete + href: api/security-retentionlabel-delete.md + - name: File plan descriptors + items: + - name: File plan descriptors + items: + - name: File plan descriptor set + href: resources/security-fileplandescriptor.md + - name: Applied category + href: resources/security-fileplanappliedcategory.md + - name: Authority + href: resources/security-fileplanauthority.md + - name: Citation + href: resources/security-fileplancitation.md + - name: Department + href: resources/security-fileplandepartment.md + - name: File plan reference + href: resources/security-fileplanreference.md + - name: Subcategory + href: resources/security-fileplansubcategory.md + - name: File plan descriptor templates + items: + - name: Applied category template + items: + - name: Category template + href: resources/security-categorytemplate.md - name: List- href: api/security-retentionevent-list.md + href: api/security-labelsroot-list-categories.md - name: Create- href: api/security-retentionevent-post.md + href: api/security-labelsroot-post-categories.md - name: Get- href: api/security-retentionevent-get.md + href: api/security-categorytemplate-get.md - name: Delete- href: api/security-retentionevent-delete.md - - name: Retention event type - href: resources/security-retentioneventtype.md - items: + href: api/security-labelsroot-delete-categories.md + - name: Authority template + items: + - name: Authority template + href: resources/security-authoritytemplate.md - name: List- href: api/security-retentioneventtype-list.md + href: api/security-labelsroot-list-authorities.md - name: Create- href: api/security-retentioneventtype-post.md + href: api/security-labelsroot-post-authorities.md - name: Get- href: api/security-retentioneventtype-get.md - - name: Update - href: api/security-retentioneventtype-update.md + href: api/security-authoritytemplate-get.md + - name: Delete + href: api/security-labelsroot-delete-authorities.md + - name: Citation template + items: + - name: Citation template + href: resources/security-citationtemplate.md + - name: List + href: api/security-labelsroot-list-citations.md + - name: Create + href: api/security-labelsroot-post-citations.md + - name: Get + href: api/security-citationtemplate-get.md + - name: Delete + href: api/security-labelsroot-delete-citations.md + - name: Department template + items: + - name: Department template + href: resources/security-departmenttemplate.md + - name: List + href: api/security-labelsroot-list-departments.md + - name: Create + href: api/security-labelsroot-post-departments.md + - name: Get + href: api/security-departmenttemplate-get.md + - name: Delete + href: api/security-labelsroot-delete-departments.md + - name: File plan reference template + items: + - name: File plan reference template + href: resources/security-fileplanreferencetemplate.md + - name: List + href: api/security-labelsroot-list-fileplanreferences.md + - name: Create + href: api/security-labelsroot-post-fileplanreferences.md + - name: Get + href: api/security-fileplanreferencetemplate-get.md + - name: Delete + href: api/security-labelsroot-delete-fileplanreferences.md + - name: Subcategory template + items: + - name: Subcategory template + href: resources/security-subcategorytemplate.md + - name: List + href: api/security-categorytemplate-list-subcategories.md + - name: Create + href: api/security-categorytemplate-post-subcategories.md + - name: Get + href: api/security-subcategorytemplate-get.md - name: Delete- href: api/security-retentioneventtype-delete.md + href: api/security-categorytemplate-delete-subcategories.md + - name: Retention event + href: resources/security-retentionevent.md + items: + - name: List + href: api/security-retentionevent-list.md + - name: Create + href: api/security-retentionevent-post.md + - name: Get + href: api/security-retentionevent-get.md + - name: Delete + href: api/security-retentionevent-delete.md + - name: Retention event type + href: resources/security-retentioneventtype.md + items: + - name: List + href: api/security-retentioneventtype-list.md + - name: Create + href: api/security-retentioneventtype-post.md + - name: Get + href: api/security-retentioneventtype-get.md + - name: Update + href: api/security-retentioneventtype-update.md + - name: Delete + href: api/security-retentioneventtype-delete.md - name: Secure score href: resources/securescore.md items: items: - name: List item href: resources/listitem.md items:- - name: Get item - href: api/listitem-get.md - name: Create item href: api/listitem-create.md- - name: Update item + - name: Get + href: api/listitem-get.md + - name: Update href: api/listitem-update.md- - name: Delete item + - name: Delete href: api/listitem-delete.md- - name: List versions - href: api/listitem-list-versions.md + - name: Get delta + href: api/listitem-delta.md - name: Get item analytics href: api/itemanalytics-get.md+ - name: List versions + href: api/listitem-list-versions.md - name: Document set version items: - name: Document set version items: href: api/documentsetversion-delete.md - name: Restore href: api/documentsetversion-restore.md+ - name: Pages + items: + - name: Base site page + href: resources/basesitepage.md + items: + - name: List + href: api/basesitepage-list.md + - name: Get + href: api/basesitepage-get.md + - name: Delete + href: api/basesitepage-delete.md + - name: Site page + href: resources/sitepage.md + items: + - name: List + href: api/sitepage-list.md + - name: Create + href: api/sitepage-create.md + - name: Get + href: api/sitepage-get.md + - name: Update + href: api/sitepage-update.md + - name: Delete + href: api/basesitepage-delete.md + - name: Publish + href: api/sitepage-publish.md + - name: Horizontal section + items: + - name: Horizontal section + href: resources/horizontalsection.md + - name: List + href: api/horizontalsection-list.md + - name: Create + href: api/sitepage-post-horizontalsection.md + - name: Get + href: api/horizontalsection-get.md + - name: Update + href: api/horizontalsection-update.md + - name: Delete + href: api/horizontalsection-delete.md + - name: Column + items: + - name: Horizontal section column + href: resources/horizontalsectioncolumn.md + - name: List + href: api/horizontalsectioncolumn-list.md + - name: Get + href: api/horizontalsectioncolumn-get.md + - name: Vertical section + items: + - name: Vertical section + href: resources/verticalsection.md + - name: Create + href: api/sitepage-post-verticalsection.md + - name: Get + href: api/verticalsection-get.md + - name: Update + href: api/verticalsection-update.md + - name: Delete + href: api/verticalsection-delete.md + - name: Web part + items: + - name: Web part + href: resources/webpart.md + - name: Text web part + href: resources/textwebpart.md + - name: Standard web part + href: resources/standardwebpart.md + - name: List + href: api/webpart-list.md + - name: Create + href: api/sitepage-create-webpart.md + - name: Get + href: api/webpart-get.md + - name: Update + href: api/webpart-update.md + - name: Delete + href: api/webpart-delete.md + - name: Get position + href: api/webpart-getposition.md + - name: Get by position + href: api/sitepage-getwebpartsbyposition.md - name: Rich long-running operation items: - name: Rich long-running operation items: href: api/virtualevent-list-sessions.md - name: Get href: api/virtualeventsession-get.md+ - name: Settings + items: + - name: License details + href: resources/licensedetails.md + items: + - name: Get + href: api/licenseDetails-getteamslicensingdetails.md + - name: Organization settings + items: + - name: Teamwork + href: resources/teamwork.md + items: + - name: Get + href: api/teamwork-get.md + - name: User settings + items: + - name: User teamwork + href: resources/userteamwork.md + items: + - name: Get + href: api/userteamwork-get.md - name: Employee learning displayName: Viva Learning items: items: - name: Delete href: api/range-delete.md - name: Table- href: resources/table.md + href: resources/workbooktable.md items: - name: Add table href: api/tablecollection-add.md items: - name: Get range href: api/table-range.md - name: Chart- href: resources/chart.md + href: resources/workbookchart.md items: - name: List charts href: api/chart-list.md items: - name: Set position data href: api/chart-setposition.md - name: Named item- href: resources/nameditem.md + href: resources/workbooknameditem.md items: - name: List named item href: api/nameditem-list.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/applications/toc.yml | +items: +- name: Overview + href: ../../resources/applications-api-overview.md +- name: Application + items: + - name: Application + href: ../../resources/application.md + - name: List applications + href: ../../api/application-list.md + - name: Create application + href: ../../api/application-post-applications.md + - name: Get application + href: ../../api/application-get.md + - name: Update application + href: ../../api/application-update.md + - name: Upsert application + href: ../../api/application-upsert.md + - name: Delete application + href: ../../api/application-delete.md + - name: Get delta + href: ../../api/application-delta.md + - name: List deleted applications + href: ../../api/directory-deleteditems-list.md + - name: List deleted applications owned by user + href: ../../api/directory-deleteditems-getuserownedobjects.md + - name: Get deleted application + href: ../../api/directory-deleteditems-get.md + - name: Permanently delete application + href: ../../api/directory-deleteditems-delete.md + - name: Restore deleted application + href: ../../api/directory-deleteditems-restore.md + - name: Certificates and secrets + items: + - name: Add password + href: ../../api/application-addpassword.md + - name: Remove password + href: ../../api/application-removepassword.md + - name: Add key + href: ../../api/application-addkey.md + - name: Remove key + href: ../../api/application-removekey.md + - name: Owners + items: + - name: List owners + href: ../../api/application-list-owners.md + - name: Add owner + href: ../../api/application-post-owners.md + - name: Remove owner + href: ../../api/application-delete-owners.md + - name: Verified publisher + items: + - name: Set verified publisher + href: ../../api/application-setverifiedpublisher.md + - name: Unset verified publisher + href: ../../api/application-unsetverifiedpublisher.md + - name: Application template + items: + - name: Application template + href: ../../resources/applicationtemplate.md + - name: List applicationTemplate + href: ../../api/applicationtemplate-list.md + - name: Get applicationTemplate + href: ../../api/applicationtemplate-get.md + - name: Instantiate applicationTemplate + href: ../../api/applicationtemplate-instantiate.md + - name: Directory extension + items: + - name: Directory extension + href: ../../resources/extensionproperty.md + - name: Create extensionProperties + href: ../../api/application-post-extensionproperty.md + - name: List extensionProperties + href: ../../api/application-list-extensionproperty.md + - name: Get extensionProperty + href: ../../api/extensionproperty-get.md + - name: Delete extensionProperty + href: ../../api/extensionproperty-delete.md + - name: Get available extensions + href: ../../api/directoryobject-getavailableextensionproperties.md + - name: Federated identity credential + items: + - name: Overview + href: ../../resources/federatedidentitycredentials-overview.md + - name: Federated identity credential + href: ../../resources/federatedidentitycredential.md + - name: List federatedIdentityCredentials + href: ../../api/application-list-federatedidentitycredentials.md + - name: Create federatedIdentityCredential + href: ../../api/application-post-federatedidentitycredentials.md + - name: Get federatedIdentityCredential + href: ../../api/federatedidentitycredential-get.md + - name: Update federatedIdentityCredential + href: ../../api/federatedidentitycredential-update.md + - name: Upsert federatedIdentityCredential + href: ../../api/federatedidentitycredential-upsert.md + - name: Delete federatedIdentityCredential + href: ../../api/federatedidentitycredential-delete.md + - name: Policies + items: + - name: Remote desktop security configuration + items: + - name: Remote desktop security configuration + href: ../../resources/remotedesktopsecurityconfiguration.md + - name: Create remoteDesktopSecurityConfiguration + href: ../../api/serviceprincipal-post-remotedesktopsecurityconfiguration.md + - name: Get remoteDesktopSecurityConfiguration + href: ../../api/remotedesktopsecurityconfiguration-get.md + - name: Update remoteDesktopSecurityConfiguration + href: ../../api/remotedesktopsecurityconfiguration-update.md + - name: Delete remoteDesktopSecurityConfiguration + href: ../../api/serviceprincipal-delete-remotedesktopsecurityconfiguration.md + - name: Token issuance policy + items: + - name: Token issuance policy + href: ../../resources/tokenissuancepolicy.md + - name: List tokenIssuancePolicy + href: ../../api/tokenissuancepolicy-list.md + - name: Create tokenIssuancePolicy + href: ../../api/tokenissuancepolicy-post-tokenissuancepolicy.md + - name: Get tokenIssuancePolicy + href: ../../api/tokenissuancepolicy-get.md + - name: Update tokenIssuancePolicy + href: ../../api/tokenissuancepolicy-update.md + - name: Delete tokenIssuancePolicy + href: ../../api/tokenissuancepolicy-delete.md + - name: List appliesTo + href: ../../api/tokenissuancepolicy-list-appliesto.md + - name: Token lifetime policy + items: + - name: Token lifetime policy + href: ../../resources/tokenlifetimepolicy.md + - name: List tokenLifetimePolicies + href: ../../api/tokenlifetimepolicy-list.md + - name: Create tokenLifetimePolicy + href: ../../api/tokenlifetimepolicy-post-tokenlifetimepolicies.md + - name: Get tokenLifetimePolicy + href: ../../api/tokenlifetimepolicy-get.md + - name: Update tokenLifetimePolicy + href: ../../api/tokenlifetimepolicy-update.md + - name: Delete tokenLifetimePolicy + href: ../../api/tokenlifetimepolicy-delete.md + - name: List appliesTo + href: ../../api/tokenlifetimepolicy-list-appliesto.md +- name: Service principal + items: + - name: Service principal + href: ../../resources/serviceprincipal.md + - name: List servicePrincipals + href: ../../api/serviceprincipal-list.md + - name: Create servicePrincipal + href: ../../api/serviceprincipal-post-serviceprincipals.md + - name: Get servicePrincipal + href: ../../api/serviceprincipal-get.md + - name: Update servicePrincipal + href: ../../api/serviceprincipal-update.md + - name: Upsert servicePrincipal + href: ../../api/serviceprincipal-upsert.md + - name: Delete servicePrincipal + href: ../../api/serviceprincipal-delete.md + - name: List deleted servicePrincipals + href: ../../api/directory-deleteditems-list.md + - name: Get deleted servicePrincipal + href: ../../api/directory-deleteditems-get.md + - name: Permanently delete servicePrincipal + href: ../../api/directory-deleteditems-delete.md + - name: Restore deleted servicePrincipal + href: ../../api/directory-deleteditems-restore.md + - name: List createdObjects + href: ../../api/serviceprincipal-list-createdobjects.md + - name: List ownedObjects + href: ../../api/serviceprincipal-list-ownedobjects.md + - name: Get delta + href: ../../api/serviceprincipal-delta.md + - name: Create remoteDesktopSecurityConfiguration + href: ../../api/serviceprincipal-post-remotedesktopsecurityconfiguration.md + - name: Get remoteDesktopSecurityConfiguration + href: ../../api/remotedesktopsecurityconfiguration-get.md + - name: Delete remoteDesktopSecurityConfiguration + href: ../../api/serviceprincipal-delete-remotedesktopsecurityconfiguration.md + - name: App role assignments + items: + - name: List appRoleAssignments + href: ../../api/serviceprincipal-list-approleassignments.md + - name: Add appRoleAssignment + href: ../../api/serviceprincipal-post-approleassignments.md + - name: Remove appRoleAssignment + href: ../../api/serviceprincipal-delete-approleassignments.md + - name: List appRoleAssignedTo + href: ../../api/serviceprincipal-list-approleassignedto.md + - name: Add appRoleAssignedTo + href: ../../api/serviceprincipal-post-approleassignedto.md + - name: Remove appRoleAssignedTo + href: ../../api/serviceprincipal-delete-approleassignedto.md + - name: Certificates and secrets + items: + - name: Add password + href: ../../api/serviceprincipal-addpassword.md + - name: Add tokenSigningCertificate + href: ../../api/serviceprincipal-addtokensigningcertificate.md + - name: Remove password + href: ../../api/serviceprincipal-removepassword.md + - name: Add key + href: ../../api/serviceprincipal-addkey.md + - name: Remove key + href: ../../api/serviceprincipal-removekey.md + - name: Delegated permission classifications + items: + - name: List delegated permission classifications + href: ../../api/serviceprincipal-list-delegatedpermissionclassifications.md + - name: Add delegated permission classification + href: ../../api/serviceprincipal-post-delegatedpermissionclassifications.md + - name: Remove delegated permission classification + href: ../../api/serviceprincipal-delete-delegatedpermissionclassifications.md + - name: Delegated permission grants + items: + - name: List oauth2PermissionGrants + href: ../../api/serviceprincipal-list-oauth2permissiongrants.md + - name: Membership + items: + - name: List memberOf + href: ../../api/serviceprincipal-list-memberof.md + - name: List transitive memberOf + href: ../../api/serviceprincipal-list-transitivememberof.md + - name: checkMemberGroups + href: ../../api/directoryobject-checkmembergroups.md + - name: checkMemberObjects + href: ../../api/directoryobject-checkmemberobjects.md + - name: getMemberGroups + href: ../../api/directoryobject-getmembergroups.md + - name: getMemberObjects + href: ../../api/directoryobject-getmemberobjects.md + - name: Owners + items: + - name: List owners + href: ../../api/serviceprincipal-list-owners.md + - name: Add owner + href: ../../api/serviceprincipal-post-owners.md + - name: Remove owner + href: ../../api/serviceprincipal-delete-owners.md + - name: Policies + items: + - name: Assign claimsMappingPolicy + href: ../../api/serviceprincipal-post-claimsmappingpolicies.md + - name: List claimsMappingPolicies + href: ../../api/serviceprincipal-list-claimsmappingpolicies.md + - name: Remove claimsMappingPolicy + href: ../../api/serviceprincipal-delete-claimsmappingpolicies.md + - name: Assign homeRealmDiscoveryPolicy + href: ../../api/serviceprincipal-post-homerealmdiscoverypolicies.md + - name: List homeRealmDiscoveryPolicies + href: ../../api/serviceprincipal-list-homerealmdiscoverypolicies.md + - name: Remove homeRealmDiscoveryPolicy + href: ../../api/serviceprincipal-delete-homerealmdiscoverypolicies.md + - name: Assign tokenIssuancePolicy + href: ../../api/application-post-tokenissuancepolicies.md + - name: List tokenIssuancePolicies + href: ../../api/application-list-tokenissuancepolicies.md + - name: Remove tokenIssuancePolicy + href: ../../api/application-delete-tokenissuancepolicies.md + - name: Assign tokenLifetimePolicy + href: ../../api/serviceprincipal-post-tokenlifetimepolicies.md + - name: List tokenLifetimePolicies + href: ../../api/serviceprincipal-list-tokenlifetimepolicies.md + - name: Remove tokenLifetimePolicy + href: ../../api/serviceprincipal-delete-tokenlifetimepolicies.md +- name: Synchronization + items: + - name: Overview + href: ../../resources/synchronization-overview.md + - name: Synchronization + items: + - name: Synchronization + href: ../../resources/synchronization-synchronization.md + - name: acquireAccessToken + href: ../../api/synchronization-synchronization-acquireaccesstoken.md + - name: Add secrets + href: ../../api/synchronization-serviceprincipal-put-synchronization.md + - name: Synchronization job + items: + - name: Synchronization job + href: ../../resources/synchronization-synchronizationjob.md + - name: List + href: ../../api/synchronization-synchronization-list-jobs.md + - name: Get synchronizationJob + href: ../../api/synchronization-synchronizationjob-get.md + - name: Create + href: ../../api/synchronization-synchronization-post-jobs.md + - name: Start + href: ../../api/synchronization-synchronizationjob-start.md + - name: Restart + href: ../../api/synchronization-synchronizationjob-restart.md + - name: Pause + href: ../../api/synchronization-synchronizationjob-pause.md + - name: Delete + href: ../../api/synchronization-synchronizationjob-delete.md + - name: Get synchronizationSchema + href: ../../api/synchronization-synchronizationschema-get.md + - name: Update synchronizationSchema + href: ../../api/synchronization-synchronizationschema-update.md + - name: Validate credentials + href: ../../api/synchronization-synchronizationjob-validatecredentials.md + - name: provisionOnDemand + href: ../../api/synchronization-synchronizationjob-provisionondemand.md + - name: Bulk upload + items: + - name: Bulk upload + href: ../../resources/synchronization-bulkupload.md + - name: Perform bulkUpload + href: ../../api/synchronization-synchronizationjob-post-bulkupload.md + - name: Synchronization schema + items: + - name: Synchronization schema + href: ../../resources/synchronization-synchronizationschema.md + - name: Get schema + href: ../../api/synchronization-synchronizationschema-get.md + - name: Update schema + href: ../../api/synchronization-synchronizationschema-update.md + - name: Delete schema + href: ../../api/synchronization-synchronizationschema-delete.md + - name: List filter operators + href: ../../api/synchronization-synchronizationschema-filteroperators.md + - name: List attribute mapping functions + href: ../../api/synchronization-synchronizationschema-functions.md + - name: Parse attribute mapping expression + href: ../../api/synchronization-synchronizationschema-parseexpression.md + - name: Synchronization template + items: + - name: Synchronization template + href: ../../resources/synchronization-synchronizationtemplate.md + - name: List + href: ../../api/synchronization-synchronization-list-templates.md + - name: Get + href: ../../api/synchronization-synchronizationtemplate-get.md + - name: Update + href: ../../api/synchronization-synchronizationtemplate-update.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/calendars/toc.yml | +items: +- name: Calendar + items: + - name: Calendar + href: ../../resources/calendar.md + - name: List calendars + href: ../../api/user-list-calendars.md + - name: Create calendar + href: ../../api/user-post-calendars.md + - name: Get calendar + href: ../../api/calendar-get.md + - name: Update + href: ../../api/calendar-update.md + - name: Delete + href: ../../api/calendar-delete.md + - name: List calendarView + href: ../../api/calendar-list-calendarview.md + - name: List events + href: ../../api/calendar-list-events.md + - name: Create event + href: ../../api/calendar-post-events.md + - name: getSchedule + href: ../../api/calendar-getschedule.md + - name: findMeetingTimes + href: ../../api/user-findmeetingtimes.md + - name: Create single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get calendar with single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Create multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get calendar with multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-get.md +- name: Event + items: + - name: Event + href: ../../resources/event.md + - name: List events + href: ../../api/user-list-events.md + - name: Create event + href: ../../api/user-post-events.md + - name: Get event + href: ../../api/event-get.md + - name: Update + href: ../../api/event-update.md + - name: Delete + href: ../../api/event-delete.md + - name: delta + href: ../../api/event-delta.md + - name: forward + href: ../../api/event-forward.md + - name: cancel + href: ../../api/event-cancel.md + - name: accept + href: ../../api/event-accept.md + - name: tentativelyAccept + href: ../../api/event-tentativelyaccept.md + - name: decline + href: ../../api/event-decline.md + - name: dismissReminder + href: ../../api/event-dismissreminder.md + - name: snoozeReminder + href: ../../api/event-snoozereminder.md + - name: List instances + href: ../../api/event-list-instances.md + - name: Attachments + items: + - name: List attachments + href: ../../api/event-list-attachments.md + - name: Add attachment + href: ../../api/event-post-attachments.md + - name: Open extensions + items: + - name: Create open extension + href: ../../api/opentypeextension-post-opentypeextension.md + - name: Get open extension + href: ../../api/opentypeextension-get.md + - name: Schema extensions + items: + - name: Add schema extension values + href: ../../graph/extensibility-schema-groups + - name: Extended properties + items: + - name: Create single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get event with single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Create multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get event with multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-get.md +- name: Event message + items: + - name: Event message + href: ../../resources/eventmessage.md + - name: Get eventMessage + href: ../../api/eventmessage-get.md + - name: Update + href: ../../api/eventmessage-update.md + - name: Delete + href: ../../api/message-delete.md + - name: copy + href: ../../api/message-copy.md + - name: createForward + href: ../../api/message-createforward.md + - name: createReply + href: ../../api/message-createreply.md + - name: createReplyAll + href: ../../api/message-createreplyall.md + - name: forward + href: ../../api/message-forward.md + - name: move + href: ../../api/message-move.md + - name: reply + href: ../../api/message-reply.md + - name: replyAll + href: ../../api/message-replyall.md + - name: send + href: ../../api/message-send.md + - name: Attachments + items: + - name: List attachments + href: ../../api/eventmessage-list-attachments.md + - name: Add attachment + href: ../../api/eventmessage-post-attachments.md + - name: Open extensions + items: + - name: Create open extension + href: ../../api/opentypeextension-post-opentypeextension.md + - name: Get open extension + href: ../../api/opentypeextension-get.md + - name: Extended properties + items: + - name: Create single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get eventMessage with single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Create multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get eventMessage with multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-get.md +- name: Attachment + items: + - name: Attachment + href: ../../resources/attachment.md + - name: Get attachment + href: ../../api/attachment-get.md + - name: Add attachment to a user event + href: ../../api/event-post-attachments.md + - name: Add attachment to a message + href: ../../api/message-post-attachments.md + - name: Create session to attach large file + href: ../../api/attachment-createuploadsession.md + - name: Add attachment to a post + href: ../../api/post-post-attachments.md + - name: List attachments of a user event + href: ../../api/event-list-attachments.md + - name: List attachments of a message + href: ../../api/message-list-attachments.md + - name: List attachments of a post + href: ../../api/post-list-attachments.md + - name: Delete + href: ../../api/attachment-delete.md +- name: Calendar group + items: + - name: Calendar group + href: ../../resources/calendargroup.md + - name: List calendar groups + href: ../../api/user-list-calendargroups.md + - name: Create calendar group + href: ../../api/user-post-calendargroups.md + - name: Get calendar group + href: ../../api/calendargroup-get.md + - name: Update + href: ../../api/calendargroup-update.md + - name: Delete + href: ../../api/calendargroup-delete.md + - name: List calendars + href: ../../api/calendargroup-list-calendars.md + - name: Create Calendar + href: ../../api/calendargroup-post-calendars.md +- name: Calendar permission + items: + - name: Calendar permission + href: ../../resources/calendarpermission.md + - name: List + href: ../../api/calendar-list-calendarpermissions.md + - name: Create + href: ../../api/calendar-post-calendarpermissions.md + - name: Get calendarPermission + href: ../../api/calendarpermission-get.md + - name: Update + href: ../../api/calendarpermission-update.md + - name: Delete + href: ../../api/calendarpermission-delete.md +- name: Outlook category + items: + - name: Outlook category + href: ../../resources/outlookcategory.md + - name: List categories + href: ../../api/outlookuser-list-mastercategories.md + - name: Get category + href: ../../api/outlookcategory-get.md + - name: Create + href: ../../api/outlookuser-post-mastercategories.md + - name: Update + href: ../../api/outlookcategory-update.md + - name: Delete + href: ../../api/outlookcategory-delete.md +- name: Extended properties + items: + - name: Overview + href: ../../resources/extended-properties-overview.md + - name: Single value legacy extended property + items: + - name: Single value legacy extended property + href: ../../resources/singlevaluelegacyextendedproperty.md + - name: Post + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Multivalue legacy extended property + items: + - name: Multivalue legacy extended property + href: ../../resources/multivaluelegacyextendedproperty.md + - name: Post + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get + href: ../../api/multivaluelegacyextendedproperty-get.md +- name: Places + items: + - name: Place + items: + - name: Place + href: ../../resources/place.md + - name: List places + href: ../../api/place-list.md + - name: Get place + href: ../../api/place-get.md + - name: Update place + href: ../../api/place-update.md + - name: Room + items: + - name: Room + href: ../../resources/room.md + - name: List places + href: ../../api/place-list.md + - name: Get place + href: ../../api/place-get.md + - name: Room list + items: + - name: Room list + href: ../../resources/roomlist.md + - name: List places + href: ../../api/place-list.md + - name: Get place + href: ../../api/place-get.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/change-notifications/toc.yml | +items: +- name: Overview + href: ../../resources/change-notifications-api-overview.md +- name: Subscription + items: + - name: Subscription + href: ../../resources/subscription.md + - name: List subscriptions + href: ../../api/subscription-list.md + - name: Create subscription + href: ../../api/subscription-post-subscriptions.md + - name: Get subscription + href: ../../api/subscription-get.md + - name: Update subscription + href: ../../api/subscription-update.md + - name: Delete subscription + href: ../../api/subscription-delete.md + - name: Reauthorize + href: ../../api/subscription-reauthorize.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/compliance/toc.yml | +items: +- name: Overview + href: ../../resources/complianceapioverview.md +- name: Subject rights request + items: + - name: Overview + href: ../../resources/subjectrightsrequest-subjectrightsrequestapioverview.md + - name: Subject rights request + href: ../../resources/subjectrightsrequest.md + - name: List subjectRightsRequests + href: ../../api/subjectRightsRequest-list.md + - name: Create subjectRightsRequest + href: ../../api/subjectRightsRequest-post.md + - name: Get subjectRightsRequest + href: ../../api/subjectRightsRequest-get.md + - name: Update subjectRightsRequest + href: ../../api/subjectRightsRequest-update.md + - name: getFinalAttachment + href: ../../api/subjectRightsRequest-getfinalattachment.md + - name: getFinalReport + href: ../../api/subjectRightsRequest-getfinalreport.md + - name: List notes + href: ../../api/subjectRightsRequest-list-notes.md + - name: Create authoredNote + href: ../../api/subjectRightsRequest-post-notes.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/cross-device-experiences/toc.yml | +items: +- name: Overview + href: ../../resources/project-rome-overview.md +- name: Activity feed + items: + - name: Overview + href: ../../resources/activity-feed-api-overview.md + - name: User activity + items: + - name: User activity + href: ../../resources/projectrome-activity.md + - name: Create or replace activity + href: ../../api/projectrome-put-activity.md + - name: Delete an activity + href: ../../api/projectrome-delete-activity.md + - name: Get activities + href: ../../api/projectrome-get-activities.md + - name: Get recent activities + href: ../../api/projectrome-get-recent-activities.md + - name: Activity history item + items: + - name: Activity history item + href: ../../resources/projectrome-historyitem.md + - name: Create or replace activityHistoryItem + href: ../../api/projectrome-put-historyitem.md + - name: Delete a activityHistoryItem + href: ../../api/projectrome-delete-historyitem.md +- name: Roaming data + items: + - name: Cloud clipboard + items: + - name: Cloud clipboard + href: ../../resources/cloudclipboardroot.md + - name: List items + href: ../../api/cloudclipboardroot-list-items.md + - name: Cloud clipboard item + items: + - name: Cloud clipboard item + href: ../../resources/cloudclipboarditem.md + - name: List cloudClipboardItems + href: ../../api/cloudclipboardroot-list-items.md + - name: Get cloudClipboardItem + href: ../../api/cloudclipboarditem-get.md + - name: Windows settings + items: + - name: Overview + href: ../../resources/windows-setting-api-overview.md + - name: Windows setting + items: + - name: Windows setting + href: ../../resources/windowssetting.md + - name: List Windows settings + href: ../../api/usersettings-list-windows.md + - name: Get windowsSetting + href: ../../api/windowssetting-get.md + - name: List instances + href: ../../api/windowssetting-list-instances.md + - name: Windows setting instance + items: + - name: Windows setting instance + href: ../../resources/windowssettinginstance.md + - name: List instances + href: ../../api/windowssetting-list-instances.md + - name: Get windowsSettingInstance + href: ../../api/windowssettinginstance-get.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/customer-booking/toc.yml | +items: +- name: Overview + href: ../../resources/booking-api-overview.md +- name: Booking appointment + items: + - name: Booking appointment + href: ../../resources/bookingappointment.md + - name: List appointments + href: ../../api/bookingbusiness-list-appointments.md + - name: Create bookingAppointment + href: ../../api/bookingbusiness-post-appointments.md + - name: Get bookingAppointment + href: ../../api/bookingappointment-get.md + - name: Update + href: ../../api/bookingappointment-update.md + - name: Delete + href: ../../api/bookingappointment-delete.md + - name: Cancel + href: ../../api/bookingappointment-cancel.md +- name: Booking business + items: + - name: Booking business + href: ../../resources/bookingbusiness.md + - name: List bookingBusinesses + href: ../../api/bookingbusiness-list.md + - name: Create bookingBusiness + href: ../../api/bookingbusiness-post-bookingbusinesses.md + - name: Get bookingBusiness + href: ../../api/bookingbusiness-get.md + - name: Update + href: ../../api/bookingbusiness-update.md + - name: Delete + href: ../../api/bookingbusiness-delete.md + - name: Create bookingAppointment + href: ../../api/bookingbusiness-post-appointments.md + - name: List appointments + href: ../../api/bookingbusiness-list-appointments.md + - name: Create bookingCustomer + href: ../../api/bookingbusiness-post-customers.md + - name: List customers + href: ../../api/bookingbusiness-list-customers.md + - name: Create bookingService + href: ../../api/bookingbusiness-post-services.md + - name: List services + href: ../../api/bookingbusiness-list-services.md + - name: Create bookingStaffMember + href: ../../api/bookingbusiness-post-staffmembers.md + - name: List staffMembers + href: ../../api/bookingbusiness-list-staffmembers.md + - name: List customQuestions + href: ../../api/bookingbusiness-list-customquestions.md + - name: Create bookingCustomQuestion + href: ../../api/bookingbusiness-post-customquestions.md + - name: List calendarView + href: ../../api/bookingbusiness-list-calendarview.md + - name: Publish + href: ../../api/bookingbusiness-publish.md + - name: Unpublish + href: ../../api/bookingbusiness-unpublish.md +- name: Booking currency + items: + - name: Booking currency + href: ../../resources/bookingcurrency.md + - name: List bookingCurrencies + href: ../../api/bookingcurrency-list.md + - name: Get bookingCurrency + href: ../../api/bookingcurrency-get.md +- name: Booking custom question + items: + - name: Booking custom question + href: ../../resources/bookingcustomquestion.md + - name: List bookingCustomQuestions + href: ../../api/bookingbusiness-list-customquestions.md + - name: Create bookingCustomQuestion + href: ../../api/bookingbusiness-post-customquestions.md + - name: Get bookingCustomQuestion + href: ../../api/bookingcustomquestion-get.md + - name: Update bookingCustomQuestion + href: ../../api/bookingcustomquestion-update.md + - name: Delete bookingCustomQuestion + href: ../../api/bookingcustomquestion-delete.md +- name: Booking customer + items: + - name: Booking customer + href: ../../resources/bookingcustomer.md + - name: List customers + href: ../../api/bookingbusiness-list-customers.md + - name: Create bookingCustomer + href: ../../api/bookingbusiness-post-customers.md + - name: Get bookingCustomer + href: ../../api/bookingcustomer-get.md + - name: Update + href: ../../api/bookingcustomer-update.md + - name: Delete + href: ../../api/bookingcustomer-delete.md +- name: Booking service + items: + - name: Booking service + href: ../../resources/bookingservice.md + - name: List services + href: ../../api/bookingbusiness-list-services.md + - name: Create bookingService + href: ../../api/bookingbusiness-post-services.md + - name: Get bookingService + href: ../../api/bookingservice-get.md + - name: Update + href: ../../api/bookingservice-update.md + - name: Delete + href: ../../api/bookingservice-delete.md +- name: Booking staff member + items: + - name: Booking staff member + href: ../../resources/bookingstaffmember.md + - name: List staff members + href: ../../api/bookingbusiness-list-staffmembers.md + - name: Create bookingStaff + href: ../../api/bookingbusiness-post-staffmembers.md + - name: Get bookingStaffMember + href: ../../api/bookingstaffmember-get.md + - name: Update + href: ../../api/bookingstaffmember-update.md + - name: Delete + href: ../../api/bookingstaffmember-delete.md +- name: Complex types + items: + - name: Availability item + href: ../../resources/availabilityitem.md + - name: Booking customer information + href: ../../resources/bookingcustomerinformation.md + - name: Booking customer information base + href: ../../resources/bookingcustomerinformationbase.md + - name: Booking question answer + href: ../../resources/bookingquestionanswer.md + - name: Booking question assignment + href: ../../resources/bookingquestionassignment.md + - name: Booking reminder + href: ../../resources/bookingreminder.md + - name: Booking scheduling policy + href: ../../resources/bookingschedulingpolicy.md + - name: Booking work hours + href: ../../resources/bookingworkhours.md + - name: Booking work time slot + href: ../../resources/bookingworktimeslot.md + - name: Date time time zone + href: ../../resources/datetimetimezone.md + - name: Location + href: ../../resources/location.md + - name: Outlook geo coordinates + href: ../../resources/outlookgeocoordinates.md + - name: Phone + href: ../../resources/phone.md + - name: Physical address + href: ../../resources/physicaladdress.md + - name: Staff availability item + href: ../../resources/staffavailabilityitem.md + - name: Time slot + href: ../../resources/timeslot.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/device-and-app-management/toc.yml | +items: +- name: Browser management + displayName: Edge, Internet Explorer, IE mode, site list + items: + - name: Overview + href: ../../resources/browser-edge-api-overview.md + - name: Browser shared cookie + items: + - name: Browser shared cookie + href: ../../resources/browsersharedcookie.md + - name: List browserSharedCookies + href: ../../api/browsersitelist-list-sharedcookies.md + - name: Create browserSharedCookie + href: ../../api/browsersitelist-post-sharedcookies.md + - name: Get browserSharedCookie + href: ../../api/browsersharedcookie-get.md + - name: Update browserSharedCookie + href: ../../api/browsersharedcookie-update.md + - name: Delete browserSharedCookie + href: ../../api/browsersitelist-delete-sharedcookies.md + - name: Browser site + items: + - name: Browser site + href: ../../resources/browsersite.md + - name: List browserSites + href: ../../api/browsersitelist-list-sites.md + - name: Create browserSite + href: ../../api/browsersitelist-post-sites.md + - name: Get browserSite + href: ../../api/browsersite-get.md + - name: Update browserSite + href: ../../api/browsersite-update.md + - name: Delete browserSite + href: ../../api/browsersitelist-delete-sites.md + - name: Browser site list + items: + - name: Browser site list + href: ../../resources/browsersitelist.md + - name: List browserSiteLists + href: ../../api/internetexplorermode-list-sitelists.md + - name: Create browserSiteList + href: ../../api/internetexplorermode-post-sitelists.md + - name: Get browserSiteList + href: ../../api/browsersitelist-get.md + - name: Update browserSiteList + href: ../../api/browsersitelist-update.md + - name: Delete browserSiteList + href: ../../api/internetexplorermode-delete-sitelists.md + - name: Publish a browserSiteList + href: ../../api/browsersitelist-publish.md + - name: Complex types + items: + - name: Browser shared cookie history + href: ../../resources/browsersharedcookiehistory.md + - name: Browser site history + href: ../../resources/browsersitehistory.md + - name: Date time time zone + href: ../../resources/datetimetimezone.md + - name: Identity + href: ../../resources/identity.md + - name: Identity set + href: ../../resources/identityset.md +- name: Cloud PC + items: + - name: Overview + href: ../../resources/cloudpc-api-overview.md + - name: Cloud PC + items: + - name: Cloud PC + href: ../../resources/cloudpc.md + - name: List cloudPCs + href: ../../api/virtualendpoint-list-cloudpcs.md + - name: Get cloudPC + href: ../../api/cloudpc-get.md + - name: End grace period + href: ../../api/cloudpc-endgraceperiod.md + - name: Reboot + href: ../../api/cloudpc-reboot.md + - name: Rename + href: ../../api/cloudpc-rename.md + - name: Troubleshoot + href: ../../api/cloudpc-troubleshoot.md + - name: Restore + href: ../../api/cloudpc-restore.md + - name: Cloud PC audit event + items: + - name: Cloud PC audit event + href: ../../resources/cloudpcauditevent.md + - name: List auditEvents + href: ../../api/virtualendpoint-list-auditevents.md + - name: Get cloudPcAuditEvent + href: ../../api/cloudpcauditevent-get.md + - name: getAuditActivityTypes function + href: ../../api/cloudpcauditevent-getauditactivitytypes.md + - name: Cloud PC Azure network connection + items: + - name: Cloud PC Azure network connection + href: ../../resources/cloudpconpremisesconnection.md + - name: List onPremisesConnections + href: ../../api/virtualendpoint-list-onpremisesconnections.md + - name: Get cloudPcOnPremisesConnection + href: ../../api/cloudpconpremisesconnection-get.md + - name: Create cloudPcOnPremisesConnection + href: ../../api/virtualendpoint-post-onpremisesconnections.md + - name: Update cloudPcOnPremisesConnection + href: ../../api/cloudpconpremisesconnection-update.md + - name: Delete cloudPcOnPremisesConnection + href: ../../api/cloudpconpremisesconnection-delete.md + - name: RunHealthChecks of a cloudPcOnPremisesConnection + href: ../../api/cloudpconpremisesconnection-runhealthcheck.md + - name: Cloud PC device image + items: + - name: Cloud PC device image + href: ../../resources/cloudpcdeviceimage.md + - name: List deviceImages + href: ../../api/virtualendpoint-list-deviceimages.md + - name: Get cloudPcDeviceImage + href: ../../api/cloudpcdeviceimage-get.md + - name: Create cloudPcDeviceImage + href: ../../api/virtualendpoint-post-deviceimages.md + - name: Delete cloudPcDeviceImage + href: ../../api/cloudpcdeviceimage-delete.md + - name: getSourceImages + href: ../../api/cloudpcdeviceimage-getsourceimages.md + - name: Cloud PC gallery image + items: + - name: Cloud PC gallery image + href: ../../resources/cloudpcgalleryimage.md + - name: List galleryImages + href: ../../api/virtualendpoint-list-galleryimages.md + - name: Get cloudPcGalleryImage + href: ../../api/cloudpcgalleryimage-get.md + - name: Cloud PC provisioning policy + items: + - name: Cloud PC provisioning policy + href: ../../resources/cloudpcprovisioningpolicy.md + - name: List provisioningPolicies + href: ../../api/virtualendpoint-list-provisioningpolicies.md + - name: Create cloudPcProvisioningPolicy + href: ../../api/virtualendpoint-post-provisioningpolicies.md + - name: Get cloudPcProvisioningPolicy + href: ../../api/cloudpcprovisioningpolicy-get.md + - name: Update cloudPcProvisioningPolicy + href: ../../api/cloudpcprovisioningpolicy-update.md + - name: Delete cloudPcProvisioningPolicy + href: ../../api/cloudpcprovisioningpolicy-delete.md + - name: Assign + href: ../../api/cloudpcprovisioningpolicy-assign.md + - name: Cloud PC user setting + items: + - name: Cloud PC user setting + href: ../../resources/cloudpcusersetting.md + - name: List userSettings + href: ../../api/virtualendpoint-list-usersettings.md + - name: Create cloudPcUserSetting + href: ../../api/virtualendpoint-post-usersettings.md + - name: Get cloudPcUserSetting + href: ../../api/cloudpcusersetting-get.md + - name: Update cloudPcUserSetting + href: ../../api/cloudpcusersetting-update.md + - name: Delete cloudPcUserSetting + href: ../../api/cloudpcusersetting-delete.md + - name: Assign + href: ../../api/cloudpcusersetting-assign.md +- name: Cloud printing + displayName: Universal Print + items: + - name: Print + items: + - name: Print + href: ../../resources/print.md + - name: List connectors + href: ../../api/print-list-connectors.md + - name: List printers + href: ../../api/print-list-printers.md + - name: List shares + href: ../../api/print-list-shares.md + - name: List services + href: ../../api/print-list-services.md + - name: Create printerShare + href: ../../api/print-post-shares.md + - name: Create printer + href: ../../api/printer-create.md + - name: Update settings + href: ../../api/print-update-settings.md + - name: List taskDefinitions + href: ../../api/print-list-taskdefinitions.md + - name: Create taskDefinition + href: ../../api/print-post-taskdefinitions.md + - name: Print connector + items: + - name: Print connector + href: ../../resources/printconnector.md + - name: List connectors + href: ../../api/print-list-connectors.md + - name: Get connector + href: ../../api/printconnector-get.md + - name: Update connector + href: ../../api/printconnector-update.md + - name: Delete connector + href: ../../api/printconnector-delete.md + - name: Print document + items: + - name: Print document + href: ../../resources/printdocument.md + - name: Create upload session + href: ../../api/printdocument-createuploadsession.md + - name: Download binary file + href: ../../api/printdocument-get-file.md + - name: Print job + items: + - name: Print job + href: ../../resources/printjob.md + - name: Get + href: ../../api/printjob-get.md + - name: Create + href: ../../api/printer-post-jobs.md + - name: Update + href: ../../api/printjob-update.md + - name: Start + href: ../../api/printjob-start.md + - name: Cancel + href: ../../api/printjob-cancel.md + - name: Abort + href: ../../api/printjob-abort.md + - name: Redirect (to another printer) + href: ../../api/printjob-redirect.md + - name: Print operation + items: + - name: Print operation + href: ../../resources/printoperation.md + - name: Get operation + href: ../../api/printoperation-get.md + - name: Print service + items: + - name: Print service + href: ../../resources/printservice.md + - name: List services + href: ../../api/print-list-services.md + - name: Get service + href: ../../api/printservice-get.md + - name: List endpoints + href: ../../api/printservice-list-endpoints.md + - name: Print service endpoint + items: + - name: Print service endpoint + href: ../../resources/printserviceendpoint.md + - name: Get endpoint + href: ../../api/printserviceendpoint-get.md + - name: Print task definition + items: + - name: Print task definition + href: ../../resources/printtaskdefinition.md + - name: List + href: ../../api/print-list-taskdefinitions.md + - name: Create + href: ../../api/print-post-taskdefinitions.md + - name: Update + href: ../../api/print-update-taskdefinition.md + - name: Delete + href: ../../api/print-delete-taskdefinition.md + - name: List tasks + href: ../../api/printtaskdefinition-list-tasks.md + - name: Get task + href: ../../api/printtask-get.md + - name: Update task + href: ../../api/printtaskdefinition-update-task.md + - name: Print task trigger + items: + - name: Print task trigger + href: ../../resources/printtasktrigger.md + - name: List + href: ../../api/printer-list-tasktriggers.md + - name: Get + href: ../../api/printtasktrigger-get.md + - name: Printer + items: + - name: Printer + href: ../../resources/printer.md + - name: Create + href: ../../api/printer-create.md + - name: Get + href: ../../api/printer-get.md + - name: Update + href: ../../api/printer-update.md + - name: Delete + href: ../../api/printer-delete.md + - name: restoreFactoryDefaults + href: ../../api/printer-restorefactorydefaults.md + - name: List jobs + href: ../../api/printer-list-jobs.md + - name: Create job + href: ../../api/printer-post-jobs.md + - name: List connectors + href: ../../api/printer-list-connectors.md + - name: List shares + href: ../../api/printer-list-shares.md + - name: List taskTriggers + href: ../../api/printer-list-tasktriggers.md + - name: Create taskTrigger + href: ../../api/printer-post-tasktriggers.md + - name: Delete taskTrigger + href: ../../api/printer-delete-tasktrigger.md + - name: Printer create operation + items: + - name: Printer create operation + href: ../../resources/printercreateoperation.md + - name: Get operation + href: ../../api/printoperation-get.md + - name: Printer share + items: + - name: Printer share + href: ../../resources/printershare.md + - name: List + href: ../../api/print-list-shares.md + - name: Get + href: ../../api/printershare-get.md + - name: Update + href: ../../api/printershare-update.md + - name: Delete + href: ../../api/printershare-delete.md + - name: List jobs + href: ../../api/printershare-list-jobs.md + - name: Create job + href: ../../api/printershare-post-jobs.md + - name: List allowedUsers + href: ../../api/printershare-list-allowedusers.md + - name: Add allowedUser + href: ../../api/printershare-post-allowedusers.md + - name: Remove allowedUser + href: ../../api/printershare-delete-alloweduser.md + - name: List allowedGroups + href: ../../api/printershare-list-allowedgroups.md + - name: Add allowedGroup + href: ../../api/printershare-post-allowedgroups.md + - name: Remove allowedGroup + href: ../../api/printershare-delete-allowedgroup.md + - name: Reports + items: + - name: Print usage by printer + items: + - name: Print usage by printer + href: ../../resources/printusagebyprinter.md + - name: List (daily) + href: ../../api/reportroot-list-dailyprintusagebyprinter.md + - name: List (monthly) + href: ../../api/reportroot-list-monthlyprintusagebyprinter.md + - name: Get + href: ../../api/printUsageByPrinter-get.md + - name: Print usage by user + items: + - name: Print usage by user + href: ../../resources/printusagebyuser.md + - name: List (daily) + href: ../../api/reportroot-list-dailyprintusagebyuser.md + - name: List (monthly) + href: ../../api/reportroot-list-monthlyprintusagebyuser.md + - name: Get + href: ../../api/printusagebyuser-get.md + - name: Archived print jobs + items: + - name: List a user's archived print jobs + href: ../../api/reports-getuserarchivedprintjobs.md + - name: List a groups's archived print jobs + href: ../../api/reports-getgrouparchivedprintjobs.md + - name: List a printer's archived print jobs + href: ../../api/reports-getprinterarchivedprintjobs.md + - name: Complex types + items: + - name: App identity + href: ../../resources/appidentity.md + - name: Archived print job + href: ../../resources/archivedprintjob.md + - name: Identity + href: ../../resources/identity.md + - name: Integer range + href: ../../resources/integerrange.md + - name: Print certificate signing request + href: ../../resources/printcertificatesigningrequest.md + - name: Print document upload properties + href: ../../resources/printdocumentuploadproperties.md + - name: Print job configuration + href: ../../resources/printjobconfiguration.md + - name: Print job status + href: ../../resources/printjobstatus.md + - name: Print margin + href: ../../resources/printmargin.md + - name: Print operation status + href: ../../resources/printoperationstatus.md + - name: Print settings + href: ../../resources/printsettings.md + - name: Print task status + href: ../../resources/printtaskstatus.md + - name: Printer capabilities + href: ../../resources/printercapabilities.md + - name: Printer defaults + href: ../../resources/printerdefaults.md + - name: Printer location + href: ../../resources/printerlocation.md + - name: Printer share viewpoint + href: ../../resources/printershareviewpoint.md + - name: Printer status + href: ../../resources/printerstatus.md + - name: Upload session + href: ../../resources/uploadsession.md + - name: User identity + href: ../../resources/useridentity.md +- name: Corporate management + displayName: Intune + items: + - name: Overview + href: ../../resources/intune-graph-overview.md + - name: App management + items: + - name: Overview + href: ../../resources/intune-app-conceptual.md + - name: Android LOB app + items: + - name: Android LOB app + href: ../../resources/intune-apps-androidlobapp.md + - name: List androidLobApps + href: ../../api/intune-apps-androidlobapp-list.md + - name: Get androidLobApp + href: ../../api/intune-apps-androidlobapp-get.md + - name: Create androidLobApp + href: ../../api/intune-apps-androidlobapp-create.md + - name: Delete androidLobApp + href: ../../api/intune-apps-androidlobapp-delete.md + - name: Update androidLobApp + href: ../../api/intune-apps-androidlobapp-update.md + - name: Android store app + items: + - name: Android store app + href: ../../resources/intune-apps-androidstoreapp.md + - name: List androidStoreApps + href: ../../api/intune-apps-androidstoreapp-list.md + - name: Get androidStoreApp + href: ../../api/intune-apps-androidstoreapp-get.md + - name: Create androidStoreApp + href: ../../api/intune-apps-androidstoreapp-create.md + - name: Delete androidStoreApp + href: ../../api/intune-apps-androidstoreapp-delete.md + - name: Update androidStoreApp + href: ../../api/intune-apps-androidstoreapp-update.md + - name: Device install state + items: + - name: Device install state + href: ../../resources/intune-books-deviceinstallstate.md + - name: List deviceInstallStates + href: ../../api/intune-books-deviceinstallstate-list.md + - name: Get deviceInstallState + href: ../../api/intune-books-deviceinstallstate-get.md + - name: Create deviceInstallState + href: ../../api/intune-books-deviceinstallstate-create.md + - name: Delete deviceInstallState + href: ../../api/intune-books-deviceinstallstate-delete.md + - name: Update deviceInstallState + href: ../../api/intune-books-deviceinstallstate-update.md + - name: eBook install summary + items: + - name: eBook install summary + href: ../../resources/intune-books-ebookinstallsummary.md + - name: Get eBookInstallSummary + href: ../../api/intune-books-ebookinstallsummary-get.md + - name: Update eBookInstallSummary + href: ../../api/intune-books-ebookinstallsummary-update.md + - name: Enterprise code signing certificate + items: + - name: Enterprise code signing certificate + href: ../../resources/intune-apps-enterprisecodesigningcertificate.md + - name: List enterpriseCodeSigningCertificates + href: ../../api/intune-apps-enterprisecodesigningcertificate-list.md + - name: Get enterpriseCodeSigningCertificate + href: ../../api/intune-apps-enterprisecodesigningcertificate-get.md + - name: Create enterpriseCodeSigningCertificate + href: ../../api/intune-apps-enterprisecodesigningcertificate-create.md + - name: Delete enterpriseCodeSigningCertificate + href: ../../api/intune-apps-enterprisecodesigningcertificate-delete.md + - name: Update enterpriseCodeSigningCertificate + href: ../../api/intune-apps-enterprisecodesigningcertificate-update.md + - name: iOS iPadOS web clip + items: + - name: iOS iPadOS web clip + href: ../../resources/intune-apps-iosipadoswebclip.md + - name: List iosiPadOSWebClips + href: ../../api/intune-apps-iosipadoswebclip-list.md + - name: Get iosiPadOSWebClip + href: ../../api/intune-apps-iosipadoswebclip-get.md + - name: Create iosiPadOSWebClip + href: ../../api/intune-apps-iosipadoswebclip-create.md + - name: Delete iosiPadOSWebClip + href: ../../api/intune-apps-iosipadoswebclip-delete.md + - name: Update iosiPadOSWebClip + href: ../../api/intune-apps-iosipadoswebclip-update.md + - name: iOS LOB app + items: + - name: iOS LOB app + href: ../../resources/intune-apps-ioslobapp.md + - name: List iosLobApps + href: ../../api/intune-apps-ioslobapp-list.md + - name: Get iosLobApp + href: ../../api/intune-apps-ioslobapp-get.md + - name: Create iosLobApp + href: ../../api/intune-apps-ioslobapp-create.md + - name: Delete iosLobApp + href: ../../api/intune-apps-ioslobapp-delete.md + - name: Update iosLobApp + href: ../../api/intune-apps-ioslobapp-update.md + - name: iOS LOB app provisioning configuration assignment + items: + - name: iOS LOB app provisioning configuration assignment + href: ../../resources/intune-apps-ioslobappprovisioningconfigurationassignment.md + - name: List iosLobAppProvisioningConfigurationAssignments + href: ../../api/intune-apps-ioslobappprovisioningconfigurationassignment-list.md + - name: Get iosLobAppProvisioningConfigurationAssignment + href: ../../api/intune-apps-ioslobappprovisioningconfigurationassignment-get.md + - name: Create iosLobAppProvisioningConfigurationAssignment + href: ../../api/intune-apps-ioslobappprovisioningconfigurationassignment-create.md + - name: Delete iosLobAppProvisioningConfigurationAssignment + href: ../../api/intune-apps-ioslobappprovisioningconfigurationassignment-delete.md + - name: Update iosLobAppProvisioningConfigurationAssignment + href: ../../api/intune-apps-ioslobappprovisioningconfigurationassignment-update.md + - name: iOS mobile app configuration + items: + - name: iOS mobile app configuration + href: ../../resources/intune-apps-iosmobileappconfiguration.md + - name: List iosMobileAppConfigurations + href: ../../api/intune-apps-iosmobileappconfiguration-list.md + - name: Get iosMobileAppConfiguration + href: ../../api/intune-apps-iosmobileappconfiguration-get.md + - name: Create iosMobileAppConfiguration + href: ../../api/intune-apps-iosmobileappconfiguration-create.md + - name: Delete iosMobileAppConfiguration + href: ../../api/intune-apps-iosmobileappconfiguration-delete.md + - name: Update iosMobileAppConfiguration + href: ../../api/intune-apps-iosmobileappconfiguration-update.md + - name: iOS store app + items: + - name: iOS store app + href: ../../resources/intune-apps-iosstoreapp.md + - name: List iosStoreApps + href: ../../api/intune-apps-iosstoreapp-list.md + - name: Get iosStoreApp + href: ../../api/intune-apps-iosstoreapp-get.md + - name: Create iosStoreApp + href: ../../api/intune-apps-iosstoreapp-create.md + - name: Delete iosStoreApp + href: ../../api/intune-apps-iosstoreapp-delete.md + - name: Update iosStoreApp + href: ../../api/intune-apps-iosstoreapp-update.md + - name: iOS VPP app + items: + - name: iOS VPP app + href: ../../resources/intune-apps-iosvppapp.md + - name: List iosVppApps + href: ../../api/intune-apps-iosvppapp-list.md + - name: Get iosVppApp + href: ../../api/intune-apps-iosvppapp-get.md + - name: Create iosVppApp + href: ../../api/intune-apps-iosvppapp-create.md + - name: Delete iosVppApp + href: ../../api/intune-apps-iosvppapp-delete.md + - name: Update iosVppApp + href: ../../api/intune-apps-iosvppapp-update.md + - name: iOS VPP eBook + items: + - name: iOS VPP eBook + href: ../../resources/intune-books-iosvppebook.md + - name: List iosVppEBooks + href: ../../api/intune-books-iosvppebook-list.md + - name: Get iosVppEBook + href: ../../api/intune-books-iosvppebook-get.md + - name: Create iosVppEBook + href: ../../api/intune-books-iosvppebook-create.md + - name: Delete iosVppEBook + href: ../../api/intune-books-iosvppebook-delete.md + - name: Update iosVppEBook + href: ../../api/intune-books-iosvppebook-update.md + - name: iOS VPP eBook assignment + items: + - name: iOS VPP eBook assignment + href: ../../resources/intune-books-iosvppebookassignment.md + - name: List iosVppEBookAssignments + href: ../../api/intune-books-iosvppebookassignment-list.md + - name: Get iosVppEBookAssignment + href: ../../api/intune-books-iosvppebookassignment-get.md + - name: Create iosVppEBookAssignment + href: ../../api/intune-books-iosvppebookassignment-create.md + - name: Delete iosVppEBookAssignment + href: ../../api/intune-books-iosvppebookassignment-delete.md + - name: Update iosVppEBookAssignment + href: ../../api/intune-books-iosvppebookassignment-update.md + - name: macOS LOB app + items: + - name: macOS LOB app + href: ../../resources/intune-apps-macoslobapp.md + - name: List macOSLobApps + href: ../../api/intune-apps-macoslobapp-list.md + - name: Get macOSLobApp + href: ../../api/intune-apps-macoslobapp-get.md + - name: Create macOSLobApp + href: ../../api/intune-apps-macoslobapp-create.md + - name: Delete macOSLobApp + href: ../../api/intune-apps-macoslobapp-delete.md + - name: Update macOSLobApp + href: ../../api/intune-apps-macoslobapp-update.md + - name: macOS Microsoft Defender app + items: + - name: macOS Microsoft Defender app + href: ../../resources/intune-apps-macosmicrosoftdefenderapp.md + - name: List macOSMicrosoftDefenderApps + href: ../../api/intune-apps-macosmicrosoftdefenderapp-list.md + - name: Get macOSMicrosoftDefenderApp + href: ../../api/intune-apps-macosmicrosoftdefenderapp-get.md + - name: Create macOSMicrosoftDefenderApp + href: ../../api/intune-apps-macosmicrosoftdefenderapp-create.md + - name: Delete macOSMicrosoftDefenderApp + href: ../../api/intune-apps-macosmicrosoftdefenderapp-delete.md + - name: Update macOSMicrosoftDefenderApp + href: ../../api/intune-apps-macosmicrosoftdefenderapp-update.md + - name: macOS Microsoft Edge app + items: + - name: macOS Microsoft Edge app + href: ../../resources/intune-apps-macosmicrosoftedgeapp.md + - name: List macOSMicrosoftEdgeApps + href: ../../api/intune-apps-macosmicrosoftedgeapp-list.md + - name: Get macOSMicrosoftEdgeApp + href: ../../api/intune-apps-macosmicrosoftedgeapp-get.md + - name: Create macOSMicrosoftEdgeApp + href: ../../api/intune-apps-macosmicrosoftedgeapp-create.md + - name: Delete macOSMicrosoftEdgeApp + href: ../../api/intune-apps-macosmicrosoftedgeapp-delete.md + - name: Update macOSMicrosoftEdgeApp + href: ../../api/intune-apps-macosmicrosoftedgeapp-update.md + - name: macOS Office Suite app + items: + - name: macOS Office Suite app + href: ../../resources/intune-apps-macosofficesuiteapp.md + - name: List macOSOfficeSuiteApps + href: ../../api/intune-apps-macosofficesuiteapp-list.md + - name: Get macOSOfficeSuiteApp + href: ../../api/intune-apps-macosofficesuiteapp-get.md + - name: Create macOSOfficeSuiteApp + href: ../../api/intune-apps-macosofficesuiteapp-create.md + - name: Delete macOSOfficeSuiteApp + href: ../../api/intune-apps-macosofficesuiteapp-delete.md + - name: Update macOSOfficeSuiteApp + href: ../../api/intune-apps-macosofficesuiteapp-update.md + - name: Managed Android LOB app + items: + - name: Managed Android LOB app + href: ../../resources/intune-apps-managedandroidlobapp.md + - name: List managedAndroidLobApps + href: ../../api/intune-apps-managedandroidlobapp-list.md + - name: Get managedAndroidLobApp + href: ../../api/intune-apps-managedandroidlobapp-get.md + - name: Create managedAndroidLobApp + href: ../../api/intune-apps-managedandroidlobapp-create.md + - name: Delete managedAndroidLobApp + href: ../../api/intune-apps-managedandroidlobapp-delete.md + - name: Update managedAndroidLobApp + href: ../../api/intune-apps-managedandroidlobapp-update.md + - name: Managed Android store app + items: + - name: Managed Android store app + href: ../../resources/intune-apps-managedandroidstoreapp.md + - name: List managedAndroidStoreApps + href: ../../api/intune-apps-managedandroidstoreapp-list.md + - name: Get managedAndroidStoreApp + href: ../../api/intune-apps-managedandroidstoreapp-get.md + - name: Create managedAndroidStoreApp + href: ../../api/intune-apps-managedandroidstoreapp-create.md + - name: Delete managedAndroidStoreApp + href: ../../api/intune-apps-managedandroidstoreapp-delete.md + - name: Update managedAndroidStoreApp + href: ../../api/intune-apps-managedandroidstoreapp-update.md + - name: Managed app + items: + - name: Managed app + href: ../../resources/intune-apps-managedapp.md + - name: List managedApps + href: ../../api/intune-apps-managedapp-list.md + - name: Get managedApp + href: ../../api/intune-apps-managedapp-get.md + - name: Managed device mobile app configuration + items: + - name: Managed device mobile app configuration + href: ../../resources/intune-apps-manageddevicemobileappconfiguration.md + - name: List managedDeviceMobileAppConfigurations + href: ../../api/intune-apps-manageddevicemobileappconfiguration-list.md + - name: Get managedDeviceMobileAppConfiguration + href: ../../api/intune-apps-manageddevicemobileappconfiguration-get.md + - name: assign action + href: ../../api/intune-apps-manageddevicemobileappconfiguration-assign.md + - name: Managed device mobile app configuration assignment + items: + - name: Managed device mobile app configuration assignment + href: ../../resources/intune-apps-manageddevicemobileappconfigurationassignment.md + - name: List managedDeviceMobileAppConfigurationAssignments + href: ../../api/intune-apps-manageddevicemobileappconfigurationassignment-list.md + - name: Get managedDeviceMobileAppConfigurationAssignment + href: ../../api/intune-apps-manageddevicemobileappconfigurationassignment-get.md + - name: Create managedDeviceMobileAppConfigurationAssignment + href: ../../api/intune-apps-manageddevicemobileappconfigurationassignment-create.md + - name: Delete managedDeviceMobileAppConfigurationAssignment + href: ../../api/intune-apps-manageddevicemobileappconfigurationassignment-delete.md + - name: Update managedDeviceMobileAppConfigurationAssignment + href: ../../api/intune-apps-manageddevicemobileappconfigurationassignment-update.md + - name: Managed device mobile app configuration device status + items: + - name: Managed device mobile app configuration device status + href: ../../resources/intune-apps-manageddevicemobileappconfigurationdevicestatus.md + - name: List managedDeviceMobileAppConfigurationDeviceStatuses + href: ../../api/intune-apps-manageddevicemobileappconfigurationdevicestatus-list.md + - name: Get managedDeviceMobileAppConfigurationDeviceStatus + href: ../../api/intune-apps-manageddevicemobileappconfigurationdevicestatus-get.md + - name: Create managedDeviceMobileAppConfigurationDeviceStatus + href: ../../api/intune-apps-manageddevicemobileappconfigurationdevicestatus-create.md + - name: Delete managedDeviceMobileAppConfigurationDeviceStatus + href: ../../api/intune-apps-manageddevicemobileappconfigurationdevicestatus-delete.md + - name: Update managedDeviceMobileAppConfigurationDeviceStatus + href: ../../api/intune-apps-manageddevicemobileappconfigurationdevicestatus-update.md + - name: Managed device mobile app configuration device summary + items: + - name: Managed device mobile app configuration device summary + href: ../../resources/intune-apps-manageddevicemobileappconfigurationdevicesummary.md + - name: Get managedDeviceMobileAppConfigurationDeviceSummary + href: ../../api/intune-apps-manageddevicemobileappconfigurationdevicesummary-get.md + - name: Update managedDeviceMobileAppConfigurationDeviceSummary + href: ../../api/intune-apps-manageddevicemobileappconfigurationdevicesummary-update.md + - name: Managed device mobile app configuration user status + items: + - name: Managed device mobile app configuration user status + href: ../../resources/intune-apps-manageddevicemobileappconfigurationuserstatus.md + - name: List managedDeviceMobileAppConfigurationUserStatuses + href: ../../api/intune-apps-manageddevicemobileappconfigurationuserstatus-list.md + - name: Get managedDeviceMobileAppConfigurationUserStatus + href: ../../api/intune-apps-manageddevicemobileappconfigurationuserstatus-get.md + - name: Create managedDeviceMobileAppConfigurationUserStatus + href: ../../api/intune-apps-manageddevicemobileappconfigurationuserstatus-create.md + - name: Delete managedDeviceMobileAppConfigurationUserStatus + href: ../../api/intune-apps-manageddevicemobileappconfigurationuserstatus-delete.md + - name: Update managedDeviceMobileAppConfigurationUserStatus + href: ../../api/intune-apps-manageddevicemobileappconfigurationuserstatus-update.md + - name: Managed device mobile app configuration user summary + items: + - name: Managed device mobile app configuration user summary + href: ../../resources/intune-apps-manageddevicemobileappconfigurationusersummary.md + - name: Get managedDeviceMobileAppConfigurationUserSummary + href: ../../api/intune-apps-manageddevicemobileappconfigurationusersummary-get.md + - name: Update managedDeviceMobileAppConfigurationUserSummary + href: ../../api/intune-apps-manageddevicemobileappconfigurationusersummary-update.md + - name: Managed eBook + items: + - name: Managed eBook + href: ../../resources/intune-books-managedebook.md + - name: List managedEBooks + href: ../../api/intune-books-managedebook-list.md + - name: Get managedEBook + href: ../../api/intune-books-managedebook-get.md + - name: assign action + href: ../../api/intune-books-managedebook-assign.md + - name: Managed eBook assignment + items: + - name: Managed eBook assignment + href: ../../resources/intune-books-managedebookassignment.md + - name: List managedEBookAssignments + href: ../../api/intune-books-managedebookassignment-list.md + - name: Get managedEBookAssignment + href: ../../api/intune-books-managedebookassignment-get.md + - name: Create managedEBookAssignment + href: ../../api/intune-books-managedebookassignment-create.md + - name: Delete managedEBookAssignment + href: ../../api/intune-books-managedebookassignment-delete.md + - name: Update managedEBookAssignment + href: ../../api/intune-books-managedebookassignment-update.md + - name: Managed iOS LOB app + items: + - name: Managed iOS LOB app + href: ../../resources/intune-apps-managedioslobapp.md + - name: List managedIOSLobApps + href: ../../api/intune-apps-managedioslobapp-list.md + - name: Get managedIOSLobApp + href: ../../api/intune-apps-managedioslobapp-get.md + - name: Create managedIOSLobApp + href: ../../api/intune-apps-managedioslobapp-create.md + - name: Delete managedIOSLobApp + href: ../../api/intune-apps-managedioslobapp-delete.md + - name: Update managedIOSLobApp + href: ../../api/intune-apps-managedioslobapp-update.md + - name: Managed iOS store app + items: + - name: Managed iOS store app + href: ../../resources/intune-apps-managediosstoreapp.md + - name: List managedIOSStoreApps + href: ../../api/intune-apps-managediosstoreapp-list.md + - name: Get managedIOSStoreApp + href: ../../api/intune-apps-managediosstoreapp-get.md + - name: Create managedIOSStoreApp + href: ../../api/intune-apps-managediosstoreapp-create.md + - name: Delete managedIOSStoreApp + href: ../../api/intune-apps-managediosstoreapp-delete.md + - name: Update managedIOSStoreApp + href: ../../api/intune-apps-managediosstoreapp-update.md + - name: Managed mobile LOB app + items: + - name: Managed mobile LOB app + href: ../../resources/intune-apps-managedmobilelobapp.md + - name: List managedMobileLobApps + href: ../../api/intune-apps-managedmobilelobapp-list.md + - name: Get managedMobileLobApp + href: ../../api/intune-apps-managedmobilelobapp-get.md + - name: Microsoft Store for Business app + items: + - name: Microsoft Store for Business app + href: ../../resources/intune-apps-microsoftstoreforbusinessapp.md + - name: List microsoftStoreForBusinessApps + href: ../../api/intune-apps-microsoftstoreforbusinessapp-list.md + - name: Get microsoftStoreForBusinessApp + href: ../../api/intune-apps-microsoftstoreforbusinessapp-get.md + - name: Create microsoftStoreForBusinessApp + href: ../../api/intune-apps-microsoftstoreforbusinessapp-create.md + - name: Delete microsoftStoreForBusinessApp + href: ../../api/intune-apps-microsoftstoreforbusinessapp-delete.md + - name: Update microsoftStoreForBusinessApp + href: ../../api/intune-apps-microsoftstoreforbusinessapp-update.md + - name: Mobile app + items: + - name: Mobile app + href: ../../resources/intune-apps-mobileapp.md + - name: List mobileApps + href: ../../api/intune-apps-mobileapp-list.md + - name: Get mobileApp + href: ../../api/intune-apps-mobileapp-get.md + - name: assign action + href: ../../api/intune-apps-mobileapp-assign.md + - name: Mobile app assignment + items: + - name: Mobile app assignment + href: ../../resources/intune-apps-mobileappassignment.md + - name: List mobileAppAssignments + href: ../../api/intune-apps-mobileappassignment-list.md + - name: Get mobileAppAssignment + href: ../../api/intune-apps-mobileappassignment-get.md + - name: Create mobileAppAssignment + href: ../../api/intune-apps-mobileappassignment-create.md + - name: Delete mobileAppAssignment + href: ../../api/intune-apps-mobileappassignment-delete.md + - name: Update mobileAppAssignment + href: ../../api/intune-apps-mobileappassignment-update.md + - name: Mobile app category + items: + - name: Mobile app category + href: ../../resources/intune-apps-mobileappcategory.md + - name: List mobileAppCategories + href: ../../api/intune-apps-mobileappcategory-list.md + - name: Get mobileAppCategory + href: ../../api/intune-apps-mobileappcategory-get.md + - name: Create mobileAppCategory + href: ../../api/intune-apps-mobileappcategory-create.md + - name: Delete mobileAppCategory + href: ../../api/intune-apps-mobileappcategory-delete.md + - name: Update mobileAppCategory + href: ../../api/intune-apps-mobileappcategory-update.md + - name: Mobile app content + items: + - name: Mobile app content + href: ../../resources/intune-apps-mobileappcontent.md + - name: List mobileAppContents + href: ../../api/intune-apps-mobileappcontent-list.md + - name: Get mobileAppContent + href: ../../api/intune-apps-mobileappcontent-get.md + - name: Create mobileAppContent + href: ../../api/intune-apps-mobileappcontent-create.md + - name: Delete mobileAppContent + href: ../../api/intune-apps-mobileappcontent-delete.md + - name: Update mobileAppContent + href: ../../api/intune-apps-mobileappcontent-update.md + - name: Mobile app content file + items: + - name: Mobile app content file + href: ../../resources/intune-apps-mobileappcontentfile.md + - name: List mobileAppContentFiles + href: ../../api/intune-apps-mobileappcontentfile-list.md + - name: Get mobileAppContentFile + href: ../../api/intune-apps-mobileappcontentfile-get.md + - name: Create mobileAppContentFile + href: ../../api/intune-apps-mobileappcontentfile-create.md + - name: Delete mobileAppContentFile + href: ../../api/intune-apps-mobileappcontentfile-delete.md + - name: Update mobileAppContentFile + href: ../../api/intune-apps-mobileappcontentfile-update.md + - name: commit action + href: ../../api/intune-apps-mobileappcontentfile-commit.md + - name: renewUpload action + href: ../../api/intune-apps-mobileappcontentfile-renewupload.md + - name: Mobile contained app + items: + - name: Mobile contained app + href: ../../resources/intune-apps-mobilecontainedapp.md + - name: List mobileContainedApps + href: ../../api/intune-apps-mobilecontainedapp-list.md + - name: Get mobileContainedApp + href: ../../api/intune-apps-mobilecontainedapp-get.md + - name: Mobile LOB app + items: + - name: Mobile LOB app + href: ../../resources/intune-apps-mobilelobapp.md + - name: List mobileLobApps + href: ../../api/intune-apps-mobilelobapp-list.md + - name: Get mobileLobApp + href: ../../api/intune-apps-mobilelobapp-get.md + - name: User install state summary + items: + - name: User install state summary + href: ../../resources/intune-books-userinstallstatesummary.md + - name: List userInstallStateSummaries + href: ../../api/intune-books-userinstallstatesummary-list.md + - name: Get userInstallStateSummary + href: ../../api/intune-books-userinstallstatesummary-get.md + - name: Create userInstallStateSummary + href: ../../api/intune-books-userinstallstatesummary-create.md + - name: Delete userInstallStateSummary + href: ../../api/intune-books-userinstallstatesummary-delete.md + - name: Update userInstallStateSummary + href: ../../api/intune-books-userinstallstatesummary-update.md + - name: Web app + items: + - name: Web app + href: ../../resources/intune-apps-webapp.md + - name: List webApps + href: ../../api/intune-apps-webapp-list.md + - name: Get webApp + href: ../../api/intune-apps-webapp-get.md + - name: Create webApp + href: ../../api/intune-apps-webapp-create.md + - name: Delete webApp + href: ../../api/intune-apps-webapp-delete.md + - name: Update webApp + href: ../../api/intune-apps-webapp-update.md + - name: Win32 LOB app + items: + - name: Win32 LOB app + href: ../../resources/intune-apps-win32lobapp.md + - name: List win32LobApps + href: ../../api/intune-apps-win32lobapp-list.md + - name: Get win32LobApp + href: ../../api/intune-apps-win32lobapp-get.md + - name: Create win32LobApp + href: ../../api/intune-apps-win32lobapp-create.md + - name: Delete win32LobApp + href: ../../api/intune-apps-win32lobapp-delete.md + - name: Update win32LobApp + href: ../../api/intune-apps-win32lobapp-update.md + - name: Windows AppX + items: + - name: Windows AppX + href: ../../resources/intune-apps-windowsappx.md + - name: List windowsAppXs + href: ../../api/intune-apps-windowsappx-list.md + - name: Get windowsAppX + href: ../../api/intune-apps-windowsappx-get.md + - name: Create windowsAppX + href: ../../api/intune-apps-windowsappx-create.md + - name: Delete windowsAppX + href: ../../api/intune-apps-windowsappx-delete.md + - name: Update windowsAppX + href: ../../api/intune-apps-windowsappx-update.md + - name: Windows Microsoft Edge app + items: + - name: Windows Microsoft Edge app + href: ../../resources/intune-apps-windowsmicrosoftedgeapp.md + - name: List windowsMicrosoftEdgeApps + href: ../../api/intune-apps-windowsmicrosoftedgeapp-list.md + - name: Get windowsMicrosoftEdgeApp + href: ../../api/intune-apps-windowsmicrosoftedgeapp-get.md + - name: Create windowsMicrosoftEdgeApp + href: ../../api/intune-apps-windowsmicrosoftedgeapp-create.md + - name: Delete windowsMicrosoftEdgeApp + href: ../../api/intune-apps-windowsmicrosoftedgeapp-delete.md + - name: Update windowsMicrosoftEdgeApp + href: ../../api/intune-apps-windowsmicrosoftedgeapp-update.md + - name: Windows Mobile MSI + items: + - name: Windows Mobile MSI + href: ../../resources/intune-apps-windowsmobilemsi.md + - name: List windowsMobileMSIs + href: ../../api/intune-apps-windowsmobilemsi-list.md + - name: Get windowsMobileMSI + href: ../../api/intune-apps-windowsmobilemsi-get.md + - name: Create windowsMobileMSI + href: ../../api/intune-apps-windowsmobilemsi-create.md + - name: Delete windowsMobileMSI + href: ../../api/intune-apps-windowsmobilemsi-delete.md + - name: Update windowsMobileMSI + href: ../../api/intune-apps-windowsmobilemsi-update.md + - name: Windows Universal AppX + items: + - name: Windows Universal AppX + href: ../../resources/intune-apps-windowsuniversalappx.md + - name: List windowsUniversalAppXs + href: ../../api/intune-apps-windowsuniversalappx-list.md + - name: Get windowsUniversalAppX + href: ../../api/intune-apps-windowsuniversalappx-get.md + - name: Create windowsUniversalAppX + href: ../../api/intune-apps-windowsuniversalappx-create.md + - name: Delete windowsUniversalAppX + href: ../../api/intune-apps-windowsuniversalappx-delete.md + - name: Update windowsUniversalAppX + href: ../../api/intune-apps-windowsuniversalappx-update.md + - name: Windows Universal AppX contained app + items: + - name: Windows Universal AppX contained app + href: ../../resources/intune-apps-windowsuniversalappxcontainedapp.md + - name: List windowsUniversalAppXContainedApps + href: ../../api/intune-apps-windowsuniversalappxcontainedapp-list.md + - name: Get windowsUniversalAppXContainedApp + href: ../../api/intune-apps-windowsuniversalappxcontainedapp-get.md + - name: Create windowsUniversalAppXContainedApp + href: ../../api/intune-apps-windowsuniversalappxcontainedapp-create.md + - name: Delete windowsUniversalAppXContainedApp + href: ../../api/intune-apps-windowsuniversalappxcontainedapp-delete.md + - name: Update windowsUniversalAppXContainedApp + href: ../../api/intune-apps-windowsuniversalappxcontainedapp-update.md + - name: Windows web app + items: + - name: Windows web app + href: ../../resources/intune-apps-windowswebapp.md + - name: List windowsWebApps + href: ../../api/intune-apps-windowswebapp-list.md + - name: Get windowsWebApp + href: ../../api/intune-apps-windowswebapp-get.md + - name: Create windowsWebApp + href: ../../api/intune-apps-windowswebapp-create.md + - name: Delete windowsWebApp + href: ../../api/intune-apps-windowswebapp-delete.md + - name: Update windowsWebApp + href: ../../api/intune-apps-windowswebapp-update.md + - name: Complex types + items: + - name: All devices assignment target + href: ../../resources/intune-shared-alldevicesassignmenttarget.md + - name: All licensed users assignment target + href: ../../resources/intune-shared-alllicensedusersassignmenttarget.md + - name: All licensed users assignment target + href: ../../resources/intune-shared-alllicensedusersassignmenttarget.md + - name: Android minimum operating system + href: ../../resources/intune-apps-androidminimumoperatingsystem.md + - name: App configuration setting item + href: ../../resources/intune-apps-appconfigurationsettingitem.md + - name: Configuration manager collection assignment target + href: ../../resources/intune-shared-configurationmanagercollectionassignmenttarget.md + - name: Configuration manager collection assignment target + href: ../../resources/intune-shared-configurationmanagercollectionassignmenttarget.md + - name: Device and app management assignment target + href: ../../resources/intune-shared-deviceandappmanagementassignmenttarget.md + - name: Device and app management assignment target + href: ../../resources/intune-shared-deviceandappmanagementassignmenttarget.md + - name: Exclusion group assignment target + href: ../../resources/intune-shared-exclusiongroupassignmenttarget.md + - name: Exclusion group assignment target + href: ../../resources/intune-shared-exclusiongroupassignmenttarget.md + - name: File encryption info + href: ../../resources/intune-apps-fileencryptioninfo.md + - name: Group assignment target + href: ../../resources/intune-shared-groupassignmenttarget.md + - name: Group assignment target + href: ../../resources/intune-shared-groupassignmenttarget.md + - name: iOS device type + href: ../../resources/intune-apps-iosdevicetype.md + - name: iOS LOB app assignment settings + href: ../../resources/intune-apps-ioslobappassignmentsettings.md + - name: iOS minimum operating system + href: ../../resources/intune-apps-iosminimumoperatingsystem.md + - name: iOS store app assignment settings + href: ../../resources/intune-apps-iosstoreappassignmentsettings.md + - name: iOS VPP app assignment settings + href: ../../resources/intune-apps-iosvppappassignmentsettings.md + - name: macOS LOB app assignment settings + href: ../../resources/intune-apps-macoslobappassignmentsettings.md + - name: macOS LOB child app + href: ../../resources/intune-apps-macoslobchildapp.md + - name: macOS minimum operating system + href: ../../resources/intune-apps-macosminimumoperatingsystem.md + - name: Microsoft Store for Business app assignment settings + href: ../../resources/intune-apps-microsoftstoreforbusinessappassignmentsettings.md + - name: Mime content + href: ../../resources/intune-shared-mimecontent.md + - name: Mime content + href: ../../resources/intune-shared-mimecontent.md + - name: Mobile app assignment settings + href: ../../resources/intune-apps-mobileappassignmentsettings.md + - name: Mobile app install time settings + href: ../../resources/intune-apps-mobileappinstalltimesettings.md + - name: VPP licensing type + href: ../../resources/intune-apps-vpplicensingtype.md + - name: Win32 LOB app assignment settings + href: ../../resources/intune-apps-win32lobappassignmentsettings.md + - name: Win32 LOB app file system rule + href: ../../resources/intune-apps-win32lobappfilesystemrule.md + - name: Win32 LOB app install experience + href: ../../resources/intune-apps-win32lobappinstallexperience.md + - name: Win32 LOB app MSI information + href: ../../resources/intune-apps-win32lobappmsiinformation.md + - name: Win32 LOB app power shell script rule + href: ../../resources/intune-apps-win32lobapppowershellscriptrule.md + - name: Win32 LOB app product code rule + href: ../../resources/intune-apps-win32lobappproductcoderule.md + - name: Win32 LOB app registry rule + href: ../../resources/intune-apps-win32lobappregistryrule.md + - name: Win32 LOB app restart settings + href: ../../resources/intune-apps-win32lobapprestartsettings.md + - name: Win32 LOB app return code + href: ../../resources/intune-apps-win32lobappreturncode.md + - name: Win32 LOB app rule + href: ../../resources/intune-apps-win32lobapprule.md + - name: Windows AppX app assignment settings + href: ../../resources/intune-apps-windowsappxappassignmentsettings.md + - name: Windows minimum operating system + href: ../../resources/intune-apps-windowsminimumoperatingsystem.md + - name: Windows Universal AppX app assignment settings + href: ../../resources/intune-apps-windowsuniversalappxappassignmentsettings.md + - name: Company terms + items: + - name: Overview + href: ../../resources/intune-company-conceptual.md + - name: Terms and conditions + items: + - name: Terms and conditions + href: ../../resources/intune-companyterms-termsandconditions.md + - name: List termsAndConditionses + href: ../../api/intune-companyterms-termsandconditions-list.md + - name: Get termsAndConditions + href: ../../api/intune-companyterms-termsandconditions-get.md + - name: Create termsAndConditions + href: ../../api/intune-companyterms-termsandconditions-create.md + - name: Delete termsAndConditions + href: ../../api/intune-companyterms-termsandconditions-delete.md + - name: Update termsAndConditions + href: ../../api/intune-companyterms-termsandconditions-update.md + - name: Terms and conditions acceptance status + items: + - name: Terms and conditions acceptance status + href: ../../resources/intune-companyterms-termsandconditionsacceptancestatus.md + - name: List termsAndConditionsAcceptanceStatuses + href: ../../api/intune-companyterms-termsandconditionsacceptancestatus-list.md + - name: Get termsAndConditionsAcceptanceStatus + href: ../../api/intune-companyterms-termsandconditionsacceptancestatus-get.md + - name: Create termsAndConditionsAcceptanceStatus + href: ../../api/intune-companyterms-termsandconditionsacceptancestatus-create.md + - name: Delete termsAndConditionsAcceptanceStatus + href: ../../api/intune-companyterms-termsandconditionsacceptancestatus-delete.md + - name: Update termsAndConditionsAcceptanceStatus + href: ../../api/intune-companyterms-termsandconditionsacceptancestatus-update.md + - name: Terms and conditions assignment + items: + - name: Terms and conditions assignment + href: ../../resources/intune-companyterms-termsandconditionsassignment.md + - name: List termsAndConditionsAssignments + href: ../../api/intune-companyterms-termsandconditionsassignment-list.md + - name: Get termsAndConditionsAssignment + href: ../../api/intune-companyterms-termsandconditionsassignment-get.md + - name: Create termsAndConditionsAssignment + href: ../../api/intune-companyterms-termsandconditionsassignment-create.md + - name: Delete termsAndConditionsAssignment + href: ../../api/intune-companyterms-termsandconditionsassignment-delete.md + - name: Update termsAndConditionsAssignment + href: ../../api/intune-companyterms-termsandconditionsassignment-update.md + - name: Complex types + items: + - name: All devices assignment target + href: ../../resources/intune-shared-alldevicesassignmenttarget.md + - name: All licensed users assignment target + href: ../../resources/intune-shared-alllicensedusersassignmenttarget.md + - name: Configuration manager collection assignment target + href: ../../resources/intune-shared-configurationmanagercollectionassignmenttarget.md + - name: Device and app management assignment target + href: ../../resources/intune-shared-deviceandappmanagementassignmenttarget.md + - name: Exclusion group assignment target + href: ../../resources/intune-shared-exclusiongroupassignmenttarget.md + - name: Group assignment target + href: ../../resources/intune-shared-groupassignmenttarget.md + - name: Corporate enrollment + items: + - name: Overview + href: ../../resources/intune-enrollment-conceptual.md + - name: Imported Windows Autopilot device identity + items: + - name: Imported Windows Autopilot device identity + href: ../../resources/intune-enrollment-importedwindowsautopilotdeviceidentity.md + - name: List importedWindowsAutopilotDeviceIdentities + href: ../../api/intune-enrollment-importedwindowsautopilotdeviceidentity-list.md + - name: Get importedWindowsAutopilotDeviceIdentity + href: ../../api/intune-enrollment-importedwindowsautopilotdeviceidentity-get.md + - name: Create importedWindowsAutopilotDeviceIdentity + href: ../../api/intune-enrollment-importedwindowsautopilotdeviceidentity-create.md + - name: Delete importedWindowsAutopilotDeviceIdentity + href: ../../api/intune-enrollment-importedwindowsautopilotdeviceidentity-delete.md + - name: import action + href: ../../api/intune-enrollment-importedwindowsautopilotdeviceidentity-import.md + - name: Windows Autopilot device identity + items: + - name: Windows Autopilot device identity + href: ../../resources/intune-enrollment-windowsautopilotdeviceidentity.md + - name: List windowsAutopilotDeviceIdentities + href: ../../api/intune-enrollment-windowsautopilotdeviceidentity-list.md + - name: Get windowsAutopilotDeviceIdentity + href: ../../api/intune-enrollment-windowsautopilotdeviceidentity-get.md + - name: Create windowsAutopilotDeviceIdentity + href: ../../api/intune-enrollment-windowsautopilotdeviceidentity-create.md + - name: Delete windowsAutopilotDeviceIdentity + href: ../../api/intune-enrollment-windowsautopilotdeviceidentity-delete.md + - name: assignUserToDevice action + href: ../../api/intune-enrollment-windowsautopilotdeviceidentity-assignusertodevice.md + - name: unassignUserFromDevice action + href: ../../api/intune-enrollment-windowsautopilotdeviceidentity-unassignuserfromdevice.md + - name: updateDeviceProperties action + href: ../../api/intune-enrollment-windowsautopilotdeviceidentity-updatedeviceproperties.md + - name: Complex types + items: + - name: Imported Windows Autopilot device identity state + href: ../../resources/intune-enrollment-importedwindowsautopilotdeviceidentitystate.md + - name: Device configuration + items: + - name: Overview + href: ../../resources/intune-device-cfg-conceptual.md + - name: Android compliance policy + items: + - name: Android compliance policy + href: ../../resources/intune-deviceconfig-androidcompliancepolicy.md + - name: List androidCompliancePolicies + href: ../../api/intune-deviceconfig-androidcompliancepolicy-list.md + - name: Get androidCompliancePolicy + href: ../../api/intune-deviceconfig-androidcompliancepolicy-get.md + - name: Create androidCompliancePolicy + href: ../../api/intune-deviceconfig-androidcompliancepolicy-create.md + - name: Delete androidCompliancePolicy + href: ../../api/intune-deviceconfig-androidcompliancepolicy-delete.md + - name: Update androidCompliancePolicy + href: ../../api/intune-deviceconfig-androidcompliancepolicy-update.md + - name: Android custom configuration + items: + - name: Android custom configuration + href: ../../resources/intune-deviceconfig-androidcustomconfiguration.md + - name: List androidCustomConfigurations + href: ../../api/intune-deviceconfig-androidcustomconfiguration-list.md + - name: Get androidCustomConfiguration + href: ../../api/intune-deviceconfig-androidcustomconfiguration-get.md + - name: Create androidCustomConfiguration + href: ../../api/intune-deviceconfig-androidcustomconfiguration-create.md + - name: Delete androidCustomConfiguration + href: ../../api/intune-deviceconfig-androidcustomconfiguration-delete.md + - name: Update androidCustomConfiguration + href: ../../api/intune-deviceconfig-androidcustomconfiguration-update.md + - name: Android general device configuration + items: + - name: Android general device configuration + href: ../../resources/intune-deviceconfig-androidgeneraldeviceconfiguration.md + - name: List androidGeneralDeviceConfigurations + href: ../../api/intune-deviceconfig-androidgeneraldeviceconfiguration-list.md + - name: Get androidGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-androidgeneraldeviceconfiguration-get.md + - name: Create androidGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-androidgeneraldeviceconfiguration-create.md + - name: Delete androidGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-androidgeneraldeviceconfiguration-delete.md + - name: Update androidGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-androidgeneraldeviceconfiguration-update.md + - name: Android work profile compliance policy + items: + - name: Android work profile compliance policy + href: ../../resources/intune-deviceconfig-androidworkprofilecompliancepolicy.md + - name: List androidWorkProfileCompliancePolicies + href: ../../api/intune-deviceconfig-androidworkprofilecompliancepolicy-list.md + - name: Get androidWorkProfileCompliancePolicy + href: ../../api/intune-deviceconfig-androidworkprofilecompliancepolicy-get.md + - name: Create androidWorkProfileCompliancePolicy + href: ../../api/intune-deviceconfig-androidworkprofilecompliancepolicy-create.md + - name: Delete androidWorkProfileCompliancePolicy + href: ../../api/intune-deviceconfig-androidworkprofilecompliancepolicy-delete.md + - name: Update androidWorkProfileCompliancePolicy + href: ../../api/intune-deviceconfig-androidworkprofilecompliancepolicy-update.md + - name: Android work profile custom configuration + items: + - name: Android work profile custom configuration + href: ../../resources/intune-deviceconfig-androidworkprofilecustomconfiguration.md + - name: List androidWorkProfileCustomConfigurations + href: ../../api/intune-deviceconfig-androidworkprofilecustomconfiguration-list.md + - name: Get androidWorkProfileCustomConfiguration + href: ../../api/intune-deviceconfig-androidworkprofilecustomconfiguration-get.md + - name: Create androidWorkProfileCustomConfiguration + href: ../../api/intune-deviceconfig-androidworkprofilecustomconfiguration-create.md + - name: Delete androidWorkProfileCustomConfiguration + href: ../../api/intune-deviceconfig-androidworkprofilecustomconfiguration-delete.md + - name: Update androidWorkProfileCustomConfiguration + href: ../../api/intune-deviceconfig-androidworkprofilecustomconfiguration-update.md + - name: Android work profile general device configuration + items: + - name: Android work profile general device configuration + href: ../../resources/intune-deviceconfig-androidworkprofilegeneraldeviceconfiguration.md + - name: List androidWorkProfileGeneralDeviceConfigurations + href: ../../api/intune-deviceconfig-androidworkprofilegeneraldeviceconfiguration-list.md + - name: Get androidWorkProfileGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-androidworkprofilegeneraldeviceconfiguration-get.md + - name: Create androidWorkProfileGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-androidworkprofilegeneraldeviceconfiguration-create.md + - name: Delete androidWorkProfileGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-androidworkprofilegeneraldeviceconfiguration-delete.md + - name: Update androidWorkProfileGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-androidworkprofilegeneraldeviceconfiguration-update.md + - name: Apple device features configuration base + items: + - name: Apple device features configuration base + href: ../../resources/intune-deviceconfig-appledevicefeaturesconfigurationbase.md + - name: List appleDeviceFeaturesConfigurationBases + href: ../../api/intune-deviceconfig-appledevicefeaturesconfigurationbase-list.md + - name: Get appleDeviceFeaturesConfigurationBase + href: ../../api/intune-deviceconfig-appledevicefeaturesconfigurationbase-get.md + - name: Device compliance action item + items: + - name: Device compliance action item + href: ../../resources/intune-deviceconfig-devicecomplianceactionitem.md + - name: List deviceComplianceActionItems + href: ../../api/intune-deviceconfig-devicecomplianceactionitem-list.md + - name: Get deviceComplianceActionItem + href: ../../api/intune-deviceconfig-devicecomplianceactionitem-get.md + - name: Create deviceComplianceActionItem + href: ../../api/intune-deviceconfig-devicecomplianceactionitem-create.md + - name: Delete deviceComplianceActionItem + href: ../../api/intune-deviceconfig-devicecomplianceactionitem-delete.md + - name: Update deviceComplianceActionItem + href: ../../api/intune-deviceconfig-devicecomplianceactionitem-update.md + - name: Device compliance device overview + items: + - name: Device compliance device overview + href: ../../resources/intune-deviceconfig-devicecompliancedeviceoverview.md + - name: Get deviceComplianceDeviceOverview + href: ../../api/intune-deviceconfig-devicecompliancedeviceoverview-get.md + - name: Update deviceComplianceDeviceOverview + href: ../../api/intune-deviceconfig-devicecompliancedeviceoverview-update.md + - name: Device compliance device status + items: + - name: Device compliance device status + href: ../../resources/intune-deviceconfig-devicecompliancedevicestatus.md + - name: List deviceComplianceDeviceStatuses + href: ../../api/intune-deviceconfig-devicecompliancedevicestatus-list.md + - name: Get deviceComplianceDeviceStatus + href: ../../api/intune-deviceconfig-devicecompliancedevicestatus-get.md + - name: Create deviceComplianceDeviceStatus + href: ../../api/intune-deviceconfig-devicecompliancedevicestatus-create.md + - name: Delete deviceComplianceDeviceStatus + href: ../../api/intune-deviceconfig-devicecompliancedevicestatus-delete.md + - name: Update deviceComplianceDeviceStatus + href: ../../api/intune-deviceconfig-devicecompliancedevicestatus-update.md + - name: Device compliance policy + items: + - name: Device compliance policy + href: ../../resources/intune-deviceconfig-devicecompliancepolicy.md + - name: List deviceCompliancePolicies + href: ../../api/intune-deviceconfig-devicecompliancepolicy-list.md + - name: Get deviceCompliancePolicy + href: ../../api/intune-deviceconfig-devicecompliancepolicy-get.md + - name: assign action + href: ../../api/intune-deviceconfig-devicecompliancepolicy-assign.md + - name: scheduleActionsForRules action + href: ../../api/intune-deviceconfig-devicecompliancepolicy-scheduleactionsforrules.md + - name: Device compliance policy assignment + items: + - name: Device compliance policy assignment + href: ../../resources/intune-deviceconfig-devicecompliancepolicyassignment.md + - name: List deviceCompliancePolicyAssignments + href: ../../api/intune-deviceconfig-devicecompliancepolicyassignment-list.md + - name: Get deviceCompliancePolicyAssignment + href: ../../api/intune-deviceconfig-devicecompliancepolicyassignment-get.md + - name: Create deviceCompliancePolicyAssignment + href: ../../api/intune-deviceconfig-devicecompliancepolicyassignment-create.md + - name: Delete deviceCompliancePolicyAssignment + href: ../../api/intune-deviceconfig-devicecompliancepolicyassignment-delete.md + - name: Update deviceCompliancePolicyAssignment + href: ../../api/intune-deviceconfig-devicecompliancepolicyassignment-update.md + - name: Device compliance policy device state summary + items: + - name: Device compliance policy device state summary + href: ../../resources/intune-deviceconfig-devicecompliancepolicydevicestatesummary.md + - name: Get deviceCompliancePolicyDeviceStateSummary + href: ../../api/intune-deviceconfig-devicecompliancepolicydevicestatesummary-get.md + - name: Update deviceCompliancePolicyDeviceStateSummary + href: ../../api/intune-deviceconfig-devicecompliancepolicydevicestatesummary-update.md + - name: Device compliance policy setting state summary + items: + - name: Device compliance policy setting state summary + href: ../../resources/intune-deviceconfig-devicecompliancepolicysettingstatesummary.md + - name: List deviceCompliancePolicySettingStateSummaries + href: ../../api/intune-deviceconfig-devicecompliancepolicysettingstatesummary-list.md + - name: Get deviceCompliancePolicySettingStateSummary + href: ../../api/intune-deviceconfig-devicecompliancepolicysettingstatesummary-get.md + - name: Create deviceCompliancePolicySettingStateSummary + href: ../../api/intune-deviceconfig-devicecompliancepolicysettingstatesummary-create.md + - name: Delete deviceCompliancePolicySettingStateSummary + href: ../../api/intune-deviceconfig-devicecompliancepolicysettingstatesummary-delete.md + - name: Update deviceCompliancePolicySettingStateSummary + href: ../../api/intune-deviceconfig-devicecompliancepolicysettingstatesummary-update.md + - name: Device compliance scheduled action for rule + items: + - name: Device compliance scheduled action for rule + href: ../../resources/intune-deviceconfig-devicecompliancescheduledactionforrule.md + - name: List deviceComplianceScheduledActionForRules + href: ../../api/intune-deviceconfig-devicecompliancescheduledactionforrule-list.md + - name: Get deviceComplianceScheduledActionForRule + href: ../../api/intune-deviceconfig-devicecompliancescheduledactionforrule-get.md + - name: Create deviceComplianceScheduledActionForRule + href: ../../api/intune-deviceconfig-devicecompliancescheduledactionforrule-create.md + - name: Delete deviceComplianceScheduledActionForRule + href: ../../api/intune-deviceconfig-devicecompliancescheduledactionforrule-delete.md + - name: Update deviceComplianceScheduledActionForRule + href: ../../api/intune-deviceconfig-devicecompliancescheduledactionforrule-update.md + - name: Device compliance setting state + items: + - name: Device compliance setting state + href: ../../resources/intune-deviceconfig-devicecompliancesettingstate.md + - name: List deviceComplianceSettingStates + href: ../../api/intune-deviceconfig-devicecompliancesettingstate-list.md + - name: Get deviceComplianceSettingState + href: ../../api/intune-deviceconfig-devicecompliancesettingstate-get.md + - name: Create deviceComplianceSettingState + href: ../../api/intune-deviceconfig-devicecompliancesettingstate-create.md + - name: Delete deviceComplianceSettingState + href: ../../api/intune-deviceconfig-devicecompliancesettingstate-delete.md + - name: Update deviceComplianceSettingState + href: ../../api/intune-deviceconfig-devicecompliancesettingstate-update.md + - name: Device compliance user overview + items: + - name: Device compliance user overview + href: ../../resources/intune-deviceconfig-devicecomplianceuseroverview.md + - name: Get deviceComplianceUserOverview + href: ../../api/intune-deviceconfig-devicecomplianceuseroverview-get.md + - name: Update deviceComplianceUserOverview + href: ../../api/intune-deviceconfig-devicecomplianceuseroverview-update.md + - name: Device compliance user status + items: + - name: Device compliance user status + href: ../../resources/intune-deviceconfig-devicecomplianceuserstatus.md + - name: List deviceComplianceUserStatuses + href: ../../api/intune-deviceconfig-devicecomplianceuserstatus-list.md + - name: Get deviceComplianceUserStatus + href: ../../api/intune-deviceconfig-devicecomplianceuserstatus-get.md + - name: Create deviceComplianceUserStatus + href: ../../api/intune-deviceconfig-devicecomplianceuserstatus-create.md + - name: Delete deviceComplianceUserStatus + href: ../../api/intune-deviceconfig-devicecomplianceuserstatus-delete.md + - name: Update deviceComplianceUserStatus + href: ../../api/intune-deviceconfig-devicecomplianceuserstatus-update.md + - name: Device configuration + items: + - name: Device configuration + href: ../../resources/intune-deviceconfig-deviceconfiguration.md + - name: List deviceConfigurations + href: ../../api/intune-deviceconfig-deviceconfiguration-list.md + - name: Get deviceConfiguration + href: ../../api/intune-deviceconfig-deviceconfiguration-get.md + - name: assign action + href: ../../api/intune-deviceconfig-deviceconfiguration-assign.md + - name: getOmaSettingPlainTextValue function + href: ../../api/intune-deviceconfig-deviceconfiguration-getomasettingplaintextvalue.md + - name: Device configuration assignment + items: + - name: Device configuration assignment + href: ../../resources/intune-deviceconfig-deviceconfigurationassignment.md + - name: List deviceConfigurationAssignments + href: ../../api/intune-deviceconfig-deviceconfigurationassignment-list.md + - name: Get deviceConfigurationAssignment + href: ../../api/intune-deviceconfig-deviceconfigurationassignment-get.md + - name: Create deviceConfigurationAssignment + href: ../../api/intune-deviceconfig-deviceconfigurationassignment-create.md + - name: Delete deviceConfigurationAssignment + href: ../../api/intune-deviceconfig-deviceconfigurationassignment-delete.md + - name: Update deviceConfigurationAssignment + href: ../../api/intune-deviceconfig-deviceconfigurationassignment-update.md + - name: Device configuration device overview + items: + - name: Device configuration device overview + href: ../../resources/intune-deviceconfig-deviceconfigurationdeviceoverview.md + - name: Get deviceConfigurationDeviceOverview + href: ../../api/intune-deviceconfig-deviceconfigurationdeviceoverview-get.md + - name: Update deviceConfigurationDeviceOverview + href: ../../api/intune-deviceconfig-deviceconfigurationdeviceoverview-update.md + - name: Device configuration device state summary + items: + - name: Device configuration device state summary + href: ../../resources/intune-deviceconfig-deviceconfigurationdevicestatesummary.md + - name: Get deviceConfigurationDeviceStateSummary + href: ../../api/intune-deviceconfig-deviceconfigurationdevicestatesummary-get.md + - name: Update deviceConfigurationDeviceStateSummary + href: ../../api/intune-deviceconfig-deviceconfigurationdevicestatesummary-update.md + - name: Device configuration device status + items: + - name: Device configuration device status + href: ../../resources/intune-deviceconfig-deviceconfigurationdevicestatus.md + - name: List deviceConfigurationDeviceStatuses + href: ../../api/intune-deviceconfig-deviceconfigurationdevicestatus-list.md + - name: Get deviceConfigurationDeviceStatus + href: ../../api/intune-deviceconfig-deviceconfigurationdevicestatus-get.md + - name: Create deviceConfigurationDeviceStatus + href: ../../api/intune-deviceconfig-deviceconfigurationdevicestatus-create.md + - name: Delete deviceConfigurationDeviceStatus + href: ../../api/intune-deviceconfig-deviceconfigurationdevicestatus-delete.md + - name: Update deviceConfigurationDeviceStatus + href: ../../api/intune-deviceconfig-deviceconfigurationdevicestatus-update.md + - name: Device configuration user overview + items: + - name: Device configuration user overview + href: ../../resources/intune-deviceconfig-deviceconfigurationuseroverview.md + - name: Get deviceConfigurationUserOverview + href: ../../api/intune-deviceconfig-deviceconfigurationuseroverview-get.md + - name: Update deviceConfigurationUserOverview + href: ../../api/intune-deviceconfig-deviceconfigurationuseroverview-update.md + - name: Device configuration user status + items: + - name: Device configuration user status + href: ../../resources/intune-deviceconfig-deviceconfigurationuserstatus.md + - name: List deviceConfigurationUserStatuses + href: ../../api/intune-deviceconfig-deviceconfigurationuserstatus-list.md + - name: Get deviceConfigurationUserStatus + href: ../../api/intune-deviceconfig-deviceconfigurationuserstatus-get.md + - name: Create deviceConfigurationUserStatus + href: ../../api/intune-deviceconfig-deviceconfigurationuserstatus-create.md + - name: Delete deviceConfigurationUserStatus + href: ../../api/intune-deviceconfig-deviceconfigurationuserstatus-delete.md + - name: Update deviceConfigurationUserStatus + href: ../../api/intune-deviceconfig-deviceconfigurationuserstatus-update.md + - name: Edition upgrade configuration + items: + - name: Edition upgrade configuration + href: ../../resources/intune-deviceconfig-editionupgradeconfiguration.md + - name: List editionUpgradeConfigurations + href: ../../api/intune-deviceconfig-editionupgradeconfiguration-list.md + - name: Get editionUpgradeConfiguration + href: ../../api/intune-deviceconfig-editionupgradeconfiguration-get.md + - name: Create editionUpgradeConfiguration + href: ../../api/intune-deviceconfig-editionupgradeconfiguration-create.md + - name: Delete editionUpgradeConfiguration + href: ../../api/intune-deviceconfig-editionupgradeconfiguration-delete.md + - name: Update editionUpgradeConfiguration + href: ../../api/intune-deviceconfig-editionupgradeconfiguration-update.md + - name: iOS certificate profile + items: + - name: iOS certificate profile + href: ../../resources/intune-deviceconfig-ioscertificateprofile.md + - name: List iosCertificateProfiles + href: ../../api/intune-deviceconfig-ioscertificateprofile-list.md + - name: Get iosCertificateProfile + href: ../../api/intune-deviceconfig-ioscertificateprofile-get.md + - name: iOS compliance policy + items: + - name: iOS compliance policy + href: ../../resources/intune-deviceconfig-ioscompliancepolicy.md + - name: List iosCompliancePolicies + href: ../../api/intune-deviceconfig-ioscompliancepolicy-list.md + - name: Get iosCompliancePolicy + href: ../../api/intune-deviceconfig-ioscompliancepolicy-get.md + - name: Create iosCompliancePolicy + href: ../../api/intune-deviceconfig-ioscompliancepolicy-create.md + - name: Delete iosCompliancePolicy + href: ../../api/intune-deviceconfig-ioscompliancepolicy-delete.md + - name: Update iosCompliancePolicy + href: ../../api/intune-deviceconfig-ioscompliancepolicy-update.md + - name: iOS custom configuration + items: + - name: iOS custom configuration + href: ../../resources/intune-deviceconfig-ioscustomconfiguration.md + - name: List iosCustomConfigurations + href: ../../api/intune-deviceconfig-ioscustomconfiguration-list.md + - name: Get iosCustomConfiguration + href: ../../api/intune-deviceconfig-ioscustomconfiguration-get.md + - name: Create iosCustomConfiguration + href: ../../api/intune-deviceconfig-ioscustomconfiguration-create.md + - name: Delete iosCustomConfiguration + href: ../../api/intune-deviceconfig-ioscustomconfiguration-delete.md + - name: Update iosCustomConfiguration + href: ../../api/intune-deviceconfig-ioscustomconfiguration-update.md + - name: iOS device features configuration + items: + - name: iOS device features configuration + href: ../../resources/intune-deviceconfig-iosdevicefeaturesconfiguration.md + - name: List iosDeviceFeaturesConfigurations + href: ../../api/intune-deviceconfig-iosdevicefeaturesconfiguration-list.md + - name: Get iosDeviceFeaturesConfiguration + href: ../../api/intune-deviceconfig-iosdevicefeaturesconfiguration-get.md + - name: Create iosDeviceFeaturesConfiguration + href: ../../api/intune-deviceconfig-iosdevicefeaturesconfiguration-create.md + - name: Delete iosDeviceFeaturesConfiguration + href: ../../api/intune-deviceconfig-iosdevicefeaturesconfiguration-delete.md + - name: Update iosDeviceFeaturesConfiguration + href: ../../api/intune-deviceconfig-iosdevicefeaturesconfiguration-update.md + - name: iOS general device configuration + items: + - name: iOS general device configuration + href: ../../resources/intune-deviceconfig-iosgeneraldeviceconfiguration.md + - name: List iosGeneralDeviceConfigurations + href: ../../api/intune-deviceconfig-iosgeneraldeviceconfiguration-list.md + - name: Get iosGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-iosgeneraldeviceconfiguration-get.md + - name: Create iosGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-iosgeneraldeviceconfiguration-create.md + - name: Delete iosGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-iosgeneraldeviceconfiguration-delete.md + - name: Update iosGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-iosgeneraldeviceconfiguration-update.md + - name: iOS update configuration + items: + - name: iOS update configuration + href: ../../resources/intune-deviceconfig-iosupdateconfiguration.md + - name: List iosUpdateConfigurations + href: ../../api/intune-deviceconfig-iosupdateconfiguration-list.md + - name: Get iosUpdateConfiguration + href: ../../api/intune-deviceconfig-iosupdateconfiguration-get.md + - name: Create iosUpdateConfiguration + href: ../../api/intune-deviceconfig-iosupdateconfiguration-create.md + - name: Delete iosUpdateConfiguration + href: ../../api/intune-deviceconfig-iosupdateconfiguration-delete.md + - name: Update iosUpdateConfiguration + href: ../../api/intune-deviceconfig-iosupdateconfiguration-update.md + - name: iOS update device status + items: + - name: iOS update device status + href: ../../resources/intune-deviceconfig-iosupdatedevicestatus.md + - name: List iosUpdateDeviceStatuses + href: ../../api/intune-deviceconfig-iosupdatedevicestatus-list.md + - name: Get iosUpdateDeviceStatus + href: ../../api/intune-deviceconfig-iosupdatedevicestatus-get.md + - name: Create iosUpdateDeviceStatus + href: ../../api/intune-deviceconfig-iosupdatedevicestatus-create.md + - name: Delete iosUpdateDeviceStatus + href: ../../api/intune-deviceconfig-iosupdatedevicestatus-delete.md + - name: Update iosUpdateDeviceStatus + href: ../../api/intune-deviceconfig-iosupdatedevicestatus-update.md + - name: macOS compliance policy + items: + - name: macOS compliance policy + href: ../../resources/intune-deviceconfig-macoscompliancepolicy.md + - name: List macOSCompliancePolicies + href: ../../api/intune-deviceconfig-macoscompliancepolicy-list.md + - name: Get macOSCompliancePolicy + href: ../../api/intune-deviceconfig-macoscompliancepolicy-get.md + - name: Create macOSCompliancePolicy + href: ../../api/intune-deviceconfig-macoscompliancepolicy-create.md + - name: Delete macOSCompliancePolicy + href: ../../api/intune-deviceconfig-macoscompliancepolicy-delete.md + - name: Update macOSCompliancePolicy + href: ../../api/intune-deviceconfig-macoscompliancepolicy-update.md + - name: macOS custom configuration + items: + - name: macOS custom configuration + href: ../../resources/intune-deviceconfig-macoscustomconfiguration.md + - name: List macOSCustomConfigurations + href: ../../api/intune-deviceconfig-macoscustomconfiguration-list.md + - name: Get macOSCustomConfiguration + href: ../../api/intune-deviceconfig-macoscustomconfiguration-get.md + - name: Create macOSCustomConfiguration + href: ../../api/intune-deviceconfig-macoscustomconfiguration-create.md + - name: Delete macOSCustomConfiguration + href: ../../api/intune-deviceconfig-macoscustomconfiguration-delete.md + - name: Update macOSCustomConfiguration + href: ../../api/intune-deviceconfig-macoscustomconfiguration-update.md + - name: macOS device features configuration + items: + - name: macOS device features configuration + href: ../../resources/intune-deviceconfig-macosdevicefeaturesconfiguration.md + - name: List macOSDeviceFeaturesConfigurations + href: ../../api/intune-deviceconfig-macosdevicefeaturesconfiguration-list.md + - name: Get macOSDeviceFeaturesConfiguration + href: ../../api/intune-deviceconfig-macosdevicefeaturesconfiguration-get.md + - name: Create macOSDeviceFeaturesConfiguration + href: ../../api/intune-deviceconfig-macosdevicefeaturesconfiguration-create.md + - name: Delete macOSDeviceFeaturesConfiguration + href: ../../api/intune-deviceconfig-macosdevicefeaturesconfiguration-delete.md + - name: Update macOSDeviceFeaturesConfiguration + href: ../../api/intune-deviceconfig-macosdevicefeaturesconfiguration-update.md + - name: macOS general device configuration + items: + - name: macOS general device configuration + href: ../../resources/intune-deviceconfig-macosgeneraldeviceconfiguration.md + - name: List macOSGeneralDeviceConfigurations + href: ../../api/intune-deviceconfig-macosgeneraldeviceconfiguration-list.md + - name: Get macOSGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-macosgeneraldeviceconfiguration-get.md + - name: Create macOSGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-macosgeneraldeviceconfiguration-create.md + - name: Delete macOSGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-macosgeneraldeviceconfiguration-delete.md + - name: Update macOSGeneralDeviceConfiguration + href: ../../api/intune-deviceconfig-macosgeneraldeviceconfiguration-update.md + - name: Setting state device summary + items: + - name: Setting state device summary + href: ../../resources/intune-deviceconfig-settingstatedevicesummary.md + - name: List settingStateDeviceSummaries + href: ../../api/intune-deviceconfig-settingstatedevicesummary-list.md + - name: Get settingStateDeviceSummary + href: ../../api/intune-deviceconfig-settingstatedevicesummary-get.md + - name: Create settingStateDeviceSummary + href: ../../api/intune-deviceconfig-settingstatedevicesummary-create.md + - name: Delete settingStateDeviceSummary + href: ../../api/intune-deviceconfig-settingstatedevicesummary-delete.md + - name: Update settingStateDeviceSummary + href: ../../api/intune-deviceconfig-settingstatedevicesummary-update.md + - name: Shared PC configuration + items: + - name: Shared PC configuration + href: ../../resources/intune-deviceconfig-sharedpcconfiguration.md + - name: List sharedPCConfigurations + href: ../../api/intune-deviceconfig-sharedpcconfiguration-list.md + - name: Get sharedPCConfiguration + href: ../../api/intune-deviceconfig-sharedpcconfiguration-get.md + - name: Create sharedPCConfiguration + href: ../../api/intune-deviceconfig-sharedpcconfiguration-create.md + - name: Delete sharedPCConfiguration + href: ../../api/intune-deviceconfig-sharedpcconfiguration-delete.md + - name: Update sharedPCConfiguration + href: ../../api/intune-deviceconfig-sharedpcconfiguration-update.md + - name: Software update status summary + items: + - name: Software update status summary + href: ../../resources/intune-deviceconfig-softwareupdatestatussummary.md + - name: Get softwareUpdateStatusSummary + href: ../../api/intune-deviceconfig-softwareupdatestatussummary-get.md + - name: Update softwareUpdateStatusSummary + href: ../../api/intune-deviceconfig-softwareupdatestatussummary-update.md + - name: Windows 10 compliance policy + items: + - name: Windows 10 compliance policy + href: ../../resources/intune-deviceconfig-windows10compliancepolicy.md + - name: List windows10CompliancePolicies + href: ../../api/intune-deviceconfig-windows10compliancepolicy-list.md + - name: Get windows10CompliancePolicy + href: ../../api/intune-deviceconfig-windows10compliancepolicy-get.md + - name: Create windows10CompliancePolicy + href: ../../api/intune-deviceconfig-windows10compliancepolicy-create.md + - name: Delete windows10CompliancePolicy + href: ../../api/intune-deviceconfig-windows10compliancepolicy-delete.md + - name: Update windows10CompliancePolicy + href: ../../api/intune-deviceconfig-windows10compliancepolicy-update.md + - name: Windows 10 custom configuration + items: + - name: Windows 10 custom configuration + href: ../../resources/intune-deviceconfig-windows10customconfiguration.md + - name: List windows10CustomConfigurations + href: ../../api/intune-deviceconfig-windows10customconfiguration-list.md + - name: Get windows10CustomConfiguration + href: ../../api/intune-deviceconfig-windows10customconfiguration-get.md + - name: Create windows10CustomConfiguration + href: ../../api/intune-deviceconfig-windows10customconfiguration-create.md + - name: Delete windows10CustomConfiguration + href: ../../api/intune-deviceconfig-windows10customconfiguration-delete.md + - name: Update windows10CustomConfiguration + href: ../../api/intune-deviceconfig-windows10customconfiguration-update.md + - name: Windows 10 endpoint protection configuration + items: + - name: Windows 10 endpoint protection configuration + href: ../../resources/intune-deviceconfig-windows10endpointprotectionconfiguration.md + - name: List windows10EndpointProtectionConfigurations + href: ../../api/intune-deviceconfig-windows10endpointprotectionconfiguration-list.md + - name: Get windows10EndpointProtectionConfiguration + href: ../../api/intune-deviceconfig-windows10endpointprotectionconfiguration-get.md + - name: Create windows10EndpointProtectionConfiguration + href: ../../api/intune-deviceconfig-windows10endpointprotectionconfiguration-create.md + - name: Delete windows10EndpointProtectionConfiguration + href: ../../api/intune-deviceconfig-windows10endpointprotectionconfiguration-delete.md + - name: Update windows10EndpointProtectionConfiguration + href: ../../api/intune-deviceconfig-windows10endpointprotectionconfiguration-update.md + - name: Windows 10 enterprise modern app management configuration + items: + - name: Windows 10 enterprise modern app management configuration + href: ../../resources/intune-deviceconfig-windows10enterprisemodernappmanagementconfiguration.md + - name: List windows10EnterpriseModernAppManagementConfigurations + href: ../../api/intune-deviceconfig-windows10enterprisemodernappmanagementconfiguration-list.md + - name: Get windows10EnterpriseModernAppManagementConfiguration + href: ../../api/intune-deviceconfig-windows10enterprisemodernappmanagementconfiguration-get.md + - name: Create windows10EnterpriseModernAppManagementConfiguration + href: ../../api/intune-deviceconfig-windows10enterprisemodernappmanagementconfiguration-create.md + - name: Delete windows10EnterpriseModernAppManagementConfiguration + href: ../../api/intune-deviceconfig-windows10enterprisemodernappmanagementconfiguration-delete.md + - name: Update windows10EnterpriseModernAppManagementConfiguration + href: ../../api/intune-deviceconfig-windows10enterprisemodernappmanagementconfiguration-update.md + - name: Windows 10 general configuration + items: + - name: Windows 10 general configuration + href: ../../resources/intune-deviceconfig-windows10generalconfiguration.md + - name: List windows10GeneralConfigurations + href: ../../api/intune-deviceconfig-windows10generalconfiguration-list.md + - name: Get windows10GeneralConfiguration + href: ../../api/intune-deviceconfig-windows10generalconfiguration-get.md + - name: Create windows10GeneralConfiguration + href: ../../api/intune-deviceconfig-windows10generalconfiguration-create.md + - name: Delete windows10GeneralConfiguration + href: ../../api/intune-deviceconfig-windows10generalconfiguration-delete.md + - name: Update windows10GeneralConfiguration + href: ../../api/intune-deviceconfig-windows10generalconfiguration-update.md + - name: Windows 10 mobile compliance policy + items: + - name: Windows 10 mobile compliance policy + href: ../../resources/intune-deviceconfig-windows10mobilecompliancepolicy.md + - name: List windows10MobileCompliancePolicies + href: ../../api/intune-deviceconfig-windows10mobilecompliancepolicy-list.md + - name: Get windows10MobileCompliancePolicy + href: ../../api/intune-deviceconfig-windows10mobilecompliancepolicy-get.md + - name: Create windows10MobileCompliancePolicy + href: ../../api/intune-deviceconfig-windows10mobilecompliancepolicy-create.md + - name: Delete windows10MobileCompliancePolicy + href: ../../api/intune-deviceconfig-windows10mobilecompliancepolicy-delete.md + - name: Update windows10MobileCompliancePolicy + href: ../../api/intune-deviceconfig-windows10mobilecompliancepolicy-update.md + - name: Windows 10 secure assessment configuration + items: + - name: Windows 10 secure assessment configuration + href: ../../resources/intune-deviceconfig-windows10secureassessmentconfiguration.md + - name: List windows10SecureAssessmentConfigurations + href: ../../api/intune-deviceconfig-windows10secureassessmentconfiguration-list.md + - name: Get windows10SecureAssessmentConfiguration + href: ../../api/intune-deviceconfig-windows10secureassessmentconfiguration-get.md + - name: Create windows10SecureAssessmentConfiguration + href: ../../api/intune-deviceconfig-windows10secureassessmentconfiguration-create.md + - name: Delete windows10SecureAssessmentConfiguration + href: ../../api/intune-deviceconfig-windows10secureassessmentconfiguration-delete.md + - name: Update windows10SecureAssessmentConfiguration + href: ../../api/intune-deviceconfig-windows10secureassessmentconfiguration-update.md + - name: Windows 10 team general configuration + items: + - name: Windows 10 team general configuration + href: ../../resources/intune-deviceconfig-windows10teamgeneralconfiguration.md + - name: List windows10TeamGeneralConfigurations + href: ../../api/intune-deviceconfig-windows10teamgeneralconfiguration-list.md + - name: Get windows10TeamGeneralConfiguration + href: ../../api/intune-deviceconfig-windows10teamgeneralconfiguration-get.md + - name: Create windows10TeamGeneralConfiguration + href: ../../api/intune-deviceconfig-windows10teamgeneralconfiguration-create.md + - name: Delete windows10TeamGeneralConfiguration + href: ../../api/intune-deviceconfig-windows10teamgeneralconfiguration-delete.md + - name: Update windows10TeamGeneralConfiguration + href: ../../api/intune-deviceconfig-windows10teamgeneralconfiguration-update.md + - name: Windows 8.1 compliance policy + items: + - name: Windows 8.1 compliance policy + href: ../../resources/intune-deviceconfig-windows81compliancepolicy.md + - name: List windows81CompliancePolicies + href: ../../api/intune-deviceconfig-windows81compliancepolicy-list.md + - name: Get windows81CompliancePolicy + href: ../../api/intune-deviceconfig-windows81compliancepolicy-get.md + - name: Create windows81CompliancePolicy + href: ../../api/intune-deviceconfig-windows81compliancepolicy-create.md + - name: Delete windows81CompliancePolicy + href: ../../api/intune-deviceconfig-windows81compliancepolicy-delete.md + - name: Update windows81CompliancePolicy + href: ../../api/intune-deviceconfig-windows81compliancepolicy-update.md + - name: Windows 8.1 general configuration + items: + - name: Windows 8.1 general configuration + href: ../../resources/intune-deviceconfig-windows81generalconfiguration.md + - name: List windows81GeneralConfigurations + href: ../../api/intune-deviceconfig-windows81generalconfiguration-list.md + - name: Get windows81GeneralConfiguration + href: ../../api/intune-deviceconfig-windows81generalconfiguration-get.md + - name: Create windows81GeneralConfiguration + href: ../../api/intune-deviceconfig-windows81generalconfiguration-create.md + - name: Delete windows81GeneralConfiguration + href: ../../api/intune-deviceconfig-windows81generalconfiguration-delete.md + - name: Update windows81GeneralConfiguration + href: ../../api/intune-deviceconfig-windows81generalconfiguration-update.md + - name: Windows Defender Advanced Threat Protection configuration + items: + - name: Windows Defender Advanced Threat Protection configuration + href: ../../resources/intune-deviceconfig-windowsdefenderadvancedthreatprotectionconfiguration.md + - name: List windowsDefenderAdvancedThreatProtectionConfigurations + href: ../../api/intune-deviceconfig-windowsdefenderadvancedthreatprotectionconfiguration-list.md + - name: Get windowsDefenderAdvancedThreatProtectionConfiguration + href: ../../api/intune-deviceconfig-windowsdefenderadvancedthreatprotectionconfiguration-get.md + - name: Create windowsDefenderAdvancedThreatProtectionConfiguration + href: ../../api/intune-deviceconfig-windowsdefenderadvancedthreatprotectionconfiguration-create.md + - name: Delete windowsDefenderAdvancedThreatProtectionConfiguration + href: ../../api/intune-deviceconfig-windowsdefenderadvancedthreatprotectionconfiguration-delete.md + - name: Update windowsDefenderAdvancedThreatProtectionConfiguration + href: ../../api/intune-deviceconfig-windowsdefenderadvancedthreatprotectionconfiguration-update.md + - name: Windows Phone 8.1 compliance policy + items: + - name: Windows Phone 8.1 compliance policy + href: ../../resources/intune-deviceconfig-windowsphone81compliancepolicy.md + - name: List windowsPhone81CompliancePolicies + href: ../../api/intune-deviceconfig-windowsphone81compliancepolicy-list.md + - name: Get windowsPhone81CompliancePolicy + href: ../../api/intune-deviceconfig-windowsphone81compliancepolicy-get.md + - name: Create windowsPhone81CompliancePolicy + href: ../../api/intune-deviceconfig-windowsphone81compliancepolicy-create.md + - name: Delete windowsPhone81CompliancePolicy + href: ../../api/intune-deviceconfig-windowsphone81compliancepolicy-delete.md + - name: Update windowsPhone81CompliancePolicy + href: ../../api/intune-deviceconfig-windowsphone81compliancepolicy-update.md + - name: Windows Phone 8.1 custom configuration + items: + - name: Windows Phone 8.1 custom configuration + href: ../../resources/intune-deviceconfig-windowsphone81customconfiguration.md + - name: List windowsPhone81CustomConfigurations + href: ../../api/intune-deviceconfig-windowsphone81customconfiguration-list.md + - name: Get windowsPhone81CustomConfiguration + href: ../../api/intune-deviceconfig-windowsphone81customconfiguration-get.md + - name: Create windowsPhone81CustomConfiguration + href: ../../api/intune-deviceconfig-windowsphone81customconfiguration-create.md + - name: Delete windowsPhone81CustomConfiguration + href: ../../api/intune-deviceconfig-windowsphone81customconfiguration-delete.md + - name: Update windowsPhone81CustomConfiguration + href: ../../api/intune-deviceconfig-windowsphone81customconfiguration-update.md + - name: Windows Phone 8.1 general configuration + items: + - name: Windows Phone 8.1 general configuration + href: ../../resources/intune-deviceconfig-windowsphone81generalconfiguration.md + - name: List windowsPhone81GeneralConfigurations + href: ../../api/intune-deviceconfig-windowsphone81generalconfiguration-list.md + - name: Get windowsPhone81GeneralConfiguration + href: ../../api/intune-deviceconfig-windowsphone81generalconfiguration-get.md + - name: Create windowsPhone81GeneralConfiguration + href: ../../api/intune-deviceconfig-windowsphone81generalconfiguration-create.md + - name: Delete windowsPhone81GeneralConfiguration + href: ../../api/intune-deviceconfig-windowsphone81generalconfiguration-delete.md + - name: Update windowsPhone81GeneralConfiguration + href: ../../api/intune-deviceconfig-windowsphone81generalconfiguration-update.md + - name: Windows Update for Business configuration + items: + - name: Windows Update for Business configuration + href: ../../resources/intune-deviceconfig-windowsupdateforbusinessconfiguration.md + - name: List windowsUpdateForBusinessConfigurations + href: ../../api/intune-deviceconfig-windowsupdateforbusinessconfiguration-list.md + - name: Get windowsUpdateForBusinessConfiguration + href: ../../api/intune-deviceconfig-windowsupdateforbusinessconfiguration-get.md + - name: Create windowsUpdateForBusinessConfiguration + href: ../../api/intune-deviceconfig-windowsupdateforbusinessconfiguration-create.md + - name: Delete windowsUpdateForBusinessConfiguration + href: ../../api/intune-deviceconfig-windowsupdateforbusinessconfiguration-delete.md + - name: Update windowsUpdateForBusinessConfiguration + href: ../../api/intune-deviceconfig-windowsupdateforbusinessconfiguration-update.md + - name: Complex types + items: + - name: All devices assignment target + href: ../../resources/intune-shared-alldevicesassignmenttarget.md + - name: All licensed users assignment target + href: ../../resources/intune-shared-alllicensedusersassignmenttarget.md + - name: App list item + href: ../../resources/intune-deviceconfig-applistitem.md + - name: Bit locker removable drive policy + href: ../../resources/intune-deviceconfig-bitlockerremovabledrivepolicy.md + - name: Configuration manager collection assignment target + href: ../../resources/intune-shared-configurationmanagercollectionassignmenttarget.md + - name: Defender detected malware actions + href: ../../resources/intune-deviceconfig-defenderdetectedmalwareactions.md + - name: Device and app management assignment target + href: ../../resources/intune-shared-deviceandappmanagementassignmenttarget.md + - name: Device compliance policy setting state + href: ../../resources/intune-deviceconfig-devicecompliancepolicysettingstate.md + - name: Device configuration setting state + href: ../../resources/intune-deviceconfig-deviceconfigurationsettingstate.md + - name: Device management settings + href: ../../resources/intune-deviceconfig-devicemanagementsettings.md + - name: Edge search engine + href: ../../resources/intune-deviceconfig-edgesearchengine.md + - name: Edge search engine base + href: ../../resources/intune-deviceconfig-edgesearchenginebase.md + - name: Edge search engine custom + href: ../../resources/intune-deviceconfig-edgesearchenginecustom.md + - name: Exclusion group assignment target + href: ../../resources/intune-shared-exclusiongroupassignmenttarget.md + - name: Group assignment target + href: ../../resources/intune-shared-groupassignmenttarget.md + - name: iOS home screen app + href: ../../resources/intune-deviceconfig-ioshomescreenapp.md + - name: iOS home screen folder + href: ../../resources/intune-deviceconfig-ioshomescreenfolder.md + - name: iOS home screen folder page + href: ../../resources/intune-deviceconfig-ioshomescreenfolderpage.md + - name: iOS home screen item + href: ../../resources/intune-deviceconfig-ioshomescreenitem.md + - name: iOS home screen page + href: ../../resources/intune-deviceconfig-ioshomescreenpage.md + - name: iOS network usage rule + href: ../../resources/intune-deviceconfig-iosnetworkusagerule.md + - name: iOS notification settings + href: ../../resources/intune-deviceconfig-iosnotificationsettings.md + - name: Media content rating australia + href: ../../resources/intune-deviceconfig-mediacontentratingaustralia.md + - name: Media content rating canada + href: ../../resources/intune-deviceconfig-mediacontentratingcanada.md + - name: Media content rating france + href: ../../resources/intune-deviceconfig-mediacontentratingfrance.md + - name: Media content rating germany + href: ../../resources/intune-deviceconfig-mediacontentratinggermany.md + - name: Media content rating ireland + href: ../../resources/intune-deviceconfig-mediacontentratingireland.md + - name: Media content rating japan + href: ../../resources/intune-deviceconfig-mediacontentratingjapan.md + - name: Media content rating new zealand + href: ../../resources/intune-deviceconfig-mediacontentratingnewzealand.md + - name: Media content rating united kingdom + href: ../../resources/intune-deviceconfig-mediacontentratingunitedkingdom.md + - name: Media content rating united states + href: ../../resources/intune-deviceconfig-mediacontentratingunitedstates.md + - name: OMA setting + href: ../../resources/intune-deviceconfig-omasetting.md + - name: OMA setting base 64 + href: ../../resources/intune-deviceconfig-omasettingbase64.md + - name: OMA setting boolean + href: ../../resources/intune-deviceconfig-omasettingboolean.md + - name: OMA setting date time + href: ../../resources/intune-deviceconfig-omasettingdatetime.md + - name: OMA setting floating point + href: ../../resources/intune-deviceconfig-omasettingfloatingpoint.md + - name: OMA setting integer + href: ../../resources/intune-deviceconfig-omasettinginteger.md + - name: OMA setting string + href: ../../resources/intune-deviceconfig-omasettingstring.md + - name: OMA setting string xml + href: ../../resources/intune-deviceconfig-omasettingstringxml.md + - name: Setting source + href: ../../resources/intune-deviceconfig-settingsource.md + - name: Shared PC account manager policy + href: ../../resources/intune-deviceconfig-sharedpcaccountmanagerpolicy.md + - name: Windows 10 network proxy server + href: ../../resources/intune-deviceconfig-windows10networkproxyserver.md + - name: Windows firewall network profile + href: ../../resources/intune-deviceconfig-windowsfirewallnetworkprofile.md + - name: Windows Update active hours install + href: ../../resources/intune-deviceconfig-windowsupdateactivehoursinstall.md + - name: Windows Update install schedule type + href: ../../resources/intune-deviceconfig-windowsupdateinstallscheduletype.md + - name: Windows Update scheduled install + href: ../../resources/intune-deviceconfig-windowsupdatescheduledinstall.md + - name: Device management + items: + - name: Overview + href: ../../resources/intune-device-mgt-conceptual.md + - name: App log collection request + items: + - name: App log collection request + href: ../../resources/intune-devices-applogcollectionrequest.md + - name: List appLogCollectionRequests + href: ../../api/intune-devices-applogcollectionrequest-list.md + - name: Get appLogCollectionRequest + href: ../../api/intune-devices-applogcollectionrequest-get.md + - name: Create appLogCollectionRequest + href: ../../api/intune-devices-applogcollectionrequest-create.md + - name: Delete appLogCollectionRequest + href: ../../api/intune-devices-applogcollectionrequest-delete.md + - name: Update appLogCollectionRequest + href: ../../api/intune-devices-applogcollectionrequest-update.md + - name: createDownloadUrl action + href: ../../api/intune-devices-applogcollectionrequest-createdownloadurl.md + - name: Apple push notification certificate + items: + - name: Apple push notification certificate + href: ../../resources/intune-devices-applepushnotificationcertificate.md + - name: Get applePushNotificationCertificate + href: ../../api/intune-devices-applepushnotificationcertificate-get.md + - name: Update applePushNotificationCertificate + href: ../../api/intune-devices-applepushnotificationcertificate-update.md + - name: downloadApplePushNotificationCertificateSigningRequest function + href: ../../api/intune-devices-applepushnotificationcertificate-downloadapplepushnotificationcertificatesigningrequest.md + - name: Detected app + items: + - name: Detected app + href: ../../resources/intune-devices-detectedapp.md + - name: List detectedApps + href: ../../api/intune-devices-detectedapp-list.md + - name: Get detectedApp + href: ../../api/intune-devices-detectedapp-get.md + - name: Create detectedApp + href: ../../api/intune-devices-detectedapp-create.md + - name: Delete detectedApp + href: ../../api/intune-devices-detectedapp-delete.md + - name: Update detectedApp + href: ../../api/intune-devices-detectedapp-update.md + - name: Device log collection response + items: + - name: Device log collection response + href: ../../resources/intune-devices-devicelogcollectionresponse.md + - name: List deviceLogCollectionResponses + href: ../../api/intune-devices-devicelogcollectionresponse-list.md + - name: Get deviceLogCollectionResponse + href: ../../api/intune-devices-devicelogcollectionresponse-get.md + - name: Create deviceLogCollectionResponse + href: ../../api/intune-devices-devicelogcollectionresponse-create.md + - name: Delete deviceLogCollectionResponse + href: ../../api/intune-devices-devicelogcollectionresponse-delete.md + - name: Update deviceLogCollectionResponse + href: ../../api/intune-devices-devicelogcollectionresponse-update.md + - name: createDownloadUrl action + href: ../../api/intune-devices-devicelogcollectionresponse-createdownloadurl.md + - name: Malware state for windows device + items: + - name: Malware state for windows device + href: ../../resources/intune-devices-malwarestateforwindowsdevice.md + - name: List malwareStateForWindowsDevices + href: ../../api/intune-devices-malwarestateforwindowsdevice-list.md + - name: Get malwareStateForWindowsDevice + href: ../../api/intune-devices-malwarestateforwindowsdevice-get.md + - name: Create malwareStateForWindowsDevice + href: ../../api/intune-devices-malwarestateforwindowsdevice-create.md + - name: Delete malwareStateForWindowsDevice + href: ../../api/intune-devices-malwarestateforwindowsdevice-delete.md + - name: Update malwareStateForWindowsDevice + href: ../../api/intune-devices-malwarestateforwindowsdevice-update.md + - name: Managed device + items: + - name: Managed device + href: ../../resources/intune-devices-manageddevice.md + - name: List managedDevices + href: ../../api/intune-devices-manageddevice-list.md + - name: Get managedDevice + href: ../../api/intune-devices-manageddevice-get.md + - name: Create managedDevice + href: ../../api/intune-devices-manageddevice-create.md + - name: Delete managedDevice + href: ../../api/intune-devices-manageddevice-delete.md + - name: Update managedDevice + href: ../../api/intune-devices-manageddevice-update.md + - name: Managed device overview + items: + - name: Managed device overview + href: ../../resources/intune-devices-manageddeviceoverview.md + - name: Get managedDeviceOverview + href: ../../api/intune-devices-manageddeviceoverview-get.md + - name: Update managedDeviceOverview + href: ../../api/intune-devices-manageddeviceoverview-update.md + - name: Mobile app troubleshooting event + items: + - name: Mobile app troubleshooting event + href: ../../resources/intune-devices-mobileapptroubleshootingevent.md + - name: List mobileAppTroubleshootingEvents + href: ../../api/intune-devices-mobileapptroubleshootingevent-list.md + - name: Get mobileAppTroubleshootingEvent + href: ../../api/intune-devices-mobileapptroubleshootingevent-get.md + - name: Create mobileAppTroubleshootingEvent + href: ../../api/intune-devices-mobileapptroubleshootingevent-create.md + - name: Delete mobileAppTroubleshootingEvent + href: ../../api/intune-devices-mobileapptroubleshootingevent-delete.md + - name: Update mobileAppTroubleshootingEvent + href: ../../api/intune-devices-mobileapptroubleshootingevent-update.md + - name: User experience analytics app health app performance by app version details + items: + - name: User experience analytics app health app performance by app version details + href: ../../resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondetails.md + - name: List userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetailses + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondetails-list.md + - name: Get userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondetails-get.md + - name: Create userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondetails-create.md + - name: Delete userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondetails-delete.md + - name: Update userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondetails-update.md + - name: User experience analytics app health app performance by app version device id + items: + - name: User experience analytics app health app performance by app version device id + href: ../../resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondeviceid.md + - name: List userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceIds + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondeviceid-list.md + - name: Get userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondeviceid-get.md + - name: Create userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondeviceid-create.md + - name: Delete userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondeviceid-delete.md + - name: Update userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondeviceid-update.md + - name: User experience analytics app health app performance by OS version + items: + - name: User experience analytics app health app performance by OS version + href: ../../resources/intune-devices-userexperienceanalyticsapphealthappperformancebyosversion.md + - name: List userExperienceAnalyticsAppHealthAppPerformanceByOSVersions + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyosversion-list.md + - name: Get userExperienceAnalyticsAppHealthAppPerformanceByOSVersion + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyosversion-get.md + - name: Create userExperienceAnalyticsAppHealthAppPerformanceByOSVersion + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyosversion-create.md + - name: Delete userExperienceAnalyticsAppHealthAppPerformanceByOSVersion + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyosversion-delete.md + - name: Update userExperienceAnalyticsAppHealthAppPerformanceByOSVersion + href: ../../api/intune-devices-userexperienceanalyticsapphealthappperformancebyosversion-update.md + - name: User experience analytics app health application performance + items: + - name: User experience analytics app health application performance + href: ../../resources/intune-devices-userexperienceanalyticsapphealthapplicationperformance.md + - name: List userExperienceAnalyticsAppHealthApplicationPerformances + href: ../../api/intune-devices-userexperienceanalyticsapphealthapplicationperformance-list.md + - name: Get userExperienceAnalyticsAppHealthApplicationPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthapplicationperformance-get.md + - name: Create userExperienceAnalyticsAppHealthApplicationPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthapplicationperformance-create.md + - name: Delete userExperienceAnalyticsAppHealthApplicationPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthapplicationperformance-delete.md + - name: Update userExperienceAnalyticsAppHealthApplicationPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthapplicationperformance-update.md + - name: User experience analytics app health device model performance + items: + - name: User experience analytics app health device model performance + href: ../../resources/intune-devices-userexperienceanalyticsapphealthdevicemodelperformance.md + - name: List userExperienceAnalyticsAppHealthDeviceModelPerformances + href: ../../api/intune-devices-userexperienceanalyticsapphealthdevicemodelperformance-list.md + - name: Get userExperienceAnalyticsAppHealthDeviceModelPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthdevicemodelperformance-get.md + - name: Create userExperienceAnalyticsAppHealthDeviceModelPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthdevicemodelperformance-create.md + - name: Delete userExperienceAnalyticsAppHealthDeviceModelPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthdevicemodelperformance-delete.md + - name: Update userExperienceAnalyticsAppHealthDeviceModelPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthdevicemodelperformance-update.md + - name: User experience analytics app health device performance + items: + - name: User experience analytics app health device performance + href: ../../resources/intune-devices-userexperienceanalyticsapphealthdeviceperformance.md + - name: List userExperienceAnalyticsAppHealthDevicePerformances + href: ../../api/intune-devices-userexperienceanalyticsapphealthdeviceperformance-list.md + - name: Get userExperienceAnalyticsAppHealthDevicePerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthdeviceperformance-get.md + - name: Create userExperienceAnalyticsAppHealthDevicePerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthdeviceperformance-create.md + - name: Delete userExperienceAnalyticsAppHealthDevicePerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthdeviceperformance-delete.md + - name: Update userExperienceAnalyticsAppHealthDevicePerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthdeviceperformance-update.md + - name: User experience analytics app health device performance details + items: + - name: User experience analytics app health device performance details + href: ../../resources/intune-devices-userexperienceanalyticsapphealthdeviceperformancedetails.md + - name: List userExperienceAnalyticsAppHealthDevicePerformanceDetailses + href: ../../api/intune-devices-userexperienceanalyticsapphealthdeviceperformancedetails-list.md + - name: Get userExperienceAnalyticsAppHealthDevicePerformanceDetails + href: ../../api/intune-devices-userexperienceanalyticsapphealthdeviceperformancedetails-get.md + - name: Create userExperienceAnalyticsAppHealthDevicePerformanceDetails + href: ../../api/intune-devices-userexperienceanalyticsapphealthdeviceperformancedetails-create.md + - name: Delete userExperienceAnalyticsAppHealthDevicePerformanceDetails + href: ../../api/intune-devices-userexperienceanalyticsapphealthdeviceperformancedetails-delete.md + - name: Update userExperienceAnalyticsAppHealthDevicePerformanceDetails + href: ../../api/intune-devices-userexperienceanalyticsapphealthdeviceperformancedetails-update.md + - name: User experience analytics app health OS version performance + items: + - name: User experience analytics app health OS version performance + href: ../../resources/intune-devices-userexperienceanalyticsapphealthosversionperformance.md + - name: List userExperienceAnalyticsAppHealthOSVersionPerformances + href: ../../api/intune-devices-userexperienceanalyticsapphealthosversionperformance-list.md + - name: Get userExperienceAnalyticsAppHealthOSVersionPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthosversionperformance-get.md + - name: Create userExperienceAnalyticsAppHealthOSVersionPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthosversionperformance-create.md + - name: Delete userExperienceAnalyticsAppHealthOSVersionPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthosversionperformance-delete.md + - name: Update userExperienceAnalyticsAppHealthOSVersionPerformance + href: ../../api/intune-devices-userexperienceanalyticsapphealthosversionperformance-update.md + - name: User experience analytics baseline + items: + - name: User experience analytics baseline + href: ../../resources/intune-devices-userexperienceanalyticsbaseline.md + - name: List userExperienceAnalyticsBaselines + href: ../../api/intune-devices-userexperienceanalyticsbaseline-list.md + - name: Get userExperienceAnalyticsBaseline + href: ../../api/intune-devices-userexperienceanalyticsbaseline-get.md + - name: Create userExperienceAnalyticsBaseline + href: ../../api/intune-devices-userexperienceanalyticsbaseline-create.md + - name: Delete userExperienceAnalyticsBaseline + href: ../../api/intune-devices-userexperienceanalyticsbaseline-delete.md + - name: Update userExperienceAnalyticsBaseline + href: ../../api/intune-devices-userexperienceanalyticsbaseline-update.md + - name: User experience analytics category + items: + - name: User experience analytics category + href: ../../resources/intune-devices-userexperienceanalyticscategory.md + - name: Get userExperienceAnalyticsCategory + href: ../../api/intune-devices-userexperienceanalyticscategory-get.md + - name: Update userExperienceAnalyticsCategory + href: ../../api/intune-devices-userexperienceanalyticscategory-update.md + - name: User experience analytics device performance + items: + - name: User experience analytics device performance + href: ../../resources/intune-devices-userexperienceanalyticsdeviceperformance.md + - name: List userExperienceAnalyticsDevicePerformances + href: ../../api/intune-devices-userexperienceanalyticsdeviceperformance-list.md + - name: Get userExperienceAnalyticsDevicePerformance + href: ../../api/intune-devices-userexperienceanalyticsdeviceperformance-get.md + - name: Create userExperienceAnalyticsDevicePerformance + href: ../../api/intune-devices-userexperienceanalyticsdeviceperformance-create.md + - name: Delete userExperienceAnalyticsDevicePerformance + href: ../../api/intune-devices-userexperienceanalyticsdeviceperformance-delete.md + - name: Update userExperienceAnalyticsDevicePerformance + href: ../../api/intune-devices-userexperienceanalyticsdeviceperformance-update.md + - name: summarizeDevicePerformanceDevices function + href: ../../api/intune-devices-userexperienceanalyticsdeviceperformance-summarizedeviceperformancedevices.md + - name: User experience analytics device scores + items: + - name: User experience analytics device scores + href: ../../resources/intune-devices-userexperienceanalyticsdevicescores.md + - name: List userExperienceAnalyticsDeviceScoreses + href: ../../api/intune-devices-userexperienceanalyticsdevicescores-list.md + - name: Get userExperienceAnalyticsDeviceScores + href: ../../api/intune-devices-userexperienceanalyticsdevicescores-get.md + - name: Create userExperienceAnalyticsDeviceScores + href: ../../api/intune-devices-userexperienceanalyticsdevicescores-create.md + - name: Delete userExperienceAnalyticsDeviceScores + href: ../../api/intune-devices-userexperienceanalyticsdevicescores-delete.md + - name: Update userExperienceAnalyticsDeviceScores + href: ../../api/intune-devices-userexperienceanalyticsdevicescores-update.md + - name: User experience analytics device startup history + items: + - name: User experience analytics device startup history + href: ../../resources/intune-devices-userexperienceanalyticsdevicestartuphistory.md + - name: List userExperienceAnalyticsDeviceStartupHistories + href: ../../api/intune-devices-userexperienceanalyticsdevicestartuphistory-list.md + - name: Get userExperienceAnalyticsDeviceStartupHistory + href: ../../api/intune-devices-userexperienceanalyticsdevicestartuphistory-get.md + - name: Create userExperienceAnalyticsDeviceStartupHistory + href: ../../api/intune-devices-userexperienceanalyticsdevicestartuphistory-create.md + - name: Delete userExperienceAnalyticsDeviceStartupHistory + href: ../../api/intune-devices-userexperienceanalyticsdevicestartuphistory-delete.md + - name: Update userExperienceAnalyticsDeviceStartupHistory + href: ../../api/intune-devices-userexperienceanalyticsdevicestartuphistory-update.md + - name: User experience analytics device startup process + items: + - name: User experience analytics device startup process + href: ../../resources/intune-devices-userexperienceanalyticsdevicestartupprocess.md + - name: List userExperienceAnalyticsDeviceStartupProcesses + href: ../../api/intune-devices-userexperienceanalyticsdevicestartupprocess-list.md + - name: Get userExperienceAnalyticsDeviceStartupProcess + href: ../../api/intune-devices-userexperienceanalyticsdevicestartupprocess-get.md + - name: Create userExperienceAnalyticsDeviceStartupProcess + href: ../../api/intune-devices-userexperienceanalyticsdevicestartupprocess-create.md + - name: Delete userExperienceAnalyticsDeviceStartupProcess + href: ../../api/intune-devices-userexperienceanalyticsdevicestartupprocess-delete.md + - name: Update userExperienceAnalyticsDeviceStartupProcess + href: ../../api/intune-devices-userexperienceanalyticsdevicestartupprocess-update.md + - name: User experience analytics metric + items: + - name: User experience analytics metric + href: ../../resources/intune-devices-userexperienceanalyticsmetric.md + - name: List userExperienceAnalyticsMetrics + href: ../../api/intune-devices-userexperienceanalyticsmetric-list.md + - name: Get userExperienceAnalyticsMetric + href: ../../api/intune-devices-userexperienceanalyticsmetric-get.md + - name: Create userExperienceAnalyticsMetric + href: ../../api/intune-devices-userexperienceanalyticsmetric-create.md + - name: Delete userExperienceAnalyticsMetric + href: ../../api/intune-devices-userexperienceanalyticsmetric-delete.md + - name: Update userExperienceAnalyticsMetric + href: ../../api/intune-devices-userexperienceanalyticsmetric-update.md + - name: User experience analytics metric history + items: + - name: User experience analytics metric history + href: ../../resources/intune-devices-userexperienceanalyticsmetrichistory.md + - name: List userExperienceAnalyticsMetricHistories + href: ../../api/intune-devices-userexperienceanalyticsmetrichistory-list.md + - name: Get userExperienceAnalyticsMetricHistory + href: ../../api/intune-devices-userexperienceanalyticsmetrichistory-get.md + - name: Create userExperienceAnalyticsMetricHistory + href: ../../api/intune-devices-userexperienceanalyticsmetrichistory-create.md + - name: Delete userExperienceAnalyticsMetricHistory + href: ../../api/intune-devices-userexperienceanalyticsmetrichistory-delete.md + - name: Update userExperienceAnalyticsMetricHistory + href: ../../api/intune-devices-userexperienceanalyticsmetrichistory-update.md + - name: User experience analytics model scores + items: + - name: User experience analytics model scores + href: ../../resources/intune-devices-userexperienceanalyticsmodelscores.md + - name: List userExperienceAnalyticsModelScoreses + href: ../../api/intune-devices-userexperienceanalyticsmodelscores-list.md + - name: Get userExperienceAnalyticsModelScores + href: ../../api/intune-devices-userexperienceanalyticsmodelscores-get.md + - name: Create userExperienceAnalyticsModelScores + href: ../../api/intune-devices-userexperienceanalyticsmodelscores-create.md + - name: Delete userExperienceAnalyticsModelScores + href: ../../api/intune-devices-userexperienceanalyticsmodelscores-delete.md + - name: Update userExperienceAnalyticsModelScores + href: ../../api/intune-devices-userexperienceanalyticsmodelscores-update.md + - name: User experience analytics overview + items: + - name: User experience analytics overview + href: ../../resources/intune-devices-userexperienceanalyticsoverview.md + - name: Get userExperienceAnalyticsOverview + href: ../../api/intune-devices-userexperienceanalyticsoverview-get.md + - name: Update userExperienceAnalyticsOverview + href: ../../api/intune-devices-userexperienceanalyticsoverview-update.md + - name: User experience analytics score history + items: + - name: User experience analytics score history + href: ../../resources/intune-devices-userexperienceanalyticsscorehistory.md + - name: List userExperienceAnalyticsScoreHistories + href: ../../api/intune-devices-userexperienceanalyticsscorehistory-list.md + - name: Get userExperienceAnalyticsScoreHistory + href: ../../api/intune-devices-userexperienceanalyticsscorehistory-get.md + - name: Create userExperienceAnalyticsScoreHistory + href: ../../api/intune-devices-userexperienceanalyticsscorehistory-create.md + - name: Delete userExperienceAnalyticsScoreHistory + href: ../../api/intune-devices-userexperienceanalyticsscorehistory-delete.md + - name: Update userExperienceAnalyticsScoreHistory + href: ../../api/intune-devices-userexperienceanalyticsscorehistory-update.md + - name: User experience analytics work from anywhere device + items: + - name: User experience analytics work from anywhere device + href: ../../resources/intune-devices-userexperienceanalyticsworkfromanywheredevice.md + - name: List userExperienceAnalyticsWorkFromAnywhereDevices + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheredevice-list.md + - name: Get userExperienceAnalyticsWorkFromAnywhereDevice + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheredevice-get.md + - name: Create userExperienceAnalyticsWorkFromAnywhereDevice + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheredevice-create.md + - name: Delete userExperienceAnalyticsWorkFromAnywhereDevice + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheredevice-delete.md + - name: Update userExperienceAnalyticsWorkFromAnywhereDevice + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheredevice-update.md + - name: User experience analytics work from anywhere hardware readiness metric + items: + - name: User experience analytics work from anywhere hardware readiness metric + href: ../../resources/intune-devices-userexperienceanalyticsworkfromanywherehardwarereadinessmetric.md + - name: Get userExperienceAnalyticsWorkFromAnywhereHardwareReadinessMetric + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywherehardwarereadinessmetric-get.md + - name: Update userExperienceAnalyticsWorkFromAnywhereHardwareReadinessMetric + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywherehardwarereadinessmetric-update.md + - name: User experience analytics work from anywhere metric + items: + - name: User experience analytics work from anywhere metric + href: ../../resources/intune-devices-userexperienceanalyticsworkfromanywheremetric.md + - name: List userExperienceAnalyticsWorkFromAnywhereMetrics + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheremetric-list.md + - name: Get userExperienceAnalyticsWorkFromAnywhereMetric + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheremetric-get.md + - name: Create userExperienceAnalyticsWorkFromAnywhereMetric + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheremetric-create.md + - name: Delete userExperienceAnalyticsWorkFromAnywhereMetric + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheremetric-delete.md + - name: Update userExperienceAnalyticsWorkFromAnywhereMetric + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheremetric-update.md + - name: User experience analytics work from anywhere model performance + items: + - name: User experience analytics work from anywhere model performance + href: ../../resources/intune-devices-userexperienceanalyticsworkfromanywheremodelperformance.md + - name: List userExperienceAnalyticsWorkFromAnywhereModelPerformances + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheremodelperformance-list.md + - name: Get userExperienceAnalyticsWorkFromAnywhereModelPerformance + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheremodelperformance-get.md + - name: Create userExperienceAnalyticsWorkFromAnywhereModelPerformance + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheremodelperformance-create.md + - name: Delete userExperienceAnalyticsWorkFromAnywhereModelPerformance + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheremodelperformance-delete.md + - name: Update userExperienceAnalyticsWorkFromAnywhereModelPerformance + href: ../../api/intune-devices-userexperienceanalyticsworkfromanywheremodelperformance-update.md + - name: Windows device malware state + items: + - name: Windows device malware state + href: ../../resources/intune-devices-windowsdevicemalwarestate.md + - name: List windowsDeviceMalwareStates + href: ../../api/intune-devices-windowsdevicemalwarestate-list.md + - name: Get windowsDeviceMalwareState + href: ../../api/intune-devices-windowsdevicemalwarestate-get.md + - name: Create windowsDeviceMalwareState + href: ../../api/intune-devices-windowsdevicemalwarestate-create.md + - name: Delete windowsDeviceMalwareState + href: ../../api/intune-devices-windowsdevicemalwarestate-delete.md + - name: Update windowsDeviceMalwareState + href: ../../api/intune-devices-windowsdevicemalwarestate-update.md + - name: Windows malware information + items: + - name: Windows malware information + href: ../../resources/intune-devices-windowsmalwareinformation.md + - name: List windowsMalwareInformations + href: ../../api/intune-devices-windowsmalwareinformation-list.md + - name: Get windowsMalwareInformation + href: ../../api/intune-devices-windowsmalwareinformation-get.md + - name: Create windowsMalwareInformation + href: ../../api/intune-devices-windowsmalwareinformation-create.md + - name: Delete windowsMalwareInformation + href: ../../api/intune-devices-windowsmalwareinformation-delete.md + - name: Update windowsMalwareInformation + href: ../../api/intune-devices-windowsmalwareinformation-update.md + - name: Windows protection state + items: + - name: Windows protection state + href: ../../resources/intune-devices-windowsprotectionstate.md + - name: Get windowsProtectionState + href: ../../api/intune-devices-windowsprotectionstate-get.md + - name: Update windowsProtectionState + href: ../../api/intune-devices-windowsprotectionstate-update.md + - name: Complex types + items: + - name: App log collection download details + href: ../../resources/intune-devices-applogcollectiondownloaddetails.md + - name: Configuration manager client enabled features + href: ../../resources/intune-devices-configurationmanagerclientenabledfeatures.md + - name: Delete user from shared Apple device action result + href: ../../resources/intune-devices-deleteuserfromsharedappledeviceactionresult.md + - name: Device action result + href: ../../resources/intune-devices-deviceactionresult.md + - name: Device exchange access state summary + href: ../../resources/intune-devices-deviceexchangeaccessstatesummary.md + - name: Device geo location + href: ../../resources/intune-devices-devicegeolocation.md + - name: Device health attestation state + href: ../../resources/intune-devices-devicehealthattestationstate.md + - name: Device operating system summary + href: ../../resources/intune-devices-deviceoperatingsystemsummary.md + - name: Device protection overview + href: ../../resources/intune-devices-deviceprotectionoverview.md + - name: Insight value double + href: ../../resources/intune-devices-insightvaluedouble.md + - name: Insight value int + href: ../../resources/intune-devices-insightvalueint.md + - name: Locate device action result + href: ../../resources/intune-devices-locatedeviceactionresult.md + - name: OS version count + href: ../../resources/intune-devices-osversioncount.md + - name: Remote lock action result + href: ../../resources/intune-devices-remotelockactionresult.md + - name: Reset passcode action result + href: ../../resources/intune-devices-resetpasscodeactionresult.md + - name: Update windows device account action parameter + href: ../../resources/intune-devices-updatewindowsdeviceaccountactionparameter.md + - name: User experience analytics autopilot devices summary + href: ../../resources/intune-devices-userexperienceanalyticsautopilotdevicessummary.md + - name: User experience analytics cloud identity devices summary + href: ../../resources/intune-devices-userexperienceanalyticscloudidentitydevicessummary.md + - name: User experience analytics cloud management devices summary + href: ../../resources/intune-devices-userexperienceanalyticscloudmanagementdevicessummary.md + - name: User experience analytics insight + href: ../../resources/intune-devices-userexperienceanalyticsinsight.md + - name: User experience analytics insight value + href: ../../resources/intune-devices-userexperienceanalyticsinsightvalue.md + - name: User experience analytics settings + href: ../../resources/intune-devices-userexperienceanalyticssettings.md + - name: User experience analytics windows 10 devices summary + href: ../../resources/intune-devices-userexperienceanalyticswindows10devicessummary.md + - name: User experience analytics work from anywhere devices summary + href: ../../resources/intune-devices-userexperienceanalyticsworkfromanywheredevicessummary.md + - name: Windows defender scan action result + href: ../../resources/intune-devices-windowsdefenderscanactionresult.md + - name: Windows device account + href: ../../resources/intune-devices-windowsdeviceaccount.md + - name: Windows device ad account + href: ../../resources/intune-devices-windowsdeviceadaccount.md + - name: Windows device Microsoft Entra account + href: ../../resources/intune-devices-windowsdeviceazureadaccount.md + - name: Windows malware category count + href: ../../resources/intune-devices-windowsmalwarecategorycount.md + - name: Windows malware execution state count + href: ../../resources/intune-devices-windowsmalwareexecutionstatecount.md + - name: Windows malware name count + href: ../../resources/intune-devices-windowsmalwarenamecount.md + - name: Windows malware overview + href: ../../resources/intune-devices-windowsmalwareoverview.md + - name: Windows malware severity count + href: ../../resources/intune-devices-windowsmalwareseveritycount.md + - name: Windows malware state count + href: ../../resources/intune-devices-windowsmalwarestatecount.md + - name: Mobile app management (MAM) + items: + - name: Overview + href: ../../resources/intune-mam-conceptual.md + - name: Android managed app protection + items: + - name: Android managed app protection + href: ../../resources/intune-mam-androidmanagedappprotection.md + - name: List androidManagedAppProtections + href: ../../api/intune-mam-androidmanagedappprotection-list.md + - name: Get androidManagedAppProtection + href: ../../api/intune-mam-androidmanagedappprotection-get.md + - name: Create androidManagedAppProtection + href: ../../api/intune-mam-androidmanagedappprotection-create.md + - name: Delete androidManagedAppProtection + href: ../../api/intune-mam-androidmanagedappprotection-delete.md + - name: Update androidManagedAppProtection + href: ../../api/intune-mam-androidmanagedappprotection-update.md + - name: Android managed app registration + items: + - name: Android managed app registration + href: ../../resources/intune-mam-androidmanagedappregistration.md + - name: List androidManagedAppRegistrations + href: ../../api/intune-mam-androidmanagedappregistration-list.md + - name: Get androidManagedAppRegistration + href: ../../api/intune-mam-androidmanagedappregistration-get.md + - name: Create androidManagedAppRegistration + href: ../../api/intune-mam-androidmanagedappregistration-create.md + - name: Default managed app protection + items: + - name: Default managed app protection + href: ../../resources/intune-mam-defaultmanagedappprotection.md + - name: List defaultManagedAppProtections + href: ../../api/intune-mam-defaultmanagedappprotection-list.md + - name: Get defaultManagedAppProtection + href: ../../api/intune-mam-defaultmanagedappprotection-get.md + - name: Create defaultManagedAppProtection + href: ../../api/intune-mam-defaultmanagedappprotection-create.md + - name: Delete defaultManagedAppProtection + href: ../../api/intune-mam-defaultmanagedappprotection-delete.md + - name: Update defaultManagedAppProtection + href: ../../api/intune-mam-defaultmanagedappprotection-update.md + - name: iOS managed app protection + items: + - name: iOS managed app protection + href: ../../resources/intune-mam-iosmanagedappprotection.md + - name: List iosManagedAppProtections + href: ../../api/intune-mam-iosmanagedappprotection-list.md + - name: Get iosManagedAppProtection + href: ../../api/intune-mam-iosmanagedappprotection-get.md + - name: Create iosManagedAppProtection + href: ../../api/intune-mam-iosmanagedappprotection-create.md + - name: Delete iosManagedAppProtection + href: ../../api/intune-mam-iosmanagedappprotection-delete.md + - name: Update iosManagedAppProtection + href: ../../api/intune-mam-iosmanagedappprotection-update.md + - name: iOS managed app registration + items: + - name: iOS managed app registration + href: ../../resources/intune-mam-iosmanagedappregistration.md + - name: List iosManagedAppRegistrations + href: ../../api/intune-mam-iosmanagedappregistration-list.md + - name: Get iosManagedAppRegistration + href: ../../api/intune-mam-iosmanagedappregistration-get.md + - name: Managed app configuration + items: + - name: Managed app configuration + href: ../../resources/intune-mam-managedappconfiguration.md + - name: List managedAppConfigurations + href: ../../api/intune-mam-managedappconfiguration-list.md + - name: Get managedAppConfiguration + href: ../../api/intune-mam-managedappconfiguration-get.md + - name: Managed app operation + items: + - name: Managed app operation + href: ../../resources/intune-mam-managedappoperation.md + - name: List managedAppOperations + href: ../../api/intune-mam-managedappoperation-list.md + - name: Get managedAppOperation + href: ../../api/intune-mam-managedappoperation-get.md + - name: Create managedAppOperation + href: ../../api/intune-mam-managedappoperation-create.md + - name: Delete managedAppOperation + href: ../../api/intune-mam-managedappoperation-delete.md + - name: Update managedAppOperation + href: ../../api/intune-mam-managedappoperation-update.md + - name: Managed app policy + items: + - name: Managed app policy + href: ../../resources/intune-mam-managedapppolicy.md + - name: List managedAppPolicies + href: ../../api/intune-mam-managedapppolicy-list.md + - name: Get managedAppPolicy + href: ../../api/intune-mam-managedapppolicy-get.md + - name: targetApps action + href: ../../api/intune-mam-managedapppolicy-targetapps.md + - name: Managed app policy deployment summary + items: + - name: Managed app policy deployment summary + href: ../../resources/intune-mam-managedapppolicydeploymentsummary.md + - name: Get managedAppPolicyDeploymentSummary + href: ../../api/intune-mam-managedapppolicydeploymentsummary-get.md + - name: Update managedAppPolicyDeploymentSummary + href: ../../api/intune-mam-managedapppolicydeploymentsummary-update.md + - name: Managed app protection + items: + - name: Managed app protection + href: ../../resources/intune-mam-managedappprotection.md + - name: List managedAppProtections + href: ../../api/intune-mam-managedappprotection-list.md + - name: Get managedAppProtection + href: ../../api/intune-mam-managedappprotection-get.md + - name: targetApps action + href: ../../api/intune-mam-managedappprotection-targetapps.md + - name: Managed app registration + items: + - name: Managed app registration + href: ../../resources/intune-mam-managedappregistration.md + - name: List managedAppRegistrations + href: ../../api/intune-mam-managedappregistration-list.md + - name: Get managedAppRegistration + href: ../../api/intune-mam-managedappregistration-get.md + - name: getUserIdsWithFlaggedAppRegistration function + href: ../../api/intune-mam-managedappregistration-getuseridswithflaggedappregistration.md + - name: Managed app status + items: + - name: Managed app status + href: ../../resources/intune-mam-managedappstatus.md + - name: List managedAppStatuses + href: ../../api/intune-mam-managedappstatus-list.md + - name: Get managedAppStatus + href: ../../api/intune-mam-managedappstatus-get.md + - name: Managed app status raw + items: + - name: Managed app status raw + href: ../../resources/intune-mam-managedappstatusraw.md + - name: List managedAppStatusRaws + href: ../../api/intune-mam-managedappstatusraw-list.md + - name: Get managedAppStatusRaw + href: ../../api/intune-mam-managedappstatusraw-get.md + - name: Managed mobile app + items: + - name: Managed mobile app + href: ../../resources/intune-mam-managedmobileapp.md + - name: List managedMobileApps + href: ../../api/intune-mam-managedmobileapp-list.md + - name: Get managedMobileApp + href: ../../api/intune-mam-managedmobileapp-get.md + - name: Create managedMobileApp + href: ../../api/intune-mam-managedmobileapp-create.md + - name: Delete managedMobileApp + href: ../../api/intune-mam-managedmobileapp-delete.md + - name: Update managedMobileApp + href: ../../api/intune-mam-managedmobileapp-update.md + - name: Mdm windows information protection policy + items: + - name: Mdm windows information protection policy + href: ../../resources/intune-mam-mdmwindowsinformationprotectionpolicy.md + - name: List mdmWindowsInformationProtectionPolicies + href: ../../api/intune-mam-mdmwindowsinformationprotectionpolicy-list.md + - name: Get mdmWindowsInformationProtectionPolicy + href: ../../api/intune-mam-mdmwindowsinformationprotectionpolicy-get.md + - name: Create mdmWindowsInformationProtectionPolicy + href: ../../api/intune-mam-mdmwindowsinformationprotectionpolicy-create.md + - name: Delete mdmWindowsInformationProtectionPolicy + href: ../../api/intune-mam-mdmwindowsinformationprotectionpolicy-delete.md + - name: Update mdmWindowsInformationProtectionPolicy + href: ../../api/intune-mam-mdmwindowsinformationprotectionpolicy-update.md + - name: Targeted managed app configuration + items: + - name: Targeted managed app configuration + href: ../../resources/intune-mam-targetedmanagedappconfiguration.md + - name: List targetedManagedAppConfigurations + href: ../../api/intune-mam-targetedmanagedappconfiguration-list.md + - name: Get targetedManagedAppConfiguration + href: ../../api/intune-mam-targetedmanagedappconfiguration-get.md + - name: Create targetedManagedAppConfiguration + href: ../../api/intune-mam-targetedmanagedappconfiguration-create.md + - name: Delete targetedManagedAppConfiguration + href: ../../api/intune-mam-targetedmanagedappconfiguration-delete.md + - name: Update targetedManagedAppConfiguration + href: ../../api/intune-mam-targetedmanagedappconfiguration-update.md + - name: assign action + href: ../../api/intune-mam-targetedmanagedappconfiguration-assign.md + - name: targetApps action + href: ../../api/intune-mam-targetedmanagedappconfiguration-targetapps.md + - name: Targeted managed app policy assignment + items: + - name: Targeted managed app policy assignment + href: ../../resources/intune-mam-targetedmanagedapppolicyassignment.md + - name: List targetedManagedAppPolicyAssignments + href: ../../api/intune-mam-targetedmanagedapppolicyassignment-list.md + - name: Get targetedManagedAppPolicyAssignment + href: ../../api/intune-mam-targetedmanagedapppolicyassignment-get.md + - name: Delete targetedManagedAppPolicyAssignment + href: ../../api/intune-mam-targetedmanagedapppolicyassignment-delete.md + - name: Update targetedManagedAppPolicyAssignment + href: ../../api/intune-mam-targetedmanagedapppolicyassignment-update.md + - name: Targeted managed app protection + items: + - name: Targeted managed app protection + href: ../../resources/intune-mam-targetedmanagedappprotection.md + - name: List targetedManagedAppProtections + href: ../../api/intune-mam-targetedmanagedappprotection-list.md + - name: Get targetedManagedAppProtection + href: ../../api/intune-mam-targetedmanagedappprotection-get.md + - name: assign action + href: ../../api/intune-mam-targetedmanagedappprotection-assign.md + - name: targetApps action + href: ../../api/intune-mam-targetedmanagedappprotection-targetapps.md + - name: Windows information protection + items: + - name: Windows information protection + href: ../../resources/intune-mam-windowsinformationprotection.md + - name: List windowsInformationProtections + href: ../../api/intune-mam-windowsinformationprotection-list.md + - name: Get windowsInformationProtection + href: ../../api/intune-mam-windowsinformationprotection-get.md + - name: assign action + href: ../../api/intune-mam-windowsinformationprotection-assign.md + - name: Windows information protection app locker file + items: + - name: Windows information protection app locker file + href: ../../resources/intune-mam-windowsinformationprotectionapplockerfile.md + - name: List windowsInformationProtectionAppLockerFiles + href: ../../api/intune-mam-windowsinformationprotectionapplockerfile-list.md + - name: Get windowsInformationProtectionAppLockerFile + href: ../../api/intune-mam-windowsinformationprotectionapplockerfile-get.md + - name: Create windowsInformationProtectionAppLockerFile + href: ../../api/intune-mam-windowsinformationprotectionapplockerfile-create.md + - name: Delete windowsInformationProtectionAppLockerFile + href: ../../api/intune-mam-windowsinformationprotectionapplockerfile-delete.md + - name: Update windowsInformationProtectionAppLockerFile + href: ../../api/intune-mam-windowsinformationprotectionapplockerfile-update.md + - name: Windows information protection policy + items: + - name: Windows information protection policy + href: ../../resources/intune-mam-windowsinformationprotectionpolicy.md + - name: List windowsInformationProtectionPolicies + href: ../../api/intune-mam-windowsinformationprotectionpolicy-list.md + - name: Get windowsInformationProtectionPolicy + href: ../../api/intune-mam-windowsinformationprotectionpolicy-get.md + - name: Create windowsInformationProtectionPolicy + href: ../../api/intune-mam-windowsinformationprotectionpolicy-create.md + - name: Delete windowsInformationProtectionPolicy + href: ../../api/intune-mam-windowsinformationprotectionpolicy-delete.md + - name: Update windowsInformationProtectionPolicy + href: ../../api/intune-mam-windowsinformationprotectionpolicy-update.md + - name: Windows information protection app learning summary + items: + - name: Windows information protection app learning summary + href: ../../resources/intune-wip-windowsinformationprotectionapplearningsummary.md + - name: List windowsInformationProtectionAppLearningSummaries + href: ../../api/intune-wip-windowsinformationprotectionapplearningsummary-list.md + - name: Get windowsInformationProtectionAppLearningSummary + href: ../../api/intune-wip-windowsinformationprotectionapplearningsummary-get.md + - name: Create windowsInformationProtectionAppLearningSummary + href: ../../api/intune-wip-windowsinformationprotectionapplearningsummary-create.md + - name: Delete windowsInformationProtectionAppLearningSummary + href: ../../api/intune-wip-windowsinformationprotectionapplearningsummary-delete.md + - name: Update windowsInformationProtectionAppLearningSummary + href: ../../api/intune-wip-windowsinformationprotectionapplearningsummary-update.md + - name: Windows information protection network learning summary + items: + - name: Windows information protection network learning summary + href: ../../resources/intune-wip-windowsinformationprotectionnetworklearningsummary.md + - name: List windowsInformationProtectionNetworkLearningSummaries + href: ../../api/intune-wip-windowsinformationprotectionnetworklearningsummary-list.md + - name: Get windowsInformationProtectionNetworkLearningSummary + href: ../../api/intune-wip-windowsinformationprotectionnetworklearningsummary-get.md + - name: Create windowsInformationProtectionNetworkLearningSummary + href: ../../api/intune-wip-windowsinformationprotectionnetworklearningsummary-create.md + - name: Delete windowsInformationProtectionNetworkLearningSummary + href: ../../api/intune-wip-windowsinformationprotectionnetworklearningsummary-delete.md + - name: Update windowsInformationProtectionNetworkLearningSummary + href: ../../api/intune-wip-windowsinformationprotectionnetworklearningsummary-update.md + - name: Complex types + items: + - name: All devices assignment target + href: ../../resources/intune-shared-alldevicesassignmenttarget.md + - name: All licensed users assignment target + href: ../../resources/intune-shared-alllicensedusersassignmenttarget.md + - name: Android mobile app identifier + href: ../../resources/intune-mam-androidmobileappidentifier.md + - name: Cloud PC audit actor + href: ../../resources/cloudpcauditactor.md + - name: Cloud PC audit property + href: ../../resources/cloudpcauditproperty.md + - name: Cloud PC audit resource + href: ../../resources/cloudpcauditresource.md + - name: Cloud PC domain join configuration + href: ../../resources/cloudpcdomainjoinconfiguration.md + - name: Cloud PC management assignment target + href: ../../resources/cloudpcmanagementassignmenttarget.md + - name: Cloud PC management group assignment target + href: ../../resources/cloudpcmanagementgroupassignmenttarget.md + - name: Cloud PC on-premises connection health check + href: ../../resources/cloudpconpremisesconnectionhealthcheck.md + - name: Cloud PC on-premises connection status detail + href: ../../resources/cloudpconpremisesconnectionstatusdetail.md + - name: Cloud PC provisioning policy assignment + href: ../../resources/cloudpcprovisioningpolicyassignment.md + - name: Cloud PC restore point setting + href: ../../resources/cloudpcrestorepointsetting.md + - name: Cloud PC source device image + href: ../../resources/cloudpcsourcedeviceimage.md + - name: Cloud PC user role scope tag info + href: ../../resources/cloudpcuserrolescopetaginfo.md + - name: Cloud PC user setting assignment + href: ../../resources/cloudpcusersettingassignment.md + - name: Cloud PC windows setting + href: ../../resources/cloudpcwindowssetting.md + - name: Configuration manager collection assignment target + href: ../../resources/intune-shared-configurationmanagercollectionassignmenttarget.md + - name: Device and app management assignment target + href: ../../resources/intune-shared-deviceandappmanagementassignmenttarget.md + - name: Exclusion group assignment target + href: ../../resources/intune-shared-exclusiongroupassignmenttarget.md + - name: Group assignment target + href: ../../resources/intune-shared-groupassignmenttarget.md + - name: I pv 4 range + href: ../../resources/intune-mam-ipv4range.md + - name: I pv 6 range + href: ../../resources/intune-mam-ipv6range.md + - name: iOS mobile app identifier + href: ../../resources/intune-mam-iosmobileappidentifier.md + - name: IP range + href: ../../resources/iprange.md + - name: Json + href: ../../resources/json.md + - name: Key value pair + href: ../../resources/keyvaluepair.md + - name: Managed app diagnostic status + href: ../../resources/intune-mam-managedappdiagnosticstatus.md + - name: Managed app policy deployment summary per app + href: ../../resources/intune-mam-managedapppolicydeploymentsummaryperapp.md + - name: Microsoft managed desktop + href: ../../resources/microsoftmanageddesktop.md + - name: Mobile app identifier + href: ../../resources/intune-mam-mobileappidentifier.md + - name: Proxied domain + href: ../../resources/intune-mam-proxieddomain.md + - name: Windows information protection app + href: ../../resources/intune-mam-windowsinformationprotectionapp.md + - name: Windows information protection data recovery certificate + href: ../../resources/intune-mam-windowsinformationprotectiondatarecoverycertificate.md + - name: Windows information protection desktop app + href: ../../resources/intune-mam-windowsinformationprotectiondesktopapp.md + - name: Windows information protection IP range collection + href: ../../resources/intune-mam-windowsinformationprotectioniprangecollection.md + - name: Windows information protection proxied domain collection + href: ../../resources/intune-mam-windowsinformationprotectionproxieddomaincollection.md + - name: Windows information protection resource collection + href: ../../resources/intune-mam-windowsinformationprotectionresourcecollection.md + - name: Windows information protection store app + href: ../../resources/intune-mam-windowsinformationprotectionstoreapp.md + - name: Onboarding + items: + - name: Overview + href: ../../resources/intune-onboarding-conceptual.md + - name: Compliance management partner + items: + - name: Compliance management partner + href: ../../resources/intune-onboarding-compliancemanagementpartner.md + - name: List complianceManagementPartners + href: ../../api/intune-onboarding-compliancemanagementpartner-list.md + - name: Get complianceManagementPartner + href: ../../api/intune-onboarding-compliancemanagementpartner-get.md + - name: Create complianceManagementPartner + href: ../../api/intune-onboarding-compliancemanagementpartner-create.md + - name: Delete complianceManagementPartner + href: ../../api/intune-onboarding-compliancemanagementpartner-delete.md + - name: Update complianceManagementPartner + href: ../../api/intune-onboarding-compliancemanagementpartner-update.md + - name: Device enrollment configuration + items: + - name: Device enrollment configuration + href: ../../resources/intune-onboarding-deviceenrollmentconfiguration.md + - name: List deviceEnrollmentConfigurations + href: ../../api/intune-onboarding-deviceenrollmentconfiguration-list.md + - name: Get deviceEnrollmentConfiguration + href: ../../api/intune-onboarding-deviceenrollmentconfiguration-get.md + - name: setPriority action + href: ../../api/intune-onboarding-deviceenrollmentconfiguration-setpriority.md + - name: assign action + href: ../../api/intune-onboarding-deviceenrollmentconfiguration-assign.md + - name: Device enrollment limit configuration + items: + - name: Device enrollment limit configuration + href: ../../resources/intune-onboarding-deviceenrollmentlimitconfiguration.md + - name: List deviceEnrollmentLimitConfigurations + href: ../../api/intune-onboarding-deviceenrollmentlimitconfiguration-list.md + - name: Get deviceEnrollmentLimitConfiguration + href: ../../api/intune-onboarding-deviceenrollmentlimitconfiguration-get.md + - name: Create deviceEnrollmentLimitConfiguration + href: ../../api/intune-onboarding-deviceenrollmentlimitconfiguration-create.md + - name: Delete deviceEnrollmentLimitConfiguration + href: ../../api/intune-onboarding-deviceenrollmentlimitconfiguration-delete.md + - name: Update deviceEnrollmentLimitConfiguration + href: ../../api/intune-onboarding-deviceenrollmentlimitconfiguration-update.md + - name: Device enrollment platform restrictions configuration + items: + - name: Device enrollment platform restrictions configuration + href: ../../resources/intune-onboarding-deviceenrollmentplatformrestrictionsconfiguration.md + - name: List deviceEnrollmentPlatformRestrictionsConfigurations + href: ../../api/intune-onboarding-deviceenrollmentplatformrestrictionsconfiguration-list.md + - name: Get deviceEnrollmentPlatformRestrictionsConfiguration + href: ../../api/intune-onboarding-deviceenrollmentplatformrestrictionsconfiguration-get.md + - name: Create deviceEnrollmentPlatformRestrictionsConfiguration + href: ../../api/intune-onboarding-deviceenrollmentplatformrestrictionsconfiguration-create.md + - name: Delete deviceEnrollmentPlatformRestrictionsConfiguration + href: ../../api/intune-onboarding-deviceenrollmentplatformrestrictionsconfiguration-delete.md + - name: Update deviceEnrollmentPlatformRestrictionsConfiguration + href: ../../api/intune-onboarding-deviceenrollmentplatformrestrictionsconfiguration-update.md + - name: Device enrollment Windows Hello for Business configuration + items: + - name: Device enrollment Windows Hello for Business configuration + href: ../../resources/intune-onboarding-deviceenrollmentwindowshelloforbusinessconfiguration.md + - name: List deviceEnrollmentWindowsHelloForBusinessConfigurations + href: ../../api/intune-onboarding-deviceenrollmentwindowshelloforbusinessconfiguration-list.md + - name: Get deviceEnrollmentWindowsHelloForBusinessConfiguration + href: ../../api/intune-onboarding-deviceenrollmentwindowshelloforbusinessconfiguration-get.md + - name: Create deviceEnrollmentWindowsHelloForBusinessConfiguration + href: ../../api/intune-onboarding-deviceenrollmentwindowshelloforbusinessconfiguration-create.md + - name: Delete deviceEnrollmentWindowsHelloForBusinessConfiguration + href: ../../api/intune-onboarding-deviceenrollmentwindowshelloforbusinessconfiguration-delete.md + - name: Update deviceEnrollmentWindowsHelloForBusinessConfiguration + href: ../../api/intune-onboarding-deviceenrollmentwindowshelloforbusinessconfiguration-update.md + - name: Device management Exchange connector + items: + - name: Device management Exchange connector + href: ../../resources/intune-onboarding-devicemanagementexchangeconnector.md + - name: List deviceManagementExchangeConnectors + href: ../../api/intune-onboarding-devicemanagementexchangeconnector-list.md + - name: Get deviceManagementExchangeConnector + href: ../../api/intune-onboarding-devicemanagementexchangeconnector-get.md + - name: Create deviceManagementExchangeConnector + href: ../../api/intune-onboarding-devicemanagementexchangeconnector-create.md + - name: Delete deviceManagementExchangeConnector + href: ../../api/intune-onboarding-devicemanagementexchangeconnector-delete.md + - name: Update deviceManagementExchangeConnector + href: ../../api/intune-onboarding-devicemanagementexchangeconnector-update.md + - name: sync action + href: ../../api/intune-onboarding-devicemanagementexchangeconnector-sync.md + - name: Device management partner + items: + - name: Device management partner + href: ../../resources/intune-onboarding-devicemanagementpartner.md + - name: List deviceManagementPartners + href: ../../api/intune-onboarding-devicemanagementpartner-list.md + - name: Get deviceManagementPartner + href: ../../api/intune-onboarding-devicemanagementpartner-get.md + - name: Create deviceManagementPartner + href: ../../api/intune-onboarding-devicemanagementpartner-create.md + - name: Delete deviceManagementPartner + href: ../../api/intune-onboarding-devicemanagementpartner-delete.md + - name: Update deviceManagementPartner + href: ../../api/intune-onboarding-devicemanagementpartner-update.md + - name: terminate action + href: ../../api/intune-onboarding-devicemanagementpartner-terminate.md + - name: Enrollment configuration assignment + items: + - name: Enrollment configuration assignment + href: ../../resources/intune-onboarding-enrollmentconfigurationassignment.md + - name: List enrollmentConfigurationAssignments + href: ../../api/intune-onboarding-enrollmentconfigurationassignment-list.md + - name: Get enrollmentConfigurationAssignment + href: ../../api/intune-onboarding-enrollmentconfigurationassignment-get.md + - name: Create enrollmentConfigurationAssignment + href: ../../api/intune-onboarding-enrollmentconfigurationassignment-create.md + - name: Delete enrollmentConfigurationAssignment + href: ../../api/intune-onboarding-enrollmentconfigurationassignment-delete.md + - name: Update enrollmentConfigurationAssignment + href: ../../api/intune-onboarding-enrollmentconfigurationassignment-update.md + - name: Mobile threat defense connector + items: + - name: Mobile threat defense connector + href: ../../resources/intune-onboarding-mobilethreatdefenseconnector.md + - name: List mobileThreatDefenseConnectors + href: ../../api/intune-onboarding-mobilethreatdefenseconnector-list.md + - name: Get mobileThreatDefenseConnector + href: ../../api/intune-onboarding-mobilethreatdefenseconnector-get.md + - name: Create mobileThreatDefenseConnector + href: ../../api/intune-onboarding-mobilethreatdefenseconnector-create.md + - name: Delete mobileThreatDefenseConnector + href: ../../api/intune-onboarding-mobilethreatdefenseconnector-delete.md + - name: Update mobileThreatDefenseConnector + href: ../../api/intune-onboarding-mobilethreatdefenseconnector-update.md + - name: On-premises conditional access settings + items: + - name: On-premises conditional access settings + href: ../../resources/intune-onboarding-onpremisesconditionalaccesssettings.md + - name: Get onPremisesConditionalAccessSettings + href: ../../api/intune-onboarding-onpremisesconditionalaccesssettings-get.md + - name: Update onPremisesConditionalAccessSettings + href: ../../api/intune-onboarding-onpremisesconditionalaccesssettings-update.md + - name: VPP token + items: + - name: VPP token + href: ../../resources/intune-onboarding-vpptoken.md + - name: List vppTokens + href: ../../api/intune-onboarding-vpptoken-list.md + - name: Get vppToken + href: ../../api/intune-onboarding-vpptoken-get.md + - name: Create vppToken + href: ../../api/intune-onboarding-vpptoken-create.md + - name: Delete vppToken + href: ../../api/intune-onboarding-vpptoken-delete.md + - name: Update vppToken + href: ../../api/intune-onboarding-vpptoken-update.md + - name: syncLicenses action + href: ../../api/intune-onboarding-vpptoken-synclicenses.md + - name: Complex types + items: + - name: All devices assignment target + href: ../../resources/intune-shared-alldevicesassignmenttarget.md + - name: All licensed users assignment target + href: ../../resources/intune-shared-alllicensedusersassignmenttarget.md + - name: Compliance management partner assignment + href: ../../resources/intune-onboarding-compliancemanagementpartnerassignment.md + - name: Configuration manager collection assignment target + href: ../../resources/intune-shared-configurationmanagercollectionassignmenttarget.md + - name: Device and app management assignment target + href: ../../resources/intune-shared-deviceandappmanagementassignmenttarget.md + - name: Device and app management data + href: ../../resources/intune-onboarding-deviceandappmanagementdata.md + - name: Device enrollment platform restriction + href: ../../resources/intune-onboarding-deviceenrollmentplatformrestriction.md + - name: Device management partner assignment + href: ../../resources/intune-onboarding-devicemanagementpartnerassignment.md + - name: Exclusion group assignment target + href: ../../resources/intune-shared-exclusiongroupassignmenttarget.md + - name: Group assignment target + href: ../../resources/intune-shared-groupassignmenttarget.md + - name: Intune brand + href: ../../resources/intune-onboarding-intunebrand.md + - name: Mime content + href: ../../resources/intune-shared-mimecontent.md + - name: Rgb color + href: ../../resources/intune-onboarding-rgbcolor.md + - name: Role-based access control (RBAC) + items: + - name: Overview + href: ../../resources/intune-rbac-conceptual.md + - name: Device and app management role assignment + items: + - name: Device and app management role assignment + href: ../../resources/intune-rbac-deviceandappmanagementroleassignment.md + - name: List deviceAndAppManagementRoleAssignments + href: ../../api/intune-rbac-deviceandappmanagementroleassignment-list.md + - name: Get deviceAndAppManagementRoleAssignment + href: ../../api/intune-rbac-deviceandappmanagementroleassignment-get.md + - name: Create deviceAndAppManagementRoleAssignment + href: ../../api/intune-rbac-deviceandappmanagementroleassignment-create.md + - name: Delete deviceAndAppManagementRoleAssignment + href: ../../api/intune-rbac-deviceandappmanagementroleassignment-delete.md + - name: Update deviceAndAppManagementRoleAssignment + href: ../../api/intune-rbac-deviceandappmanagementroleassignment-update.md + - name: Device and app management role definition + items: + - name: Device and app management role definition + href: ../../resources/intune-rbac-deviceandappmanagementroledefinition.md + - name: List deviceAndAppManagementRoleDefinitions + href: ../../api/intune-rbac-deviceandappmanagementroledefinition-list.md + - name: Get deviceAndAppManagementRoleDefinition + href: ../../api/intune-rbac-deviceandappmanagementroledefinition-get.md + - name: Create deviceAndAppManagementRoleDefinition + href: ../../api/intune-rbac-deviceandappmanagementroledefinition-create.md + - name: Delete deviceAndAppManagementRoleDefinition + href: ../../api/intune-rbac-deviceandappmanagementroledefinition-delete.md + - name: Update deviceAndAppManagementRoleDefinition + href: ../../api/intune-rbac-deviceandappmanagementroledefinition-update.md + - name: Resource operation + items: + - name: Resource operation + href: ../../resources/intune-rbac-resourceoperation.md + - name: List resourceOperations + href: ../../api/intune-rbac-resourceoperation-list.md + - name: Get resourceOperation + href: ../../api/intune-rbac-resourceoperation-get.md + - name: Create resourceOperation + href: ../../api/intune-rbac-resourceoperation-create.md + - name: Delete resourceOperation + href: ../../api/intune-rbac-resourceoperation-delete.md + - name: Update resourceOperation + href: ../../api/intune-rbac-resourceoperation-update.md + - name: Role assignment + items: + - name: Role assignment + href: ../../resources/intune-rbac-roleassignment.md + - name: List roleAssignments + href: ../../api/intune-rbac-roleassignment-list.md + - name: Get roleAssignment + href: ../../api/intune-rbac-roleassignment-get.md + - name: Create roleAssignment + href: ../../api/intune-rbac-roleassignment-create.md + - name: Delete roleAssignment + href: ../../api/intune-rbac-roleassignment-delete.md + - name: Update roleAssignment + href: ../../api/intune-rbac-roleassignment-update.md + - name: Role definition + items: + - name: Role definition + href: ../../resources/intune-rbac-roledefinition.md + - name: List roleDefinitions + href: ../../api/intune-rbac-roledefinition-list.md + - name: Get roleDefinition + href: ../../api/intune-rbac-roledefinition-get.md + - name: Create roleDefinition + href: ../../api/intune-rbac-roledefinition-create.md + - name: Delete roleDefinition + href: ../../api/intune-rbac-roledefinition-delete.md + - name: Update roleDefinition + href: ../../api/intune-rbac-roledefinition-update.md + - name: Complex types + items: + - name: Resource action + href: ../../resources/intune-rbac-resourceaction.md + - name: Role permission + href: ../../resources/intune-rbac-rolepermission.md +- name: Microsoft 365 apps + displayName: Microsoft 365 applications + items: + - name: Installation options + items: + - name: Installation options + href: ../../resources/m365appsinstallationoptions.md + - name: Get m365AppsInstallationOptions + href: ../../api/m365AppsInstallationOptions-get.md + - name: Update m365AppsInstallationOptions + href: ../../api/m365AppsInstallationOptions-update.md + - name: Complex types + items: + - name: Admin + href: ../../resources/admin.md + - name: Admin Microsoft 365 apps + href: ../../resources/adminmicrosoft365apps.md + - name: Apps installation options for mac + href: ../../resources/appsinstallationoptionsformac.md + - name: Apps installation options for windows + href: ../../resources/appsinstallationoptionsforwindows.md +- name: Service health and communications + items: + - name: Overview + href: ../../resources/service-communications-api-overview.md + - name: Service announcement + items: + - name: Service announcement + href: ../../resources/serviceannouncement.md + - name: List healthOverviews + href: ../../api/serviceannouncement-list-healthoverviews.md + - name: List issues + href: ../../api/serviceannouncement-list-issues.md + - name: List messages + href: ../../api/serviceannouncement-list-messages.md + - name: Service announcement attachment + items: + - name: Service announcement attachment + href: ../../resources/serviceannouncementattachment.md + - name: Get serviceAnnouncementAttachment + href: ../../api/serviceannouncementattachment-get.md + - name: Service health + items: + - name: Service health + href: ../../resources/servicehealth.md + - name: Get serviceHealth + href: ../../api/servicehealth-get.md + - name: Service health issue + items: + - name: Service health issue + href: ../../resources/servicehealthissue.md + - name: Get serviceHealthIssue + href: ../../api/servicehealthissue-get.md + - name: Get post-incident review report + href: ../../api/servicehealthissue-incidentreport.md + - name: Service update message + items: + - name: Service update message + href: ../../resources/serviceupdatemessage.md + - name: Get serviceUpdateMessage + href: ../../api/serviceupdatemessage-get.md + - name: markRead + href: ../../api/serviceupdatemessage-markread.md + - name: markUnread + href: ../../api/serviceupdatemessage-markunread.md + - name: archive + href: ../../api/serviceupdatemessage-archive.md + - name: unarchive + href: ../../api/serviceupdatemessage-unarchive.md + - name: favorite + href: ../../api/serviceupdatemessage-favorite.md + - name: unfavorite + href: ../../api/serviceupdatemessage-unfavorite.md + - name: List attachments + href: ../../api/serviceupdatemessage-list-attachments.md + - name: Complex types + items: + - name: Admin + href: ../../resources/admin.md + - name: Item body + href: ../../resources/itembody.md + - name: Key value pair + href: ../../resources/keyvaluepair.md + - name: Service health issue post + href: ../../resources/servicehealthissuepost.md + - name: Service update message viewpoint + href: ../../resources/serviceupdatemessageviewpoint.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/education/toc.yml | +items: +- name: Overview + href: ../../resources/education-overview.md +- name: Education school + items: + - name: Education school + href: ../../resources/educationschool.md + - name: List educationSchools + href: ../../api/educationschool-list.md + - name: Create educationSchool + href: ../../api/educationschool-post.md + - name: Get educationSchool + href: ../../api/educationschool-get.md + - name: Update educationSchool + href: ../../api/educationschool-update.md + - name: Delete educationSchool + href: ../../api/educationschool-delete.md + - name: delta + href: ../../api/educationschool-delta.md +- name: Education class + items: + - name: Education class + href: ../../resources/educationclass.md + - name: List educationClasses + href: ../../api/educationclass-list.md + - name: List modules + href: ../../api/educationclass-list-modules.md + - name: Create educationClass + href: ../../api/educationclass-post.md + - name: Get educationClass + href: ../../api/educationclass-get.md + - name: Update educationClass + href: ../../api/educationclass-update.md + - name: Delete educationClass + href: ../../api/educationclass-delete.md + - name: Get delta + href: ../../api/educationclass-delta.md +- name: Education user + items: + - name: Education user + href: ../../resources/educationuser.md + - name: List educationUsers + href: ../../api/educationuser-list.md + - name: Create educationUser + href: ../../api/educationuser-post.md + - name: Get educationUser + href: ../../api/educationuser-get.md + - name: Update educationUser + href: ../../api/educationuser-update.md + - name: Delete educationUser + href: ../../api/educationuser-delete.md + - name: delta + href: ../../api/educationuser-delta.md + - name: List taughtClasses + href: ../../api/educationuser-list-taughtclasses.md +- name: Education assignment + items: + - name: Education assignment + href: ../../resources/educationassignment.md + - name: Create assignment resource + href: ../../api/educationassignment-post-resource.md + - name: Get assignment + href: ../../api/educationassignment-get.md + - name: Update + href: ../../api/educationassignment-update.md + - name: Delete + href: ../../api/educationassignment-delete.md + - name: Publish + href: ../../api/educationassignment-publish.md + - name: Set up assignment resources folder + href: ../../api/educationassignment-setupresourcesfolder.md + - name: Set up assignment feedback resources folder + href: ../../api/educationassignment-setupfeedbackresourcesfolder.md + - name: List resources + href: ../../api/educationassignment-list-resources.md + - name: List submissions + href: ../../api/educationassignment-list-submissions.md + - name: List categories + href: ../../api/educationassignment-list-categories.md + - name: Add categories + href: ../../api/educationassignment-post-categories.md + - name: Remove category + href: ../../api/educationassignment-remove-category.md + - name: Attach rubric + href: ../../api/educationassignment-put-rubric.md + - name: Remove rubric + href: ../../api/educationassignment-delete-rubric.md + - name: Get delta + href: ../../api/educationassignment-delta.md + - name: Add educationGradingCategory + href: ../../api/educationassignment-post-gradingcategory.md + - name: Remove educationGradingCategory + href: ../../api/educationassignment-delete-gradingcategory.md + - name: Activate assignment + href: ../../api/educationassignment-activate.md + - name: Deactivate assignment + href: ../../api/educationassignment-deactivate.md +- name: Education assignment defaults + items: + - name: Education assignment defaults + href: ../../resources/educationassignmentdefaults.md + - name: Get educationAssignmentDefaults + href: ../../api/educationassignmentdefaults-get.md + - name: Update educationAssignmentDefaults + href: ../../api/educationassignmentdefaults-update.md +- name: Education assignment resource + items: + - name: Education assignment resource + href: ../../resources/educationassignmentresource.md + - name: Get educationAssignmentResource + href: ../../api/educationassignmentresource-get.md + - name: Delete + href: ../../api/educationassignmentresource-delete.md +- name: Education assignment settings + items: + - name: Education assignment settings + href: ../../resources/educationassignmentsettings.md + - name: Get educationAssignmentSettings + href: ../../api/educationassignmentsettings-get.md + - name: Update educationAssignmentSettings + href: ../../api/educationassignmentsettings-update.md + - name: Update educationGradingCategory + href: ../../api/educationgradingcategory-update.md +- name: Education category + items: + - name: Education category + href: ../../resources/educationcategory.md + - name: Create category + href: ../../api/educationclass-post-category.md + - name: Get educationCategory + href: ../../api/educationcategory-get.md + - name: Delete category + href: ../../api/educationcategory-delete.md + - name: Get delta + href: ../../api/educationcategory-delta.md +- name: Education feedback outcome + items: + - name: Education feedback outcome + href: ../../resources/educationfeedbackoutcome.md + - name: Update educationOutcome + href: ../../api/educationoutcome-update.md +- name: Education feedback resource outcome + items: + - name: Education feedback resource outcome + href: ../../resources/educationfeedbackresourceoutcome.md + - name: Create educationFeedbackResourceOutcome + href: ../../api/educationfeedbackresourceoutcome-post-outcomes.md + - name: Delete educationFeedbackResourceOutcome + href: ../../api/educationfeedbackresourceoutcome-delete.md +- name: Education grading category + items: + - name: Education grading category + href: ../../resources/educationgradingcategory.md + - name: Add gradingCategory + href: ../../api/educationassignment-post-gradingcategory.md + - name: Remove gradingCategory + href: ../../api/educationassignment-delete-gradingcategory.md + - name: Update gradingCategory + href: ../../api/educationgradingcategory-update.md +- name: Education module + items: + - name: Education module + href: ../../resources/educationmodule.md + - name: List modules + href: ../../api/educationclass-list-modules.md + - name: Create + href: ../../api/educationclass-post-module.md + - name: Get module + href: ../../api/educationmodule-get.md + - name: Update + href: ../../api/educationmodule-update.md + - name: Delete + href: ../../api/educationmodule-delete.md + - name: Pin + href: ../../api/educationmodule-pin.md + - name: Unpin + href: ../../api/educationmodule-unpin.md + - name: Publish + href: ../../api/educationmodule-publish.md + - name: Set up module resources folder + href: ../../api/educationmodule-setupresourcesfolder.md +- name: Education module resource + items: + - name: Education module resource + href: ../../resources/educationmoduleresource.md + - name: List resources + href: ../../api/educationmodule-list-resources.md + - name: Create educationModuleResource + href: ../../api/educationmodule-post-resources.md + - name: Get educationModuleResource + href: ../../api/educationmoduleresource-get.md + - name: Update educationModuleResource + href: ../../api/educationmoduleresource-update.md + - name: Delete educationModuleResource + href: ../../api/educationmoduleresource-delete.md +- name: Education outcome + items: + - name: Education outcome + href: ../../resources/educationoutcome.md + - name: Update educationOutcome + href: ../../api/educationoutcome-update.md +- name: Education points outcome + items: + - name: Education points outcome + href: ../../resources/educationpointsoutcome.md + - name: Update educationOutcome + href: ../../api/educationoutcome-update.md +- name: Education rubric + items: + - name: Education rubric + href: ../../resources/educationrubric.md + - name: Create educationRubric + href: ../../api/educationuser-post-rubrics.md + - name: Get educationRubric + href: ../../api/educationrubric-get.md + - name: Update educationRubric + href: ../../api/educationrubric-update.md + - name: Delete educationRubric + href: ../../api/educationrubric-delete.md +- name: Education rubric outcome + items: + - name: Education rubric outcome + href: ../../resources/educationrubricoutcome.md + - name: Update educationOutcome + href: ../../api/educationoutcome-update.md +- name: Education submission + items: + - name: Education submission + href: ../../resources/educationsubmission.md + - name: Get educationSubmission + href: ../../api/educationsubmission-get.md + - name: List resources + href: ../../api/educationsubmission-list-resources.md + - name: List submittedResources + href: ../../api/educationsubmission-list-submittedresources.md + - name: List outcomes + href: ../../api/educationsubmission-list-outcomes.md + - name: return + href: ../../api/educationsubmission-return.md + - name: reassign + href: ../../api/educationsubmission-reassign.md + - name: Set up submission specific resources folder + href: ../../api/educationsubmission-setupResourcesFolder.md + - name: submit + href: ../../api/educationsubmission-submit.md + - name: unsubmit + href: ../../api/educationsubmission-unsubmit.md +- name: Education submission resource + items: + - name: Education submission resource + href: ../../resources/educationsubmissionresource.md + - name: List resources + href: ../../api/educationsubmission-list-resources.md + - name: Get educationSubmissionResource + href: ../../api/educationsubmissionresource-get.md + - name: Delete + href: ../../api/educationsubmissionresource-delete.md +- name: Complex types + items: + - name: Education assignment class recipient + href: ../../resources/educationassignmentclassrecipient.md + - name: Education assignment grade + href: ../../resources/educationassignmentgrade.md + - name: Education assignment grade type + href: ../../resources/educationassignmentgradetype.md + - name: Education assignment individual recipient + href: ../../resources/educationassignmentindividualrecipient.md + - name: Education assignment points grade + href: ../../resources/educationassignmentpointsgrade.md + - name: Education assignment points grade type + href: ../../resources/educationassignmentpointsgradetype.md + - name: Education assignment recipient + href: ../../resources/educationassignmentrecipient.md + - name: Education channel resource + href: ../../resources/educationchannelresource.md + - name: Education excel resource + href: ../../resources/educationexcelresource.md + - name: Education external resource + href: ../../resources/educationexternalresource.md + - name: Education feedback + href: ../../resources/educationfeedback.md + - name: Education file resource + href: ../../resources/educationfileresource.md + - name: Education link resource + href: ../../resources/educationlinkresource.md + - name: Education linked assignment resource + href: ../../resources/educationlinkedassignmentresource.md + - name: Education media resource + href: ../../resources/educationmediaresource.md + - name: Education power point resource + href: ../../resources/educationpowerpointresource.md + - name: Education resource + href: ../../resources/educationresource.md + - name: Education submission individual recipient + href: ../../resources/educationsubmissionindividualrecipient.md + - name: Education submission recipient + href: ../../resources/educationsubmissionrecipient.md + - name: Education teams app resource + href: ../../resources/educationteamsappresource.md + - name: Education word resource + href: ../../resources/educationwordresource.md + - name: Identity + href: ../../resources/identity.md + - name: Identity set + href: ../../resources/identityset.md + - name: Rubric criterion + href: ../../resources/rubriccriterion.md + - name: Rubric level + href: ../../resources/rubriclevel.md + - name: Rubric quality + href: ../../resources/rubricquality.md + - name: Rubric quality feedback model + href: ../../resources/rubricqualityfeedbackmodel.md + - name: Rubric quality selected column model + href: ../../resources/rubricqualityselectedcolumnmodel.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/extensions/toc.yml | +items: +- name: Overview + href: ../../graph/extensibility-overview?context=graph%2Fapi%2F1.0&preserve-view=true&tabs=http +- name: Directory extension + items: + - name: Directory extension + href: ../../resources/extensionproperty.md + - name: Create extensionProperties + href: ../../api/application-post-extensionproperty.md + - name: List extensionProperties + href: ../../api/application-list-extensionproperty.md + - name: Get extensionProperty + href: ../../api/extensionproperty-get.md + - name: Delete extensionProperty + href: ../../api/extensionproperty-delete.md + - name: Get available extensions + href: ../../api/directoryobject-getavailableextensionproperties.md +- name: Open type extension + items: + - name: Open type extension + href: ../../resources/opentypeextension.md + - name: Create + href: ../../api/opentypeextension-post-opentypeextension.md + - name: Get + href: ../../api/opentypeextension-get.md + - name: Update + href: ../../api/opentypeextension-update.md + - name: Delete + href: ../../api/opentypeextension-delete.md +- name: Schema extension + items: + - name: Schema extension + href: ../../resources/schemaextension.md + - name: Create + href: ../../api/schemaextension-post-schemaextensions.md + - name: List + href: ../../api/schemaextension-list.md + - name: Get + href: ../../api/schemaextension-get.md + - name: Update + href: ../../api/schemaextension-update.md + - name: Delete + href: ../../api/schemaextension-delete.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/external-data-connections/toc.yml | +items: +- name: Overview + href: ../../resources/connectors-api-overview.md +- name: External connection + items: + - name: External connection + href: ../../resources/externalconnectors-externalconnection.md + - name: Create externalConnection + href: ../../api/externalconnectors-external-post-connections.md + - name: List externalConnections + href: ../../api/externalconnectors-externalconnection-list.md + - name: Get externalConnection + href: ../../api/externalconnectors-externalconnection-get.md + - name: Update externalConnection + href: ../../api/externalconnectors-externalconnection-update.md + - name: Delete externalConnection + href: ../../api/externalconnectors-externalconnection-delete.md + - name: Create schema + href: ../../api/externalconnectors-externalconnection-patch-schema.md + - name: Create externalItem + href: ../../api/externalconnectors-externalconnection-put-items.md +- name: External group + items: + - name: External group + href: ../../resources/externalconnectors-externalgroup.md + - name: Create externalGroup + href: ../../api/externalconnectors-externalconnection-post-groups.md + - name: Get externalGroup + href: ../../api/externalconnectors-externalgroup-get.md + - name: Update externalGroup + href: ../../api/externalconnectors-externalgroup-update.md + - name: Delete externalGroup + href: ../../api/externalconnectors-externalgroup-delete.md +- name: Identity + items: + - name: Identity + href: ../../resources/externalconnectors-identity.md + - name: Create identity + href: ../../api/externalconnectors-externalgroup-post-members.md + - name: Delete identity + href: ../../api/externalconnectors-externalgroupmember-delete.md +- name: External item + items: + - name: External item + href: ../../resources/externalconnectors-externalitem.md + - name: Create externalItem + href: ../../api/externalconnectors-externalconnection-put-items.md + - name: Get externalItem + href: ../../api/externalconnectors-externalitem-get.md + - name: Update externalItem + href: ../../api/externalconnectors-externalitem-update.md + - name: Delete externalItem + href: ../../api/externalconnectors-externalitem-delete.md + - name: Add activities + href: ../../api/externalconnectors-externalitem-addactivities.md +- name: Schema + items: + - name: Schema + href: ../../resources/externalconnectors-schema.md + - name: Create schema + href: ../../api/externalconnectors-externalconnection-patch-schema.md + - name: Get schema + href: ../../api/externalconnectors-schema-get.md +- name: Connection operation + items: + - name: Connection operation + href: ../../resources/externalconnectors-connectionoperation.md + - name: Get connectionOperation + href: ../../api/externalconnectors-connectionoperation-get.md +- name: Complex types + items: + - name: Acl + href: ../../resources/externalconnectors-acl.md + - name: Activity settings + href: ../../resources/externalconnectors-activitysettings.md + - name: Configuration + href: ../../resources/externalconnectors-configuration.md + - name: Display template + href: ../../resources/externalconnectors-displaytemplate.md + - name: External activity + href: ../../resources/externalconnectors-externalactivity.md + - name: External activity result + href: ../../resources/externalconnectors-externalactivityresult.md + - name: External item content + href: ../../resources/externalconnectors-externalitemcontent.md + - name: Item id resolver + href: ../../resources/externalconnectors-itemidresolver.md + - name: Json + href: ../../resources/json.md + - name: Properties + href: ../../resources/externalconnectors-properties.md + - name: Property + href: ../../resources/externalconnectors-property.md + - name: Property rule + href: ../../resources/externalconnectors-propertyrule.md + - name: Public error + href: ../../resources/publicerror.md + - name: Public error detail + href: ../../resources/publicerrordetail.md + - name: Public inner error + href: ../../resources/publicinnererror.md + - name: Search settings + href: ../../resources/externalconnectors-searchsettings.md + - name: URL match info + href: ../../resources/externalconnectors-urlmatchinfo.md + - name: URL to item resolver base + href: ../../resources/externalconnectors-urltoitemresolverbase.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/files/toc.yml | +items: +- name: Overview + href: ../../resources/onedrive.md +- name: Drive + items: + - name: Drive + href: ../../resources/drive.md + - name: Get drive + href: ../../api/drive-get.md + - name: Get drive root + href: ../../api/driveitem-get.md + - name: List followed items + href: ../../api/drive-list-following.md + - name: List children + href: ../../api/driveitem-list-children.md + - name: List changes + href: ../../api/driveitem-delta.md + - name: Search + href: ../../api/driveitem-search.md + - name: Get special folder + href: ../../api/drive-get-specialfolder.md +- name: Drive item + items: + - name: Drive item + href: ../../resources/driveitem.md + - name: Get item + href: ../../api/driveitem-get.md + - name: Get analytics + href: ../../api/itemanalytics-get.md + - name: Get activities by interval + href: ../../api/itemactivitystat-getactivitybyinterval.md + - name: List children + href: ../../api/driveitem-list-children.md + - name: List versions + href: ../../api/driveitem-list-versions.md + - name: Create item + href: ../../api/driveitem-post-children.md + - name: Update item + href: ../../api/driveitem-update.md + - name: Upload content + href: ../../api/driveitem-put-content.md + - name: Download content + href: ../../api/driveitem-get-content.md + - name: Download specific file format + href: ../../api/driveitem-get-content-format.md + - name: Delete item + href: ../../api/driveitem-delete.md + - name: PermanentDelete item + href: ../../api/driveitem-permanentdelete.md + - name: Move item + href: ../../api/driveitem-move.md + - name: Copy item + href: ../../api/driveitem-copy.md + - name: Search items + href: ../../api/driveitem-search.md + - name: List changes in a drive + href: ../../api/driveitem-delta.md + - name: Follow Item + href: ../../api/driveitem-follow.md + - name: Unfollow Item + href: ../../api/driveitem-unfollow.md + - name: List thumbnails + href: ../../api/driveitem-list-thumbnails.md + - name: Create sharing link + href: ../../api/driveitem-createlink.md + - name: Add permissions + href: ../../api/driveitem-invite.md + - name: List permissions + href: ../../api/driveitem-list-permissions.md + - name: Delete permission + href: ../../api/permission-delete.md + - name: Get WebSocket channel + href: ../../api/subscriptions-socketio.md + - name: Preview item + href: ../../api/driveitem-preview.md + - name: Check in + href: ../../api/driveitem-checkin.md + - name: Check out + href: ../../api/driveitem-checkout.md + - name: Extract sensitivity labels + href: ../../api/driveitem-extractsensitivitylabels.md + - name: Assign sensitivity label + href: ../../api/driveitem-assignsensitivitylabel.md + - name: Get retention label + href: ../../api/driveitem-getretentionlabel.md + - name: Set retention label + href: ../../api/driveitem-setretentionlabel.md + - name: Remove retention label + href: ../../api/driveitem-removeretentionlabel.md + - name: Lock or unlock record + href: ../../api/driveitem-lockorunlockrecord.md +- name: Bundle + items: + - name: Bundle + href: ../../resources/bundle.md + - name: List bundles + href: ../../api/bundle-list.md + - name: Get bundle + href: ../../api/bundle-get.md + - name: Create bundle + href: ../../api/drive-post-bundles.md + - name: Add item + href: ../../api/bundle-addItem.md + - name: Remove item + href: ../../api/bundle-removeItem.md + - name: Update bundle + href: ../../api/bundle-update.md + - name: Delete bundle + href: ../../api/bundle-delete.md +- name: Permission + items: + - name: Permission + href: ../../resources/permission.md + - name: List permissions + href: ../../api/driveitem-list-permissions.md + - name: Get permission + href: ../../api/permission-get.md + - name: Add + href: ../../api/driveitem-invite.md + - name: Update + href: ../../api/permission-update.md + - name: Delete + href: ../../api/permission-delete.md + - name: Add users to sharing link + href: ../../api/permission-grant.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/groups/toc.yml | +items: +- name: Overview + href: ../../resources/groups-overview.md +- name: Group + href: ../../resources/group.md + items: + - name: List groups + href: ../../api/group-list.md + - name: Create group + href: ../../api/group-post-groups.md + - name: Get group + href: ../../api/group-get.md + - name: Update group + href: ../../api/group-update.md + - name: Upsert group + href: ../../api/group-upsert.md + - name: Delete group + href: ../../api/group-delete.md + - name: Renew group + href: ../../api/group-renew.md + - name: Add favorite + href: ../../api/group-addfavorite.md + - name: Remove favorite + href: ../../api/group-removefavorite.md + - name: List members + href: ../../api/group-list-members.md + - name: Add member + href: ../../api/group-post-members.md + - name: Remove member + href: ../../api/group-delete-members.md + - name: List member of + href: ../../api/group-list-memberof.md + - name: List transitive member of + href: ../../api/group-list-transitivememberof.md + - name: List transitive members + href: ../../api/group-list-transitivemembers.md + - name: List owners + href: ../../api/group-list-owners.md + - name: Add owner + href: ../../api/group-post-owners.md + - name: Remove owner + href: ../../api/group-delete-owners.md + - name: Get delta + href: ../../api/group-delta.md + - name: Get delta for directory object + href: ../../api/directoryobject-delta.md + - name: Assign license + href: ../../api/group-assignlicense.md + - name: List joined teams + href: ../../api/user-list-joinedteams.md + - name: List associated teams + href: ../../api/associatedteaminfo-list.md + - name: List lifecycle policies + href: ../../api/group-list-grouplifecyclepolicies.md + - name: List photos + href: ../../api/group-list-photos.md + - name: List permission grants + href: ../../api/group-list-permissiongrants.md + - name: Reset unseen count + href: ../../api/group-resetunseencount.md + - name: Subscribe by mail + href: ../../api/group-subscribebymail.md + - name: Unsubscribe by mail + href: ../../api/group-unsubscribebymail.md + - name: Lifecycle policy + href: ../../resources/grouplifecyclepolicy.md + items: + - name: List policies + href: ../../api/grouplifecyclepolicy-list.md + - name: Create policy + href: ../../api/grouplifecyclepolicy-post-grouplifecyclepolicies.md + - name: Get policy + href: ../../api/grouplifecyclepolicy-get.md + - name: Update policy + href: ../../api/grouplifecyclepolicy-update.md + - name: Delete policy + href: ../../api/grouplifecyclepolicy-delete.md + - name: Add group + href: ../../api/grouplifecyclepolicy-addgroup.md + - name: Remove group + href: ../../api/grouplifecyclepolicy-removegroup.md + - name: Validate properties + href: ../../api/group-validateproperties.md +- name: App role assignment + href: ../../resources/approleassignment.md + items: + - name: List + href: ../../api/group-list-approleassignments.md + - name: Add + href: ../../api/group-post-approleassignments.md + - name: Get + href: ../../api/approleassignment-get.md + - name: Remove + href: ../../api/group-delete-approleassignments.md + - name: Get delta for directory object + href: ../../api/directoryobject-delta.md +- name: Attachment + items: + - name: Attachment + href: ../../resources/attachment.md + - name: File attachment type + href: ../../resources/fileattachment.md + - name: Item attachment type + href: ../../resources/itemattachment.md + - name: Reference attachment type + href: ../../resources/referenceattachment.md + - name: Get attachment + href: ../../api/attachment-get.md + - name: Delete attachment + href: ../../api/attachment-delete.md +- name: Calendar + href: ../../resources/calendar.md + items: + - name: Get calendar + href: ../../api/calendar-get.md + - name: Update calendar + href: ../../api/calendar-update.md + - name: List events + href: ../../api/group-list-events.md + - name: Create event + href: ../../api/group-post-events.md + - name: Get event + href: ../../api/group-get-event.md + - name: Update event + href: ../../api/group-update-event.md + - name: Delete event + href: ../../api/group-delete-event.md + - name: List calendar view + href: ../../api/group-list-calendarview.md + - name: Get delta + href: ../../api/event-delta.md + - name: Create open extension + href: ../../api/opentypeextension-post-opentypeextension.md + - name: Get open extension + href: ../../api/opentypeextension-get.md +- name: Conversation + href: ../../resources/conversation.md + items: + - name: List conversations + href: ../../api/group-list-conversations.md + - name: Create conversation + href: ../../api/group-post-conversations.md + - name: Get group conversation + href: ../../api/group-get-conversation.md + - name: Delete group conversation + href: ../../api/group-delete-conversation.md + - name: List conversation threads + href: ../../api/conversation-list-threads.md + - name: Create conversation thread + href: ../../api/conversation-post-threads.md + - name: List accepted senders + href: ../../api/group-list-acceptedsenders.md + - name: Create accepted sender + href: ../../api/group-post-acceptedsenders.md + - name: Remove accepted sender + href: ../../api/group-delete-acceptedsenders.md + - name: List rejected senders + href: ../../api/group-list-rejectedsenders.md + - name: Create rejected sender + href: ../../api/group-post-rejectedsenders.md + - name: Remove rejected senders + href: ../../api/group-delete-rejectedsenders.md +- name: Conversation thread + href: ../../resources/conversationthread.md + items: + - name: List threads + href: ../../api/group-list-threads.md + - name: Create thread + href: ../../api/group-post-threads.md + - name: Get conversation thread + href: ../../api/group-get-thread.md + - name: Update conversation thread + href: ../../api/group-update-thread.md + - name: Delete conversation thread + href: ../../api/group-delete-thread.md + - name: Reply to conversation thread + href: ../../api/conversationthread-reply.md +- name: Directory object + href: ../../resources/directoryobject.md + items: + - name: Get delta + href: ../../api/directoryobject-delta.md + - name: Check member groups + href: ../../api/directoryobject-checkmembergroups.md + - name: Get member groups + href: ../../api/directoryobject-getmembergroups.md + - name: Check member objects + href: ../../api/directoryobject-checkmemberobjects.md + - name: Get member objects + href: ../../api/directoryobject-getmemberobjects.md + - name: List deleted groups + href: ../../api/directory-deleteditems-list.md + - name: List deleted groups owned by user + href: ../../api/directory-deleteditems-getuserownedobjects.md + - name: Get deleted group + href: ../../api/directory-deleteditems-get.md + - name: Permanently delete group + href: ../../api/directory-deleteditems-delete.md + - name: Restore deleted group + href: ../../api/directory-deleteditems-restore.md +- name: Drive + href: ../../resources/drive.md + items: + - name: Get drive + href: ../../api/drive-get.md + - name: List children + href: ../../api/driveitem-list-children.md +- name: Extended properties + items: + - name: Overview + href: ../../resources/extended-properties-overview.md + - name: Single-value extended property + items: + - name: Single-value extended property + href: ../../resources/singlevaluelegacyextendedproperty.md + - name: Create single-value property + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get single-value property + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Multi-value extended property + items: + - name: Multi-value extended property + href: ../../resources/multivaluelegacyextendedproperty.md + - name: Create multi-value property + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get multi-value property + href: ../../api/multivaluelegacyextendedproperty-get.md +- name: Notes + items: + - name: OneNote root + href: ../../resources/onenote.md + - name: List notebooks + href: ../../api/onenote-list-notebooks.md + - name: Create notebook + href: ../../api/onenote-post-notebooks.md +- name: Photo + items: + - name: Profile photo + href: ../../resources/profilephoto.md + - name: Get photo + href: ../../api/profilephoto-get.md + - name: Update photo + href: ../../api/profilephoto-update.md + - name: Delete photo + href: ../../api/profilephoto-delete.md +- name: Planner + items: + - name: Planner plan + href: ../../resources/plannerplan.md + - name: List plans + href: ../../api/plannergroup-list-plans.md +- name: Post + href: ../../resources/post.md + items: + - name: List posts + href: ../../api/conversationthread-list-posts.md + - name: Get post + href: ../../api/post-get.md + - name: Reply post + href: ../../api/post-reply.md + - name: Forward post + href: ../../api/post-forward.md + - name: List attachments + href: ../../api/post-list-attachments.md + - name: Add attachment + href: ../../api/post-post-attachments.md + - name: Create open extension + href: ../../api/opentypeextension-post-opentypeextension.md + - name: Get open extension + href: ../../api/opentypeextension-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 | +items: +- name: Overview + href: ../../resources/azure-ad-overview.md +- name: Directory management + items: + - name: Administrative unit + items: + - name: Administrative unit + href: ../../resources/administrativeunit.md + - name: Create + href: ../../api/directory-post-administrativeunits.md + - name: List + href: ../../api/directory-list-administrativeunits.md + - name: Get + href: ../../api/administrativeunit-get.md + - name: Update + href: ../../api/administrativeunit-update.md + - name: Delete + href: ../../api/administrativeunit-delete.md + - name: Add a member + href: ../../api/administrativeunit-post-members.md + - name: List members + href: ../../api/administrativeunit-list-members.md + - name: Get a member + href: ../../api/administrativeunit-get-members.md + - name: Remove a member + href: ../../api/administrativeunit-delete-members.md + - name: Add a scopedRoleMember + href: ../../api/administrativeunit-post-scopedrolemembers.md + - name: List scopedRoleMembers + href: ../../api/administrativeunit-list-scopedrolemembers.md + - name: Get a scopedRoleMember + href: ../../api/administrativeunit-get-scopedrolemembers.md + - name: Remove a scopedRoleMember + href: ../../api/administrativeunit-delete-scopedrolemembers.md + - name: BitLocker recovery key + items: + - name: BitLocker recovery key + href: ../../resources/bitlockerrecoverykey.md + - name: List recoveryKeys + href: ../../api/bitlocker-list-recoverykeys.md + - name: Get bitlockerRecoveryKey + href: ../../api/bitlockerrecoverykey-get.md + - name: Contract + items: + - name: Contract + href: ../../resources/contract.md + - name: Get contract + href: ../../api/contract-get.md + - name: List contracts + href: ../../api/contract-list.md + - name: Custom security attributes + items: + - name: Overview + href: ../../resources/custom-security-attributes-overview.md + - name: Allowed value + items: + - name: Allowed value + href: ../../resources/allowedvalue.md + - name: List allowedValues + href: ../../api/customsecurityattributedefinition-list-allowedvalues.md + - name: Get allowedValue + href: ../../api/allowedvalue-get.md + - name: Create allowedValue + href: ../../api/customsecurityattributedefinition-post-allowedvalues.md + - name: Update allowedValue + href: ../../api/allowedvalue-update.md + - name: Attribute set + items: + - name: Attribute set + href: ../../resources/attributeset.md + - name: List attributeSets + href: ../../api/directory-list-attributesets.md + - name: Get attributeSet + href: ../../api/attributeset-get.md + - name: Create attributeSet + href: ../../api/directory-post-attributesets.md + - name: Update attributeSet + href: ../../api/attributeset-update.md + - name: Custom security attribute definition + items: + - name: Custom security attribute definition + href: ../../resources/customsecurityattributedefinition.md + - name: List customSecurityAttributeDefinitions + href: ../../api/directory-list-customsecurityattributedefinitions.md + - name: Get customSecurityAttributeDefinition + href: ../../api/customsecurityattributedefinition-get.md + - name: Create customSecurityAttributeDefinition + href: ../../api/directory-post-customsecurityattributedefinitions.md + - name: Update customSecurityAttributeDefinition + href: ../../api/customsecurityattributedefinition-update.md + - name: Deleted item + items: + - name: Deleted item + href: ../../resources/directory.md + - name: Get deleted item + href: ../../api/directory-deleteditems-get.md + - name: Restore deleted item + href: ../../api/directory-deleteditems-restore.md + - name: List deleted items + href: ../../api/directory-deleteditems-list.md + - name: Permanently delete an item + href: ../../api/directory-deleteditems-delete.md + - name: List deleted items owned by a user + href: ../../api/directory-deleteditems-getuserownedobjects.md + - name: Device + items: + - name: Device + href: ../../resources/device.md + - name: Get device + href: ../../api/device-get.md + - name: List devices + href: ../../api/device-list.md + - name: Update device + href: ../../api/device-update.md + - name: Delete device + href: ../../api/device-delete.md + - name: delta + href: ../../api/device-delta.md + - name: List memberOf + href: ../../api/device-list-memberof.md + - name: List transitive memberOf + href: ../../api/device-list-transitivememberof.md + - name: List registeredOwners + href: ../../api/device-list-registeredowners.md + - name: List registeredUsers + href: ../../api/device-list-registeredusers.md + - name: checkMemberObjects + href: ../../api/directoryobject-checkmemberobjects.md + - name: getMemberObjects + href: ../../api/directoryobject-checkmemberobjects.md + - name: Open extensions + items: + - name: Create open extension + href: ../../api/opentypeextension-post-opentypeextension.md + - name: Get open extension + href: ../../api/opentypeextension-get.md + - name: Schema extensions + items: + - name: Add schema extension values + href: ../../graph/extensibility-schema-groups + - name: Device local credential info + items: + - name: Device local credential info + href: ../../resources/devicelocalcredentialinfo.md + - name: List deviceLocationCredentialInfo + href: ../../api/directory-list-devicelocalcredentials.md + - name: Get deviceLocalCredentialInfo + href: ../../api/devicelocalcredentialinfo-get.md + - name: Directory object + items: + - name: Directory object + href: ../../resources/directoryobject.md + - name: Get directoryObject + href: ../../api/directoryobject-get.md + - name: Get delta + href: ../../api/directoryobject-delta.md + - name: Delete directoryObject + href: ../../api/directoryobject-delete.md + - name: Get available extension properties + href: ../../api/directoryobject-getavailableextensionproperties.md + - name: checkMemberGroups + href: ../../api/directoryobject-checkmembergroups.md + - name: getMemberGroups + href: ../../api/directoryobject-getmembergroups.md + - name: checkMemberObjects + href: ../../api/directoryobject-checkmemberobjects.md + - name: getMemberObjects + href: ../../api/directoryobject-getmemberobjects.md + - name: getByIds + href: ../../api/directoryobject-getbyids.md + - name: validateProperties + href: ../../api/directoryobject-validateproperties.md + - name: Directory role + items: + - name: Directory role + href: ../../resources/directoryrole.md + - name: Get directoryRole + href: ../../api/directoryrole-get.md + - name: List directoryRoles + href: ../../api/directoryrole-list.md + - name: Add member + href: ../../api/directoryrole-post-members.md + - name: List members + href: ../../api/directoryrole-list-members.md + - name: Remove a member + href: ../../api/directoryrole-delete-member.md + - name: Activate directoryRole + href: ../../api/directoryrole-post-directoryroles.md + - name: List scopedMembers + href: ../../api/directoryrole-list-scopedmembers.md + - name: delta + href: ../../api/directoryrole-delta.md + - name: Directory role template + items: + - name: Directory role template + href: ../../resources/directoryroletemplate.md + - name: Get directoryRoleTemplate + href: ../../api/directoryroletemplate-get.md + - name: List directoryRoleTemplate + href: ../../api/directoryroletemplate-list.md + - name: Domain + items: + - name: Domain + href: ../../resources/domain.md + - name: Get domain + href: ../../api/domain-get.md + - name: Create domain + href: ../../api/domain-post-domains.md + - name: List domain + href: ../../api/domain-list.md + - name: List domainNameReference + href: ../../api/domain-list-domainnamereferences.md + - name: List serviceConfigurationRecords + href: ../../api/domain-list-serviceconfigurationrecords.md + - name: List verificationDnsRecords + href: ../../api/domain-list-verificationdnsrecords.md + - name: Update domain + href: ../../api/domain-update.md + - name: Delete domain + href: ../../api/domain-delete.md + - name: ForceDelete domain + href: ../../api/domain-forcedelete.md + - name: Verify domain + href: ../../api/domain-verify.md + - name: Promote domain + href: ../../api/domain-promote.md + - name: Group setting + items: + - name: Group setting + href: ../../resources/groupsetting.md + - name: Create setting + href: ../../api/group-post-settings.md + - name: Get setting + href: ../../api/groupsetting-get.md + - name: List settings + href: ../../api/group-list-settings.md + - name: Update setting + href: ../../api/groupsetting-update.md + - name: Delete setting + href: ../../api/groupsetting-delete.md + - name: Group setting template + items: + - name: Group setting template + href: ../../resources/groupsettingtemplate.md + - name: Get groupSettingTemplate + href: ../../api/groupsettingtemplate-get.md + - name: List groupSettingTemplate + href: ../../api/groupsettingtemplate-list.md + - name: On-premises directory synchronization + items: + - name: On-premises directory synchronization + href: ../../resources/onpremisesdirectorysynchronization.md + - name: Get onPremisesDirectorySynchronization + href: ../../api/onpremisesdirectorysynchronization-get.md + - name: Update onPremisesDirectorySynchronization + href: ../../api/onpremisesdirectorysynchronization-update.md + - name: Org contact + items: + - name: Org contact + href: ../../resources/orgcontact.md + - name: Organizational contacts + items: + - name: List organizational contacts + href: ../../api/orgcontact-list.md + - name: Get organizational contact + href: ../../api/orgcontact-get.md + - name: Organizational hierarchy + items: + - name: Get manager + href: ../../api/orgcontact-get-manager.md + - name: List directReports + href: ../../api/orgcontact-list-directreports.md + - name: List memberOf + href: ../../api/orgcontact-list-memberof.md + - name: List transitiveMemberOf + href: ../../api/orgcontact-list-transitivememberof.md + - name: checkMemberGroups + href: ../../api/directoryobject-checkmembergroups.md + - name: getMemberGroups + href: ../../api/directoryobject-getmembergroups.md + - name: getMemberObjects + href: ../../api/directoryobject-getmemberobjects.md + - name: Organization + items: + - name: Organization + href: ../../resources/organization.md + - name: List organizations + href: ../../api/organization-list.md + - name: Get organization + href: ../../api/organization-get.md + - name: Update + href: ../../api/organization-update.md + - name: Role management + items: + - name: Role management + href: ../../resources/rolemanagement.md + - name: Unified role definition + items: + - name: Unified role definition + href: ../../resources/unifiedroledefinition.md + - name: List unifiedRoleDefinition + href: ../../api/rbacapplication-list-roledefinitions.md + - name: Get unifiedRoleDefinition + href: ../../api/unifiedroledefinition-get.md + - name: Create roleDefinitions + href: ../../api/rbacapplication-post-roledefinitions.md + - name: Update unifiedRoleDefinition + href: ../../api/unifiedroledefinition-update.md + - name: Delete unifiedRoleDefinition + href: ../../api/unifiedroledefinition-delete.md + - name: Unified role assignment + items: + - name: Unified role assignment + href: ../../resources/unifiedroleassignment.md + - name: List unifiedRoleAssignments + href: ../../api/rbacapplication-list-roleassignments.md + - name: Create unifiedRoleAssignment + href: ../../api/rbacapplication-post-roleassignments.md + - name: Get unifiedRoleAssignment + href: ../../api/unifiedroleassignment-get.md + - name: Delete unifiedRoleAssignment + href: ../../api/unifiedroleassignment-delete.md + - name: Subscribed SKU + items: + - name: Subscribed SKU + href: ../../resources/subscribedsku.md + - name: Get subscribedSku + href: ../../api/subscribedsku-get.md + - name: List subscribedsku + href: ../../api/subscribedsku-list.md + - name: Tenant information + items: + - name: Tenant information + href: ../../resources/tenantinformation.md + - name: Find tenant by domain name + href: ../../api/tenantrelationship-findtenantinformationbydomainname.md + - name: Find tenant by tenant ID + href: ../../api/tenantrelationship-findtenantinformationbytenantid.md +- name: Governance + displayName: Identity Governance, Access reviews, Entitlement Management, Terms of Use, Privileged Identity Management + items: + - name: Overview + href: ../../resources/identitygovernance-overview.md + - name: Access reviews + items: + - name: Overview + href: ../../resources/accessreviewsv2-overview.md + - name: Access review history definition + items: + - name: Access review history definition + href: ../../resources/accessreviewhistorydefinition.md + - name: List accessReviewHistoryDefinitions + href: ../../api/accessreviewset-list-historydefinitions.md + - name: Create accessReviewHistoryDefinition + href: ../../api/accessreviewset-post-historydefinitions.md + - name: Get accessReviewHistoryDefinition + href: ../../api/accessreviewhistorydefinition-get.md + - name: Access review history instance + items: + - name: Access review history instance + href: ../../resources/accessreviewhistoryinstance.md + - name: List accessReviewHistoryInstances + href: ../../api/accessreviewhistorydefinition-list-instances.md + - name: generateDownloadUri + href: ../../api/accessreviewhistoryinstance-generatedownloaduri.md + - name: Access review instance + items: + - name: Access review instance + href: ../../resources/accessreviewinstance.md + - name: List accessReviewInstances + href: ../../api/accessreviewscheduledefinition-list-instances.md + - name: Get accessReviewInstance + href: ../../api/accessreviewinstance-get.md + - name: Update accessReviewInstance + href: ../../api/accessreviewinstance-update.md + - name: filterByCurrentUser + href: ../../api/accessreviewinstance-filterbycurrentuser.md + - name: List contacted reviewers + href: ../../api/accessreviewinstance-list-contactedreviewers.md + - name: sendReminder + href: ../../api/accessreviewinstance-sendreminder.md + - name: stop + href: ../../api/accessreviewinstance-stop.md + - name: acceptRecommendations + href: ../../api/accessreviewinstance-acceptrecommendations.md + - name: applyDecisions + href: ../../api/accessreviewinstance-applydecisions.md + - name: batchRecordDecisions + href: ../../api/accessreviewinstance-batchrecorddecisions.md + - name: resetDecisions + href: ../../api/accessreviewinstance-resetdecisions.md + - name: List stages + href: ../../api/accessreviewinstance-list-stages.md + - name: List decisions + href: ../../api/accessreviewinstance-list-decisions.md + - name: Access review instance decision item + displayName: access review decisions + items: + - name: Access review instance decision item + href: ../../resources/accessreviewinstancedecisionitem.md + - name: List decisions + href: ../../api/accessreviewinstance-list-decisions.md + - name: List decisions + href: ../../api/accessreviewstage-list-decisions.md + - name: Get accessReviewInstanceDecisionItem + href: ../../api/accessreviewinstancedecisionitem-get.md + - name: Update accessReviewInstanceDecisionItem + href: ../../api/accessreviewinstancedecisionitem-update.md + - name: filterByCurrentUser + href: ../../api/accessreviewinstancedecisionitem-filterbycurrentuser.md + - name: Access review schedule definition + items: + - name: Access review schedule definition + href: ../../resources/accessreviewscheduledefinition.md + - name: List accessReviewScheduleDefinitions + href: ../../api/accessreviewset-list-definitions.md + - name: Get accessReviewScheduleDefinition + href: ../../api/accessreviewscheduledefinition-get.md + - name: Create accessReviewScheduleDefinition + href: ../../api/accessreviewset-post-definitions.md + - name: Delete accessReviewScheduleDefinition + href: ../../api/accessreviewscheduledefinition-delete.md + - name: Update accessReviewScheduleDefinition + href: ../../api/accessreviewscheduledefinition-update.md + - name: filterByCurrentUser + href: ../../api/accessreviewscheduledefinition-filterbycurrentuser.md + - name: Access review stage + items: + - name: Access review stage + href: ../../resources/accessreviewstage.md + - name: List accessReviewStages + href: ../../api/accessreviewinstance-list-stages.md + - name: Get accessReviewStage + href: ../../api/accessreviewstage-get.md + - name: Update accessReviewStage + href: ../../api/accessreviewstage-update.md + - name: stop + href: ../../api/accessreviewstage-stop.md + - name: filterByCurrentUser + href: ../../api/accessreviewstage-filterbycurrentuser.md + - name: List decisions + href: ../../api/accessreviewstage-list-decisions.md + - name: Complex types + items: + - name: Access review apply action + href: ../../resources/accessreviewapplyaction.md + - name: Access review history schedule settings + href: ../../resources/accessreviewhistoryschedulesettings.md + - name: Access review inactive users query scope + href: ../../resources/accessreviewinactiveusersqueryscope.md + - name: Access review instance decision item access package assignment policy resource + href: ../../resources/accessreviewinstancedecisionitemaccesspackageassignmentpolicyresource.md + - name: Access review instance decision item Azure role resource + href: ../../resources/accessreviewinstancedecisionitemazureroleresource.md + - name: Access review instance decision item resource + href: ../../resources/accessreviewinstancedecisionitemresource.md + - name: Access review instance decision item service principal resource + href: ../../resources/accessreviewinstancedecisionitemserviceprincipalresource.md + - name: Access review notification recipient item + href: ../../resources/accessreviewnotificationrecipientitem.md + - name: Access review notification recipient query scope + href: ../../resources/accessreviewnotificationrecipientqueryscope.md + - name: Access review notification recipient scope + href: ../../resources/accessreviewnotificationrecipientscope.md + - name: Access review query scope + href: ../../resources/accessreviewqueryscope.md + - name: Access review recommendation insight setting + href: ../../resources/accessreviewrecommendationinsightsetting.md + - name: Access review reviewer + href: ../../resources/accessreviewreviewer.md + - name: Access review reviewer scope + href: ../../resources/accessreviewreviewerscope.md + - name: Access review schedule settings + href: ../../resources/accessreviewschedulesettings.md + - name: Access review scope + href: ../../resources/accessreviewscope.md + - name: Access review set + href: ../../resources/accessreviewset.md + - name: Access review stage settings + href: ../../resources/accessreviewstagesettings.md + - name: App consent approval route + href: ../../resources/appconsentapprovalroute.md + - name: App consent request scope + href: ../../resources/appconsentrequestscope.md + - name: Disable and delete user apply action + href: ../../resources/disableanddeleteuserapplyaction.md + - name: Governance insight + href: ../../resources/governanceinsight.md + - name: Group peer outlier recommendation insight settings + href: ../../resources/grouppeeroutlierrecommendationinsightsettings.md + - name: Identity + href: ../../resources/identity.md + - name: Identity governance + href: ../../resources/identitygovernance.md + - name: Identity set + href: ../../resources/identityset.md + - name: Patterned recurrence + href: ../../resources/patternedrecurrence.md + - name: Principal resource memberships scope + href: ../../resources/principalresourcemembershipsscope.md + - name: Recurrence pattern + href: ../../resources/recurrencepattern.md + - name: Recurrence range + href: ../../resources/recurrencerange.md + - name: Remove access apply action + href: ../../resources/removeaccessapplyaction.md + - name: Request + href: ../../resources/request.md + - name: Service principal identity + href: ../../resources/serviceprincipalidentity.md + - name: User identity + href: ../../resources/useridentity.md + - name: User last sign in recommendation insight setting + href: ../../resources/userlastsigninrecommendationinsightsetting.md + - name: User sign in insight + href: ../../resources/usersignininsight.md + - name: Consent requests + items: + - name: Overview + href: ../../resources/consentrequests-overview.md + - name: Admin consent request policy + items: + - name: Admin consent request policy + href: ../../resources/adminconsentrequestpolicy.md + - name: Get adminConsentRequestPolicy + href: ../../api/adminconsentrequestpolicy-get.md + - name: Update adminConsentRequestPolicy + href: ../../api/adminconsentrequestpolicy-update.md + - name: App consent request + items: + - name: App consent request + href: ../../resources/appconsentrequest.md + - name: List appConsentRequests + href: ../../api/appconsentapprovalroute-list-appconsentrequests.md + - name: Get appConsentRequest + href: ../../api/appconsentrequest-get.md + - name: filterByCurrentUser + href: ../../api/appconsentrequest-filterByCurrentUser.md + - name: User consent request + items: + - name: User consent request + href: ../../resources/userconsentrequest.md + - name: List userConsentRequests + href: ../../api/appconsentrequest-list-userconsentrequests.md + - name: Get userConsentRequest + href: ../../api/userconsentrequest-get.md + - name: filterByCurrentUser + href: ../../api/userconsentrequest-filterByCurrentUser.md + - name: Entitlement management + items: + - name: Overview + href: ../../resources/entitlementmanagement-overview.md + - name: Access package + items: + - name: Access package + href: ../../resources/accesspackage.md + - name: List accessPackages + href: ../../api/entitlementmanagement-list-accesspackages.md + - name: Create accessPackage + href: ../../api/entitlementmanagement-post-accesspackages.md + - name: Get accessPackage + href: ../../api/accesspackage-get.md + - name: Update accessPackage + href: ../../api/accesspackage-update.md + - name: Delete accessPackage + href: ../../api/accesspackage-delete.md + - name: List incompatibleAccessPackages + href: ../../api/accesspackage-list-incompatibleaccesspackages.md + - name: Add accessPackage to incompatibleAccessPackages + href: ../../api/accesspackage-post-incompatibleaccesspackage.md + - name: Remove accessPackage from incompatibleAccessPackages + href: ../../api/accesspackage-delete-incompatibleaccesspackage.md + - name: List incompatibleGroups + href: ../../api/accesspackage-list-incompatiblegroups.md + - name: Add group to incompatibleGroups + href: ../../api/accesspackage-post-incompatiblegroup.md + - name: Remove group from incompatibleGroups + href: ../../api/accesspackage-delete-incompatiblegroup.md + - name: List accessPackagesIncompatibleWith + href: ../../api/accesspackage-list-accesspackagesincompatiblewith.md + - name: filterByCurrentUser + href: ../../api/accesspackage-filterbycurrentuser.md + - name: getApplicablePolicyRequirements + href: ../../api/accesspackage-getapplicablepolicyrequirements.md + - name: List accessPackageResourceRoleScopes + href: ../../api/accesspackage-list-resourcerolescopes.md + - name: Create accessPackageResourceRoleScope + href: ../../api/accesspackage-post-resourcerolescopes.md + - name: Delete accessPackageResourceRoleScope + href: ../../api/accesspackage-delete-resourcerolescopes.md + - name: Access package assignment + items: + - name: Access package assignment + href: ../../resources/accesspackageassignment.md + - name: List accessPackageAssignments + href: ../../api/entitlementmanagement-list-assignments.md + - name: Get accessPackageAssignment + href: ../../api/accesspackageassignment-get.md + - name: filterByCurrentUser + href: ../../api/accesspackageassignment-filterbycurrentuser.md + - name: reprocess + href: ../../api/accesspackageassignment-reprocess.md + - name: additionalAccess + href: ../../api/accesspackageassignment-additionalaccess.md + - name: Access package assignment policy + items: + - name: Access package assignment policy + href: ../../resources/accesspackageassignmentpolicy.md + - name: List accessPackageAssignmentPolicies + href: ../../api/entitlementmanagement-list-assignmentpolicies.md + - name: Create accessPackageAssignmentPolicy + href: ../../api/entitlementmanagement-post-assignmentpolicies.md + - name: Get accessPackageAssignmentPolicy + href: ../../api/accesspackageassignmentpolicy-get.md + - name: Update accessPackageAssignmentPolicy + href: ../../api/accesspackageassignmentpolicy-update.md + - name: Delete accessPackageAssignmentPolicy + href: ../../api/accesspackageassignmentpolicy-delete.md + - name: Access package assignment request + items: + - name: Access package assignment request + href: ../../resources/accesspackageassignmentrequest.md + - name: List accessPackageAssignmentRequests + href: ../../api/entitlementmanagement-list-assignmentrequests.md + - name: Create accessPackageAssignmentRequest + href: ../../api/entitlementmanagement-post-assignmentrequests.md + - name: Get accessPackageAssignmentRequest + href: ../../api/accesspackageassignmentrequest-get.md + - name: Delete accessPackageAssignmentRequest + href: ../../api/accesspackageassignmentrequest-delete.md + - name: filterByCurrentUser + href: ../../api/accesspackageassignmentrequest-filterbycurrentuser.md + - name: cancel + href: ../../api/accesspackageassignmentrequest-cancel.md + - name: reprocess + href: ../../api/accesspackageassignmentrequest-reprocess.md + - name: Access package assignment request workflow extension + items: + - name: Access package assignment request workflow extension + href: ../../resources/accesspackageassignmentrequestworkflowextension.md + - name: List accessPackageAssignmentRequestWorkflowExtension + href: ../../api/accesspackagecatalog-list-accesspackagecustomworkflowextensions.md + - name: Create accessPackageAssignmentRequestWorkflowExtension + href: ../../api/accesspackagecatalog-post-accesspackagecustomworkflowextensions.md + - name: Get accessPackageAssignmentRequestWorkflowExtension + href: ../../api/accesspackageassignmentrequestworkflowextension-get.md + - name: Update accessPackageAssignmentRequestWorkflowExtension + href: ../../api/accesspackageassignmentrequestworkflowextension-update.md + - name: Delete accessPackageAssignmentRequestWorkflowExtension + href: ../../api/accesspackageassignmentrequestworkflowextension-delete.md + - name: Access package assignment workflow extension + items: + - name: Access package assignment workflow extension + href: ../../resources/accesspackageassignmentworkflowextension.md + - name: List accessPackageAssignmentWorkflowExtensions + href: ../../api/accesspackagecatalog-list-accesspackagecustomworkflowextensions.md + - name: Create accessPackageAssignmentWorkflowExtension + href: ../../api/accesspackagecatalog-post-accesspackagecustomworkflowextensions.md + - name: Get accessPackageAssignmentWorkflowExtension + href: ../../api/accesspackageassignmentworkflowextension-get.md + - name: Update accessPackageAssignmentWorkflowExtension + href: ../../api/accesspackageassignmentworkflowextension-update.md + - name: Delete accessPackageAssignmentWorkflowExtension + href: ../../api/accesspackageassignmentworkflowextension-delete.md + - name: Access package catalog + items: + - name: Access package catalog + href: ../../resources/accesspackagecatalog.md + - name: List accessPackageCatalogs + href: ../../api/entitlementmanagement-list-catalogs.md + - name: Create accessPackageCatalog + href: ../../api/entitlementmanagement-post-catalogs.md + - name: Get accessPackageCatalog + href: ../../api/accesspackagecatalog-get.md + - name: Update accessPackageCatalog + href: ../../api/accesspackagecatalog-update.md + - name: Delete accessPackageCatalog + href: ../../api/accesspackagecatalog-delete.md + - name: List accessPackageCatalog resources + href: ../../api/accesspackagecatalog-list-resources.md + - name: List accessPackageCatalog resource roles + href: ../../api/accesspackagecatalog-list-resourceroles.md + - name: Access package resource + items: + - name: Access package resource + href: ../../resources/accesspackageresource.md + - name: List accessPackageCatalog resources + href: ../../api/accesspackagecatalog-list-resources.md + - name: Access package resource environment + items: + - name: Access package resource environment + href: ../../resources/accesspackageresourceenvironment.md + - name: List accessPackageResourceEnvironments + href: ../../api/entitlementmanagement-list-resourceenvironments.md + - name: Access package resource request + items: + - name: Access package resource request + href: ../../resources/accesspackageresourcerequest.md + - name: List accessPackageResourceRequests + href: ../../api/entitlementmanagement-list-resourcerequests.md + - name: Create accessPackageResourceRequest + href: ../../api/entitlementmanagement-post-resourcerequests.md + - name: Access package resource role + items: + - name: Access package resource role + href: ../../resources/accesspackageresourcerole.md + - name: List accessPackageCatalog resource roles + href: ../../api/accesspackagecatalog-list-resourceroles.md + - name: Access package resource role scope + items: + - name: Access package resource role scope + href: ../../resources/accesspackageresourcerolescope.md + - name: List accessPackageResourceRoleScopes + href: ../../api/accesspackage-list-resourcerolescopes.md + - name: Create accessPackageResourceRoleScope + href: ../../api/accesspackage-post-resourcerolescopes.md + - name: Delete accessPackageResourceRoleScope + href: ../../api/accesspackage-delete-resourcerolescopes.md + - name: Connected organization + items: + - name: Connected organization + href: ../../resources/connectedorganization.md + - name: List connectedOrganizations + href: ../../api/entitlementmanagement-list-connectedorganizations.md + - name: Create connectedOrganization + href: ../../api/entitlementmanagement-post-connectedorganizations.md + - name: Get connectedOrganization + href: ../../api/connectedorganization-get.md + - name: Update connectedOrganization + href: ../../api/connectedorganization-update.md + - name: Delete connectedOrganization + href: ../../api/connectedorganization-delete.md + - name: List externalSponsors + href: ../../api/connectedorganization-list-externalsponsors.md + - name: Add externalSponsors + href: ../../api/connectedorganization-post-externalsponsors.md + - name: List internalSponsors + href: ../../api/connectedorganization-list-internalsponsors.md + - name: Add internalSponsors + href: ../../api/connectedorganization-post-internalsponsors.md + - name: Remove internalSponsors + href: ../../api/connectedorganization-delete-internalsponsors.md + - name: Remove externalSponsors + href: ../../api/connectedorganization-delete-externalsponsors.md + - name: Entitlement management settings + items: + - name: Entitlement management settings + href: ../../resources/entitlementmanagementsettings.md + - name: Get entitlementManagementSettings + href: ../../api/entitlementmanagementsettings-get.md + - name: Update entitlementManagementSettings + href: ../../api/entitlementmanagementsettings-update.md + - name: Complex types + items: + - name: Access package answer + href: ../../resources/accesspackageanswer.md + - name: Access package answer choice + href: ../../resources/accesspackageanswerchoice.md + - name: Access package answer string + href: ../../resources/accesspackageanswerstring.md + - name: Access package approval stage + href: ../../resources/accesspackageapprovalstage.md + - name: Access package assignment approval settings + href: ../../resources/accesspackageassignmentapprovalsettings.md + - name: Access package assignment request callback data + href: ../../resources/accesspackageassignmentrequestcallbackdata.md + - name: Access package assignment request requirements + href: ../../resources/accesspackageassignmentrequestrequirements.md + - name: Access package assignment requestor settings + href: ../../resources/accesspackageassignmentrequestorsettings.md + - name: Access package assignment review settings + href: ../../resources/accesspackageassignmentreviewsettings.md + - name: Access package automatic request settings + href: ../../resources/accesspackageautomaticrequestsettings.md + - name: Access package localized text + href: ../../resources/accesspackagelocalizedtext.md + - name: Access package multiple choice question + href: ../../resources/accesspackagemultiplechoicequestion.md + - name: Access package question + href: ../../resources/accesspackagequestion.md + - name: Access package resource attribute + href: ../../resources/accesspackageresourceattribute.md + - name: Access package resource attribute destination + href: ../../resources/accesspackageresourceattributedestination.md + - name: Access package resource attribute question + href: ../../resources/accesspackageresourceattributequestion.md + - name: Access package resource attribute source + href: ../../resources/accesspackageresourceattributesource.md + - name: Access package resource scope + href: ../../resources/accesspackageresourcescope.md + - name: Access package subject + href: ../../resources/accesspackagesubject.md + - name: Access package text input question + href: ../../resources/accesspackagetextinputquestion.md + - name: Access package user directory attribute store + href: ../../resources/accesspackageuserdirectoryattributestore.md + - name: Attribute rule members + href: ../../resources/attributerulemembers.md + - name: Azure active directory tenant + href: ../../resources/azureactivedirectorytenant.md + - name: Connected organization members + href: ../../resources/connectedorganizationmembers.md + - name: Connection info + href: ../../resources/connectioninfo.md + - name: Cross cloud Azure active directory tenant + href: ../../resources/crosscloudazureactivedirectorytenant.md + - name: Custom callout extension + href: ../../resources/customcalloutextension.md + - name: Custom extension authentication configuration + href: ../../resources/customextensionauthenticationconfiguration.md + - name: Custom extension callback configuration + href: ../../resources/customextensioncallbackconfiguration.md + - name: Custom extension callout instance + href: ../../resources/customextensioncalloutinstance.md + - name: Custom extension client configuration + href: ../../resources/customextensionclientconfiguration.md + - name: Custom extension data + href: ../../resources/customextensiondata.md + - name: Custom extension endpoint configuration + href: ../../resources/customextensionendpointconfiguration.md + - name: Custom extension stage setting + href: ../../resources/customextensionstagesetting.md + - name: Domain identity source + href: ../../resources/domainidentitysource.md + - name: Entitlement management + href: ../../resources/entitlementmanagement.md + - name: Entitlement management schedule + href: ../../resources/entitlementmanagementschedule.md + - name: Expiration pattern + href: ../../resources/expirationpattern.md + - name: External domain federation + href: ../../resources/externaldomainfederation.md + - name: External sponsors + href: ../../resources/externalsponsors.md + - name: Group members + href: ../../resources/groupmembers.md + - name: Identity source + href: ../../resources/identitysource.md + - name: Internal sponsors + href: ../../resources/internalsponsors.md + - name: Logic app trigger endpoint configuration + href: ../../resources/logicapptriggerendpointconfiguration.md + - name: Microsoft Entra pop token authentication + href: ../../resources/azureadpoptokenauthentication.md + - name: Patterned recurrence + href: ../../resources/patternedrecurrence.md + - name: Recurrence pattern + href: ../../resources/recurrencepattern.md + - name: Recurrence range + href: ../../resources/recurrencerange.md + - name: Requestor manager + href: ../../resources/requestormanager.md + - name: Single service principal + href: ../../resources/singleserviceprincipal.md + - name: Single user + href: ../../resources/singleuser.md + - name: Social identity source + href: ../../resources/socialidentitysource.md + - name: Subject set + href: ../../resources/subjectset.md + - name: Target application owners + href: ../../resources/targetapplicationowners.md + - name: Target manager + href: ../../resources/targetmanager.md + - name: Target user sponsors + href: ../../resources/targetusersponsors.md + - name: Lifecycle workflows + displayName: LCW, Identity Governance, Joiner, Mover, Leaver + items: + - name: Overview + href: ../../resources/identitygovernance-lifecycleworkflows-overview.md + - name: Custom task extension + items: + - name: Custom task extension + href: ../../resources/identitygovernance-customtaskextension.md + - name: List customTaskExtensions + href: ../../api/identitygovernance-lifecycleworkflowscontainer-list-customtaskextensions.md + - name: Create customTaskExtension + href: ../../api/identitygovernance-lifecycleworkflowscontainer-post-customtaskextensions.md + - name: Get customTaskExtension + href: ../../api/identitygovernance-customtaskextension-get.md + - name: Update customTaskExtension + href: ../../api/identitygovernance-customtaskextension-update.md + - name: Delete customTaskExtension + href: ../../api/identitygovernance-customtaskextension-delete.md + - name: Lifecycle management settings + items: + - name: Lifecycle management settings + href: ../../resources/identitygovernance-lifecyclemanagementsettings.md + - name: Get lifecycleManagementSettings + href: ../../api/identitygovernance-lifecyclemanagementsettings-get.md + - name: Update lifecycleManagementSettings + href: ../../api/identitygovernance-lifecyclemanagementsettings-update.md + - name: Task definition + items: + - name: Task definition + href: ../../resources/identitygovernance-taskdefinition.md + - name: List taskDefinitions + href: ../../api/identitygovernance-lifecycleworkflowscontainer-list-taskdefinitions.md + - name: Get taskDefinition + href: ../../api/identitygovernance-taskdefinition-get.md + - name: Workflow + items: + - name: Workflow + href: ../../resources/identitygovernance-workflow.md + - name: List workflows + href: ../../api/identitygovernance-lifecycleworkflowscontainer-list-workflows.md + - name: Create workflow + href: ../../api/identitygovernance-lifecycleworkflowscontainer-post-workflows.md + - name: Get workflow + href: ../../api/identitygovernance-workflow-get.md + - name: Update workflow + href: ../../api/identitygovernance-workflow-update.md + - name: Delete workflow + href: ../../api/identitygovernance-workflow-delete.md + - name: List users in scope + href: ../../api/workflow-list-executionscope.md + - name: Get a deleted workflow + href: ../../api/identitygovernance-deleteditemcontainer-get.md + - name: Permanently delete a workflow + href: ../../api/identitygovernance-deletedItemcontainer-delete.md + - name: List deleted workflows + href: ../../api/identitygovernance-lifecycleworkflowscontainer-list-deleteditems.md + - name: activate + href: ../../api/identitygovernance-workflow-activate.md + - name: Create workflowVersion + href: ../../api/identitygovernance-workflow-createnewversion.md + - name: restore + href: ../../api/identitygovernance-workflow-restore.md + - name: List runs + href: ../../api/identitygovernance-workflow-list-runs.md + - name: Get task + href: ../../api/identitygovernance-task-get.md + - name: List tasks + href: ../../api/identitygovernance-workflow-list-task.md + - name: List versions + href: ../../api/identitygovernance-workflow-list-versions.md + - name: Task + items: + - name: Task + href: ../../resources/identitygovernance-task.md + - name: List tasks + href: ../../api/identitygovernance-workflow-list-task.md + - name: Get task + href: ../../api/identitygovernance-task-get.md + - name: Update task + href: ../../api/identitygovernance-task-update.md + - name: Workflow version + items: + - name: Workflow version + href: ../../resources/identitygovernance-workflowversion.md + - name: List workflowVersions + href: ../../api/identitygovernance-workflow-list-versions.md + - name: Get workflowVersion + href: ../../api/identitygovernance-workflowversion-get.md + - name: List tasks + href: ../../api/identitygovernance-workflowversion-list-tasks.md + - name: Get task + href: ../../api/identitygovernance-task-get.md + - name: Reports + displayName: Lifecycle Workflows reporting + items: + - name: Overview + href: ../../resources/identitygovernance-lifecycleworkflows-reporting-overview.md + - name: User processing result + items: + - name: User processing result + href: ../../resources/identitygovernance-userprocessingresult.md + - name: List userProcessingResults + href: ../../api/identitygovernance-workflow-list-userprocessingresults.md + - name: Get userProcessingResult + href: ../../api/identitygovernance-userprocessingresult-get.md + - name: summary + href: ../../api/identitygovernance-userprocessingresult-summary.md + - name: List taskProcessingResults for a userProcessingResult + href: ../../api/identitygovernance-userprocessingresult-list-taskprocessingresults.md + - name: Task report + items: + - name: Task report + href: ../../resources/identitygovernance-taskreport.md + - name: List taskReports + href: ../../api/identitygovernance-workflow-list-taskreports.md + - name: Summary + href: ../../api/identitygovernance-taskreport-summary.md + - name: List taskProcessingResults + href: ../../api/identitygovernance-taskreport-list-taskprocessingresults.md + - name: Run + items: + - name: Run + href: ../../resources/identitygovernance-run.md + - name: List runs + href: ../../api/identitygovernance-workflow-list-runs.md + - name: Get run + href: ../../api/identitygovernance-run-get.md + - name: summary + href: ../../api/identitygovernance-run-summary.md + - name: List task processing results of a run + href: ../../api/identitygovernance-run-list-taskprocessingresults.md + - name: Task processing result + items: + - name: Task processing result + href: ../../resources/identitygovernance-taskprocessingresult.md + - name: resume + href: ../../api/identitygovernance-taskprocessingresult-resume.md + - name: Workflow template + items: + - name: Workflow template + href: ../../resources/identitygovernance-workflowtemplate.md + - name: List workflowTemplates + href: ../../api/identitygovernance-lifecycleworkflowscontainer-list-workflowtemplates.md + - name: Get workflowTemplate + href: ../../api/identitygovernance-workflowtemplate-get.md + - name: Complex types + items: + - name: Custom callout extension + href: ../../resources/customcalloutextension.md + - name: Custom extension authentication configuration + href: ../../resources/customextensionauthenticationconfiguration.md + - name: Custom extension callback configuration + href: ../../resources/customextensioncallbackconfiguration.md + - name: Custom extension callout request + href: ../../resources/customextensioncalloutrequest.md + - name: Custom extension callout response + href: ../../resources/customextensioncalloutresponse.md + - name: Custom extension client configuration + href: ../../resources/customextensionclientconfiguration.md + - name: Custom extension data + href: ../../resources/customextensiondata.md + - name: Custom extension endpoint configuration + href: ../../resources/customextensionendpointconfiguration.md + - name: Custom task extension callback configuration + href: ../../resources/identitygovernance-customtaskextensioncallbackconfiguration.md + - name: Custom task extension callback data + href: ../../resources/identitygovernance-customtaskextensioncallbackdata.md + - name: Custom task extension callout data + href: ../../resources/identitygovernance-customtaskextensioncalloutdata.md + - name: Email settings + href: ../../resources/emailsettings.md + - name: Identity + href: ../../resources/identity.md + - name: Identity governance + href: ../../resources/identitygovernance.md + - name: Key value pair + href: ../../resources/keyvaluepair.md + - name: Lifecycle workflows container + href: ../../resources/identitygovernance-lifecycleworkflowscontainer.md + - name: Logic app trigger endpoint configuration + href: ../../resources/logicapptriggerendpointconfiguration.md + - name: Microsoft Entra pop token authentication + href: ../../resources/azureadpoptokenauthentication.md + - name: On demand execution only + href: ../../resources/identitygovernance-ondemandexecutiononly.md + - name: Parameter + href: ../../resources/identitygovernance-parameter.md + - name: Rule based subject set + href: ../../resources/identitygovernance-rulebasedsubjectset.md + - name: Run summary + href: ../../resources/identitygovernance-runsummary.md + - name: Subject set + href: ../../resources/subjectset.md + - name: Task report summary + href: ../../resources/identitygovernance-taskreportsummary.md + - name: Time based attribute trigger + href: ../../resources/identitygovernance-timebasedattributetrigger.md + - name: Trigger and scope based conditions + href: ../../resources/identitygovernance-triggerandscopebasedconditions.md + - name: User summary + href: ../../resources/identitygovernance-usersummary.md + - name: Workflow base + href: ../../resources/identitygovernance-workflowbase.md + - name: Workflow execution conditions + href: ../../resources/identitygovernance-workflowexecutionconditions.md + - name: Workflow execution trigger + href: ../../resources/identitygovernance-workflowexecutiontrigger.md + - name: Privileged Identity Management + items: + - name: PIM for Microsoft Entra roles + displayName: Privileged Identity Management, PIM, Identity Governance + items: + - name: Overview + href: ../../resources/privilegedidentitymanagementv3-overview.md + - name: Unified role assignment schedule request + items: + - name: Unified role assignment schedule request + href: ../../resources/unifiedroleassignmentschedulerequest.md + - name: List unifiedRoleAssignmentScheduleRequests + href: ../../api/rbacapplication-list-roleassignmentschedulerequests.md + - name: Create unifiedRoleAssignmentScheduleRequest + href: ../../api/rbacapplication-post-roleassignmentschedulerequests.md + - name: Get unifiedRoleAssignmentScheduleRequest + href: ../../api/unifiedroleassignmentschedulerequest-get.md + - name: cancel + href: ../../api/unifiedroleassignmentschedulerequest-cancel.md + - name: filterByCurrentUser + href: ../../api/unifiedroleassignmentschedulerequest-filterbycurrentuser.md + - name: Unified role assignment schedule + items: + - name: Unified role assignment schedule + href: ../../resources/unifiedroleassignmentschedule.md + - name: List unifiedRoleAssignmentSchedules + href: ../../api/rbacapplication-list-roleassignmentschedules.md + - name: Get unifiedRoleAssignmentSchedule + href: ../../api/unifiedroleassignmentschedule-get.md + - name: filterByCurrentUser + href: ../../api/unifiedroleassignmentschedule-filterbycurrentuser.md + - name: Unified role assignment schedule instance + items: + - name: Unified role assignment schedule instance + href: ../../resources/unifiedroleassignmentscheduleinstance.md + - name: List unifiedRoleAssignmentScheduleInstances + href: ../../api/rbacapplication-list-roleassignmentscheduleinstances.md + - name: Get unifiedRoleAssignmentScheduleInstance + href: ../../api/unifiedroleassignmentscheduleinstance-get.md + - name: filterByCurrentUser + href: ../../api/unifiedroleassignmentscheduleinstance-filterbycurrentuser.md + - name: Unified role eligibility schedule request + items: + - name: Unified role eligibility schedule request + href: ../../resources/unifiedroleeligibilityschedulerequest.md + - name: List unifiedRoleEligibilityScheduleRequests + href: ../../api/rbacapplication-list-roleeligibilityschedulerequests.md + - name: Create unifiedRoleEligibilityScheduleRequest + href: ../../api/rbacapplication-post-roleeligibilityschedulerequests.md + - name: Get unifiedRoleEligibilityScheduleRequest + href: ../../api/unifiedroleeligibilityschedulerequest-get.md + - name: filterByCurrentUser + href: ../../api/unifiedroleeligibilityschedulerequest-filterbycurrentuser.md + - name: cancel + href: ../../api/unifiedroleeligibilityschedulerequest-cancel.md + - name: Unified role eligibility schedule + items: + - name: Unified role eligibility schedule + href: ../../resources/unifiedroleeligibilityschedule.md + - name: List unifiedRoleEligibilitySchedules + href: ../../api/rbacapplication-list-roleeligibilityschedules.md + - name: Get unifiedRoleEligibilitySchedule + href: ../../api/unifiedroleeligibilityschedule-get.md + - name: filterByCurrentUser + href: ../../api/unifiedroleeligibilityschedule-filterbycurrentuser.md + - name: Unified role eligibility schedule instance + items: + - name: Unified role eligibility schedule instance + href: ../../resources/unifiedroleeligibilityscheduleinstance.md + - name: List unifiedRoleEligibilityScheduleInstances + href: ../../api/rbacapplication-list-roleeligibilityscheduleinstances.md + - name: Get unifiedRoleEligibilityScheduleInstance + href: ../../api/unifiedroleeligibilityscheduleinstance-get.md + - name: filterByCurrentUser + href: ../../api/unifiedroleeligibilityscheduleinstance-filterbycurrentuser.md + - name: Unified role management policy + items: + - name: Unified role management policy + href: ../../resources/unifiedrolemanagementpolicy.md + - name: List unifiedRoleManagementPolicies + href: ../../api/policyroot-list-rolemanagementpolicies.md + - name: Get unifiedRoleManagementPolicy + href: ../../api/unifiedrolemanagementpolicy-get.md + - name: Update unifiedRoleManagementPolicy + href: ../../api/unifiedrolemanagementpolicy-update.md + - name: List rules + href: ../../api/unifiedrolemanagementpolicy-list-rules.md + - name: Get unifiedRoleManagementPolicyRule + href: ../../api/unifiedrolemanagementpolicyrule-get.md + - name: Update unifiedRoleManagementPolicyRule + href: ../../api/unifiedrolemanagementpolicyrule-update.md + - name: Unified role management policy rule + items: + - name: Unified role management policy rule + href: ../../resources/unifiedrolemanagementpolicyrule.md + - name: List unifiedRoleManagementPolicyRules + href: ../../api/unifiedrolemanagementpolicy-list-rules.md + - name: Get unifiedRoleManagementPolicyRule + href: ../../api/unifiedrolemanagementpolicyrule-get.md + - name: Update unifiedRoleManagementPolicyRule + href: ../../api/unifiedrolemanagementpolicyrule-update.md + - name: Unified role management policy assignment + items: + - name: Unified role management policy assignment + href: ../../resources/unifiedrolemanagementpolicyassignment.md + - name: List unifiedRoleManagementPolicyAssignments + href: ../../api/policyroot-list-rolemanagementpolicyassignments.md + - name: Get unifiedRoleManagementPolicyAssignment + href: ../../api/unifiedrolemanagementpolicyassignment-get.md + - name: PIM for Groups + items: + - name: Overview + href: ../../resources/privilegedidentitymanagement-for-groups-api-overview.md + - name: Privileged access group assignment schedule request + items: + - name: Privileged access group assignment schedule request + href: ../../resources/privilegedaccessgroupassignmentschedulerequest.md + - name: List assignmentScheduleRequests + href: ../../api/privilegedaccessgroup-list-assignmentschedulerequests.md + - name: Create assignmentScheduleRequest + href: ../../api/privilegedaccessgroup-post-assignmentschedulerequests.md + - name: Get privilegedAccessGroupAssignmentScheduleRequest + href: ../../api/privilegedaccessgroupassignmentschedulerequest-get.md + - name: filterByCurrentUser + href: ../../api/privilegedaccessgroupassignmentschedulerequest-filterbycurrentuser.md + - name: cancel + href: ../../api/privilegedaccessgroupassignmentschedulerequest-cancel.md + - name: Privileged access group assignment schedule + items: + - name: Privileged access group assignment schedule + href: ../../resources/privilegedaccessgroupassignmentschedule.md + - name: List assignmentSchedules + href: ../../api/privilegedaccessgroup-list-assignmentschedules.md + - name: Get privilegedAccessGroupAssignmentSchedule + href: ../../api/privilegedaccessgroupassignmentschedule-get.md + - name: filterByCurrentUser + href: ../../api/privilegedaccessgroupassignmentschedule-filterbycurrentuser.md + - name: Privileged access group assignment schedule instance + items: + - name: Privileged access group assignment schedule instance + href: ../../resources/privilegedaccessgroupassignmentscheduleinstance.md + - name: List assignmentScheduleInstances + href: ../../api/privilegedaccessgroup-list-assignmentscheduleinstances.md + - name: Get privilegedAccessGroupAssignmentScheduleInstance + href: ../../api/privilegedaccessgroupassignmentscheduleinstance-get.md + - name: filterByCurrentUser + href: ../../api/privilegedaccessgroupassignmentscheduleinstance-filterbycurrentuser.md + - name: Privileged access group eligibility schedule request + items: + - name: Privileged access group eligibility schedule request + href: ../../resources/privilegedaccessgroupeligibilityschedulerequest.md + - name: List eligibilityScheduleRequests + href: ../../api/privilegedaccessgroup-list-eligibilityschedulerequests.md + - name: Create eligibilityScheduleRequest + href: ../../api/privilegedaccessgroup-post-eligibilityschedulerequests.md + - name: Get privilegedAccessGroupEligibilityScheduleRequest + href: ../../api/privilegedaccessgroupeligibilityschedulerequest-get.md + - name: filterByCurrentUser + href: ../../api/privilegedaccessgroupeligibilityschedulerequest-filterbycurrentuser.md + - name: cancel + href: ../../api/privilegedaccessgroupeligibilityschedulerequest-cancel.md + - name: Privileged access group eligibility schedule + items: + - name: Privileged access group eligibility schedule + href: ../../resources/privilegedaccessgroupeligibilityschedule.md + - name: List eligibilitySchedules + href: ../../api/privilegedaccessgroup-list-eligibilityschedules.md + - name: Get privilegedAccessGroupEligibilitySchedule + href: ../../api/privilegedaccessgroupeligibilityschedule-get.md + - name: filterByCurrentUser + href: ../../api/privilegedaccessgroupeligibilityschedule-filterbycurrentuser.md + - name: Privileged access group eligibility schedule instance + items: + - name: Privileged access group eligibility schedule instance + href: ../../resources/privilegedaccessgroupeligibilityscheduleinstance.md + - name: List eligibilityScheduleInstances + href: ../../api/privilegedaccessgroup-list-eligibilityscheduleinstances.md + - name: Get privilegedAccessGroupEligibilityScheduleInstance + href: ../../api/privilegedaccessgroupeligibilityscheduleinstance-get.md + - name: filterByCurrentUser + href: ../../api/privilegedaccessgroupeligibilityscheduleinstance-filterbycurrentuser.md + - name: Unified role management policy + items: + - name: Unified role management policy + href: ../../resources/unifiedrolemanagementpolicy.md + - name: List unifiedRoleManagementPolicies + href: ../../api/policyroot-list-rolemanagementpolicies.md + - name: Get unifiedRoleManagementPolicy + href: ../../api/unifiedrolemanagementpolicy-get.md + - name: Update unifiedRoleManagementPolicy + href: ../../api/unifiedrolemanagementpolicy-update.md + - name: List rules + href: ../../api/unifiedrolemanagementpolicy-list-rules.md + - name: Get unifiedRoleManagementPolicyRule + href: ../../api/unifiedrolemanagementpolicyrule-get.md + - name: Update unifiedRoleManagementPolicyRule + href: ../../api/unifiedrolemanagementpolicyrule-update.md + - name: Unified role management policy assignment + items: + - name: Unified role management policy assignment + href: ../../resources/unifiedrolemanagementpolicyassignment.md + - name: List unifiedRoleManagementPolicyAssignments + href: ../../api/policyroot-list-rolemanagementpolicyassignments.md + - name: Get unifiedRoleManagementPolicyAssignment + href: ../../api/unifiedrolemanagementpolicyassignment-get.md + - name: Approval + items: + - name: Approval + href: ../../resources/approval.md + - name: Get approval + href: ../../api/approval-get.md + - name: filterByCurrentUser + href: ../../api/approval-filterbycurrentuser.md + - name: Approval stage + items: + - name: Approval stage + href: ../../resources/approvalstage.md + - name: List approvalStages + href: ../../api/approval-list-stages.md + - name: Get approvalStage + href: ../../api/approvalstage-get.md + - name: Update approvalStage + href: ../../api/approvalstage-update.md + - name: Terms of use + items: + - name: Agreement + items: + - name: Agreement + href: ../../resources/agreement.md + - name: List + href: ../../api/termsofusecontainer-list-agreements.md + - name: Create + href: ../../api/termsofusecontainer-post-agreements.md + - name: Get + href: ../../api/agreement-get.md + - name: Update + href: ../../api/agreement-update.md + - name: Delete + href: ../../api/agreement-delete.md + - name: Agreement acceptance + items: + - name: Agreement acceptance + href: ../../resources/agreementacceptance.md + - name: List agreementAcceptances for a user + href: ../../api/user-list-agreementacceptances.md + - name: List acceptances + href: ../../api/agreement-list-acceptances.md + - name: Agreement file + items: + - name: Agreement file + href: ../../resources/agreementfile.md + - name: Get agreementFile + href: ../../api/agreementfile-get.md + - name: List agreementFiles + href: ../../api/agreement-list-files.md + - name: Create agreementFile + href: ../../api/agreement-post-files.md + - name: List localizations + href: ../../api/agreementfile-list-localizations.md + - name: Agreement file localization + items: + - name: Agreement file localization + href: ../../resources/agreementfilelocalization.md + - name: Get agreementFile + href: ../../api/agreementfile-get.md + - name: List agreementFiles + href: ../../api/agreement-list-files.md + - name: Create agreementFile + href: ../../api/agreement-post-files.md + - name: List localizations + href: ../../api/agreementfile-list-localizations.md + - name: Complex types + items: + - name: Agreement file data + href: ../../resources/agreementfiledata.md + - name: Terms expiration + href: ../../resources/termsexpiration.md +- name: Identity and sign-in + items: + - name: Authentication event listener + items: + - name: Authentication event listener + href: ../../resources/authenticationeventlistener.md + - name: List authenticationEventListener objects + href: ../../api/identitycontainer-list-authenticationeventlisteners.md + - name: Create authenticationEventListener + href: ../../api/identitycontainer-post-authenticationeventlisteners.md + - name: Get authenticationEventListener + href: ../../api/authenticationeventlistener-get.md + - name: Update authenticationEventListener + href: ../../api/authenticationeventlistener-update.md + - name: Delete authenticationEventListener + href: ../../api/authenticationeventlistener-delete.md + - name: Authentication methods + items: + - name: Overview + href: ../../resources/authenticationmethods-overview.md + - name: Authentication method + items: + - name: Authentication method + href: ../../resources/authenticationmethod.md + - name: List authenticationMethods + href: ../../api/authentication-list-methods.md + - name: Email authentication method + items: + - name: Email authentication method + href: ../../resources/emailauthenticationmethod.md + - name: List emailMethods + href: ../../api/authentication-list-emailmethods.md + - name: Create emailMethod + href: ../../api/authentication-post-emailmethods.md + - name: Get emailAuthenticationMethod + href: ../../api/emailauthenticationmethod-get.md + - name: Update emailAuthenticationMethod + href: ../../api/emailauthenticationmethod-update.md + - name: Delete emailAuthenticationMethod + href: ../../api/emailauthenticationmethod-delete.md + - name: FIDO2 authentication method + items: + - name: FIDO2 authentication method + href: ../../resources/fido2authenticationmethod.md + - name: List + href: ../../api/fido2authenticationmethod-list.md + - name: Get + href: ../../api/fido2authenticationmethod-get.md + - name: Delete + href: ../../api/fido2authenticationmethod-delete.md + - name: Microsoft Authenticator authentication method + items: + - name: Microsoft Authenticator authentication method + href: ../../resources/microsoftauthenticatorauthenticationmethod.md + - name: List microsoftAuthenticatorAuthenticationMethods + href: ../../api/microsoftauthenticatorauthenticationmethod-list.md + - name: Get microsoftAuthenticatorAuthenticationMethod + href: ../../api/microsoftauthenticatorauthenticationmethod-get.md + - name: Delete microsoftAuthenticatorAuthenticationMethod + href: ../../api/microsoftauthenticatorauthenticationmethod-delete.md + - name: Password authentication method + items: + - name: Password authentication method + href: ../../resources/passwordauthenticationmethod.md + - name: List passwordMethod + href: ../../api/authentication-list-passwordmethods.md + - name: Get passwordAuthenticationMethod + href: ../../api/passwordauthenticationmethod-get.md + - name: Reset password + href: ../../api/authenticationmethod-resetpassword.md + - name: Phone authentication method + items: + - name: Phone authentication method + href: ../../resources/phoneauthenticationmethod.md + - name: List phoneMethods + href: ../../api/authentication-list-phonemethods.md + - name: Get phoneAuthenticationMethod + href: ../../api/phoneauthenticationmethod-get.md + - name: Create phoneMethod + href: ../../api/authentication-post-phonemethods.md + - name: Update phoneAuthenticationMethod + href: ../../api/phoneauthenticationmethod-update.md + - name: Delete phoneAuthenticationMethod + href: ../../api/phoneauthenticationmethod-delete.md + - name: Disable SMS signin + href: ../../api/phoneauthenticationmethod-disablesmssignin.md + - name: Enable SMS signin + href: ../../api/phoneauthenticationmethod-enablesmssignin.md + - name: Software OATH authentication method + items: + - name: Software OATH authentication method + href: ../../resources/softwareoathauthenticationmethod.md + - name: List softwareOathMethods + href: ../../api/authentication-list-softwareoathmethods.md + - name: Get softwareOathAuthenticationMethod + href: ../../api/softwareoathauthenticationmethod-get.md + - name: Delete softwareOathAuthenticationMethod + href: ../../api/softwareoathauthenticationmethod-delete.md + - name: Temporary Access Pass authentication method + displayName: TAP + items: + - name: Temporary Access Pass authentication method + href: ../../resources/temporaryaccesspassauthenticationmethod.md + - name: List + href: ../../api/authentication-list-temporaryaccesspassmethods.md + - name: Create + href: ../../api/authentication-post-temporaryaccesspassmethods.md + - name: Get + href: ../../api/temporaryaccesspassauthenticationmethod-get.md + - name: Delete + href: ../../api/temporaryaccesspassauthenticationmethod-delete.md + - name: Windows Hello for Business authentication method + items: + - name: Windows Hello for Business authentication method + href: ../../resources/windowshelloforbusinessauthenticationmethod.md + - name: List windowsHelloForBusinessAuthenticationMethods + href: ../../api/windowshelloforbusinessauthenticationmethod-list.md + - name: Get windowsHelloForBusinessAuthenticationMethod + href: ../../api/windowshelloforbusinessauthenticationmethod-get.md + - name: Delete windowsHelloForBusinessAuthenticationMethod + href: ../../api/windowshelloforbusinessauthenticationmethod-delete.md + - name: Authentication strengths + items: + - name: Overview + href: ../../resources/authenticationstrengths-overview.md + - name: Authentication strength policy + items: + - name: Authentication strength policy + href: ../../resources/authenticationstrengthpolicy.md + - name: List authenticationStrengthPolicies + href: ../../api/authenticationstrengthroot-list-policies.md + - name: Create authenticationStrengthPolicy + href: ../../api/authenticationstrengthroot-post-policies.md + - name: Get authenticationStrengthPolicy + href: ../../api/authenticationstrengthpolicy-get.md + - name: Update authenticationStrengthPolicy + href: ../../api/authenticationstrengthpolicy-update.md + - name: Delete authenticationStrengthPolicy + href: ../../api/authenticationstrengthroot-delete-policies.md + - name: List usage + href: ../../api/authenticationstrengthpolicy-usage.md + - name: updateAllowedCombinations + href: ../../api/authenticationstrengthpolicy-updateallowedcombinations.md + - name: Authentication combination configuration + items: + - name: Authentication combination configuration + href: ../../resources/authenticationcombinationconfiguration.md + - name: List + href: ../../api/authenticationstrengthpolicy-list-combinationconfigurations.md + - name: Create + href: ../../api/authenticationstrengthpolicy-post-combinationconfigurations.md + - name: Get + href: ../../api/authenticationcombinationconfiguration-get.md + - name: Update + href: ../../api/authenticationcombinationconfiguration-update.md + - name: Delete + href: ../../api/authenticationstrengthpolicy-delete-combinationconfigurations.md + - name: Authentication method mode detail + items: + - name: Authentication method mode detail + href: ../../resources/authenticationmethodmodedetail.md + - name: List authenticationMethodModeDetails + href: ../../api/authenticationstrengthroot-list-authenticationmethodmodes.md + - name: Get authenticationMethodModeDetail + href: ../../api/authenticationmethodmodedetail-get.md + - name: Certificate based auth configuration + displayName: CBA + items: + - name: Certificate based auth configuration + href: ../../resources/certificatebasedauthconfiguration.md + - name: List certificateBasedAuthConfiguration + href: ../../api/certificatebasedauthconfiguration-list.md + - name: Create certificateBasedAuthConfiguration + href: ../../api/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration.md + - name: Get certificateBasedAuthConfiguration + href: ../../api/certificatebasedauthconfiguration-get.md + - name: Delete certificateBasedAuthConfiguration + href: ../../api/certificatebasedauthconfiguration-delete.md + - name: Conditional access + items: + - name: Conditional access policy + items: + - name: Conditional access policy + href: ../../resources/conditionalaccesspolicy.md + - name: List conditionalAccessPolicies + href: ../../api/conditionalaccessroot-list-policies.md + - name: Create conditionalAccessPolicy + href: ../../api/conditionalaccessroot-post-policies.md + - name: Get conditionalAccessPolicy + href: ../../api/conditionalaccesspolicy-get.md + - name: Update conditionalAccessPolicy + href: ../../api/conditionalaccesspolicy-update.md + - name: Delete conditionalAccessPolicy + href: ../../api/conditionalaccesspolicy-delete.md + - name: Named location + items: + - name: Named location + href: ../../resources/namedlocation.md + - name: List namedLocations + href: ../../api/conditionalaccessroot-list-namedlocations.md + - name: Get namedLocation + href: ../../api/namedlocation-get.md + - name: Delete namedLocation + href: ../../api/namedlocation-delete.md + - name: Country named location + items: + - name: Country named location + href: ../../resources/countrynamedlocation.md + - name: List countryNamedLocations + href: ../../api/conditionalaccessroot-list-namedlocations.md + - name: Create countryNamedLocation + href: ../../api/conditionalaccessroot-post-namedlocations.md + - name: Get countryNamedLocation + href: ../../api/countrynamedlocation-get.md + - name: Update countryNamedLocation + href: ../../api/countrynamedlocation-update.md + - name: Delete countryNamedLocation + href: ../../api/countrynamedlocation-delete.md + - name: IP named location + items: + - name: IP named location + href: ../../resources/ipnamedlocation.md + - name: List ipNamedLocations + href: ../../api/conditionalaccessroot-list-namedlocations.md + - name: Create ipNamedLocation + href: ../../api/conditionalaccessroot-post-namedlocations.md + - name: Get ipNamedLocation + href: ../../api/ipnamedlocation-get.md + - name: Update ipNamedLocation + href: ../../api/ipnamedlocation-update.md + - name: Delete ipNamedLocation + href: ../../api/ipnamedlocation-delete.md + - name: Authentication context class reference + items: + - name: Authentication context class reference + href: ../../resources/authenticationcontextclassreference.md + - name: List authenticationContextClassReference + href: ../../api/conditionalaccessroot-list-authenticationcontextclassreferences.md + - name: Create or update authenticationContextClassReference + href: ../../api/authenticationcontextclassreference-update.md + - name: Get authenticationContextClassReference + href: ../../api/authenticationcontextclassreference-get.md + - name: Delete authenticationContextClassReference + href: ../../api/authenticationcontextclassreference-delete.md + - name: Conditional access template + items: + - name: Conditional access template + href: ../../resources/conditionalaccesstemplate.md + - name: List conditionalAccessTemplates + href: ../../api/conditionalaccessroot-list-templates.md + - name: Get conditionalAccessTemplate + href: ../../api/conditionalaccesstemplate-get.md + - name: Cross-tenant access + items: + - name: Overview + href: ../../resources/crosstenantaccesspolicy-overview.md + - name: Cross tenant access policy + items: + - name: Cross tenant access policy + href: ../../resources/crosstenantaccesspolicy.md + - name: Get crossTenantAccessPolicy + href: ../../api/crosstenantaccesspolicy-get.md + - name: Update crossTenantAccessPolicy + href: ../../api/crosstenantaccesspolicy-update.md + - name: Cross tenant access policy configuration default + items: + - name: Cross tenant access policy configuration default + href: ../../resources/crosstenantaccesspolicyconfigurationdefault.md + - name: Get crossTenantAccessPolicyConfigurationDefault + href: ../../api/crosstenantaccesspolicyconfigurationdefault-get.md + - name: Update crossTenantAccessPolicyConfigurationDefault + href: ../../api/crosstenantaccesspolicyconfigurationdefault-update.md + - name: Reset to system default + href: ../../api/crosstenantaccesspolicyconfigurationdefault-resettosystemdefault.md + - name: Cross tenant access policy configuration partner + items: + - name: Cross tenant access policy configuration partner + href: ../../resources/crosstenantaccesspolicyconfigurationpartner.md + - name: List partners + href: ../../api/crosstenantaccesspolicy-list-partners.md + - name: Create crossTenantAccessPolicyConfigurationPartner + href: ../../api/crosstenantaccesspolicy-post-partners.md + - name: Get crossTenantAccessPolicyConfigurationPartner + href: ../../api/crosstenantaccesspolicyconfigurationpartner-get.md + - name: Update crossTenantAccessPolicyConfigurationPartner + href: ../../api/crosstenantaccesspolicyconfigurationpartner-update.md + - name: Delete crossTenantAccessPolicyConfigurationPartner + href: ../../api/crosstenantaccesspolicyconfigurationpartner-delete.md + - name: Cross tenant identity sync policy partner + items: + - name: Cross tenant identity sync policy partner + href: ../../resources/crosstenantidentitysyncpolicypartner.md + - name: Create crossTenantIdentitySyncPolicyPartner + href: ../../api/crosstenantaccesspolicyconfigurationpartner-put-identitysynchronization.md + - name: Get crossTenantIdentitySyncPolicyPartner + href: ../../api/crosstenantidentitysyncpolicypartner-get.md + - name: Update crossTenantIdentitySyncPolicyPartner + href: ../../api/crosstenantidentitysyncpolicypartner-update.md + - name: Delete crossTenantIdentitySyncPolicyPartner + href: ../../api/crosstenantidentitysyncpolicypartner-delete.md + - name: Custom authentication extension + items: + - name: Custom authentication extension + href: ../../resources/customauthenticationextension.md + - name: List customAuthenticationExtensions + href: ../../api/identitycontainer-list-customauthenticationextensions.md + - name: Create customAuthenticationExtension + href: ../../api/identitycontainer-post-customauthenticationextensions.md + - name: Get customAuthenticationExtension + href: ../../api/customauthenticationextension-get.md + - name: Update customAuthenticationExtension + href: ../../api/customauthenticationextension-update.md + - name: Delete customAuthenticationExtension + href: ../../api/customauthenticationextension-delete.md + - name: validateAuthenticationConfiguration + href: ../../api/customauthenticationextension-validateauthenticationconfiguration.md + - name: On token issuance start custom extension + href: ../../resources/ontokenissuancestartcustomextension.md + - name: Data policy operation + items: + - name: Data policy operation + href: ../../resources/datapolicyoperation.md + - name: Get dataPolicyOperation + href: ../../api/datapolicyoperation-get.md + - name: Export personal data + href: ../../api/user-exportpersonaldata.md + - name: Identity protection + items: + - name: Overview + href: ../../resources/identityprotection-overview.md + - name: Risk detection + items: + - name: Risk detection + href: ../../resources/riskdetection.md + - name: List riskDetections + href: ../../api/riskdetection-list.md + - name: Get riskDetection + href: ../../api/riskdetection-get.md + - name: Risky user + items: + - name: Risky user + href: ../../resources/riskyuser.md + - name: List riskyUsers + href: ../../api/riskyuser-list.md + - name: Get riskyUser + href: ../../api/riskyuser-get.md + - name: Dismiss a riskyUser + href: ../../api/riskyuser-dismiss.md + - name: Confirm a riskyUser as compromised + href: ../../api/riskyuser-confirmcompromised.md + - name: List history + href: ../../api/riskyuser-list-history.md + - name: Get history + href: ../../api/riskyuser-get-riskyuserhistoryitem.md + - name: Service principal risk detection + items: + - name: Service principal risk detection + href: ../../resources/serviceprincipalriskdetection.md + - name: List servicePrincipalRiskDetections + href: ../../api/identityprotectionroot-list-serviceprincipalriskdetections.md + - name: Get servicePrincipalRiskDetection + href: ../../api/serviceprincipalriskdetection-get.md + - name: Risky service principal + items: + - name: Risky service principal + href: ../../resources/riskyserviceprincipal.md + - name: List riskyServicePrincipals + href: ../../api/identityprotectionroot-list-riskyserviceprincipals.md + - name: Get riskyServicePrincipal + href: ../../api/riskyserviceprincipal-get.md + - name: dismiss + href: ../../api/riskyserviceprincipal-dismiss.md + - name: confirmCompromised + href: ../../api/riskyserviceprincipal-confirmcompromised.md + - name: List history + href: ../../api/riskyserviceprincipal-list-history.md + - name: Identity provider + items: + - name: Identity provider base + items: + - name: Identity provider base + href: ../../resources/identityproviderbase.md + - name: List + href: ../../api/identitycontainer-list-identityproviders.md + - name: Create + href: ../../api/identitycontainer-post-identityproviders.md + - name: Get + href: ../../api/identityproviderbase-get.md + - name: Update + href: ../../api/identityproviderbase-update.md + - name: Delete + href: ../../api/identityproviderbase-delete.md + - name: List available provider types + href: ../../api/identityproviderbase-availableprovidertypes.md + - name: External identities + items: + - name: Built in identity provider + items: + - name: Built in identity provider + href: ../../resources/builtinidentityprovider.md + - name: List + href: ../../api/identitycontainer-list-identityproviders.md + - name: Get + href: ../../api/identityproviderbase-get.md + - name: List available provider types + href: ../../api/identityproviderbase-availableprovidertypes.md + - name: Social identity provider + items: + - name: Social identity provider + href: ../../resources/socialidentityprovider.md + - name: List + href: ../../api/identitycontainer-list-identityproviders.md + - name: Create + href: ../../api/identitycontainer-post-identityproviders.md + - name: Get + href: ../../api/identityproviderbase-get.md + - name: Update + href: ../../api/identityproviderbase-update.md + - name: Delete + href: ../../api/identityproviderbase-delete.md + - name: List available provider types + href: ../../api/identityproviderbase-availableprovidertypes.md + - name: Apple managed identity provider + items: + - name: Apple managed identity provider + href: ../../resources/applemanagedidentityprovider.md + - name: List + href: ../../api/identitycontainer-list-identityproviders.md + - name: Create + href: ../../api/identitycontainer-post-identityproviders.md + - name: Get + href: ../../api/identityproviderbase-get.md + - name: Update + href: ../../api/identityproviderbase-update.md + - name: Delete + href: ../../api/identityproviderbase-delete.md + - name: List available provider types + href: ../../api/identityproviderbase-availableprovidertypes.md + - name: Domain-based external identities + items: + - name: SAML/WS-Fed external domain federation + items: + - name: SAML/WS-Fed external domain federation + href: ../../resources/samlorwsfedexternaldomainfederation.md + - name: List samlOrWsFedExternalDomainFederations + href: ../../api/samlorwsfedexternaldomainfederation-list.md + - name: Create samlOrWsFedExternalDomainFederation + href: ../../api/samlorwsfedexternaldomainfederation-post.md + - name: Get samlOrWsFedExternalDomainFederation + href: ../../api/samlorwsfedexternaldomainfederation-get.md + - name: Update samlOrWsFedExternalDomainFederation + href: ../../api/samlorwsfedexternaldomainfederation-update.md + - name: Delete samlOrWsFedExternalDomainFederation + href: ../../api/samlorwsfedexternaldomainfederation-delete.md + - name: List domains + href: ../../api/samlorwsfedexternaldomainfederation-list-domains.md + - name: Create externalDomainName + href: ../../api/samlorwsfedexternaldomainfederation-post-domains.md + - name: Federation with Microsoft Entra ID + items: + - name: Internal domain federation + items: + - name: Internal domain federation + href: ../../resources/internaldomainfederation.md + - name: List internalDomainFederations + href: ../../api/domain-list-federationconfiguration.md + - name: Create federationConfiguration + href: ../../api/domain-post-federationconfiguration.md + - name: Get internalDomainFederation + href: ../../api/internaldomainfederation-get.md + - name: Update internalDomainFederation + href: ../../api/internaldomainfederation-update.md + - name: Delete internalDomainFederation + href: ../../api/internaldomainfederation-delete.md + - name: Identity provider (deprecated) + items: + - name: Identity provider + items: + - name: Identity provider + href: ../../resources/identityprovider.md + - name: Get identityProvider + href: ../../api/identityprovider-get.md + - name: Create identityProvider + href: ../../api/identityprovider-post-identityproviders.md + - name: Update identityProvider + href: ../../api/identityprovider-update.md + - name: Delete identityProvider + href: ../../api/identityprovider-delete.md + - name: List identityProviders + href: ../../api/identityprovider-list.md + - name: Invitation + items: + - name: Invitation + href: ../../resources/invitation.md + - name: Create invitation + href: ../../api/invitation-post.md + - name: Multitenant organization + displayName: MTO + items: + - name: Overview + href: ../../resources/multitenantorganization-overview.md + - name: Multitenant organization + items: + - name: Multitenant organization + href: ../../resources/multitenantorganization.md + - name: Create multiTenantOrganization + href: ../../api/tenantrelationship-put-multitenantorganization.md + - name: Get multiTenantOrganization + href: ../../api/multitenantorganization-get.md + - name: Update multiTenantOrganization + href: ../../api/multitenantorganization-update.md + - name: Multitenant organization member + items: + - name: Multitenant organization member + href: ../../resources/multitenantorganizationmember.md + - name: List multiTenantOrganizationMembers + href: ../../api/multitenantorganization-list-tenants.md + - name: Add multiTenantOrganizationMember + href: ../../api/multitenantorganization-post-tenants.md + - name: Get multiTenantOrganizationMember + href: ../../api/multitenantorganizationmember-get.md + - name: Update multiTenantOrganizationMember + href: ../../api/multitenantorganizationmember-update.md + - name: Remove multiTenantOrganizationMember + href: ../../api/multitenantorganization-delete-tenants.md + - name: Multitenant organization join request record + items: + - name: Multitenant organization join request record + href: ../../resources/multitenantorganizationjoinrequestrecord.md + - name: Get multiTenantOrganizationJoinRequestRecord + href: ../../api/multitenantorganizationjoinrequestrecord-get.md + - name: Update multiTenantOrganizationJoinRequestRecord + href: ../../api/multitenantorganizationjoinrequestrecord-update.md + - name: Multitenant organization partner configuration template + items: + - name: Multitenant organization partner configuration template + href: ../../resources/multitenantorganizationpartnerconfigurationtemplate.md + - name: Get multiTenantOrganizationPartnerConfigurationTemplate + href: ../../api/multitenantorganizationpartnerconfigurationtemplate-get.md + - name: Update multiTenantOrganizationPartnerConfigurationTemplate + href: ../../api/multitenantorganizationpartnerconfigurationtemplate-update.md + - name: resetToDefaultSettings + href: ../../api/multitenantorganizationpartnerconfigurationtemplate-resettodefaultsettings.md + - name: Multitenant organization identity sync policy template + items: + - name: Multitenant organization identity sync policy template + href: ../../resources/multitenantorganizationidentitysyncpolicytemplate.md + - name: Get multiTenantOrganizationIdentitySyncPolicyTemplate + href: ../../api/multitenantorganizationidentitysyncpolicytemplate-get.md + - name: Update multiTenantOrganizationIdentitySyncPolicyTemplate + href: ../../api/multitenantorganizationidentitysyncpolicytemplate-update.md + - name: resetToDefaultSettings + href: ../../api/multitenantorganizationidentitysyncpolicytemplate-resettodefaultsettings.md + - name: OAuth 2 permission grant + items: + - name: OAuth 2 permission grant + href: ../../resources/oauth2permissiongrant.md + - name: List oAuth2PermissionGrants + href: ../../api/oauth2permissiongrant-list.md + - name: Get oAuth2PermissionGrant + href: ../../api/oauth2permissiongrant-get.md + - name: Create oAuth2PermissionGrant + href: ../../api/oauth2permissiongrant-post.md + - name: Update oAuth2PermissionGrant + href: ../../api/oauth2permissiongrant-update.md + - name: Delete oAuth2PermissionGrant + href: ../../api/oauth2permissiongrant-delete.md + - name: Get delta + href: ../../api/oauth2permissiongrant-delta.md + - name: Organizational branding + items: + - name: Organizational branding + href: ../../resources/organizationalbranding.md + - name: Get organizationalBranding + href: ../../api/organizationalbranding-get.md + - name: Update organizationalBranding + href: ../../api/organizationalbranding-update.md + - name: Organizational branding localization + items: + - name: Organizational branding localization + href: ../../resources/organizationalbrandinglocalization.md + - name: List organizationalBrandingLocalizations + href: ../../api/organizationalbranding-list-localizations.md + - name: Create organizationalBrandingLocalization + href: ../../api/organizationalbranding-post-localizations.md + - name: Get organizationalBrandingLocalization + href: ../../api/organizationalbrandinglocalization-get.md + - name: Update organizationalBrandingLocalization + href: ../../api/organizationalbrandinglocalization-update.md + - name: Delete organizationalBrandingLocalization + href: ../../api/organizationalbrandinglocalization-delete.md + - name: Policies + items: + - name: Overview + href: ../../resources/policy-overview.md + - name: Activity based timeout policy + items: + - name: Activity based timeout policy + href: ../../resources/activitybasedtimeoutpolicy.md + - name: List activityBasedTimeoutPolicies + href: ../../api/activitybasedtimeoutpolicy-list.md + - name: Create activityBasedTimeoutPolicy + href: ../../api/activitybasedtimeoutpolicy-post-activitybasedtimeoutpolicies.md + - name: Get activityBasedTimeoutPolicy + href: ../../api/activitybasedtimeoutpolicy-get.md + - name: Update activityBasedTimeoutPolicy + href: ../../api/activitybasedtimeoutpolicy-update.md + - name: Delete activityBasedTimeoutPolicy + href: ../../api/activitybasedtimeoutpolicy-delete.md + - name: Authorization policy + items: + - name: Authorization policy + href: ../../resources/authorizationpolicy.md + - name: Get authorizationPolicy + href: ../../api/authorizationpolicy-get.md + - name: Update authorizationPolicy + href: ../../api/authorizationpolicy-update.md + - name: Claims mapping policy + items: + - name: Claims mapping policy + href: ../../resources/claimsmappingpolicy.md + - name: Create claimsMappingPolicy + href: ../../api/claimsmappingpolicy-post-claimsmappingpolicies.md + - name: Get claimsMappingPolicy + href: ../../api/claimsmappingpolicy-get.md + - name: List claimsMappingPolicies + href: ../../api/claimsmappingpolicy-list.md + - name: Update claimsMappingPolicy + href: ../../api/claimsmappingpolicy-update.md + - name: Delete claimsMappingPolicy + href: ../../api/claimsmappingpolicy-delete.md + - name: Directory objects + items: + - name: List appliesTo + href: ../../api/claimsmappingpolicy-list-appliesto.md + - name: Assign claimsMappingPolicy + href: ../../api/serviceprincipal-post-claimsmappingpolicies.md + - name: List assigned claimsMappingPolicy + href: ../../api/serviceprincipal-list-claimsmappingpolicies.md + - name: Remove claimsMappingPolicy + href: ../../api/serviceprincipal-delete-claimsmappingpolicies.md + - name: Home realm discovery policy + items: + - name: Home realm discovery policy + href: ../../resources/homerealmdiscoverypolicy.md + - name: List homeRealmDiscoveryPolicies + href: ../../api/homerealmdiscoverypolicy-list.md + - name: Create homeRealmDiscoveryPolicy + href: ../../api/homerealmdiscoverypolicy-post-homerealmdiscoverypolicies.md + - name: Get homeRealmDiscoveryPolicy + href: ../../api/homerealmdiscoverypolicy-get.md + - name: Update homeRealmDiscoveryPolicy + href: ../../api/homerealmdiscoverypolicy-update.md + - name: Delete homeRealmDiscoveryPolicy + href: ../../api/homerealmdiscoverypolicy-delete.md + - name: List appliesTo + href: ../../api/homerealmdiscoverypolicy-list-appliesto.md + - name: Token issuance policy + items: + - name: Token issuance policy + href: ../../resources/tokenissuancepolicy.md + - name: List tokenIssuancePolicy + href: ../../api/tokenissuancepolicy-list.md + - name: Create tokenIssuancePolicy + href: ../../api/tokenissuancepolicy-post-tokenissuancepolicy.md + - name: Get tokenIssuancePolicy + href: ../../api/tokenissuancepolicy-get.md + - name: Update tokenIssuancePolicy + href: ../../api/tokenissuancepolicy-update.md + - name: Delete tokenIssuancePolicy + href: ../../api/tokenissuancepolicy-delete.md + - name: List appliesTo + href: ../../api/tokenissuancepolicy-list-appliesto.md + - name: Token lifetime policy + items: + - name: Token lifetime policy + href: ../../resources/tokenlifetimepolicy.md + - name: List tokenLifetimePolicies + href: ../../api/tokenlifetimepolicy-list.md + - name: Create tokenLifetimePolicy + href: ../../api/tokenlifetimepolicy-post-tokenlifetimepolicies.md + - name: Get tokenLifetimePolicy + href: ../../api/tokenlifetimepolicy-get.md + - name: Update tokenLifetimePolicy + href: ../../api/tokenlifetimepolicy-update.md + - name: Delete tokenLifetimePolicy + href: ../../api/tokenlifetimepolicy-delete.md + - name: List appliesTo + href: ../../api/tokenlifetimepolicy-list-appliesto.md + - name: Authentication flows policy + items: + - name: Authentication flows policy + href: ../../resources/authenticationflowspolicy.md + - name: Get authentication flows policy + href: ../../api/authenticationflowspolicy-get.md + - name: Update authentication flows policy + href: ../../api/authenticationflowspolicy-update.md + - name: Authentication strength policy + items: + - name: Authentication strength policy + href: ../../resources/authenticationstrengthpolicy.md + - name: List authenticationStrengthPolicies + href: ../../api/authenticationstrengthroot-list-policies.md + - name: Create authenticationStrengthPolicy + href: ../../api/authenticationstrengthroot-post-policies.md + - name: Get authenticationStrengthPolicy + href: ../../api/authenticationstrengthpolicy-get.md + - name: Update authenticationStrengthPolicy + href: ../../api/authenticationstrengthpolicy-update.md + - name: Delete authenticationStrengthPolicy + href: ../../api/authenticationstrengthroot-delete-policies.md + - name: List usage + href: ../../api/authenticationstrengthpolicy-usage.md + - name: updateAllowedCombinations + href: ../../api/authenticationstrengthpolicy-updateallowedcombinations.md + - name: Feature rollout policy + items: + - name: Feature rollout policy + href: ../../resources/featurerolloutpolicy.md + - name: List featureRolloutPolicies + href: ../../api/featurerolloutpolicies-list.md + - name: Get featureRolloutPolicy + href: ../../api/featurerolloutpolicy-get.md + - name: Create featureRolloutPolicy + href: ../../api/featurerolloutpolicies-post.md + - name: Update featureRolloutPolicy + href: ../../api/featurerolloutpolicy-update.md + - name: Delete featureRolloutPolicy + href: ../../api/featurerolloutpolicy-delete.md + - name: Assign appliesTo + href: ../../api/featurerolloutpolicy-post-appliesto.md + - name: Remove appliesTo + href: ../../api/featurerolloutpolicy-delete-appliesto.md + - name: Identity security defaults enforcement policy + items: + - name: Identity security defaults enforcement policy + href: ../../resources/identitysecuritydefaultsenforcementpolicy.md + - name: Get + 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 appliesTo + href: ../../api/appmanagementpolicy-list-appliesto.md + - name: Assign appliesTo + href: ../../api/appmanagementpolicy-post-appliesto.md + - name: Authentication methods policy + items: + - name: Overview + href: ../../resources/authenticationmethodspolicies-overview.md + - name: Authentication methods policy + items: + - name: Authentication methods policy + href: ../../resources/authenticationmethodspolicy.md + - name: Get authenticationMethodsPolicy + href: ../../api/authenticationmethodspolicy-get.md + - name: Update authenticationMethodsPolicy + href: ../../api/authenticationmethodspolicy-update.md + - name: Email authentication method configuration + items: + - name: Email authentication method configuration + href: ../../resources/emailauthenticationmethodconfiguration.md + - name: Get emailAuthenticationMethodConfiguration + href: ../../api/emailauthenticationmethodconfiguration-get.md + - name: Update emailAuthenticationMethodConfiguration + href: ../../api/emailauthenticationmethodconfiguration-update.md + - name: Delete emailAuthenticationMethodConfiguration + href: ../../api/emailauthenticationmethodconfiguration-delete.md + - name: FIDO2 authentication method configuration + items: + - name: FIDO2 authentication method configuration + href: ../../resources/fido2authenticationmethodconfiguration.md + - name: Get + href: ../../api/fido2authenticationmethodconfiguration-get.md + - name: Update + href: ../../api/fido2authenticationmethodconfiguration-update.md + - name: Delete + href: ../../api/fido2authenticationmethodconfiguration-delete.md + - name: Microsoft Authenticator authentication method configuration + items: + - name: Microsoft Authenticator authentication method configuration + href: ../../resources/microsoftauthenticatorauthenticationmethodconfiguration.md + - name: Get + href: ../../api/microsoftauthenticatorauthenticationmethodconfiguration-get.md + - name: Update + href: ../../api/microsoftauthenticatorauthenticationmethodconfiguration-update.md + - name: Delete + href: ../../api/microsoftauthenticatorauthenticationmethodconfiguration-delete.md + - name: SMS authentication method configuration + items: + - name: SMS authentication method configuration + href: ../../resources/smsauthenticationmethodconfiguration.md + - name: Get + href: ../../api/smsauthenticationmethodconfiguration-get.md + - name: Update + href: ../../api/smsauthenticationmethodconfiguration-update.md + - name: Delete + href: ../../api/smsauthenticationmethodconfiguration-delete.md + - name: Temporary Access Pass authentication method configuration + items: + - name: Temporary Access Pass authentication method configuration + href: ../../resources/temporaryaccesspassauthenticationmethodconfiguration.md + - name: Get + href: ../../api/temporaryaccesspassauthenticationmethodconfiguration-get.md + - name: Update + href: ../../api/temporaryaccesspassauthenticationmethodconfiguration-update.md + - name: Delete + href: ../../api/temporaryaccesspassauthenticationmethodconfiguration-delete.md + - name: Software OATH authentication method configuration + items: + - name: Software OATH authentication method configuration + href: ../../resources/softwareoathauthenticationmethodconfiguration.md + - name: Get softwareOathAuthenticationMethodConfiguration + href: ../../api/softwareoathauthenticationmethodconfiguration-get.md + - name: Update softwareOathAuthenticationMethodConfiguration + href: ../../api/softwareoathauthenticationmethodconfiguration-update.md + - name: Delete softwareOathAuthenticationMethodConfiguration + href: ../../api/softwareoathauthenticationmethodconfiguration-delete.md + - name: Voice authentication method configuration + items: + - name: Voice authentication method configuration + href: ../../resources/voiceauthenticationmethodconfiguration.md + - name: Get voiceAuthenticationMethodConfiguration + href: ../../api/voiceauthenticationmethodconfiguration-get.md + - name: Update voiceAuthenticationMethodConfiguration + href: ../../api/voiceauthenticationmethodconfiguration-update.md + - name: Delete voiceAuthenticationMethodConfiguration + href: ../../api/voiceauthenticationmethodconfiguration-delete.md + - name: X509 certificate authentication method configuration + displayName: certificate-based authentication, CBA + items: + - name: X509 certificate authentication method configuration + href: ../../resources/x509certificateauthenticationmethodconfiguration.md + - name: Get x509CertificateAuthenticationMethodConfiguration + href: ../../api/x509certificateauthenticationmethodconfiguration-get.md + - name: Update x509CertificateAuthenticationMethodConfiguration + href: ../../api/x509certificateauthenticationmethodconfiguration-update.md + - name: Delete x509CertificateAuthenticationMethodConfiguration + href: ../../api/x509certificateauthenticationmethodconfiguration-delete.md + - name: User flows + items: + - name: B2X identity user flow + items: + - name: B2X identity user flow + href: ../../resources/b2xidentityuserflow.md + - name: List user flows + href: ../../api/identitycontainer-list-b2xuserflows.md + - name: Get user flow + href: ../../api/b2xidentityuserflow-get.md + - name: Create user flow + href: ../../api/identitycontainer-post-b2xuserflows.md + - name: Delete user flow + href: ../../api/b2xidentityuserflow-delete.md + - name: List identity providers + href: ../../api/b2xidentityuserflow-list-identityproviders.md + - name: Add identity provider + href: ../../api/b2xidentityuserflow-post-identityproviders.md + - name: Remove identity provider + href: ../../api/b2xidentityuserflow-delete-identityproviders.md + - name: List user attribute assignments + href: ../../api/b2xidentityuserflow-list-userattributeassignments.md + - name: Create user attribute assignment + href: ../../api/b2xidentityuserflow-post-userattributeassignments.md + - name: List languages + href: ../../api/b2xidentityuserflow-list-languages.md + - name: Get API connectors configuration for user flow + href: ../../api/b2xidentityuserflow-get-apiConnectorConfiguration.md + - name: Configure an API connector in a user flow + href: ../../api/b2xidentityuserflow-put-apiConnectorConfiguration.md + - name: Identity user flow attribute + items: + - name: Identity user flow attribute + href: ../../resources/identityuserflowattribute.md + - name: List + href: ../../api/identityuserflowattribute-list.md + - name: Create + href: ../../api/identityuserflowattribute-post.md + - name: Get + href: ../../api/identityuserflowattribute-get.md + - name: Update + href: ../../api/identityuserflowattribute-update.md + - name: Delete + href: ../../api/identityuserflowattribute-delete.md + - name: Identity user flow attribute assignment + items: + - name: Identity user flow attribute assignment + href: ../../resources/identityuserflowattributeassignment.md + - name: Get identityUserFlowAttributeAssignment + href: ../../api/identityuserflowattributeassignment-get.md + - name: Update identityUserFlowAttributeAssignment + href: ../../api/identityuserflowattributeassignment-update.md + - name: Delete identityUserFlowAttributeAssignment + href: ../../api/identityuserflowattributeassignment-delete.md + - name: getOrder + href: ../../api/identityuserflowattributeassignment-getorder.md + - name: setOrder + href: ../../api/identityuserflowattributeassignment-setorder.md + - name: User flow language configuration + items: + - name: User flow language configuration + href: ../../resources/userflowlanguageconfiguration.md + - name: Get userFlowLanguageConfiguration + href: ../../api/userflowlanguageconfiguration-get.md + - name: List defaultPages + href: ../../api/userflowlanguageconfiguration-list-defaultpages.md + - name: List overridesPages + href: ../../api/userflowlanguageconfiguration-list-overridespages.md + - name: Identity API connector + items: + - name: Identity API connector + href: ../../resources/identityapiconnector.md + - name: List + href: ../../api/identityapiconnector-list.md + - name: Create + href: ../../api/identityapiconnector-create.md + - name: Get + href: ../../api/identityapiconnector-get.md + - name: Update + href: ../../api/identityapiconnector-update.md + - name: Upload client certificate + href: ../../api/identityapiconnector-uploadclientcertificate.md + - name: Delete + href: ../../api/identityapiconnector-delete.md +- name: Granular delegated admin privileges + displayName: GDAP, Partner Center, CSP, VAR + items: + - name: Overview + href: ../../resources/delegatedadminrelationships-api-overview.md + - name: Delegated admin access assignment + items: + - name: Delegated admin access assignment + href: ../../resources/delegatedadminaccessassignment.md + - name: Create delegatedAdminAccessAssignment + href: ../../api/delegatedadminrelationship-post-accessassignments.md + - name: List delegatedAdminAccessAssignments + href: ../../api/delegatedadminrelationship-list-accessassignments.md + - name: Get delegatedAdminAccessAssignment + href: ../../api/delegatedadminaccessassignment-get.md + - name: Update delegatedAdminAccessAssignment + href: ../../api/delegatedadminaccessassignment-update.md + - name: Delete delegatedAdminAccessAssignment + href: ../../api/delegatedadminaccessassignment-delete.md + - name: Delegated admin customer + items: + - name: Delegated admin customer + href: ../../resources/delegatedadmincustomer.md + - name: List delegatedAdminCustomers + href: ../../api/tenantrelationship-list-delegatedadmincustomers.md + - name: Get delegatedAdminCustomer + href: ../../api/delegatedadmincustomer-get.md + - name: Delegated admin relationship + items: + - name: Delegated admin relationship + href: ../../resources/delegatedadminrelationship.md + - name: Create delegatedAdminRelationship + href: ../../api/tenantrelationship-post-delegatedadminrelationships.md + - name: List delegatedAdminRelationships + href: ../../api/tenantrelationship-list-delegatedadminrelationships.md + - name: Get delegatedAdminRelationship + href: ../../api/delegatedadminrelationship-get.md + - name: Update delegatedAdminRelationship + href: ../../api/delegatedadminrelationship-update.md + - name: Delete delegatedAdminRelationship + href: ../../api/delegatedadminrelationship-delete.md + - name: Delegated admin relationship operation + items: + - name: Delegated admin relationship operation + href: ../../resources/delegatedadminrelationshipoperation.md + - name: List delegatedAdminRelationshipOperations + href: ../../api/delegatedadminrelationship-list-operations.md + - name: Get delegatedAdminRelationshipOperation + href: ../../api/delegatedadminrelationshipoperation-get.md + - name: Delegated admin relationship request + items: + - name: Delegated admin relationship request + href: ../../resources/delegatedadminrelationshiprequest.md + - name: List delegatedAdminRelationshipRequests + href: ../../api/delegatedadminrelationship-list-requests.md + - name: Create delegatedAdminRelationshipRequest + href: ../../api/delegatedadminrelationship-post-requests.md + - name: Get delegatedAdminRelationshipRequest + href: ../../api/delegatedadminrelationshiprequest-get.md + - name: Delegated admin service management detail + items: + - name: Delegated admin service management detail + href: ../../resources/delegatedadminservicemanagementdetail.md + - name: List delegatedAdminServiceManagementDetails + href: ../../api/delegatedadmincustomer-list-servicemanagementdetails.md + - name: Complex types + items: + - name: Delegated admin access container + href: ../../resources/delegatedadminaccesscontainer.md + - name: Delegated admin access details + href: ../../resources/delegatedadminaccessdetails.md + - name: Delegated admin relationship customer participant + href: ../../resources/delegatedadminrelationshipcustomerparticipant.md + - name: Unified role + href: ../../resources/unifiedrole.md |
v1.0 | Intune.Toc.Mapping.Json | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/intune.toc.mapping.json | +{ + "name": "Corporate management", + "overview": "../../resources/intune-graph-overview.md", + "keywords": [ + "Intune" + ], + "childNodes": [ + { + "name": "App management", + "overview": "../../resources/intune-app-conceptual.md", + "shouldSort": true, + "resources": [ + "androidLobApp", + "androidStoreApp", + "enterpriseCodeSigningCertificate", + "iosLobApp", + "iosLobAppProvisioningConfigurationAssignment", + "iosMobileAppConfiguration", + "iosStoreApp", + "iosVppApp", + "iosiPadOSWebClip", + "macOSLobApp", + "macOSMicrosoftDefenderApp", + "macOSMicrosoftEdgeApp", + "macOSOfficeSuiteApp", + "managedAndroidLobApp", + "managedAndroidStoreApp", + "managedApp", + "managedDeviceMobileAppConfiguration", + "managedDeviceMobileAppConfigurationAssignment", + "managedDeviceMobileAppConfigurationDeviceStatus", + "managedDeviceMobileAppConfigurationDeviceSummary", + "managedDeviceMobileAppConfigurationUserStatus", + "managedDeviceMobileAppConfigurationUserSummary", + "managedIOSLobApp", + "managedIOSStoreApp", + "managedMobileLobApp", + "microsoftStoreForBusinessApp", + "mobileApp", + "mobileAppAssignment", + "mobileAppCategory", + "mobileAppContent", + "mobileAppContentFile", + "mobileContainedApp", + "mobileLobApp", + "webApp", + "win32LobApp", + "windowsAppX", + "windowsMicrosoftEdgeApp", + "windowsMobileMSI", + "windowsUniversalAppX", + "windowsUniversalAppXContainedApp", + "windowsWebApp", + "deviceInstallState", + "eBookInstallSummary", + "iosVppEBook", + "iosVppEBookAssignment", + "managedEBook", + "managedEBookAssignment", + "userInstallStateSummary" + ], + "complexTypes": [ + "allDevicesAssignmentTarget", + "allLicensedUsersAssignmentTarget", + "androidMinimumOperatingSystem", + "appConfigurationSettingItem", + "configurationManagerCollectionAssignmentTarget", + "deviceAndAppManagementAssignmentTarget", + "exclusionGroupAssignmentTarget", + "fileEncryptionInfo", + "groupAssignmentTarget", + "iosDeviceType", + "iosLobAppAssignmentSettings", + "iosMinimumOperatingSystem", + "iosStoreAppAssignmentSettings", + "iosVppAppAssignmentSettings", + "macOSLobChildApp", + "macOSMinimumOperatingSystem", + "macOsLobAppAssignmentSettings", + "microsoftStoreForBusinessAppAssignmentSettings", + "mimeContent", + "mobileAppAssignmentSettings", + "mobileAppInstallTimeSettings", + "vppLicensingType", + "win32LobAppAssignmentSettings", + "win32LobAppFileSystemRule", + "win32LobAppInstallExperience", + "win32LobAppMsiInformation", + "win32LobAppPowerShellScriptRule", + "win32LobAppProductCodeRule", + "win32LobAppRegistryRule", + "win32LobAppRestartSettings", + "win32LobAppReturnCode", + "win32LobAppRule", + "windowsAppXAppAssignmentSettings", + "windowsMinimumOperatingSystem", + "windowsUniversalAppXAppAssignmentSettings", + "allLicensedUsersAssignmentTarget", + "configurationManagerCollectionAssignmentTarget", + "deviceAndAppManagementAssignmentTarget", + "exclusionGroupAssignmentTarget", + "groupAssignmentTarget", + "mimeContent" + ] + }, + { + "name": "Company terms", + "overview": "../../resources/intune-company-conceptual.md", + "resources": [ + "termsAndConditions", + "termsAndConditionsAcceptanceStatus", + "termsAndConditionsAssignment" + ], + "complexTypes": [ + "allDevicesAssignmentTarget", + "allLicensedUsersAssignmentTarget", + "configurationManagerCollectionAssignmentTarget", + "deviceAndAppManagementAssignmentTarget", + "exclusionGroupAssignmentTarget", + "groupAssignmentTarget" + ] + }, + { + "name": "Corporate enrollment", + "overview": "../../resources/intune-enrollment-conceptual.md", + "resources": [ + "importedWindowsAutopilotDeviceIdentity", + "windowsAutopilotDeviceIdentity" + ], + "complexTypes": [ + "importedWindowsAutopilotDeviceIdentityState" + ] + }, + { + "name": "Device configuration", + "overview": "../../resources/intune-device-cfg-conceptual.md", + "resources": [ + "androidCompliancePolicy", + "androidCustomConfiguration", + "androidGeneralDeviceConfiguration", + "androidWorkProfileCompliancePolicy", + "androidWorkProfileCustomConfiguration", + "androidWorkProfileGeneralDeviceConfiguration", + "appleDeviceFeaturesConfigurationBase", + "deviceComplianceActionItem", + "deviceComplianceDeviceOverview", + "deviceComplianceDeviceStatus", + "deviceCompliancePolicy", + "deviceCompliancePolicyAssignment", + "deviceCompliancePolicyDeviceStateSummary", + "deviceCompliancePolicySettingStateSummary", + "deviceComplianceScheduledActionForRule", + "deviceComplianceSettingState", + "deviceComplianceUserOverview", + "deviceComplianceUserStatus", + "deviceConfiguration", + "deviceConfigurationAssignment", + "deviceConfigurationDeviceOverview", + "deviceConfigurationDeviceStateSummary", + "deviceConfigurationDeviceStatus", + "deviceConfigurationUserOverview", + "deviceConfigurationUserStatus", + "editionUpgradeConfiguration", + "iosCertificateProfile", + "iosCompliancePolicy", + "iosCustomConfiguration", + "iosDeviceFeaturesConfiguration", + "iosGeneralDeviceConfiguration", + "iosUpdateConfiguration", + "iosUpdateDeviceStatus", + "macOSCompliancePolicy", + "macOSCustomConfiguration", + "macOSDeviceFeaturesConfiguration", + "macOSGeneralDeviceConfiguration", + "settingStateDeviceSummary", + "sharedPCConfiguration", + "softwareUpdateStatusSummary", + "windows10CompliancePolicy", + "windows10CustomConfiguration", + "windows10EndpointProtectionConfiguration", + "windows10EnterpriseModernAppManagementConfiguration", + "windows10GeneralConfiguration", + "windows10MobileCompliancePolicy", + "windows10SecureAssessmentConfiguration", + "windows10TeamGeneralConfiguration", + "windows81CompliancePolicy", + "windows81GeneralConfiguration", + "windowsDefenderAdvancedThreatProtectionConfiguration", + "windowsPhone81CompliancePolicy", + "windowsPhone81CustomConfiguration", + "windowsPhone81GeneralConfiguration", + "windowsUpdateForBusinessConfiguration" + ], + "complexTypes": [ + "allDevicesAssignmentTarget", + "allLicensedUsersAssignmentTarget", + "appListItem", + "bitLockerRemovableDrivePolicy", + "configurationManagerCollectionAssignmentTarget", + "defenderDetectedMalwareActions", + "deviceAndAppManagementAssignmentTarget", + "deviceCompliancePolicySettingState", + "deviceConfigurationSettingState", + "deviceManagementSettings", + "edgeSearchEngine", + "edgeSearchEngineBase", + "edgeSearchEngineCustom", + "exclusionGroupAssignmentTarget", + "groupAssignmentTarget", + "iosHomeScreenApp", + "iosHomeScreenFolder", + "iosHomeScreenFolderPage", + "iosHomeScreenItem", + "iosHomeScreenPage", + "iosNetworkUsageRule", + "iosNotificationSettings", + "mediaContentRatingAustralia", + "mediaContentRatingCanada", + "mediaContentRatingFrance", + "mediaContentRatingGermany", + "mediaContentRatingIreland", + "mediaContentRatingJapan", + "mediaContentRatingNewZealand", + "mediaContentRatingUnitedKingdom", + "mediaContentRatingUnitedStates", + "omaSetting", + "omaSettingBase64", + "omaSettingBoolean", + "omaSettingDateTime", + "omaSettingFloatingPoint", + "omaSettingInteger", + "omaSettingString", + "omaSettingStringXml", + "settingSource", + "sharedPCAccountManagerPolicy", + "windows10NetworkProxyServer", + "windowsFirewallNetworkProfile", + "windowsUpdateActiveHoursInstall", + "windowsUpdateInstallScheduleType", + "windowsUpdateScheduledInstall" + ] + }, + { + "name": "Device management", + "overview": "../../resources/intune-device-mgt-conceptual.md", + "resources": [ + "appLogCollectionRequest", + "applePushNotificationCertificate", + "detectedApp", + "deviceLogCollectionResponse", + "malwareStateForWindowsDevice", + "managedDevice", + "managedDeviceOverview", + "mobileAppTroubleshootingEvent", + "userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails", + "userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId", + "userExperienceAnalyticsAppHealthAppPerformanceByOSVersion", + "userExperienceAnalyticsAppHealthApplicationPerformance", + "userExperienceAnalyticsAppHealthDeviceModelPerformance", + "userExperienceAnalyticsAppHealthDevicePerformance", + "userExperienceAnalyticsAppHealthDevicePerformanceDetails", + "userExperienceAnalyticsAppHealthOSVersionPerformance", + "userExperienceAnalyticsBaseline", + "userExperienceAnalyticsCategory", + "userExperienceAnalyticsDevicePerformance", + "userExperienceAnalyticsDeviceScores", + "userExperienceAnalyticsDeviceStartupHistory", + "userExperienceAnalyticsDeviceStartupProcess", + "userExperienceAnalyticsMetric", + "userExperienceAnalyticsMetricHistory", + "userExperienceAnalyticsModelScores", + "userExperienceAnalyticsOverview", + "userExperienceAnalyticsScoreHistory", + "userExperienceAnalyticsWorkFromAnywhereDevice", + "userExperienceAnalyticsWorkFromAnywhereHardwareReadinessMetric", + "userExperienceAnalyticsWorkFromAnywhereMetric", + "userExperienceAnalyticsWorkFromAnywhereModelPerformance", + "windowsDeviceMalwareState", + "windowsMalwareInformation", + "windowsProtectionState" + ], + "complexTypes": [ + "appLogCollectionDownloadDetails", + "configurationManagerClientEnabledFeatures", + "deleteUserFromSharedAppleDeviceActionResult", + "deviceActionResult", + "deviceExchangeAccessStateSummary", + "deviceGeoLocation", + "deviceHealthAttestationState", + "deviceOperatingSystemSummary", + "deviceProtectionOverview", + "insightValueDouble", + "insightValueInt", + "locateDeviceActionResult", + "osVersionCount", + "remoteLockActionResult", + "resetPasscodeActionResult", + "updateWindowsDeviceAccountActionParameter", + "userExperienceAnalyticsAutopilotDevicesSummary", + "userExperienceAnalyticsCloudIdentityDevicesSummary", + "userExperienceAnalyticsCloudManagementDevicesSummary", + "userExperienceAnalyticsInsight", + "userExperienceAnalyticsInsightValue", + "userExperienceAnalyticsSettings", + "userExperienceAnalyticsWindows10DevicesSummary", + "userExperienceAnalyticsWorkFromAnywhereDevicesSummary", + "windowsDefenderScanActionResult", + "windowsDeviceADAccount", + "windowsDeviceAccount", + "windowsDeviceAzureADAccount", + "windowsMalwareCategoryCount", + "windowsMalwareExecutionStateCount", + "windowsMalwareNameCount", + "windowsMalwareOverview", + "windowsMalwareSeverityCount", + "windowsMalwareStateCount" + ] + }, + { + "name": "Mobile app management (MAM)", + "overview": "../../resources/intune-mam-conceptual.md", + "resources": [ + "androidManagedAppProtection", + "androidManagedAppRegistration", + "defaultManagedAppProtection", + "iosManagedAppProtection", + "iosManagedAppRegistration", + "managedAppConfiguration", + "managedAppOperation", + "managedAppPolicy", + "managedAppPolicyDeploymentSummary", + "managedAppProtection", + "managedAppRegistration", + "managedAppStatus", + "managedAppStatusRaw", + "managedMobileApp", + "mdmWindowsInformationProtectionPolicy", + "targetedManagedAppConfiguration", + "targetedManagedAppPolicyAssignment", + "targetedManagedAppProtection", + "windowsInformationProtection", + "windowsInformationProtectionAppLockerFile", + "windowsInformationProtectionPolicy", + "windowsInformationProtectionAppLearningSummary", + "windowsInformationProtectionNetworkLearningSummary" + ], + "complexTypes": [ + "Json", + "allDevicesAssignmentTarget", + "allLicensedUsersAssignmentTarget", + "androidMobileAppIdentifier", + "configurationManagerCollectionAssignmentTarget", + "deviceAndAppManagementAssignmentTarget", + "exclusionGroupAssignmentTarget", + "groupAssignmentTarget", + "iPv4Range", + "iPv6Range", + "iosMobileAppIdentifier", + "ipRange", + "keyValuePair", + "managedAppDiagnosticStatus", + "managedAppPolicyDeploymentSummaryPerApp", + "mobileAppIdentifier", + "proxiedDomain", + "windowsInformationProtectionApp", + "windowsInformationProtectionDataRecoveryCertificate", + "windowsInformationProtectionDesktopApp", + "windowsInformationProtectionIPRangeCollection", + "windowsInformationProtectionProxiedDomainCollection", + "windowsInformationProtectionResourceCollection", + "windowsInformationProtectionStoreApp", + "cloudPcAuditActor", + "cloudPcAuditProperty", + "cloudPcAuditResource", + "cloudPcDomainJoinConfiguration", + "cloudPcManagementAssignmentTarget", + "cloudPcManagementGroupAssignmentTarget", + "cloudPcOnPremisesConnectionHealthCheck", + "cloudPcOnPremisesConnectionStatusDetail", + "cloudPcProvisioningPolicyAssignment", + "cloudPcRestorePointSetting", + "cloudPcSourceDeviceImage", + "cloudPcUserRoleScopeTagInfo", + "cloudPcUserSettingAssignment", + "cloudPcWindowsSetting", + "microsoftManagedDesktop" + ] + }, + { + "name": "Onboarding", + "overview": "../../resources/intune-onboarding-conceptual.md", + "resources": [ + "complianceManagementPartner", + "deviceAppManagement", + "deviceCategory", + "deviceEnrollmentConfiguration", + "deviceEnrollmentLimitConfiguration", + "deviceEnrollmentPlatformRestrictionsConfiguration", + "deviceEnrollmentWindowsHelloForBusinessConfiguration", + "deviceManagementExchangeConnector", + "deviceManagementPartner", + "enrollmentConfigurationAssignment", + "mobileThreatDefenseConnector", + "onPremisesConditionalAccessSettings", + "vppToken" + ], + "complexTypes": [ + "allDevicesAssignmentTarget", + "allLicensedUsersAssignmentTarget", + "complianceManagementPartnerAssignment", + "configurationManagerCollectionAssignmentTarget", + "deviceAndAppManagementAssignmentTarget", + "deviceAndAppManagementData", + "deviceEnrollmentPlatformRestriction", + "deviceManagementPartnerAssignment", + "exclusionGroupAssignmentTarget", + "groupAssignmentTarget", + "intuneBrand", + "mimeContent", + "rgbColor" + ] + }, + { + "name": "Role-based access control (RBAC)", + "overview": "../../resources/intune-rbac-conceptual.md", + "resources": [ + "deviceAndAppManagementRoleAssignment", + "deviceAndAppManagementRoleDefinition", + "resourceOperation", + "roleAssignment", + "roleDefinition" + ], + "complexTypes": [ + "resourceAction", + "rolePermission" + ] + } + ] +} |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/mail/toc.yml | +items: +- name: Overview + href: ../../resources/mail-api-overview.md +- name: Message + items: + - name: Message + href: ../../resources/message.md + - name: List messages + href: ../../api/user-list-messages.md + - name: Create message + href: ../../api/user-post-messages.md + - name: Get message + href: ../../api/message-get.md + - name: Update + href: ../../api/message-update.md + - name: Delete + href: ../../api/message-delete.md + - name: copy + href: ../../api/message-copy.md + - name: createForward + href: ../../api/message-createforward.md + - name: createReply + href: ../../api/message-createreply.md + - name: createReplyAll + href: ../../api/message-createreplyall.md + - name: delta + href: ../../api/message-delta.md + - name: forward + href: ../../api/message-forward.md + - name: move + href: ../../api/message-move.md + - name: reply + href: ../../api/message-reply.md + - name: replyAll + href: ../../api/message-replyall.md + - name: send + href: ../../api/message-send.md + - name: Attachments + items: + - name: List attachments + href: ../../api/message-list-attachments.md + - name: Add attachment + href: ../../api/message-post-attachments.md + - name: Open extensions + items: + - name: Create open extension + href: ../../api/opentypeextension-post-opentypeextension.md + - name: Get open extension + href: ../../api/opentypeextension-get.md + - name: Schema extensions + items: + - name: Add schema extension values + href: ../../graph/extensibility-schema-groups + - name: Extended properties + items: + - name: Create single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get message with single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Create multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get message with multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-get.md +- name: Attachment + items: + - name: Attachment + href: ../../resources/attachment.md + - name: Get attachment + href: ../../api/attachment-get.md + - name: Add attachment to a user event + href: ../../api/event-post-attachments.md + - name: Add attachment to a message + href: ../../api/message-post-attachments.md + - name: Create session to attach large file + href: ../../api/attachment-createuploadsession.md + - name: Add attachment to a post + href: ../../api/post-post-attachments.md + - name: List attachments of a user event + href: ../../api/event-list-attachments.md + - name: List attachments of a message + href: ../../api/message-list-attachments.md + - name: List attachments of a post + href: ../../api/post-list-attachments.md + - name: Delete + href: ../../api/attachment-delete.md +- name: Outlook category + items: + - name: Outlook category + href: ../../resources/outlookcategory.md + - name: List categories + href: ../../api/outlookuser-list-mastercategories.md + - name: Get category + href: ../../api/outlookcategory-get.md + - name: Create + href: ../../api/outlookuser-post-mastercategories.md + - name: Update + href: ../../api/outlookcategory-update.md + - name: Delete + href: ../../api/outlookcategory-delete.md +- name: Mail folder + items: + - name: Mail folder + href: ../../resources/mailfolder.md + - name: List mailFolders + href: ../../api/user-list-mailfolders.md + - name: Get mailFolder + href: ../../api/mailfolder-get.md + - name: Create mailFolder + href: ../../api/user-post-mailfolders.md + - name: List childFolders + href: ../../api/mailfolder-list-childfolders.md + - name: Create childFolder + href: ../../api/mailfolder-post-childfolders.md + - name: Create Message + href: ../../api/mailfolder-post-messages.md + - name: List messages + href: ../../api/mailfolder-list-messages.md + - name: Update + href: ../../api/mailfolder-update.md + - name: Delete + href: ../../api/mailfolder-delete.md + - name: copy + href: ../../api/mailfolder-copy.md + - name: delta + href: ../../api/mailfolder-delta.md + - name: move + href: ../../api/mailfolder-move.md + - name: Extended properties + items: + - name: Create single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get mailFolder with single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Create multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get mailFolder with multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-get.md +- name: Mail search folder + items: + - name: Mail search folder + href: ../../resources/mailsearchfolder.md + - name: Create a search folder + href: ../../api/mailsearchfolder-post.md + - name: List search folders + href: ../../api/mailfolder-list-childfolders.md + - name: Get a search folder + href: ../../api/mailfolder-get.md + - name: Update a search folder + href: ../../api/mailsearchfolder-update.md + - name: Delete a search folder + href: ../../api/mailfolder-delete.md + - name: List all messages in a search folder + href: ../../api/mailfolder-list-messages.md +- name: Message rule + items: + - name: Message rule + href: ../../resources/messagerule.md + - name: List rules + href: ../../api/mailfolder-list-messagerules.md + - name: Get rule + href: ../../api/messagerule-get.md + - name: Create + href: ../../api/mailfolder-post-messagerules.md + - name: Update + href: ../../api/messagerule-update.md + - name: Delete + href: ../../api/messagerule-delete.md +- name: Focused Inbox + items: + - name: Overview + href: ../../resources/manage-focused-inbox.md + - name: Inference classification override + items: + - name: Inference classification override + href: ../../resources/inferenceclassificationoverride.md + - name: Update + href: ../../api/inferenceclassificationoverride-update.md + - name: Delete + href: ../../api/inferenceclassificationoverride-delete.md +- name: Extended properties + items: + - name: Overview + href: ../../resources/extended-properties-overview.md + - name: Single value legacy extended property + items: + - name: Single value legacy extended property + href: ../../resources/singlevaluelegacyextendedproperty.md + - name: Post + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Multivalue legacy extended property + items: + - name: Multivalue legacy extended property + href: ../../resources/multivaluelegacyextendedproperty.md + - name: Post + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get + href: ../../api/multivaluelegacyextendedproperty-get.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/notes/toc.yml | +items: +- name: Overview + href: ../../resources/onenote-api-overview.md +- name: Notebook + items: + - name: Notebook + href: ../../resources/notebook.md + - name: Get notebook + href: ../../api/notebook-get.md + - name: getRecentNotebooks + href: ../../api/notebook-getrecentnotebooks.md + - name: getNotebookFromWebUrl + href: ../../api/notebook-getnotebookfromweburl.md + - name: Create section group + href: ../../api/notebook-post-sectiongroups.md + - name: List section groups + href: ../../api/notebook-list-sectiongroups.md + - name: Create section + href: ../../api/notebook-post-sections.md + - name: List sections + href: ../../api/notebook-list-sections.md + - name: copyNotebook + href: ../../api/notebook-copynotebook.md +- name: OneNote + items: + - name: OneNote + href: ../../resources/onenote.md + - name: Create notebook + href: ../../api/onenote-post-notebooks.md + - name: List notebooks + href: ../../api/onenote-list-notebooks.md + - name: Create page + href: ../../api/onenote-post-pages.md + - name: List pages + href: ../../api/onenote-list-pages.md + - name: List section groups + href: ../../api/onenote-list-sectiongroups.md + - name: List sections + href: ../../api/onenote-list-sections.md +- name: OneNote operation + items: + - name: OneNote operation + href: ../../resources/onenoteoperation.md + - name: Get operation + href: ../../api/onenoteoperation-get.md +- name: OneNote page + items: + - name: OneNote page + href: ../../resources/page.md + - name: Get page + href: ../../api/page-get.md + - name: Update page content + href: ../../api/page-update.md + - name: Delete page + href: ../../api/page-delete.md + - name: copyToSection + href: ../../api/page-copytosection.md +- name: OneNote resource + items: + - name: OneNote resource + href: ../../resources/resource.md + - name: Get resource binary data + href: ../../api/resource-get.md +- name: OneNote section + items: + - name: OneNote section + href: ../../resources/section.md + - name: Get section + href: ../../api/section-get.md + - name: Create page + href: ../../api/section-post-pages.md + - name: List pages + href: ../../api/section-list-pages.md + - name: copyToNotebook + href: ../../api/section-copytonotebook.md + - name: copyToSectionGroup + href: ../../api/section-copytosectiongroup.md +- name: Recent notebook + items: + - name: Recent notebook + href: ../../resources/recentnotebook.md + - name: getRecentNotebooks + href: ../../api/notebook-getrecentnotebooks.md +- name: Section group + items: + - name: Section group + href: ../../resources/sectiongroup.md + - name: Get section group + href: ../../api/sectiongroup-get.md + - name: Create section group + href: ../../api/sectiongroup-post-sectiongroups.md + - name: List section groups + href: ../../api/sectiongroup-list-sectiongroups.md + - name: Create section + href: ../../api/sectiongroup-post-sections.md + - name: List sections + href: ../../api/sectiongroup-list-sections.md +- name: Complex types + items: + - name: External link + href: ../../resources/externallink.md + - name: Identity + href: ../../resources/identity.md + - name: Identity set + href: ../../resources/identityset.md + - name: Notebook links + href: ../../resources/notebooklinks.md + - name: OneNote entity base model + href: ../../resources/onenotebasemodel.md + - name: OneNote entity hierarchy model + href: ../../resources/onenoteentityhierarchymodel.md + - name: OneNote entity schema object model + href: ../../resources/onenoteentityschemaobjectmodel.md + - name: OneNote operation error + href: ../../resources/onenoteoperationerror.md + - name: Operation + href: ../../resources/operation.md + - name: Page links + href: ../../resources/pagelinks.md + - name: Recent notebook links + href: ../../resources/recentnotebooklinks.md + - name: Section links + href: ../../resources/sectionlinks.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/people-and-workplace-intelligence/toc.yml | +items: +- name: Overview + href: ../../resources/social-overview.md +- name: Person + items: + - name: Person + href: ../../resources/person.md + - name: List people + href: ../../api/user-list-people.md +- name: People admin settings + items: + - name: People admin settings + href: ../../resources/peopleadminsettings.md + - name: Get peopleAdminSettings + href: ../../api/peopleadminsettings-get.md + - name: List pronounsSettings + href: ../../api/peopleadminsettings-list-pronouns.md + - name: List profileCardProperties + href: ../../api/peopleadminsettings-list-profilecardproperties.md + - name: Create profileCardProperty + href: ../../api/peopleadminsettings-post-profilecardproperties.md +- name: Insights + items: + - name: Shared insight + items: + - name: Shared insight + href: ../../resources/insights-shared.md + - name: List shared + href: ../../api/insights-list-shared.md + - name: Trending + items: + - name: Trending + href: ../../resources/insights-trending.md + - name: List trending + href: ../../api/insights-list-trending.md + - name: Used insight + items: + - name: Used insight + href: ../../resources/insights-used.md + - name: List used + href: ../../api/insights-list-used.md + - name: Complex types + items: + - name: Insight identity + href: ../../resources/insights-insightidentity.md + - name: Office graph insights + href: ../../resources/officegraphinsights.md + - name: Resource reference + href: ../../resources/insights-resourcereference.md + - name: Resource visualization + href: ../../resources/insights-resourcevisualization.md + - name: Sharing detail + href: ../../resources/insights-sharingdetail.md + - name: Usage details + href: ../../resources/insights-usagedetails.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/personal-contacts/toc.yml | +items: +- name: Contact + items: + - name: Contact + href: ../../resources/contact.md + - name: Get contact + href: ../../api/contact-get.md + - name: Create + href: ../../api/user-post-contacts.md + - name: Update + href: ../../api/contact-update.md + - name: Delete + href: ../../api/contact-delete.md + - name: delta + href: ../../api/contact-delta.md + - name: Open extensions + items: + - name: Create open extension + href: ../../api/opentypeextension-post-opentypeextension.md + - name: Get open extension + href: ../../api/opentypeextension-get.md + - name: Schema extensions + items: + - name: Add schema extension values + href: ../../graph/extensibility-schema-groups + - name: Extended properties + items: + - name: Create single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get contact with single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Create multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get contact with multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-get.md +- name: Contact folder + items: + - name: Contact folder + href: ../../resources/contactfolder.md + - name: Get contactFolder + href: ../../api/contactfolder-get.md + - name: Update + href: ../../api/contactfolder-update.md + - name: Delete + href: ../../api/contactfolder-delete.md + - name: List childFolders + href: ../../api/contactfolder-list-childfolders.md + - name: Create child contactFolder + href: ../../api/contactfolder-post-childfolders.md + - name: delta + href: ../../api/contact-delta.md + - name: List contacts in folder + href: ../../api/contactfolder-list-contacts.md + - name: Create contact in folder + href: ../../api/contactfolder-post-contacts.md + - name: Create single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get contactFolder with single-value extended property + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Create multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get contactFolder with multi-value extended property + href: ../../api/multivaluelegacyextendedproperty-get.md +- name: Outlook category + items: + - name: Outlook category + href: ../../resources/outlookcategory.md + - name: List categories + href: ../../api/outlookuser-list-mastercategories.md + - name: Get category + href: ../../api/outlookcategory-get.md + - name: Create + href: ../../api/outlookuser-post-mastercategories.md + - name: Update + href: ../../api/outlookcategory-update.md + - name: Delete + href: ../../api/outlookcategory-delete.md +- name: Extended properties + items: + - name: Overview + href: ../../resources/extended-properties-overview.md + - name: Single value legacy extended property + items: + - name: Single value legacy extended property + href: ../../resources/singlevaluelegacyextendedproperty.md + - name: Post + href: ../../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md + - name: Get + href: ../../api/singlevaluelegacyextendedproperty-get.md + - name: Multivalue legacy extended property + items: + - name: Multivalue legacy extended property + href: ../../resources/multivaluelegacyextendedproperty.md + - name: Post + href: ../../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md + - name: Get + href: ../../api/multivaluelegacyextendedproperty-get.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/reports/toc.yml | +items: +- name: Identity and access reports + items: + - name: Microsoft Entra activity reports + items: + - name: AD FS application activity + items: + - name: Relying party detailed summary + items: + - name: Relying party detailed summary + href: ../../resources/relyingpartydetailedsummary.md + - name: List relyingPartyDetailedSummary + href: ../../api/reportroot-getrelyingpartydetailedsummary.md + - name: Registration and usage + items: + - name: Overview + href: ../../resources/authenticationmethods-usage-insights-overview.md + - name: User registration details + items: + - name: User registration details + href: ../../resources/userregistrationdetails.md + - name: List userRegistrationDetails + href: ../../api/authenticationmethodsroot-list-userregistrationdetails.md + - name: Get userRegistrationDetails + href: ../../api/userregistrationdetails-get.md + - name: User registration feature summary + items: + - name: User registration feature summary + href: ../../resources/userregistrationfeaturesummary.md + - name: usersRegisteredByFeature + href: ../../api/authenticationmethodsroot-usersregisteredbyfeature.md + - name: User registration method summary + items: + - name: User registration method summary + href: ../../resources/userregistrationmethodsummary.md + - name: usersRegisteredByMethod + href: ../../api/authenticationmethodsroot-usersregisteredbymethod.md + - name: Microsoft Entra audit logs + items: + - name: Overview + href: ../../resources/azure-ad-auditlog-overview.md + - name: Directory audit + items: + - name: Directory audit + href: ../../resources/directoryaudit.md + - name: List directoryAudits + href: ../../api/directoryaudit-list.md + - name: Get directoryAudit + href: ../../api/directoryaudit-get.md + - name: Sign in + items: + - name: Sign in + href: ../../resources/signin.md + - name: List signIn + href: ../../api/signin-list.md + - name: Get signIn + href: ../../api/signin-get.md + - name: Provisioning object summary + items: + - name: Provisioning object summary + href: ../../resources/provisioningobjectsummary.md + - name: List provisioningObjectSummary + href: ../../api/provisioningobjectsummary-list.md +- name: Microsoft 365 usage reports + items: + - name: Overview + href: ../../resources/report.md + - name: Report root + items: + - name: Report root + href: ../../resources/reportroot.md + - name: Microsoft Teams device usage + items: + - name: Get user detail + href: ../../api/reportroot-getteamsdeviceusageuserdetail.md + - name: Get user counts + href: ../../api/reportroot-getteamsdeviceusageusercounts.md + - name: Get distribution user counts + href: ../../api/reportroot-getteamsdeviceusagedistributionusercounts.md + - name: Microsoft Teams user activity + items: + - name: Get user detail + href: ../../api/reportroot-getteamsuseractivityuserdetail.md + - name: Get activity counts + href: ../../api/reportroot-getteamsuseractivitycounts.md + - name: Get user counts + href: ../../api/reportroot-getteamsuseractivityusercounts.md + - name: Microsoft Teams team activity + items: + - name: Get team detail + href: ../../api/reportroot-getteamsteamactivitydetail.md + - name: Get team activity counts + href: ../../api/reportroot-getteamsteamactivitycounts.md + - name: Get team activity distribution counts + href: ../../api/reportroot-getteamsteamactivitydistributioncounts.md + - name: Get team counts + href: ../../api/reportroot-getteamsteamcounts.md + - name: Outlook activity + items: + - name: Get user detail + href: ../../api/reportroot-getemailactivityuserdetail.md + - name: Get activity counts + href: ../../api/reportroot-getemailactivitycounts.md + - name: Get user counts + href: ../../api/reportroot-getemailactivityusercounts.md + - name: Outlook app usage + items: + - name: Get user detail + href: ../../api/reportroot-getemailappusageuserdetail.md + - name: Get apps user counts + href: ../../api/reportroot-getemailappusageappsusercounts.md + - name: Get user counts + href: ../../api/reportroot-getemailappusageusercounts.md + - name: Get versions user counts + href: ../../api/reportroot-getemailappusageversionsusercounts.md + - name: Outlook mailbox usage + items: + - name: Get mailbox detail + href: ../../api/reportroot-getmailboxusagedetail.md + - name: Get mailbox counts + href: ../../api/reportroot-getmailboxusagemailboxcounts.md + - name: Get quota status mailbox counts + href: ../../api/reportroot-getmailboxusagequotastatusmailboxcounts.md + - name: Get storage + href: ../../api/reportroot-getmailboxusagestorage.md + - name: Microsoft 365 activations + items: + - name: Get user detail + href: ../../api/reportroot-getoffice365activationsuserdetail.md + - name: Get activation counts + href: ../../api/reportroot-getoffice365activationcounts.md + - name: Get user counts + href: ../../api/reportroot-getoffice365activationsusercounts.md + - name: Microsoft 365 active users + items: + - name: Get user detail + href: ../../api/reportroot-getoffice365activeuserdetail.md + - name: Get user counts + href: ../../api/reportroot-getoffice365activeusercounts.md + - name: Get services user counts + href: ../../api/reportroot-getoffice365servicesusercounts.md + - name: Microsoft 365 apps usage + items: + - name: Get user detail + href: ../../api/reportroot-getm365appuserdetail.md + - name: Get user counts + href: ../../api/reportroot-getm365appusercounts.md + - name: Get platform user counts + href: ../../api/reportroot-getm365appplatformusercounts.md + - name: Microsoft 365 groups activity + items: + - name: Get group detail + href: ../../api/reportroot-getoffice365groupsactivitydetail.md + - name: Get activity counts + href: ../../api/reportroot-getoffice365groupsactivitycounts.md + - name: Get group counts + href: ../../api/reportroot-getoffice365groupsactivitygroupcounts.md + - name: Get storage + href: ../../api/reportroot-getoffice365groupsactivitystorage.md + - name: Get file counts + href: ../../api/reportroot-getoffice365groupsactivityfilecounts.md + - name: OneDrive activity + items: + - name: Get user detail + href: ../../api/reportroot-getonedriveactivityuserdetail.md + - name: Get user counts + href: ../../api/reportroot-getonedriveactivityusercounts.md + - name: Get file counts + href: ../../api/reportroot-getonedriveactivityfilecounts.md + - name: OneDrive usage + items: + - name: Get account detail + href: ../../api/reportroot-getonedriveusageaccountdetail.md + - name: Get account counts + href: ../../api/reportroot-getonedriveusageaccountcounts.md + - name: Get file counts + href: ../../api/reportroot-getonedriveusagefilecounts.md + - name: Get storage + href: ../../api/reportroot-getonedriveusagestorage.md + - name: SharePoint activity + items: + - name: Get user detail + href: ../../api/reportroot-getsharepointactivityuserdetail.md + - name: Get file counts + href: ../../api/reportroot-getsharepointactivityfilecounts.md + - name: Get user counts + href: ../../api/reportroot-getsharepointactivityusercounts.md + - name: Get pages + href: ../../api/reportroot-getsharepointactivitypages.md + - name: SharePoint site usage + items: + - name: Get site detail + href: ../../api/reportroot-getsharepointsiteusagedetail.md + - name: Get file counts + href: ../../api/reportroot-getsharepointsiteusagefilecounts.md + - name: Get site counts + href: ../../api/reportroot-getsharepointsiteusagesitecounts.md + - name: Get storage + href: ../../api/reportroot-getsharepointsiteusagestorage.md + - name: Get pages + href: ../../api/reportroot-getsharepointsiteusagepages.md + - name: Skype for Business activity + items: + - name: Get user detail + href: ../../api/reportroot-getskypeforbusinessactivityuserdetail.md + - name: Get activity counts + href: ../../api/reportroot-getskypeforbusinessactivitycounts.md + - name: Get user counts + href: ../../api/reportroot-getskypeforbusinessactivityusercounts.md + - name: Skype for Business device usage + items: + - name: Get user detail + href: ../../api/reportroot-getskypeforbusinessdeviceusageuserdetail.md + - name: Get distribution user counts + href: ../../api/reportroot-getskypeforbusinessdeviceusagedistributionusercounts.md + - name: Get user counts + href: ../../api/reportroot-getskypeforbusinessdeviceusageusercounts.md + - name: Skype for Business organizer activity + items: + - name: Get activity counts + href: ../../api/reportroot-getskypeforbusinessorganizeractivitycounts.md + - name: Get user counts + href: ../../api/reportroot-getskypeforbusinessorganizeractivityusercounts.md + - name: Get minute counts + href: ../../api/reportroot-getskypeforbusinessorganizeractivityminutecounts.md + - name: Skype for Business participant activity + items: + - name: Get activity counts + href: ../../api/reportroot-getskypeforbusinessparticipantactivitycounts.md + - name: Get user counts + href: ../../api/reportroot-getskypeforbusinessparticipantactivityusercounts.md + - name: Get minute counts + href: ../../api/reportroot-getskypeforbusinessparticipantactivityminutecounts.md + - name: Skype for Business peer-to-peer activity + items: + - name: Get activity counts + href: ../../api/reportroot-getskypeforbusinesspeertopeeractivitycounts.md + - name: Get user counts + href: ../../api/reportroot-getskypeforbusinesspeertopeeractivityusercounts.md + - name: Get minute counts + href: ../../api/reportroot-getskypeforbusinesspeertopeeractivityminutecounts.md + - name: Viva Engage activity + items: + - name: Get user detail + href: ../../api/reportroot-getyammeractivityuserdetail.md + - name: Get activity counts + href: ../../api/reportroot-getyammeractivitycounts.md + - name: Get user counts + href: ../../api/reportroot-getyammeractivityusercounts.md + - name: Viva Engage device usage + items: + - name: Get user detail + href: ../../api/reportroot-getyammerdeviceusageuserdetail.md + - name: Get distribution user counts + href: ../../api/reportroot-getyammerdeviceusagedistributionusercounts.md + - name: Get user counts + href: ../../api/reportroot-getyammerdeviceusageusercounts.md + - name: Viva Engage groups activity + items: + - name: Get group detail + href: ../../api/reportroot-getyammergroupsactivitydetail.md + - name: Get group counts + href: ../../api/reportroot-getyammergroupsactivitygroupcounts.md + - name: Get activity counts + href: ../../api/reportroot-getyammergroupsactivitycounts.md +- name: Microsoft Defender for Office 365 security reports + items: + - name: Overview + href: ../../resources/report-m365defender-reports-overview.md + - name: Attack simulation repeat offender + items: + - name: Attack simulation repeat offender + href: ../../resources/attacksimulationrepeatoffender.md + - name: Get repeat offenders + href: ../../api/securityreportsroot-getattacksimulationrepeatoffenders.md + - name: Attack simulation simulation user coverage + items: + - name: Attack simulation simulation user coverage + href: ../../resources/attacksimulationsimulationusercoverage.md + - name: Get simulation coverage for users + href: ../../api/securityreportsroot-getattacksimulationsimulationusercoverage.md + - name: Attack simulation training user coverage + items: + - name: Attack simulation training user coverage + href: ../../resources/attacksimulationtrainingusercoverage.md + - name: Get training coverage for users + href: ../../api/securityreportsroot-getattacksimulationtrainingusercoverage.md +- name: Partner billing reports + items: + - name: Overview + href: ../../resources/partners-billing-api-overview.md + - name: Billed reconciliation + items: + - name: Billed reconciliation + href: ../../resources/partners-billing-billedreconciliation.md + - name: export + href: ../../api/partners-billing-billedreconciliation-export.md + - name: Billed usage + items: + - name: Billed usage + href: ../../resources/partners-billing-billedusage.md + - name: export + href: ../../api/partners-billing-billedusage-export.md + - name: Manifest + items: + - name: Manifest + href: ../../resources/partners-billing-manifest.md + - name: Get manifest + href: ../../api/partners-billing-manifest-get.md + - name: Operation + items: + - name: Operation + href: ../../resources/partners-billing-operation.md + - name: Get operation + href: ../../api/partners-billing-operation-get.md + - name: Unbilled usage + items: + - name: Unbilled usage + href: ../../resources/partners-billing-unbilledusage.md + - name: export + href: ../../api/partners-billing-unbilledusage-export.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/search/toc.yml | +items: +- name: Answer + items: + - name: Overview + href: ../../resources/search-api-answers-overview.md + - name: Acronym + items: + - name: Acronym + href: ../../resources/search-acronym.md + - name: List acronyms + href: ../../api/search-searchentity-list-acronyms.md + - name: Create acronym + href: ../../api/search-searchentity-post-acronyms.md + - name: Get acronym + href: ../../api/search-acronym-get.md + - name: Update acronym + href: ../../api/search-acronym-update.md + - name: Delete acronym + href: ../../api/search-acronym-delete.md + - name: Bookmark + items: + - name: Bookmark + href: ../../resources/search-bookmark.md + - name: List bookmarks + href: ../../api/search-searchentity-list-bookmarks.md + - name: Create bookmark + href: ../../api/search-searchentity-post-bookmarks.md + - name: Get bookmark + href: ../../api/search-bookmark-get.md + - name: Update bookmark + href: ../../api/search-bookmark-update.md + - name: Delete bookmark + href: ../../api/search-bookmark-delete.md + - name: QnA + items: + - name: QnA + href: ../../resources/search-qna.md + - name: List qnas + href: ../../api/search-searchentity-list-qnas.md + - name: Create qna + href: ../../api/search-searchentity-post-qnas.md + - name: Get qna + href: ../../api/search-qna-get.md + - name: Update qna + href: ../../api/search-qna-update.md + - name: Delete qna + href: ../../api/search-qna-delete.md +- name: Query + items: + - name: Overview + href: ../../resources/search-api-overview.md + - name: Search entity + items: + - name: Search entity + href: ../../resources/searchentity.md + - name: query + href: ../../api/search-query.md + - name: Search request + href: ../../resources/searchrequest.md + - name: Search response + href: ../../resources/searchresponse.md + - name: Complex types + items: + - name: Aggregation option + href: ../../resources/aggregationoption.md + - name: Alteration response + href: ../../resources/alterationresponse.md + - name: Altered query token + href: ../../resources/alteredquerytoken.md + - name: Bucket aggregation definition + href: ../../resources/bucketaggregationdefinition.md + - name: Bucket aggregation range + href: ../../resources/bucketaggregationrange.md + - name: Collapse property + href: ../../resources/collapseproperty.md + - name: Json + href: ../../resources/json.md + - name: Result template + href: ../../resources/resulttemplate.md + - name: Result template option + href: ../../resources/resulttemplateoption.md + - name: Search alteration + href: ../../resources/searchalteration.md + - name: Search alteration options + href: ../../resources/searchalterationoptions.md + - name: Search bucket + href: ../../resources/searchbucket.md + - name: Search hit + href: ../../resources/searchhit.md + - name: Search hits container + href: ../../resources/searchhitscontainer.md + - name: Search query + href: ../../resources/searchquery.md + - name: Share point one drive 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 | +items: +- name: Overview + href: ../../resources/security-api-overview.md +- name: Errors + href: ../../resources/security-error-codes.md +- name: Advanced hunting + items: + - name: Security + items: + - name: Security + href: ../../resources/security.md + - name: runHuntingQuery + href: ../../api/security-security-runhuntingquery.md + - name: Hunting query results + href: ../../resources/security-huntingqueryresults.md + - name: Hunting row result + href: ../../resources/security-huntingrowresult.md + - name: Single property schema + href: ../../resources/security-singlepropertyschema.md +- name: Alerts and incidents + items: + - name: Alert + items: + - name: Alert + href: ../../resources/security-alert.md + - name: List alerts_v2 + href: ../../api/security-list-alerts_v2.md + - name: Get alert + href: ../../api/security-alert-get.md + - name: Update alert + href: ../../api/security-alert-update.md + - name: Create comment for alert + href: ../../api/security-alert-post-comments.md + - name: Alert evidence + href: ../../resources/security-alertevidence.md + - name: Incident + items: + - name: Incident + href: ../../resources/security-incident.md + - name: List incidents + href: ../../api/security-list-incidents.md + - name: Get incident + href: ../../api/security-incident-get.md + - name: Update incident + href: ../../api/security-incident-update.md + - name: Create comment for incident + href: ../../api/security-incident-post-comments.md +- name: Attack simulation and training + items: + - name: Simulation + items: + - name: Simulation + href: ../../resources/simulation.md + - name: List simulations + href: ../../api/attacksimulationroot-list-simulations.md + - name: Create simulation + href: ../../api/attacksimulationroot-post-simulation.md + - name: Get simulation + href: ../../api/simulation-get.md + - name: Update simulation + href: ../../api/simulation-update.md + - name: Delete simulation + href: ../../api/simulation-delete.md + - name: Get payload + href: ../../api/payload-get.md + - name: Get loginPage + href: ../../api/loginpage-get.md + - name: Get landingPage + href: ../../api/landingpage-get.md + - name: Attack simulation operation + items: + - name: Attack simulation operation + href: ../../resources/attacksimulationoperation.md + - name: Get attackSimulationOperation + href: ../../api/attacksimulationoperation-get.md + - name: End user notification + items: + - name: End user notification + href: ../../resources/endusernotification.md + - name: List endUserNotifications + href: ../../api/attacksimulationroot-list-endusernotifications.md + - name: Get endUserNotification + href: ../../api/endusernotification-get.md + - name: Landing page + items: + - name: Landing page + href: ../../resources/landingpage.md + - name: List landingPages + href: ../../api/attacksimulationroot-list-landingpage.md + - name: Get landingPage + href: ../../api/landingpage-get.md + - name: Login page + items: + - name: Login page + href: ../../resources/loginpage.md + - name: List loginPages + href: ../../api/attacksimulationroot-list-loginpage.md + - name: Get loginPage + href: ../../api/loginpage-get.md + - name: Payload + items: + - name: Payload + href: ../../resources/payload.md + - name: List payload + href: ../../api/attacksimulationroot-list-payloads.md + - name: Get payload + href: ../../api/payload-get.md + - name: Get payloadDetail + href: ../../api/payloaddetail-get.md + - name: Simulation automation + items: + - name: Simulation automation + href: ../../resources/simulationautomation.md + - name: List simulationAutomations + href: ../../api/attacksimulationroot-list-simulationautomations.md + - name: Get simulationAutomation + href: ../../api/simulationautomation-get.md + - name: List runs + href: ../../api/simulationautomation-list-runs.md + - name: Simulation automation run + items: + - name: Simulation automation run + href: ../../resources/simulationautomationrun.md + - name: List runs + href: ../../api/simulationautomation-list-runs.md + - name: Training + items: + - name: Training + href: ../../resources/training.md + - name: List trainings + href: ../../api/attacksimulationroot-list-trainings.md + - name: Get training + href: ../../api/training-get.md + - name: Get trainingLanguageDetail + href: ../../api/traininglanguagedetail-get.md + - name: Training language detail + items: + - name: Training language detail + href: ../../resources/traininglanguagedetail.md + - name: Get trainingLanguageDetail + href: ../../api/traininglanguagedetail-get.md + - name: Reports + items: + - name: Overview + href: ../../resources/report-m365defender-reports-overview.md + - name: Attack simulation repeat offender + items: + - name: Attack simulation repeat offender + href: ../../resources/attacksimulationrepeatoffender.md + - name: Get repeat offenders + href: ../../api/securityreportsroot-getattacksimulationrepeatoffenders.md + - name: Attack simulation simulation user coverage + items: + - name: Attack simulation simulation user coverage + href: ../../resources/attacksimulationsimulationusercoverage.md + - name: Get simulation coverage for users + href: ../../api/securityreportsroot-getattacksimulationsimulationusercoverage.md + - name: Attack simulation training user coverage + items: + - name: Attack simulation training user coverage + href: ../../resources/attacksimulationtrainingusercoverage.md + - name: Get training coverage for users + href: ../../api/securityreportsroot-getattacksimulationtrainingusercoverage.md +- name: eDiscovery + items: + - name: eDiscovery case + items: + - name: eDiscovery case + href: ../../resources/security-ediscoverycase.md + - name: List ediscoveryCases + href: ../../api/security-casesroot-list-ediscoverycases.md + - name: Create ediscoveryCase + href: ../../api/security-casesroot-post-ediscoverycases.md + - name: Get ediscoveryCase + href: ../../api/security-ediscoverycase-get.md + - name: Update ediscoveryCase + href: ../../api/security-ediscoverycase-update.md + - name: Delete ediscoveryCase + href: ../../api/security-casesroot-delete-ediscoverycases.md + - name: List custodians + href: ../../api/security-ediscoverycase-list-custodians.md + - name: Create ediscoveryCustodian + href: ../../api/security-ediscoverycase-post-custodians.md + - name: List noncustodialDataSources + href: ../../api/security-ediscoverysearch-list-noncustodialsources.md + - name: Create ediscoveryNoncustodialDataSource + href: ../../api/security-ediscoverycase-post-noncustodialdatasources.md + - name: List operations + href: ../../api/security-ediscoverycase-list-operations.md + - name: List reviewSets + href: ../../api/security-ediscoverycase-list-reviewsets.md + - name: Create ediscoveryReviewSet + href: ../../api/security-ediscoverycase-post-reviewsets.md + - name: List searches + href: ../../api/security-ediscoverycase-list-searches.md + - name: Create ediscoverySearch + href: ../../api/security-ediscoverycase-post-searches.md + - name: List tags + href: ../../api/security-ediscoverycase-list-tags.md + - name: Create ediscoveryReviewTag + href: ../../api/security-ediscoverycase-post-tags.md + - name: eDiscovery case settings + items: + - name: eDiscovery case settings + href: ../../resources/security-ediscoverycasesettings.md + - name: Get ediscoveryCaseSettings + href: ../../api/security-ediscoverycasesettings-get.md + - name: Update ediscoveryCaseSettings + href: ../../api/security-ediscoverycasesettings-update.md + - name: resetToDefault + href: ../../api/security-ediscoverycasesettings-resettodefault.md + - name: Case operation + items: + - name: Case operation + href: ../../resources/security-caseoperation.md + - name: List caseOperations + href: ../../api/security-ediscoverycase-list-operations.md + - name: Get caseOperation + href: ../../api/security-caseoperation-get.md + - name: eDiscovery custodian + items: + - name: eDiscovery custodian + href: ../../resources/security-ediscoverycustodian.md + - name: List ediscoveryCustodians + href: ../../api/security-ediscoverycase-list-custodians.md + - name: Create ediscoveryCustodian + href: ../../api/security-ediscoverycase-post-custodians.md + - name: Get ediscoveryCustodian + href: ../../api/security-ediscoverycustodian-get.md + - name: updateIndex + href: ../../api/security-ediscoverycustodian-updateindex.md + - name: activate + href: ../../api/security-ediscoverycustodian-activate.md + - name: release + href: ../../api/security-ediscoverycustodian-release.md + - name: applyHold + href: ../../api/security-ediscoverycustodian-applyhold.md + - name: removeHold + href: ../../api/security-ediscoverycustodian-removehold.md + - name: List ediscoveryIndexOperation + href: ../../api/security-ediscoverycustodian-list-lastindexoperation.md + - name: List siteSources + href: ../../api/security-ediscoverycustodian-list-sitesources.md + - name: Create siteSource + href: ../../api/security-ediscoverycustodian-post-sitesources.md + - name: List unifiedGroupSources + href: ../../api/security-ediscoverycustodian-list-unifiedgroupsources.md + - name: Create unifiedGroupSource + href: ../../api/security-ediscoverycustodian-post-unifiedgroupsources.md + - name: List userSources + href: ../../api/security-ediscoverycustodian-list-usersources.md + - name: Create userSource + href: ../../api/security-ediscoverycustodian-post-usersources.md + - name: eDiscovery noncustodial data source + items: + - name: eDiscovery noncustodial data source + href: ../../resources/security-ediscoverynoncustodialdatasource.md + - name: List ediscoveryNoncustodialDataSources + href: ../../api/security-ediscoverysearch-list-noncustodialsources.md + - name: Create ediscoveryNoncustodialDataSource + href: ../../api/security-ediscoverysearch-post-noncustodialsources.md + - name: Get ediscoveryNoncustodialDataSource + href: ../../api/security-ediscoverynoncustodialdatasource-get.md + - name: updateIndex + href: ../../api/security-ediscoverynoncustodialdatasource-updateindex.md + - name: release + href: ../../api/security-ediscoverynoncustodialdatasource-release.md + - name: applyHold + href: ../../api/security-ediscoverynoncustodialdatasource-applyhold.md + - name: removeHold + href: ../../api/security-ediscoverynoncustodialdatasource-removehold.md + - name: List ediscoveryIndexOperation + href: ../../api/security-ediscoverycustodian-list-lastindexoperation.md + - name: eDiscovery search + items: + - name: eDiscovery search + href: ../../resources/security-ediscoverysearch.md + - name: List ediscoverySearches + href: ../../api/security-ediscoverycase-list-searches.md + - name: Create ediscoverySearch + href: ../../api/security-ediscoverycase-post-searches.md + - name: Get ediscoverySearch + href: ../../api/security-ediscoverysearch-get.md + - name: Update ediscoverySearch + href: ../../api/security-ediscoverysearch-update.md + - name: Delete ediscoverySearch + href: ../../api/security-ediscoverycase-delete-searches.md + - name: estimateStatistics + href: ../../api/security-ediscoverysearch-estimatestatistics.md + - name: List additionalSources + href: ../../api/security-ediscoverysearch-list-additionalsources.md + - name: Add additionalSources + href: ../../api/security-ediscoverysearch-post-additionalsources.md + - name: List ediscoveryEstimateOperation + href: ../../api/security-ediscoverysearch-list-lastestimatestatisticsoperation.md + - name: List custodianSources + href: ../../api/security-ediscoverysearch-list-custodiansources.md + - name: Add custodianSources + href: ../../api/security-ediscoverysearch-post-custodiansources.md + - name: Remove custodianSources + href: ../../api/security-ediscoverysearch-delete-custodiansources.md + - name: List noncustodialSources + href: ../../api/security-ediscoverysearch-list-noncustodialsources.md + - name: Add noncustodialSources + href: ../../api/security-ediscoverysearch-post-noncustodialsources.md + - name: Remove noncustodialSources + href: ../../api/security-ediscoverysearch-delete-noncustodialsources.md + - name: eDiscovery review set + items: + - name: eDiscovery review set + href: ../../resources/security-ediscoveryreviewset.md + - name: List ediscoveryReviewSets + href: ../../api/security-ediscoverycase-list-reviewsets.md + - name: Create ediscoveryReviewSet + href: ../../api/security-ediscoverycase-post-reviewsets.md + - name: Get ediscoveryReviewSet + href: ../../api/security-ediscoveryreviewset-get.md + - name: addToReviewSet + href: ../../api/security-ediscoveryreviewset-addtoreviewset.md + - name: List queries + href: ../../api/security-ediscoveryreviewset-list-queries.md + - name: Create ediscoveryReviewSetQuery + href: ../../api/security-ediscoveryreviewset-post-queries.md + - name: export + href: ../../api/security-ediscoveryreviewset-export.md + - name: eDiscovery review tag + items: + - name: eDiscovery review tag + href: ../../resources/security-ediscoveryreviewtag.md + - name: List ediscoveryReviewTags + href: ../../api/security-ediscoverycase-list-tags.md + - name: Create ediscoveryReviewTag + href: ../../api/security-ediscoverycase-post-tags.md + - name: Get ediscoveryReviewTag + href: ../../api/security-ediscoveryreviewtag-get.md + - name: Update ediscoveryReviewTag + href: ../../api/security-ediscoveryreviewtag-update.md + - name: Delete ediscoveryReviewTag + href: ../../api/security-ediscoverycase-delete-tags.md + - name: asHierarchy + href: ../../api/security-ediscoveryreviewtag-ashierarchy.md +- name: Information protection + items: + - name: Threat assessment + items: + - name: Overview + href: ../../resources/threatassessment-api-overview.md + - name: Email file assessment request + items: + - name: Email file assessment request + href: ../../resources/emailfileassessmentrequest.md + - name: Create threatAssessmentRequest + href: ../../api/informationprotection-post-threatassessmentrequests.md + - name: Get threatAssessmentRequest + href: ../../api/threatassessmentrequest-get.md + - name: File assessment request + items: + - name: File assessment request + href: ../../resources/fileassessmentrequest.md + - name: Create threatAssessmentRequest + href: ../../api/informationprotection-post-threatassessmentrequests.md + - name: Get threatAssessmentRequest + href: ../../api/threatassessmentrequest-get.md + - name: Mail assessment request + items: + - name: Mail assessment request + href: ../../resources/mailassessmentrequest.md + - name: Create threatAssessmentRequest + href: ../../api/informationprotection-post-threatassessmentrequests.md + - name: Get threatAssessmentRequest + href: ../../api/threatassessmentrequest-get.md + - name: Threat assessment request + items: + - name: Threat assessment request + href: ../../resources/threatassessmentrequest.md + - name: List threatAssessmentRequest + href: ../../api/informationprotection-list-threatassessmentrequests.md + - name: Create threatAssessmentRequest + href: ../../api/informationprotection-post-threatassessmentrequests.md + - name: Get threatAssessmentRequest + href: ../../api/threatassessmentrequest-get.md + - name: URL assessment request + items: + - name: URL assessment request + href: ../../resources/urlassessmentrequest.md + - name: Create threatAssessmentRequest + href: ../../api/informationprotection-post-threatassessmentrequests.md + - name: Get threatAssessmentRequest + href: ../../api/threatassessmentrequest-get.md + - name: Complex types + items: + - name: Identity + href: ../../resources/identity.md + - name: Identity set + href: ../../resources/identityset.md + - name: Threat assessment result + href: ../../resources/threatassessmentresult.md +- name: Legacy alert (deprecated) + items: + - name: Alert + items: + - name: Alert + href: ../../resources/alert.md + - name: Get alert + href: ../../api/alert-get.md + - name: Update alert + href: ../../api/alert-update.md + - name: List alerts + href: ../../api/alert-list.md +- name: Records management + items: + - name: Overview + href: ../../resources/security-recordsmanagement-overview.md + - name: Retention label + items: + - name: Retention label + href: ../../resources/security-retentionlabel.md + - name: List retentionLabels + href: ../../api/security-labelsroot-list-retentionlabel.md + - name: Create retentionLabel + href: ../../api/security-labelsroot-post-retentionlabel.md + - name: Get retentionLabel + href: ../../api/security-retentionlabel-get.md + - name: Update retentionLabel + href: ../../api/security-retentionlabel-update.md + - name: Delete retentionLabel + href: ../../api/security-retentionlabel-delete.md + - name: List retentionEventType + href: ../../api/security-retentioneventtype-list.md + - name: Add retentionEventType + href: ../../api/security-retentioneventtype-post.md + - name: Retention event + items: + - name: Retention event + href: ../../resources/security-retentionevent.md + - name: List retentionEvents + href: ../../api/security-retentionevent-list.md + - name: Create retentionEvent + href: ../../api/security-retentionevent-post.md + - name: Get retentionEvent + href: ../../api/security-retentionevent-get.md + - name: Delete retentionEvent + href: ../../api/security-retentionevent-delete.md + - name: List retentionEventType + href: ../../api/security-retentioneventtype-list.md + - name: Create retentionEventType + href: ../../api/security-retentioneventtype-post.md + - name: Retention event type + items: + - name: Retention event type + href: ../../resources/security-retentioneventtype.md + - name: List retentionEventTypes + href: ../../api/security-retentioneventtype-list.md + - name: Create retentionEventType + href: ../../api/security-retentioneventtype-post.md + - name: Get retentionEventType + href: ../../api/security-retentioneventtype-get.md + - name: Update retentionEventType + href: ../../api/security-retentioneventtype-update.md + - name: Delete retentionEventType + href: ../../api/security-retentioneventtype-delete.md + - name: File plan descriptors + items: + - name: File plan descriptors + items: + - name: File plan descriptor + href: ../../resources/security-fileplandescriptor.md + - name: File plan applied category + href: ../../resources/security-fileplanappliedcategory.md + - name: File plan authority + href: ../../resources/security-fileplanauthority.md + - name: File plan citation + href: ../../resources/security-fileplancitation.md + - name: File plan department + href: ../../resources/security-fileplandepartment.md + - name: File plan reference + href: ../../resources/security-fileplanreference.md + - name: File plan subcategory + href: ../../resources/security-fileplansubcategory.md + - name: File plan descriptor templates + items: + - name: Category template + items: + - name: Category template + href: ../../resources/security-categorytemplate.md + - name: List categories + href: ../../api/security-labelsroot-list-categories.md + - name: Create categories + href: ../../api/security-labelsroot-post-categories.md + - name: Get categories + href: ../../api/security-categorytemplate-get.md + - name: Delete categories + href: ../../api/security-labelsroot-delete-categories.md + - name: List subcategories + href: ../../api/security-categorytemplate-list-subcategories.md + - name: Create subcategories + href: ../../api/security-categorytemplate-post-subcategories.md + - name: Authority template + items: + - name: Authority template + href: ../../resources/security-authoritytemplate.md + - name: List authorities + href: ../../api/security-labelsroot-list-authorities.md + - name: Create authorities + href: ../../api/security-labelsroot-post-authorities.md + - name: Get authorities + href: ../../api/security-authoritytemplate-get.md + - name: Delete authorities + href: ../../api/security-labelsroot-delete-authorities.md + - name: Citation template + items: + - name: Citation template + href: ../../resources/security-citationtemplate.md + - name: List citations + href: ../../api/security-labelsroot-list-citations.md + - name: Create citations + href: ../../api/security-labelsroot-post-citations.md + - name: Get citations + href: ../../api/security-citationtemplate-get.md + - name: Delete citations + href: ../../api/security-labelsroot-delete-citations.md + - name: Department template + items: + - name: Department template + href: ../../resources/security-departmenttemplate.md + - name: List departments + href: ../../api/security-labelsroot-list-departments.md + - name: Create departments + href: ../../api/security-labelsroot-post-departments.md + - name: Get departments + href: ../../api/security-departmenttemplate-get.md + - name: Delete departments + href: ../../api/security-labelsroot-delete-departments.md + - name: File plan reference template + items: + - name: File plan reference template + href: ../../resources/security-fileplanreferencetemplate.md + - name: List filePlanReferences + href: ../../api/security-labelsroot-list-fileplanreferences.md + - name: Create filePlanReferences + href: ../../api/security-labelsroot-post-fileplanreferences.md + - name: Get filePlanReferences + href: ../../api/security-fileplanreferencetemplate-get.md + - name: Delete filePlanReferences + href: ../../api/security-labelsroot-delete-fileplanreferences.md + - name: Subcategory template + items: + - name: Subcategory template + href: ../../resources/security-subcategorytemplate.md + - name: List subcategories + href: ../../api/security-categorytemplate-list-subcategories.md + - name: Create subcategories + href: ../../api/security-categorytemplate-post-subcategories.md + - name: Get subcategories + href: ../../api/security-subcategorytemplate-get.md + - name: Delete subcategories + href: ../../api/security-categorytemplate-delete-subcategories.md + - name: Complex types + items: + - name: Event propagation result + href: ../../resources/security-eventpropagationresult.md + - name: Event query + href: ../../resources/security-eventquery.md + - name: File plan descriptor base + href: ../../resources/security-fileplandescriptorbase.md + - name: File plan descriptor template + href: ../../resources/security-fileplandescriptortemplate.md + - name: Identity + href: ../../resources/identity.md + - name: Identity set + href: ../../resources/identityset.md + - name: Public error + href: ../../resources/publicerror.md + - name: Public error detail + href: ../../resources/publicerrordetail.md + - name: Public inner error + href: ../../resources/publicinnererror.md + - name: Retention duration + href: ../../resources/security-retentionduration.md + - name: Retention duration forever + href: ../../resources/security-retentiondurationforever.md + - name: Retention duration in days + href: ../../resources/security-retentiondurationindays.md + - name: Retention event status + href: ../../resources/security-retentioneventstatus.md +- name: Secure score + items: + - name: Secure score + items: + - name: Secure score + href: ../../resources/securescore.md + - name: List secureScores + href: ../../api/security-list-securescores.md + - name: Get secureScore + href: ../../api/securescore-get.md + - name: Secure score control profile + items: + - name: Secure score control profile + href: ../../resources/securescorecontrolprofile.md + - name: List secureScoreControlProfiles + href: ../../api/security-list-securescorecontrolprofiles.md + - name: Get secureScoreControlProfile + href: ../../api/securescorecontrolprofile-get.md + - name: Update securescorecontrolprofile + href: ../../api/securescorecontrolprofile-update.md +- name: Threat intelligence + items: + - name: Overview + href: ../../resources/security-threatintelligence-overview.md + - name: Article + items: + - name: Article + href: ../../resources/security-article.md + - name: List articles + href: ../../api/security-threatintelligence-list-articles.md + - name: Get article + href: ../../api/security-article-get.md + - name: List indicators + href: ../../api/security-article-list-indicators.md + - name: Article indicator + items: + - name: Article indicator + href: ../../resources/security-articleindicator.md + - name: Get articleIndicator + href: ../../api/security-articleindicator-get.md + - name: Host + items: + - name: Host + href: ../../resources/security-host.md + - name: Get host + href: ../../api/security-host-get.md + - name: Get whoisRecord + href: ../../api/security-whoisrecord-get.md + - name: List childHostPairs for a host as parent + href: ../../api/security-host-list-childhostpairs.md + - name: List hostPairs for a host + href: ../../api/security-host-list-hostpairs.md + - name: List components + href: ../../api/security-host-list-components.md + - name: List cookies + href: ../../api/security-host-list-cookies.md + - name: List parentHostPairs for a host as child + href: ../../api/security-host-list-parenthostpairs.md + - name: List passiveDns + href: ../../api/security-host-list-passivedns.md + - name: List passiveDnsReverse + href: ../../api/security-host-list-passivednsreverse.md + - name: List ports + href: ../../api/security-host-list-ports.md + - name: Get reputation + href: ../../api/security-host-get-reputation.md + - name: List subdomains + href: ../../api/security-host-list-subdomains.md + - name: List trackers + href: ../../api/security-host-list-trackers.md + - name: List hostSslCertificates + href: ../../api/security-host-list-sslcertificates.md + - name: Host component + items: + - name: Host component + href: ../../resources/security-hostcomponent.md + - name: Get hostComponent + href: ../../api/security-hostcomponent-get.md + - name: Host cookie + items: + - name: Host cookie + href: ../../resources/security-hostcookie.md + - name: Get hostCookie + href: ../../api/security-hostcookie-get.md + - name: Host pair + items: + - name: Host pair + href: ../../resources/security-hostpair.md + - name: Get hostPair + href: ../../api/security-hostpair-get.md + - name: List hostPairs for a host + href: ../../api/security-host-list-hostpairs.md + - name: List parentHostPairs for a host as child + href: ../../api/security-host-list-parenthostpairs.md + - name: List childHostPairs for a host as parent + href: ../../api/security-host-list-childhostpairs.md + - name: Host port + items: + - name: Host port + href: ../../resources/security-hostport.md + - name: List hostPorts + href: ../../api/security-host-list-ports.md + - name: Get hostPort + href: ../../api/security-hostport-get.md + - name: Host SSL certificate + items: + - name: Host SSL certificate + href: ../../resources/security-hostsslcertificate.md + - name: List hostSslCertificates + href: ../../api/security-host-list-sslcertificates.md + - name: Get hostSslCertificate + href: ../../api/security-hostsslcertificate-get.md + - name: Host tracker + items: + - name: Host tracker + href: ../../resources/security-hosttracker.md + - name: Get hostTracker + href: ../../api/security-hosttracker-get.md + - name: Intelligence profile + items: + - name: Intelligence profile + href: ../../resources/security-intelligenceprofile.md + - name: List intelligenceProfiles + href: ../../api/security-threatintelligence-list-intelprofiles.md + - name: Get intelligenceProfile + href: ../../api/security-intelligenceprofile-get.md + - name: List indicators + href: ../../api/security-intelligenceprofile-list-indicators.md + - name: Intelligence profile indicator + items: + - name: Intelligence profile indicator + href: ../../resources/security-intelligenceprofileindicator.md + - name: Get intelligenceProfileIndicator + href: ../../api/security-intelligenceprofileindicator-get.md + - name: Passive DNS record + items: + - name: Passive DNS record + href: ../../resources/security-passivednsrecord.md + - name: Get passiveDns + href: ../../api/security-passivednsrecord-get.md + - name: SSL certificate + items: + - name: SSL certificate + href: ../../resources/security-sslcertificate.md + - name: List sslCertificates + href: ../../api/security-threatintelligence-list-sslcertificates.md + - name: Get sslCertificate + href: ../../api/security-sslcertificate-get.md + - name: Subdomain + items: + - name: Subdomain + href: ../../resources/security-subdomain.md + - name: Get subdomain + href: ../../api/security-subdomain-get.md + - name: List subdomains for a host + href: ../../api/security-host-list-subdomains.md + - name: Vulnerability + items: + - name: Vulnerability + href: ../../resources/security-vulnerability.md + - name: Get vulnerability + href: ../../api/security-vulnerability-get.md + - name: List components + href: ../../api/security-vulnerability-list-components.md + - name: Vulnerability component + items: + - name: Vulnerability component + href: ../../resources/security-vulnerabilitycomponent.md + - name: List components + href: ../../api/security-vulnerability-list-components.md + - name: Get vulnerabilityComponent + href: ../../api/security-vulnerabilitycomponent-get.md + - name: WHOIS history record + items: + - name: WHOIS history record + href: ../../resources/security-whoishistoryrecord.md + - name: List whoisHistoryRecords + href: ../../api/security-whoisrecord-list-history.md + - name: Get whoisHistoryRecord + href: ../../api/security-whoishistoryrecord-get.md + - name: WHOIS record + items: + - name: WHOIS record + href: ../../resources/security-whoisrecord.md + - name: List whoisRecords + href: ../../api/security-threatintelligence-list-whoisrecords.md + - name: Get whoisRecord + href: ../../api/security-whoisrecord-get.md + - name: Complex types + items: + - name: Artifact + href: ../../resources/security-artifact.md + - name: Autonomous system + href: ../../resources/security-autonomoussystem.md + - name: CVSS summary + href: ../../resources/security-cvsssummary.md + - name: Formatted content + href: ../../resources/security-formattedcontent.md + - name: Host port banner + href: ../../resources/security-hostportbanner.md + - name: Host port component + href: ../../resources/security-hostportcomponent.md + - name: Host reputation rule + href: ../../resources/security-hostreputationrule.md + - name: Host SSL certificate port + href: ../../resources/security-hostsslcertificateport.md + - name: Hyperlink + href: ../../resources/security-hyperlink.md + - name: Indicator + href: ../../resources/security-indicator.md + - name: Intelligence profile country or region of origin + href: ../../resources/security-intelligenceprofilecountryorregionoforigin.md + - name: Physical address + href: ../../resources/physicaladdress.md + - name: SSL certificate entity + href: ../../resources/security-sslcertificateentity.md + - name: Unclassified artifact + href: ../../resources/security-unclassifiedartifact.md + - name: WHOIS base record + href: ../../resources/security-whoisbaserecord.md + - name: WHOIS contact + href: ../../resources/security-whoiscontact.md + - name: WHOIS nameserver + href: ../../resources/security-whoisnameserver.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/sites-and-lists/toc.yml | +items: +- name: Overview + href: ../../resources/sharepoint.md +- name: Site + items: + - name: Site + href: ../../resources/site.md + - name: Get root site + href: ../../api/site-get.md + - name: Get site + href: ../../api/site-get.md + - name: List sites across geographies + href: ../../api/site-getallsites.md + - name: Get site by path + href: ../../api/site-getbypath.md + - name: Get site for a group + href: ../../api/site-get.md + - name: Get analytics + href: ../../api/itemanalytics-get.md + - name: Get activities by interval + href: ../../api/itemactivitystat-getactivitybyinterval.md + - name: Get delta + href: ../../api/site-delta.md + - name: Search for sites + href: ../../api/site-search.md + - name: Follow site + href: ../../api/site-follow.md + - name: Unfollow site + href: ../../api/site-unfollow.md + - name: List followed sites + href: ../../api/sites-list-followed.md + - name: Get permission + href: ../../api/site-get-permission.md + - name: List permissions + href: ../../api/site-list-permissions.md + - name: Create permissions + href: ../../api/site-post-permissions.md + - name: Delete permission + href: ../../api/site-delete-permission.md + - name: Update permission + href: ../../api/site-update-permission.md + - name: List operations + href: ../../api/site-list-operations.md + - name: List pages + href: ../../api/baseSitePage-list.md +- name: List + items: + - name: List + href: ../../resources/list.md + - name: Get list + href: ../../api/list-get.md + - name: Create list + href: ../../api/list-create.md + - name: Enumerate list items + href: ../../api/listitem-list.md + - name: Update list item + href: ../../api/listitem-update.md + - name: Delete list item + href: ../../api/listitem-delete.md + - name: Create list item + href: ../../api/listitem-create.md + - name: Get websocket endpoint + href: ../../api/subscriptions-socketio.md + - name: List operations + href: ../../api/list-list-operations.md +- name: Column definition + items: + - name: Column definition + href: ../../resources/columndefinition.md + - name: List columns in a site + href: ../../api/site-list-columns.md + - name: List columns in a list + href: ../../api/list-list-columns.md + - name: List columns in a content type + href: ../../api/contenttype-list-columns.md + - name: Create columnDefinition for a site + href: ../../api/site-post-columns.md + - name: Create columnDefinition for a list + href: ../../api/list-post-columns.md + - name: Create columnDefinition for a content type + href: ../../api/contenttype-post-columns.md + - name: Get columnDefinition + href: ../../api/columndefinition-get.md + - name: Update columnDefinition + href: ../../api/columndefinition-update.md + - name: Delete columnDefinition + href: ../../api/columndefinition-delete.md +- name: Content type + items: + - name: Content type + href: ../../resources/contenttype.md + - name: List contentTypes in a site + href: ../../api/site-list-contenttypes.md + - name: List contentTypes in a list + href: ../../api/list-list-contenttypes.md + - name: Create contentType for a site + href: ../../api/site-post-contenttypes.md + - name: Get contentType + href: ../../api/contenttype-get.md + - name: Update contentType + href: ../../api/contenttype-update.md + - name: Delete contentType + href: ../../api/contenttype-delete.md + - name: isPublished + href: ../../api/contenttype-ispublished.md + - name: publish + href: ../../api/contenttype-publish.md + - name: unpublish + href: ../../api/contenttype-unpublish.md + - name: addCopy + href: ../../api/contenttype-addcopy.md + - name: associateWithHubSites + href: ../../api/contenttype-associatewithhubsites.md + - name: copyToDefaultContentLocation + href: ../../api/contenttype-copytodefaultcontentlocation.md + - name: List columns + href: ../../api/contenttype-list-columns.md + - name: Create column + href: ../../api/contenttype-post-columns.md + - name: getCompatibleHubContentTypes + href: ../../api/contenttype-getcompatiblehubcontenttypes.md + - name: addCopyFromContentTypeHub + href: ../../api/contenttype-addcopyfromcontenttypehub.md +- name: List item + items: + - name: List item + href: ../../resources/listitem.md + - name: Get + href: ../../api/listitem-get.md + - name: Get column values + href: ../../api/listitem-get.md + - name: Get analytics + href: ../../api/itemanalytics-get.md + - name: Get activities by interval + href: ../../api/itemactivitystat-getactivitybyinterval.md + - name: Create + href: ../../api/listitem-create.md + - name: Delete + href: ../../api/listitem-delete.md + - name: Update + href: ../../api/listitem-update.md + - name: Update column values + href: ../../api/listitem-update.md + - name: List documentSetVersions + href: ../../api/listitem-list-documentsetversions.md + - name: Create documentSetVersion + href: ../../api/listitem-post-documentsetversions.md + - name: Restore documentSetVersion + href: ../../api/documentsetversion-restore.md + - name: Get delta + href: ../../api/listitem-delta.md +- name: Document set version + items: + - name: Document set version + href: ../../resources/documentsetversion.md + - name: List documentSetVersions + href: ../../api/listitem-list-documentsetversions.md + - name: Create documentSetVersion + href: ../../api/listitem-post-documentsetversions.md + - name: Get documentSetVersion + href: ../../api/documentsetversion-get.md + - name: Delete documentSetVersion + href: ../../api/documentsetversion-delete.md + - name: restore + href: ../../api/documentsetversion-restore.md +- name: Rich long running operation + items: + - name: Rich long running operation + href: ../../resources/richlongrunningoperation.md + - name: Get richLongRunningOperation + href: ../../api/richlongrunningoperation-get.md +- name: Sharepoint settings + items: + - name: Sharepoint settings + href: ../../resources/sharepointsettings.md + - name: Get settings + href: ../../api/sharepointsettings-get.md + - name: Update settings + href: ../../api/sharepointsettings-update.md +- name: Taxonomy + items: + - name: Store + items: + - name: Store + href: ../../resources/termstore-store.md + - name: List groups + href: ../../api/termstore-list-groups.md + - name: Get store + href: ../../api/termstore-store-get.md + - name: Update store + href: ../../api/termstore-store-update.md + - name: Group + items: + - name: Group + href: ../../resources/termstore-group.md + - name: Create group + href: ../../api/termstore-group-post.md + - name: Get group + href: ../../api/termstore-group-get.md + - name: Delete group + href: ../../api/termstore-group-delete.md + - name: Set + items: + - name: Set + href: ../../resources/termstore-set.md + - name: List sets + href: ../../api/termstore-group-list-sets.md + - name: Create set + href: ../../api/termstore-set-post.md + - name: Create term + href: ../../api/termstore-term-post.md + - name: Get set + href: ../../api/termstore-set-get.md + - name: Get term + href: ../../api/termstore-term-get.md + - name: Update set + href: ../../api/termstore-set-update.md + - name: Delete set + href: ../../api/termstore-set-delete.md + - name: Term + items: + - name: Term + href: ../../resources/termstore-term.md + - name: List children + href: ../../api/termstore-term-list-children.md + - name: List relations + href: ../../api/termstore-term-list-relations.md + - name: Create relation + href: ../../api/termstore-relation-post.md + - name: Create term + href: ../../api/termstore-term-post.md + - name: Get term + href: ../../api/termstore-term-get.md + - name: Update term + href: ../../api/termstore-term-update.md + - name: Delete term + href: ../../api/termstore-term-delete.md + - name: Relation + items: + - name: Relation + href: ../../resources/termstore-relation.md + - name: List relations + href: ../../api/termstore-term-list-relations.md + - name: Create relation + href: ../../api/termstore-relation-post.md |
v1.0 | Static Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/static-toc.yml | +items: +- name: Overview of Microsoft Graph + href: /graph/overview?context=graph/api/1.0 +- name: What's new + href: /graph/whats-new-overview?context=graph/api/1.0 +- name: API changelog + href: https://developer.microsoft.com/en-us/graph/changelog + displayName: API changes, API updates, Microsoft Graph API, REST API, REST API updates +- name: Quick start + href: https://developer.microsoft.com/en-us/graph/quick-start +- name: Authentication and authorization + href: /graph/auth/index?context=graph/api/1.0 +- name: Permissions reference + href: /graph/permissions-reference +- name: Use the API + href: /graph/use-the-api?context=graph/api/1.0 +- name: Use SDKs + href: /graph/sdks/sdks-overview?context=graph/api/1.0 +- name: Use the toolkit + href: /graph/toolkit/overview?context=graph/api/1.0 +- name: Known issues + href: https://developer.microsoft.com/graph/known-issues +- name: Errors + href: /graph/errors?context=graph/api/1.0 +- name: API v1.0 reference + expanded: true + items: + - name: Overview + href: overview.md + displayName: Microsoft Graph REST API v1.0 reference + - name: Users + href: toc/users/toc.yml + - name: Groups + href: toc/groups/toc.yml |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/tasks-and-plans/toc.yml | +items: +- name: Overview + href: ../../resources/planner-overview.md +- name: Planner assigned to task board task format + items: + - name: Planner assigned to task board task format + href: ../../resources/plannerassignedtotaskboardtaskformat.md + - name: Get plannerAssignedToTaskBoardTaskFormat + href: ../../api/plannerassignedtotaskboardtaskformat-get.md + - name: Update + href: ../../api/plannerassignedtotaskboardtaskformat-update.md +- name: Planner bucket + items: + - name: Planner bucket + href: ../../resources/plannerbucket.md + - name: Get plannerBucket + href: ../../api/plannerbucket-get.md + - name: List plannerTasks + href: ../../api/plannerbucket-list-tasks.md + - name: Create + href: ../../api/planner-post-buckets.md + - name: Update + href: ../../api/plannerbucket-update.md + - name: Delete + href: ../../api/plannerbucket-delete.md +- name: Planner bucket task board task format + items: + - name: Planner bucket task board task format + href: ../../resources/plannerbuckettaskboardtaskformat.md + - name: Get plannerBucketTaskBoardTaskFormat + href: ../../api/plannerbuckettaskboardtaskformat-get.md + - name: Update + href: ../../api/plannerbuckettaskboardtaskformat-update.md +- name: Planner plan + items: + - name: Planner plan + href: ../../resources/plannerplan.md + - name: Get plannerPlan + href: ../../api/plannerplan-get.md + - name: List buckets + href: ../../api/plannerplan-list-buckets.md + - name: List tasks + href: ../../api/plannerplan-list-tasks.md + - name: Update + href: ../../api/plannerplan-update.md + - name: Delete + href: ../../api/plannerplan-delete.md +- name: Planner plan details + items: + - name: Planner plan details + href: ../../resources/plannerplandetails.md + - name: Get plannerPlanDetails + href: ../../api/plannerplandetails-get.md + - name: Update + href: ../../api/plannerplandetails-update.md +- name: Planner progress task board task format + items: + - name: Planner progress task board task format + href: ../../resources/plannerprogresstaskboardtaskformat.md + - name: Get plannerProgressTaskBoardTaskFormat + href: ../../api/plannerprogresstaskboardtaskformat-get.md + - name: Update + href: ../../api/plannerprogresstaskboardtaskformat-update.md +- name: Planner task + items: + - name: Planner task + href: ../../resources/plannertask.md + - name: Get plannerTask + href: ../../api/plannertask-get.md + - name: Update + href: ../../api/plannertask-update.md + - name: Delete + href: ../../api/plannertask-delete.md +- name: Planner task details + items: + - name: Planner task details + href: ../../resources/plannertaskdetails.md + - name: Get plannerTaskDetails + href: ../../api/plannertaskdetails-get.md + - name: Update + href: ../../api/plannertaskdetails-update.md +- name: Complex types + items: + - name: Identity + href: ../../resources/identity.md + - name: Identity set + href: ../../resources/identityset.md + - name: Planner applied categories + href: ../../resources/plannerappliedcategories.md + - name: Planner assignment + href: ../../resources/plannerassignment.md + - name: Planner assignments + href: ../../resources/plannerassignments.md + - name: Planner category descriptions + href: ../../resources/plannercategorydescriptions.md + - name: Planner checklist item + href: ../../resources/plannerchecklistitem.md + - name: Planner checklist items + href: ../../resources/plannerchecklistitems.md + - name: Planner external reference + href: ../../resources/plannerexternalreference.md + - name: Planner external references + href: ../../resources/plannerexternalreferences.md + - name: Planner order hints by assignee + href: ../../resources/plannerorderhintsbyassignee.md + - name: Planner plan container + href: ../../resources/plannerplancontainer.md + - name: Planner user ids + href: ../../resources/planneruserids.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/teamwork-and-communications/toc.yml | +items: +- name: Overview + href: ../../resources/teams-api-overview.md +- name: Apps + items: + - name: Teams app + items: + - name: Teams app + href: ../../resources/teamsapp.md + - name: List apps in catalog + href: ../../api/appcatalogs-list-teamsapps.md + - name: Upload app to catalog + href: ../../api/teamsapp-publish.md + - name: Update app in catalog + href: ../../api/teamsapp-update.md + - name: Delete app from catalog + href: ../../api/teamsapp-delete.md + - name: Get bot associated with app in catalog + href: ../../api/teamworkbot-get.md + - name: Teams app installation + items: + - name: Teams app installation + href: ../../resources/teamsappinstallation.md + - name: List apps installed in team + href: ../../api/team-list-installedapps.md + - name: Get app installed in team + href: ../../api/team-get-installedapps.md + - name: Add app to team + href: ../../api/team-post-installedapps.md + - name: Upgrade app installed in team + href: ../../api/team-teamsappinstallation-upgrade.md + - name: Remove app from team + href: ../../api/team-delete-installedapps.md + - name: List apps installed for user + href: ../../api/userteamwork-list-installedapps.md + - name: Get app installed for user + href: ../../api/userteamwork-get-installedapps.md + - name: Add app for user + href: ../../api/userteamwork-post-installedapps.md + - name: Upgrade app installed for user + href: ../../api/userteamwork-teamsappinstallation-upgrade.md + - name: Remove app for user + href: ../../api/userteamwork-delete-installedapps.md + - name: Teams app settings + items: + - name: Teams app settings + href: ../../resources/teamsappsettings.md + - name: Get teamsAppSettings + href: ../../api/teamsappsettings-get.md + - name: Update teamsAppSettings + href: ../../api/teamsappsettings-update.md + - name: Teams tab + items: + - name: Teams tab + href: ../../resources/teamstab.md + - name: List tabs + href: ../../api/channel-list-tabs.md + - name: Get tab + href: ../../api/channel-get-tabs.md + - name: Add tab + href: ../../api/channel-post-tabs.md + - name: Update tab + href: ../../api/channel-patch-tabs.md + - name: Remove tab + href: ../../api/channel-delete-tabs.md + - name: Resource specific permission grant + items: + - name: Resource specific permission grant + href: ../../resources/resourcespecificpermissiongrant.md + - name: List permission grants of a chat + href: ../../api/chat-list-permissiongrants.md + - name: List permission grants of a group + href: ../../api/group-list-permissiongrants.md + - name: List permission grants of a team + href: ../../api/team-list-permissiongrants.md +- name: Calls and online meetings + items: + - name: Overview + href: ../../resources/communications-api-overview.md + - name: Call records + items: + - name: Overview + href: ../../resources/callrecords-api-overview.md + - name: Call record + items: + - name: Call record + href: ../../resources/callrecords-callrecord.md + - name: Get callRecord + href: ../../api/callrecords-callrecord-get.md + - name: getPstnCalls + href: ../../api/callrecords-callrecord-getpstncalls.md + - name: getDirectRoutingCalls + href: ../../api/callrecords-callrecord-getdirectroutingcalls.md + - name: Direct routing log row + items: + - name: Direct routing log row + href: ../../resources/callrecords-directroutinglogrow.md + - name: getDirectRoutingCalls + href: ../../api/callrecords-callrecord-getdirectroutingcalls.md + - name: PSTN call log row + items: + - name: PSTN call log row + href: ../../resources/callrecords-pstncalllogrow.md + - name: getPstnCalls + href: ../../api/callrecords-callrecord-getpstncalls.md + - name: Session + items: + - name: Session + href: ../../resources/callrecords-session.md + - name: List sessions + href: ../../api/callrecords-callrecord-list-sessions.md + - name: Calls + items: + - name: Call + items: + - name: Call + href: ../../resources/call.md + - name: Get + href: ../../api/call-get.md + - name: Delete + href: ../../api/call-delete.md + - name: KeepAlive + href: ../../api/call-keepalive.md + - name: Call handling + items: + - name: Answer + href: ../../api/call-answer.md + - name: Reject + href: ../../api/call-reject.md + - name: Redirect + href: ../../api/call-redirect.md + - name: Transfer + href: ../../api/call-transfer.md + - name: Group calls + items: + - name: List participants + href: ../../api/call-list-participants.md + - name: Invite participants + href: ../../api/participant-invite.md + - name: Mute participant + href: ../../api/participant-mute.md + - name: Create audioRoutingGroup + href: ../../api/call-post-audioroutinggroups.md + - name: List audioRoutingGroups + href: ../../api/call-list-audioroutinggroups.md + - name: Add large gallery view + href: ../../api/call-addlargegalleryview.md + - name: Interactive-voice-response + items: + - name: PlayPrompt + href: ../../api/call-playprompt.md + - name: RecordResponse + href: ../../api/call-record.md + - name: CancelMediaProcessing + href: ../../api/call-cancelMediaProcessing.md + - name: SubscribeToTone + href: ../../api/call-subscribetotone.md + - name: SendDtmfTones + href: ../../api/call-senddtmftones.md + - name: Self participant operations + items: + - name: Mute + href: ../../api/call-mute.md + - name: Unmute + href: ../../api/call-unmute.md + - name: ChangeScreenSharingRole + href: ../../api/call-changescreensharingrole.md + - name: Recording Operations + items: + - name: UpdateRecordingStatus + href: ../../api/call-updaterecordingstatus.md + - name: Logging operations + items: + - name: Log device quality data + href: ../../api/call-logteleconferencedevicequality.md + - name: Audio routing group + items: + - name: Audio routing group + href: ../../resources/audioroutinggroup.md + - name: Create + href: ../../api/audioroutinggroup-get.md + - name: Get + href: ../../api/audioroutinggroup-get.md + - name: Update + href: ../../api/audioroutinggroup-update.md + - name: Delete + href: ../../api/audioroutinggroup-delete.md + - name: Content sharing session + items: + - name: Content sharing session + href: ../../resources/contentsharingsession.md + - name: Get contentSharingSession + href: ../../api/contentsharingsession-get.md + - name: List contentSharingSessions + href: ../../api/call-list-contentsharingsessions.md + - name: Participant + items: + - name: Participant + href: ../../resources/participant.md + - name: List participant + href: ../../api/participant-get.md + - name: Get participant + href: ../../api/participant-get.md + - name: Delete participant + href: ../../api/participant-delete.md + - name: Invite + href: ../../api/participant-invite.md + - name: Mute participant + href: ../../api/participant-mute.md + - name: Start hold music + href: ../../api/participant-startholdmusic.md + - name: Stop hold music + href: ../../api/participant-stopholdmusic.md + - name: Add large gallery view operation + items: + - name: Add large gallery view operation + href: ../../resources/addlargegalleryviewoperation.md + - name: Get addLargeGalleryViewOperation + href: ../../api/addlargegalleryviewoperation-get.md + - name: Online meetings + items: + - name: Meeting attendance report + items: + - name: Meeting attendance report + href: ../../resources/meetingattendancereport.md + - name: List meetingAttendanceReports + href: ../../api/meetingattendancereport-list.md + - name: Get meetingAttendanceReport + href: ../../api/meetingattendancereport-get.md + - name: Attendance record + items: + - name: Attendance record + href: ../../resources/attendancerecord.md + - name: List attendanceRecords + href: ../../api/attendancerecord-list.md + - name: Online meeting + items: + - name: Online meeting + href: ../../resources/onlinemeeting.md + - name: Create onlineMeeting + href: ../../api/application-post-onlineMeetings.md + - name: Get onlineMeeting + href: ../../api/onlinemeeting-get.md + - name: Update + href: ../../api/onlinemeeting-update.md + - name: Delete onlineMeeting + href: ../../api/onlinemeeting-delete.md + - name: Create or get onlineMeeting + href: ../../api/onlinemeeting-createorget.md + - name: List transcripts of an onlineMeeting + href: ../../api/onlinemeeting-list-transcripts.md + - name: List recordings of an onlineMeeting + href: ../../api/onlinemeeting-list-recordings.md + - name: Call recording + items: + - name: Call recording + href: ../../resources/callrecording.md + - name: List callRecordings + href: ../../api/onlinemeeting-list-recordings.md + - name: Get callRecording + href: ../../api/callrecording-get.md + - name: Call transcript + items: + - name: Call transcript + href: ../../resources/calltranscript.md + - name: List callTranscripts + href: ../../api/onlinemeeting-list-transcripts.md + - name: Get callTranscript + href: ../../api/calltranscript-get.md + - name: Virtual appointment + items: + - name: Get virtual appointment join link + href: ../../api/virtualappointment-getvirtualappointmentjoinweburl.md + - name: Send virtual appointment reminder SMS + href: ../../api/virtualappointment-sendvirtualappointmentremindersms.md + - name: Send virtual appointment SMS + href: ../../api/virtualappointment-sendvirtualappointmentsms.md + - name: Presence + items: + - name: Presence + href: ../../resources/presence.md + - name: Get presence + href: ../../api/presence-get.md + - name: Get presence of multiple users + href: ../../api/cloudcommunications-getpresencesbyuserid.md + - name: Set presence + href: ../../api/presence-setpresence.md + - name: Clear presence + href: ../../api/presence-clearpresence.md + - name: Set user preferred presence + href: ../../api/presence-setuserpreferredpresence.md + - name: Clear user preferred presence + href: ../../api/presence-clearuserpreferredpresence.md + - name: Set user status message + href: ../../api/presence-setstatusmessage.md + - name: Virtual events + items: + - name: Virtual event webinar + items: + - name: Virtual event webinar + href: ../../resources/virtualeventwebinar.md + - name: List webinars + href: ../../api/virtualeventsroot-list-webinars.md + - name: Get virtualEventWebinar + href: ../../api/virtualeventwebinar-get.md + - name: List by user role + href: ../../api/virtualeventwebinar-getbyuserrole.md + - name: List by user ID and role + href: ../../api/virtualeventwebinar-getbyuseridandrole.md + - name: Virtual event registration + items: + - name: Virtual event registration + href: ../../resources/virtualeventregistration.md + - name: List virtualEventRegistrations + href: ../../api/virtualeventwebinar-list-registrations.md + - name: Get virtualEventRegistration + href: ../../api/virtualeventregistration-get.md + - name: Virtual event session + items: + - name: Virtual event session + href: ../../resources/virtualeventsession.md + - name: List virtualEventSessions + href: ../../api/virtualevent-list-sessions.md + - name: Get virtualEventSession + href: ../../api/virtualeventsession-get.md +- name: Employee learning + displayName: Viva Learning + items: + - name: Overview + href: ../../resources/viva-learning-api-overview.md + - name: Learning content + items: + - name: Learning content + href: ../../resources/learningcontent.md + - name: List learningContents + href: ../../api/learningprovider-list-learningcontents.md + - name: Get learningContent + href: ../../api/learningcontent-get.md + - name: Update learningContent + href: ../../api/learningcontent-update.md + - name: Delete learningContent + href: ../../api/learningprovider-delete-learningcontents.md + - name: Learning course activity + items: + - name: Learning course activity + href: ../../resources/learningcourseactivity.md + - name: List learningCourseActivities + href: ../../api/learningcourseactivity-list.md + - name: Create learningCourseActivity + href: ../../api/employeeexperienceuser-post-learningcourseactivities.md + - name: Get learningCourseActivity + href: ../../api/learningcourseactivity-get.md + - name: Update learningCourseActivity + href: ../../api/learningcourseactivity-update.md + - name: Delete learningCourseActivity + href: ../../api/learningcourseactivity-delete.md + - name: Learning provider + items: + - name: Learning provider + href: ../../resources/learningprovider.md + - name: List learningProviders + href: ../../api/employeeexperience-list-learningproviders.md + - name: Create learningProvider + href: ../../api/employeeexperience-post-learningproviders.md + - name: Get learningProvider + href: ../../api/learningprovider-get.md + - name: Update learningProvider + href: ../../api/learningprovider-update.md + - name: Delete learningProvider + href: ../../api/employeeexperience-delete-learningproviders.md + - name: Complex types + items: + - name: Learning assignment + href: ../../resources/learningassignment.md + - name: Learning self initiated course + href: ../../resources/learningselfinitiatedcourse.md +- name: Messaging + items: + - name: Channel + items: + - name: Channel + href: ../../resources/channel.md + - name: List channels + href: ../../api/channel-list.md + - name: List incoming channels + href: ../../api/team-list-incomingchannels.md + - name: List all channels + href: ../../api/team-list-allchannels.md + - name: Create channel + href: ../../api/channel-post.md + - name: Get channel + href: ../../api/channel-get.md + - name: Get primary channel + href: ../../api/team-get-primarychannel.md + - name: Update channel + 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: Create channel message post + href: ../../api/channel-post-messages.md + - name: Create reply to channel message post + href: ../../api/chatmessage-post-replies.md + - name: Get files folder + href: ../../api/channel-get-filesfolder.md + - name: List tabs + href: ../../api/channel-list-tabs.md + - name: List channel members + href: ../../api/channel-list-members.md + - name: Add channel member + href: ../../api/channel-post-members.md + - name: Get channel member + href: ../../api/channel-get-members.md + - name: Update channel member's role + href: ../../api/channel-update-members.md + - name: Remove channel member + href: ../../api/channel-delete-members.md + - name: Complete migration + href: ../../api/channel-completemigration.md + - name: List tabs in channel + href: ../../api/channel-list-tabs.md + - name: Add tab to channel + href: ../../api/channel-post-tabs.md + - name: Get tab in channel + href: ../../api/channel-get-tabs.md + - name: Update tab in channel + href: ../../api/channel-patch-tabs.md + - name: Remove tab from channel + href: ../../api/channel-delete-tabs.md + - name: Provision channel email address + href: ../../api/channel-provisionemail.md + - name: Remove channel email address + href: ../../api/channel-removeemail.md + - name: Remove incoming channel + href: ../../api/team-delete-incomingchannels.md + - name: List teams sharing a channel + href: ../../api/sharedwithchannelteaminfo-list.md + - name: Get team sharing a channel + href: ../../api/sharedwithchannelteaminfo-get.md + - name: Unshare channel with team + href: ../../api/sharedwithchannelteaminfo-delete.md + - name: List allowed members + href: ../../api/sharedwithchannelteaminfo-list-allowedmembers.md + - name: Check user access + href: ../../api/channel-doesuserhaveaccess.md + - name: Chat + items: + - name: Chat + href: ../../resources/chat.md + - name: Chat management + items: + - name: Create chat + href: ../../api/chat-post.md + - name: Get chat + href: ../../api/chat-get.md + - name: Update chat + href: ../../api/chat-patch.md + - name: Delete chat + href: ../../api/chat-delete.md + - name: List chat members + href: ../../api/chat-list-members.md + - name: Add chat member + href: ../../api/chat-post-members.md + - name: Get chat member + href: ../../api/chat-get-members.md + - name: Remove chat member + href: ../../api/chat-delete-members.md + - name: Get chat between user and app + href: ../../api/userscopeteamsappinstallation-get-chat.md + - name: Messages + items: + - name: List messages in chat + href: ../../api/chat-list-messages.md + - name: Get message in chat + href: ../../api/chatmessage-get.md + - name: Get messages across all chats for user + href: ../../api/chats-getallmessages.md + - name: Apps + items: + - name: List apps in chat + href: ../../api/chat-list-installedapps.md + - name: Get app in chat + href: ../../api/chat-get-installedapps.md + - name: Add app in chat + href: ../../api/chat-post-installedapps.md + - name: Upgrade app in chat + href: ../../api/chat-teamsappinstallation-upgrade.md + - name: Uninstall app from chat + href: ../../api/chat-delete-installedapps.md + - name: List permission grants + href: ../../api/chat-list-permissiongrants.md + - name: Tabs + items: + - name: List tabs in chat + href: ../../api/chat-list-tabs.md + - name: Get tab in chat + href: ../../api/chat-get-tabs.md + - name: Add tab to chat + href: ../../api/chat-post-tabs.md + - name: Update tab in chat + href: ../../api/chat-patch-tabs.md + - name: Remove tab from chat + href: ../../api/chat-delete-tabs.md + - name: Pinned messages + items: + - name: List pinned messages + href: ../../api/chat-list-pinnedmessages.md + - name: Pin a message + href: ../../api/chat-post-pinnedmessages.md + - name: Unpin a message + href: ../../api/chat-delete-pinnedmessages.md + - name: Chat message + items: + - name: Chat message + href: ../../resources/chatmessage.md + - name: Channel messages + 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 + href: ../../api/chatmessage-get.md + - name: Send message in channel + href: ../../api/chatmessage-post.md + - name: Update message in channel + href: ../../api/chatmessage-update.md + - name: Delete message in channel + href: ../../api/chatmessage-softdelete.md + - name: Undo the deletion of a message in channel + href: ../../api/chatmessage-undoSoftdelete.md + - name: Set reaction to a message in channel + href: ../../api/chatmessage-setreaction.md + - name: Unset reaction to a message in channel + href: ../../api/chatmessage-unsetreaction.md + - name: Channel message replies + items: + - name: List replies to message + href: ../../api/chatmessage-list-replies.md + - name: Get reply message in channel + href: ../../api/chatmessage-get.md + - name: Reply to a message in channel + href: ../../api/chatmessage-post-replies.md + - name: Update reply message + href: ../../api/chatmessage-update.md + - name: Delete reply message in channel + href: ../../api/chatmessage-softdelete.md + - name: Undo deletion of a reply message in channel + href: ../../api/chatmessage-undoSoftdelete.md + - name: Set reaction to a message in channel + href: ../../api/chatmessage-setreaction.md + - name: Unset reaction to a message in channel + href: ../../api/chatmessage-unsetreaction.md + - name: Chat messages + items: + - name: List messages in chat + href: ../../api/chat-list-messages.md + - name: Get message in chat + href: ../../api/chatmessage-get.md + - name: Get messages across all chats for user + href: ../../api/chats-getallmessages.md + - name: Get all channel messages + href: ../../api/channel-getallmessages.md + - name: Create subscription for new chat messages + href: ../../api/subscription-post-subscriptions.md + - name: Send message in chat + href: ../../api/chat-post-messages.md + - name: Update message in chat + href: ../../api/chatmessage-update.md + - name: Delete message in chat + href: ../../api/chatmessage-softdelete.md + - name: Undo the deletion of a message in chat + href: ../../api/chatmessage-undoSoftdelete.md + - name: Set reaction to a message in channel + href: ../../api/chatmessage-setreaction.md + - name: Unset reaction to a message in channel + href: ../../api/chatmessage-unsetreaction.md + - name: Hosted content + items: + - name: List all hosted content + href: ../../api/chatmessage-list-hostedcontents.md + - name: Get hosted content + href: ../../api/chatmessagehostedcontent-get.md + - name: Pinned chat message info + items: + - name: Pinned chat message info + href: ../../resources/pinnedchatmessageinfo.md + - name: List pinned messages + href: ../../api/chat-list-pinnedmessages.md + - name: Pin message + href: ../../api/chat-post-pinnedmessages.md + - name: Unpin message + href: ../../api/chat-delete-pinnedmessages.md + - name: Deleted chat + items: + - name: Deleted chat + href: ../../resources/deletedchat.md + - name: Get deletedChat + href: ../../api/deletedchat-get.md + - name: undoDelete deletedChat + href: ../../api/deletedchat-undodelete.md + - name: Team + items: + - name: Team + href: ../../resources/team.md + - name: Create team + href: ../../api/team-post.md + - name: Create team from group + href: ../../api/team-put-teams.md + - name: Get team + href: ../../api/team-get.md + - name: Update team + href: ../../api/team-update.md + - name: Delete team + href: ../../api/group-delete.md + - name: List members + href: ../../api/team-list-members.md + - name: Add member + href: ../../api/team-post-members.md + - name: Add members in bulk + href: ../../api/conversationmembers-add.md + - name: Get member + href: ../../api/team-get-members.md + - name: Get primary channel + href: ../../api/team-get-primarychannel.md + - name: Update member's role + href: ../../api/team-update-members.md + - name: Remove member + href: ../../api/team-delete-members.md + - name: Archive team + href: ../../api/team-archive.md + - name: Unarchive team + href: ../../api/team-unarchive.md + - name: Clone team + href: ../../api/team-clone.md + - name: List your teams + href: ../../api/user-list-joinedteams.md + - name: List associated teams + href: ../../api/associatedteaminfo-list.md + - name: List all teams in an organization + href: ../../api/teams-list.md + - name: Complete migration + href: ../../api/team-completemigration.md + - name: List all channels + href: ../../api/team-list-allchannels.md + - name: List channels + href: ../../api/channel-list.md + - name: List incoming channels + href: ../../api/team-list-incomingchannels.md + - name: Remove incoming channel + href: ../../api/team-delete-incomingchannels.md + - name: List apps installed in team + href: ../../api/team-list-installedapps.md + - name: Add app to team + href: ../../api/team-post-installedapps.md + - name: Get app installed in team + href: ../../api/team-get-installedapps.md + - name: Upgrade app installed in team + href: ../../api/team-teamsappinstallation-upgrade.md + - name: Remove app from team + href: ../../api/team-delete-installedapps.md + - name: List permission grants + href: ../../api/team-list-permissiongrants.md + - name: Teamwork tag + items: + - name: Teamwork tag + href: ../../resources/teamworktag.md + - name: List teamworkTags + href: ../../api/teamworktag-list.md + - name: Create teamworkTag + href: ../../api/teamworktag-post.md + - name: Get teamworkTag + href: ../../api/teamworktag-get.md + - name: Update teamworkTag + href: ../../api/teamworktag-update.md + - name: Delete teamworkTag + href: ../../api/teamworktag-delete.md + - name: Teamwork tag member + items: + - name: Teamwork tag member + href: ../../resources/teamworktagmember.md + - name: List teamworkTagMembers + href: ../../api/teamworktagmember-list.md + - name: Create teamworkTagMember + href: ../../api/teamworktagmember-post.md + - name: Get teamworkTagMember + href: ../../api/teamworktagmember-get.md + - name: Delete teamworkTagMember + href: ../../api/teamworktagmember-delete.md + - name: Activity feed + items: + - name: Send notification to user in chat + href: ../../api/chat-sendactivitynotification.md + - name: Send notification to user in team + href: ../../api/team-sendactivitynotification.md + - name: Send notification to user + href: ../../api/userteamwork-sendactivitynotification.md + - name: Send notification to multiple users in bulk + href: ../../api/teamwork-sendactivitynotificationtorecipients.md +- name: Settings + items: + - name: License details + items: + - name: License details + href: ../../resources/licensedetails.md + - name: List licenseDetails + href: ../../api/user-list-licensedetails.md + - name: getTeamsLicensingDetails + href: ../../api/licensedetails-getteamslicensingdetails.md + - name: Organization settings + items: + - name: Teamwork + items: + - name: Teamwork + href: ../../resources/teamwork.md + - name: List deletedTeams + href: ../../api/teamwork-list-deletedteams.md + - name: Get teamwork + href: ../../api/teamwork-get.md + - name: User settings + items: + - name: User teamwork + items: + - name: User teamwork + href: ../../resources/userteamwork.md + - name: Get userTeamwork + href: ../../api/userteamwork-get.md +- name: Shift management + items: + - name: Offer shift request + items: + - name: Offer shift request + href: ../../resources/offershiftrequest.md + - name: List + href: ../../api/offershiftrequest-list.md + - name: Create + href: ../../api/offershiftrequest-post.md + - name: Get + href: ../../api/offershiftrequest-get.md + - name: Approve + href: ../../api/offershiftrequest-approve.md + - name: Decline + href: ../../api/offershiftrequest-decline.md + - name: Open shift + items: + - name: Open shift + href: ../../resources/openshift.md + - name: List + href: ../../api/openshift-list.md + - name: Create + href: ../../api/openshift-post.md + - name: Get + href: ../../api/openshift-get.md + - name: Update + href: ../../api/openshift-update.md + - name: Delete + href: ../../api/openshift-delete.md + - name: Open shift change request + items: + - name: Open shift change request + href: ../../resources/openshiftchangerequest.md + - name: List + href: ../../api/openshiftchangerequest-list.md + - name: Create + href: ../../api/openshiftchangerequest-post.md + - name: Get + href: ../../api/openshiftchangerequest-get.md + - name: Approve + href: ../../api/openshiftchangerequest-approve.md + - name: Decline + href: ../../api/openshiftchangerequest-decline.md + - name: Schedule + items: + - name: Schedule + href: ../../resources/schedule.md + - name: Create or replace schedule + href: ../../api/team-put-schedule.md + - name: Get schedule + href: ../../api/schedule-get.md + - name: Share + href: ../../api/schedule-share.md + - name: Scheduling group + items: + - name: Scheduling group + href: ../../resources/schedulinggroup.md + - name: List + href: ../../api/schedule-list-schedulinggroups.md + - name: Create + href: ../../api/schedule-post-schedulinggroups.md + - name: Get + href: ../../api/schedulinggroup-get.md + - name: Delete + href: ../../api/schedulinggroup-delete.md + - name: Replace + href: ../../api/schedulinggroup-put.md + - name: Shift + items: + - name: Shift + href: ../../resources/shift.md + - name: List shifts + href: ../../api/schedule-list-shifts.md + - name: Create shift + href: ../../api/schedule-post-shifts.md + - name: Get shift + href: ../../api/shift-get.md + - name: Replace shift + href: ../../api/shift-put.md + - name: Delete shift + href: ../../api/shift-delete.md + - name: Shift preferences + items: + - name: Shift preferences + href: ../../resources/shiftpreferences.md + - name: Get + href: ../../api/shiftpreferences-get.md + - name: Update + href: ../../api/shiftpreferences-put.md + - name: Swap shifts change request + items: + - name: Swap shifts change request + href: ../../resources/swapshiftschangerequest.md + - name: List + href: ../../api/swapshiftschangerequest-list.md + - name: Create + href: ../../api/swapshiftschangerequest-post.md + - name: Get + href: ../../api/swapshiftschangerequest-get.md + - name: Approve + href: ../../api/swapshiftschangerequest-approve.md + - name: Decline + href: ../../api/swapshiftschangerequest-decline.md + - name: Time off + items: + - name: Time off + href: ../../resources/timeoff.md + - name: List + href: ../../api/schedule-list-timesoff.md + - name: Create + href: ../../api/schedule-post-timesoff.md + - name: Get + href: ../../api/timeoff-get.md + - name: Replace + href: ../../api/timeoff-put.md + - name: Delete + href: ../../api/timeoff-delete.md + - name: Time off reason + items: + - name: Time off reason + href: ../../resources/timeoffreason.md + - name: List + href: ../../api/schedule-list-timeoffreasons.md + - name: Create + href: ../../api/schedule-post-timeoffreasons.md + - name: Get + href: ../../api/timeoffreason-get.md + - name: Replace + href: ../../api/timeoffreason-put.md + - name: Delete + href: ../../api/timeoffreason-delete.md + - name: Time off request + items: + - name: Time off request + href: ../../resources/timeoffrequest.md + - name: Get + href: ../../api/timeoffrequest-get.md + - name: List + href: ../../api/timeoffrequest-list.md + - name: Delete + href: ../../api/timeoffrequest-delete.md + - name: Approve + href: ../../api/timeoffrequest-approve.md + - name: Decline + href: ../../api/timeoffrequest-decline.md + - name: Workforce integration + items: + - name: Workforce integration + href: ../../resources/workforceintegration.md + - name: Create + href: ../../api/workforceintegration-post.md + - name: List + href: ../../api/workforceintegration-list.md + - name: Get + href: ../../api/workforceintegration-get.md + - name: Update + href: ../../api/workforceintegration-update.md + - name: Delete + href: ../../api/workforceintegration-delete.md + - name: Complex types + items: + - name: Change tracked entity + href: ../../resources/changetrackedentity.md + - name: Identity + href: ../../resources/identity.md + - name: Identity set + href: ../../resources/identityset.md + - name: Open shift item + href: ../../resources/openshiftitem.md + - name: Patterned recurrence + href: ../../resources/patternedrecurrence.md + - name: Recurrence pattern + href: ../../resources/recurrencepattern.md + - name: Recurrence range + href: ../../resources/recurrencerange.md + - name: Shift activity + href: ../../resources/shiftactivity.md + - name: Shift availability + href: ../../resources/shiftavailability.md + - name: Shift item + href: ../../resources/shiftitem.md + - name: Time off item + href: ../../resources/timeoffitem.md + - name: Time range + href: ../../resources/timerange.md + - name: Workforce integration encryption + href: ../../resources/workforceintegrationencryption.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/to-do-tasks/toc.yml | +items: +- name: Overview + href: ../../resources/todo-overview.md +- name: To-do task list + items: + - name: To-do task list + href: ../../resources/todotasklist.md + - name: List lists + href: ../../api/todo-list-lists.md + - name: Create todoTaskList + href: ../../api/todo-post-lists.md + - name: Get task list + href: ../../api/todotasklist-get.md + - name: Update task list + href: ../../api/todotasklist-update.md + - name: Delete task list + href: ../../api/todotasklist-delete.md + - name: List tasks + href: ../../api/todotasklist-list-tasks.md + - name: Create task + href: ../../api/todotasklist-post-tasks.md +- name: To-do task + items: + - name: To-do task + href: ../../resources/todotask.md + - name: List tasks + href: ../../api/todotasklist-list-tasks.md + - name: Create task + href: ../../api/todotasklist-post-tasks.md + - name: Get task + href: ../../api/todotask-get.md + - name: Update task + href: ../../api/todotask-update.md + - name: Delete task + href: ../../api/todotask-delete.md + - name: List checklistItems + href: ../../api/todotask-list-checklistitems.md + - name: Create checklistItem + href: ../../api/todotask-post-checklistitems.md + - name: List linkedResources + href: ../../api/todotask-list-linkedresources.md + - name: Create linkedResources + href: ../../api/todotask-post-linkedresources.md +- name: Task file attachment + items: + - name: Task file attachment + href: ../../resources/taskfileattachment.md + - name: List attachments + href: ../../api/todotask-list-attachments.md + - name: Create attachment + href: ../../api/todotask-post-attachments.md + - name: Create upload session + href: ../../api/taskfileattachment-createuploadsession.md + - name: Get attachment + href: ../../api/taskfileattachment-get.md + - name: Delete attachment + href: ../../api/taskfileattachment-delete.md +- name: Checklist item + items: + - name: Checklist item + href: ../../resources/checklistitem.md + - name: List checklistItems + href: ../../api/todotask-list-checklistitems.md + - name: Create checklistItem + href: ../../api/todotask-post-checklistitems.md + - name: Get checklistItem + href: ../../api/checklistitem-get.md + - name: Update checklistItem + href: ../../api/checklistitem-update.md + - name: Delete checklistItem + href: ../../api/checklistitem-delete.md +- name: Linked resource + items: + - name: Linked resource + href: ../../resources/linkedresource.md + - name: List linkedResources + href: ../../api/todotask-list-linkedresources.md + - name: Create linkedResource + href: ../../api/todotask-post-linkedresources.md + - name: Get linkedResource + href: ../../api/linkedresource-get.md + - name: Update linkedResource + href: ../../api/linkedresource-update.md + - name: Delete linkedResource + href: ../../api/linkedresource-delete.md |
v1.0 | Toc.Mapping.Json | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/toc.mapping.json | +{ + "tocNodes": [ + { + "name": "Applications", + "overview": "../../resources/applications-api-overview.md", + "resources": [ + "application", + "servicePrincipal" + ], + "childNodes": [ + { + "name": "Application", + "shouldSort": true, + "resources": [ + "applicationTemplate", + "extensionProperty", + "federatedIdentityCredential" + ], + "childNodes": [ + { + "name": "Policies", + "resources": [ + "remoteDesktopSecurityConfiguration", + "tokenIssuancePolicy", + "tokenLifetimePolicy" + ] + } + ] + }, + { + "name": "Synchronization", + "overview": "../../resources/synchronization-overview.md", + "shouldSort": true, + "resources": [ + "synchronization", + "synchronizationTemplate", + "synchronizationJob", + "synchronizationSchema" + ], + "childNodes": [ + { + "name": "Synchronization job", + "resources": [ + "bulkUpload" + ] + } + ] + } + ] + }, + { + "name": "Calendars", + "keywords": [ + "Outlook", + "Outlook calendar" + ], + "resources": [ + "calendar", + "event", + "eventMessage", + "attachment", + "calendarGroup", + "calendarPermission", + "outlookCategory" + ], + "childNodes": [ + { + "name": "Extended properties", + "overview": "../../resources/extended-properties-overview.md", + "resources": [ + "singleValueLegacyExtendedProperty", + "multiValueLegacyExtendedProperty" + ] + }, + { + "name": "Places", + "resources": [ + "place", + "room", + "roomList" + ] + } + ] + }, + { + "name": "Change notifications", + "keywords": [ + "Webhooks", + "Outlook mail", + "Outlook calendar", + "Outlook contacts", + "Outlook contact", + "People", + "Microsoft Teams", + "Teams", + "OneDrive", + "OneDrive for Business", + "OneDrive business", + "OneDrive personal", + "SharePoint", + "Security", + "Users", + "Groups" + ], + "overview": "../../resources/change-notifications-api-overview.md", + "resources": [ + "subscription" + ] + }, + { + "name": "Compliance", + "overview": "../../resources/complianceapioverview.md", + "keywords": [ + "Compliance API", + "Microsoft Graph Compliance API" + ], + "resources": [ + "subjectRightsRequest" + ] + }, + { + "name": "Cross-device experiences", + "overview": "../../resources/project-rome-overview.md", + "keywords": [ + "Project Rome" + ], + "childNodes": [ + { + "name": "Activity feed", + "overview": "../../resources/activity-feed-api-overview.md", + "resources": [ + "userActivity", + "activityHistoryItem" + ] + }, + { + "name": "Roaming data", + "resources": [ + "cloudClipboardRoot", + "cloudClipboardItem" + ], + "childNodes": [ + { + "name": "Windows settings", + "overview": "../../resources/windows-setting-api-overview.md", + "resources": [ + "windowsSetting", + "windowsSettingInstance" + ] + } + ] + } + ] + }, + { + "name": "Customer booking", + "overview": "../../resources/booking-api-overview.md", + "keywords": [ + "Bookings", + "Microsoft Bookings" + ], + "resources": [ + "bookingAppointment", + "bookingBusiness", + "bookingCurrency", + "bookingCustomQuestion", + "bookingCustomer", + "bookingService", + "bookingStaffMember" + ], + "complexTypes": [ + "availabilityItem", + "bookingCustomerInformation", + "bookingCustomerInformationBase", + "bookingQuestionAnswer", + "bookingQuestionAssignment", + "bookingReminder", + "bookingSchedulingPolicy", + "bookingWorkHours", + "bookingWorkTimeSlot", + "dateTimeTimeZone", + "location", + "outlookGeoCoordinates", + "phone", + "physicalAddress", + "staffAvailabilityItem", + "timeSlot" + ] + }, + { + "name": "Device and app management", + "childNodes": [ + { + "name": "Browser management", + "overview": "../../resources/browser-edge-api-overview.md", + "keywords": [ + "Edge", + "Internet Explorer", + "IE mode", + "site list" + ], + "resources": [ + "browserSharedCookie", + "browserSite", + "browserSiteList" + ], + "complexTypes": [ + "browserSharedCookieHistory", + "browserSiteHistory", + "dateTimeTimeZone", + "identity", + "identitySet" + ] + }, + { + "name": "Cloud PC", + "overview": "../../resources/cloudpc-api-overview.md", + "resources": [ + "cloudPC", + "cloudPcAuditEvent", + "cloudPcOnPremisesConnection", + "cloudPcDeviceImage", + "cloudPcGalleryImage", + "cloudPcProvisioningPolicy", + "cloudPcUserSetting" + ] + }, + { + "name": "Cloud printing", + "keywords": [ + "Universal Print" + ], + "resources": [ + "print", + "printConnector", + "printDocument", + "printJob", + "printOperation", + "printService", + "printServiceEndpoint", + "printTaskDefinition", + "printTaskTrigger", + "printer", + "printerCreateOperation", + "printerShare" + ], + "complexTypes": [ + "appIdentity", + "archivedPrintJob", + "identity", + "integerRange", + "printCertificateSigningRequest", + "printDocumentUploadProperties", + "printJobConfiguration", + "printJobStatus", + "printMargin", + "printOperationStatus", + "printSettings", + "printTaskStatus", + "printerCapabilities", + "printerDefaults", + "printerLocation", + "printerShareViewpoint", + "printerStatus", + "uploadSession", + "userIdentity" + ], + "childNodes": [ + { + "name": "Reports", + "resources": [ + "printUsageByPrinter", + "printUsageByUser" + ], + "childNodes": [ + { + "name": "Archived print jobs", + "additionalLinks": [ + { + "name": "List a user's archived print jobs", + "href": "../../api/reports-getuserarchivedprintjobs.md" + }, + { + "name": "List a groups's archived print jobs", + "href": "../../api/reports-getgrouparchivedprintjobs.md" + }, + { + "name": "List a printer's archived print jobs", + "href": "../../api/reports-getprinterarchivedprintjobs.md" + } + ] + } + ] + } + ] + }, + { + "name": "Intune", + "file": "intune.toc.mapping.json" + }, + { + "name": "Microsoft 365 apps", + "keywords": [ + "Microsoft 365 applications" + ], + "resources": [ + "m365AppsInstallationOptions" + ], + "complexTypes": [ + "admin", + "adminMicrosoft365Apps", + "appsInstallationOptionsForMac", + "appsInstallationOptionsForWindows" + ] + }, + { + "name": "Service health and communications", + "overview": "../../resources/service-communications-api-overview.md", + "resources": [ + "serviceAnnouncement", + "serviceAnnouncementAttachment", + "serviceHealth", + "serviceHealthIssue", + "serviceUpdateMessage" + ], + "complexTypes": [ + "admin", + "itemBody", + "keyValuePair", + "serviceHealthIssuePost", + "serviceUpdateMessageViewpoint" + ] + } + ] + }, + { + "name": "Education", + "overview": "../../resources/education-overview.md", + "resources": [ + "educationSchool", + "educationClass", + "educationUser", + "educationAssignment", + "educationAssignmentDefaults", + "educationAssignmentResource", + "educationAssignmentSettings", + "educationCategory", + "educationFeedbackOutcome", + "educationFeedbackResourceOutcome", + "educationGradingCategory", + "educationModule", + "educationModuleResource", + "educationOutcome", + "educationPointsOutcome", + "educationRubric", + "educationRubricOutcome", + "educationSubmission", + "educationSubmissionResource" + ], + "complexTypes": [ + "educationAssignmentClassRecipient", + "educationAssignmentGrade", + "educationAssignmentGradeType", + "educationAssignmentIndividualRecipient", + "educationAssignmentPointsGrade", + "educationAssignmentPointsGradeType", + "educationAssignmentRecipient", + "educationChannelResource", + "educationExcelResource", + "educationExternalResource", + "educationFeedback", + "educationFileResource", + "educationLinkResource", + "educationLinkedAssignmentResource", + "educationMediaResource", + "educationPowerPointResource", + "educationResource", + "educationSubmissionIndividualRecipient", + "educationSubmissionRecipient", + "educationTeamsAppResource", + "educationWordResource", + "identity", + "identitySet", + "rubricCriterion", + "rubricLevel", + "rubricQuality", + "rubricQualityFeedbackModel", + "rubricQualitySelectedColumnModel" + ] + }, + { + "name": "Extensions", + "overview": "/graph/extensibility-overview?context=graph%2Fapi%2F1.0&preserve-view=true&tabs=http", + "keywords": [ + "Directory extensions", + "Schema extensions", + "Open extensions", + "On-premises extensions" + ], + "resources": [ + "extensionProperty", + "openTypeExtension", + "schemaExtension" + ] + }, + { + "name": "External data connections", + "overview": "../../resources/connectors-api-overview.md", + "resources": [ + "microsoft.graph.externalConnectors.externalConnection", + "microsoft.graph.externalConnectors.externalGroup", + "microsoft.graph.externalConnectors.identity", + "microsoft.graph.externalConnectors.externalItem", + "microsoft.graph.externalConnectors.schema", + "microsoft.graph.externalConnectors.connectionOperation" + ], + "complexTypes": [ + "Json", + "microsoft.graph.externalConnectors.acl", + "microsoft.graph.externalConnectors.activitySettings", + "microsoft.graph.externalConnectors.configuration", + "microsoft.graph.externalConnectors.displayTemplate", + "microsoft.graph.externalConnectors.externalActivity", + "microsoft.graph.externalConnectors.externalActivityResult", + "microsoft.graph.externalConnectors.externalItemContent", + "microsoft.graph.externalConnectors.itemIdResolver", + "microsoft.graph.externalConnectors.properties", + "microsoft.graph.externalConnectors.property", + "microsoft.graph.externalConnectors.propertyRule", + "publicError", + "publicErrorDetail", + "publicInnerError", + "microsoft.graph.externalConnectors.searchSettings", + "microsoft.graph.externalConnectors.urlMatchInfo", + "microsoft.graph.externalConnectors.urlToItemResolverBase" + ] + }, + { + "name": "Files", + "overview": "../../resources/onedrive.md", + "keywords": [ + "OneDrive", + "OneDrive for Business", + "OneDrive business", + "OneDrive personal", + "SharePoint" + ], + "resources": [ + "drive", + "driveItem", + "bundle", + "permission" + ] + }, + { + "name": "Identity and access", + "overview": "../../resources/azure-ad-overview.md", + "keywords": [ + "Azure AD", + "Microsoft identity platform", + "Identity and access" + ], + "childNodes": [ + { + "name": "Directory management", + "shouldSort": true, + "resources": [ + "administrativeUnit", + "contract", + "directory", + "device", + "directoryObject", + "directoryRole", + "directoryRoleTemplate", + "domain", + "groupSetting", + "groupSettingTemplate", + "onPremisesDirectorySynchronization", + "organization", + "orgContact", + "subscribedSku", + "tenantInformation", + "bitlockerRecoveryKey", + "deviceLocalCredentialInfo" + ], + "childNodes": [ + { + "name": "Custom security attributes", + "overview": "../../resources/custom-security-attributes-overview.md", + "resources": [ + "allowedValue", + "attributeSet", + "customSecurityAttributeDefinition" + ] + }, + { + "name": "Role management", + "resources": [ + "roleManagement", + "unifiedRoleDefinition", + "unifiedRoleAssignment" + ] + } + ] + }, + { + "name": "Governance", + "overview": "../../resources/identitygovernance-overview.md", + "keywords": [ + "Identity Governance", + "Access reviews", + "Entitlement Management", + "Terms of Use", + "Privileged Identity Management" + ], + "childNodes": [ + { + "name": "Access reviews", + "overview": "../../resources/accessreviewsv2-overview.md", + "resources": [ + "accessReviewHistoryDefinition", + "accessReviewHistoryInstance", + "accessReviewInstance", + "accessReviewInstanceDecisionItem", + "accessReviewScheduleDefinition", + "accessReviewStage" + ], + "complexTypes": [ + "accessReviewApplyAction", + "accessReviewHistoryScheduleSettings", + "accessReviewInactiveUsersQueryScope", + "accessReviewInstanceDecisionItemAccessPackageAssignmentPolicyResource", + "accessReviewInstanceDecisionItemAzureRoleResource", + "accessReviewInstanceDecisionItemResource", + "accessReviewInstanceDecisionItemServicePrincipalResource", + "accessReviewNotificationRecipientItem", + "accessReviewNotificationRecipientQueryScope", + "accessReviewNotificationRecipientScope", + "accessReviewQueryScope", + "accessReviewRecommendationInsightSetting", + "accessReviewReviewer", + "accessReviewReviewerScope", + "accessReviewScheduleSettings", + "accessReviewScope", + "accessReviewSet", + "accessReviewStageSettings", + "appConsentApprovalRoute", + "appConsentRequestScope", + "disableAndDeleteUserApplyAction", + "governanceInsight", + "groupPeerOutlierRecommendationInsightSettings", + "identity", + "identityGovernance", + "identitySet", + "patternedRecurrence", + "principalResourceMembershipsScope", + "recurrencePattern", + "recurrenceRange", + "removeAccessApplyAction", + "request", + "servicePrincipalIdentity", + "userIdentity", + "userLastSignInRecommendationInsightSetting", + "userSignInInsight" + ] + }, + { + "name": "Consent requests", + "overview": "../../resources/consentrequests-overview.md", + "resources": [ + "adminConsentRequestPolicy", + "appConsentRequest", + "userConsentRequest" + ] + }, + { + "name": "Entitlement management", + "overview": "../../resources/entitlementmanagement-overview.md", + "resources": [ + "accessPackage", + "accessPackageAssignment", + "accessPackageAssignmentPolicy", + "accessPackageAssignmentRequest", + "accessPackageAssignmentRequestWorkflowExtension", + "accessPackageAssignmentWorkflowExtension", + "accessPackageCatalog", + "accessPackageResource", + "accessPackageResourceEnvironment", + "accessPackageResourceRequest", + "accessPackageResourceRole", + "accessPackageResourceRoleScope", + "connectedOrganization", + "entitlementManagementSettings" + ], + "complexTypes": [ + "accessPackageAnswer", + "accessPackageAnswerChoice", + "accessPackageAnswerString", + "accessPackageApprovalStage", + "accessPackageAssignmentApprovalSettings", + "accessPackageAssignmentRequestCallbackData", + "accessPackageAssignmentRequestRequirements", + "accessPackageAssignmentRequestorSettings", + "accessPackageAssignmentReviewSettings", + "accessPackageAutomaticRequestSettings", + "accessPackageLocalizedText", + "accessPackageMultipleChoiceQuestion", + "accessPackageQuestion", + "accessPackageResourceAttribute", + "accessPackageResourceAttributeDestination", + "accessPackageResourceAttributeQuestion", + "accessPackageResourceAttributeSource", + "accessPackageResourceScope", + "accessPackageSubject", + "accessPackageTextInputQuestion", + "accessPackageUserDirectoryAttributeStore", + "attributeRuleMembers", + "azureActiveDirectoryTenant", + "azureAdPopTokenAuthentication", + "connectedOrganizationMembers", + "connectionInfo", + "crossCloudAzureActiveDirectoryTenant", + "customCalloutExtension", + "customExtensionAuthenticationConfiguration", + "customExtensionCallbackConfiguration", + "customExtensionCalloutInstance", + "customExtensionClientConfiguration", + "customExtensionData", + "customExtensionEndpointConfiguration", + "customExtensionStageSetting", + "domainIdentitySource", + "entitlementManagement", + "entitlementManagementSchedule", + "expirationPattern", + "externalDomainFederation", + "externalSponsors", + "groupMembers", + "identitySource", + "internalSponsors", + "logicAppTriggerEndpointConfiguration", + "patternedRecurrence", + "recurrencePattern", + "recurrenceRange", + "requestorManager", + "singleServicePrincipal", + "singleUser", + "socialIdentitySource", + "subjectSet", + "targetApplicationOwners", + "targetManager", + "targetUserSponsors" + ] + }, + { + "name": "Lifecycle workflows", + "overview": "../../resources/identitygovernance-lifecycleworkflows-overview.md", + "keywords": [ + "LCW", + "Identity Governance", + "Joiner", + "Mover", + "Leaver" + ], + "resources": [ + "microsoft.graph.identityGovernance.customTaskExtension", + "microsoft.graph.identityGovernance.lifecycleManagementSettings", + "microsoft.graph.identityGovernance.taskDefinition", + "microsoft.graph.identityGovernance.workflow", + "microsoft.graph.identityGovernance.workflowTemplate" + ], + "complexTypes": [ + "azureAdPopTokenAuthentication", + "customCalloutExtension", + "customExtensionAuthenticationConfiguration", + "customExtensionCallbackConfiguration", + "customExtensionCalloutRequest", + "customExtensionCalloutResponse", + "customExtensionClientConfiguration", + "customExtensionData", + "customExtensionEndpointConfiguration", + "microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration", + "microsoft.graph.identityGovernance.customTaskExtensionCallbackData", + "microsoft.graph.identityGovernance.customTaskExtensionCalloutData", + "emailSettings", + "identity", + "identityGovernance", + "keyValuePair", + "microsoft.graph.identityGovernance.lifecycleWorkflowsContainer", + "logicAppTriggerEndpointConfiguration", + "microsoft.graph.identityGovernance.onDemandExecutionOnly", + "microsoft.graph.identityGovernance.parameter", + "microsoft.graph.identityGovernance.ruleBasedSubjectSet", + "microsoft.graph.identityGovernance.runSummary", + "subjectSet", + "microsoft.graph.identityGovernance.taskReportSummary", + "microsoft.graph.identityGovernance.timeBasedAttributeTrigger", + "microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "microsoft.graph.identityGovernance.userSummary", + "microsoft.graph.identityGovernance.workflowBase", + "microsoft.graph.identityGovernance.workflowExecutionConditions", + "microsoft.graph.identityGovernance.workflowExecutionTrigger" + ], + "childNodes": [ + { + "name": "Workflow", + "resources": [ + "microsoft.graph.identityGovernance.task", + "microsoft.graph.identityGovernance.workflowVersion" + ], + "childNodes": [ + { + "name": "Reports", + "overview": "../../resources/identitygovernance-lifecycleworkflows-reporting-overview.md", + "keywords": [ + "Lifecycle Workflows reporting" + ], + "resources": [ + "microsoft.graph.identityGovernance.userProcessingResult", + "microsoft.graph.identityGovernance.taskReport", + "microsoft.graph.identityGovernance.run", + "microsoft.graph.identityGovernance.taskProcessingResult" + ] + } + ] + } + ] + }, + { + "name": "Privileged Identity Management", + "childNodes": [ + { + "name": "PIM for Microsoft Entra roles", + "overview": "../../resources/privilegedidentitymanagementv3-overview.md", + "keywords": [ + "Privileged Identity Management", + "PIM", + "Identity Governance" + ], + "resources": [ + "unifiedRoleAssignmentScheduleRequest", + "unifiedRoleAssignmentSchedule", + "unifiedRoleAssignmentScheduleInstance", + "unifiedRoleEligibilityScheduleRequest", + "unifiedRoleEligibilitySchedule", + "unifiedRoleEligibilityScheduleInstance", + "unifiedRoleManagementPolicy", + "unifiedRoleManagementPolicyRule", + "unifiedRoleManagementPolicyAssignment" + ] + }, + { + "name": "PIM for Groups", + "overview": "../../resources/privilegedidentitymanagement-for-groups-api-overview.md", + "resources": [ + "privilegedAccessGroupAssignmentScheduleRequest", + "privilegedAccessGroupAssignmentSchedule", + "privilegedAccessGroupAssignmentScheduleInstance", + "privilegedAccessGroupEligibilityScheduleRequest", + "privilegedAccessGroupEligibilitySchedule", + "privilegedAccessGroupEligibilityScheduleInstance", + "unifiedRoleManagementPolicy", + "unifiedRoleManagementPolicyAssignment", + "approval", + "approvalStage" + ] + } + ] + }, + { + "name": "Terms of use", + "resources": [ + "agreement", + "agreementAcceptance", + "agreementFile", + "agreementFileLocalization" + ], + "complexTypes": [ + "agreementFileData", + "termsExpiration" + ] + } + ] + }, + { + "name": "Identity and sign-in", + "shouldSort": true, + "resources": [ + "authenticationEventListener", + "customAuthenticationExtension", + "dataPolicyOperation", + "oAuth2PermissionGrant", + "organizationalBranding", + "organizationalBrandingLocalization", + "certificateBasedAuthConfiguration", + "invitation" + ], + "childNodes": [ + { + "name": "Authentication methods", + "overview": "../../resources/authenticationmethods-overview.md", + "resources": [ + "authenticationMethod", + "emailAuthenticationMethod", + "fido2AuthenticationMethod", + "microsoftAuthenticatorAuthenticationMethod", + "passwordAuthenticationMethod", + "phoneAuthenticationMethod", + "softwareOathAuthenticationMethod", + "temporaryAccessPassAuthenticationMethod", + "windowsHelloForBusinessAuthenticationMethod" + ] + }, + { + "name": "Authentication strengths", + "overview": "../../resources/authenticationstrengths-overview.md", + "resources": [ + "authenticationStrengthPolicy", + "authenticationCombinationConfiguration", + "authenticationMethodModeDetail" + ] + }, + { + "name": "Conditional access", + "resources": [ + "conditionalAccessPolicy", + "namedLocation", + "authenticationContextClassReference", + "conditionalAccessTemplate" + ], + "childNodes": [ + { + "name": "Named location", + "resources": [ + "countryNamedLocation", + "ipNamedLocation" + ] + } + ] + }, + { + "name": "Cross-tenant access", + "overview": "../../resources/crosstenantaccesspolicy-overview.md", + "resources": [ + "crossTenantAccessPolicy", + "crossTenantAccessPolicyConfigurationDefault", + "crossTenantAccessPolicyConfigurationPartner", + "crossTenantIdentitySyncPolicyPartner" + ] + }, + { + "name": "Custom authentication extension", + "resources": [ + "onTokenIssuanceStartCustomExtension" + ] + }, + { + "name": "Identity protection", + "overview": "../../resources/identityprotection-overview.md", + "resources": [ + "riskDetection", + "riskyUser", + "servicePrincipalRiskDetection", + "riskyServicePrincipal" + ] + }, + { + "name": "Identity provider", + "resources": [ + "identityProviderBase" + ], + "childNodes": [ + { + "name": "External identities", + "resources": [ + "builtInIdentityProvider", + "socialIdentityProvider", + "appleManagedIdentityProvider" + ] + }, + { + "name": "Domain-based external identities", + "resources": [ + "samlOrWsFedExternalDomainFederation" + ] + }, + { + "name": "Federation with Microsoft Entra ID", + "resources": [ + "internalDomainFederation" + ] + } + ] + }, + { + "name": "Identity provider (deprecated)", + "resources": [ + "identityProvider" + ] + }, + { + "name": "Multitenant organization", + "overview": "../../resources/multitenantorganization-overview.md", + "keywords": [ + "MTO" + ], + "resources": [ + "multiTenantOrganization", + "multiTenantOrganizationMember", + "multiTenantOrganizationJoinRequestRecord", + "multiTenantOrganizationPartnerConfigurationTemplate", + "multiTenantOrganizationIdentitySyncPolicyTemplate" + ] + }, + { + "name": "Policies", + "overview": "../../resources/policy-overview.md", + "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", + "resources": [ + "authenticationMethodsPolicy", + "emailAuthenticationMethodConfiguration", + "fido2AuthenticationMethodConfiguration", + "microsoftAuthenticatorAuthenticationMethodConfiguration", + "smsAuthenticationMethodConfiguration", + "temporaryAccessPassAuthenticationMethodConfiguration", + "softwareOathAuthenticationMethodConfiguration", + "voiceAuthenticationMethodConfiguration", + "x509CertificateAuthenticationMethodConfiguration" + ] + } + ] + }, + { + "name": "User flows", + "resources": [ + "b2xIdentityUserFlow", + "identityUserFlowAttribute", + "identityUserFlowAttributeAssignment", + "userFlowLanguageConfiguration", + "identityApiConnector" + ] + } + ] + }, + { + "name": "Granular delegated admin privileges", + "overview": "../../resources/delegatedadminrelationships-api-overview.md", + "keywords": [ + "GDAP", + "Partner Center", + "CSP", + "VAR" + ], + "resources": [ + "delegatedAdminAccessAssignment", + "delegatedAdminCustomer", + "delegatedAdminRelationship", + "delegatedAdminRelationshipOperation", + "delegatedAdminRelationshipRequest", + "delegatedAdminServiceManagementDetail" + ], + "complexTypes": [ + "delegatedAdminAccessContainer", + "delegatedAdminAccessDetails", + "delegatedAdminRelationshipCustomerParticipant", + "unifiedRole" + ] + } + ] + }, + { + "name": "Mail", + "overview": "../../resources/mail-api-overview.md", + "keywords": [ + "Outlook", + "Outlook mail" + ], + "resources": [ + "message", + "attachment", + "outlookCategory", + "mailFolder", + "mailSearchFolder", + "messageRule" + ], + "childNodes": [ + { + "name": "Focused Inbox", + "overview": "../../resources/manage-focused-inbox.md", + "resources": [ + "inferenceClassificationOverride" + ] + }, + { + "name": "Extended properties", + "overview": "../../resources/extended-properties-overview.md", + "resources": [ + "singleValueLegacyExtendedProperty", + "multiValueLegacyExtendedProperty" + ] + } + ] + }, + { + "name": "Notes", + "overview": "../../resources/onenote-api-overview.md", + "keywords": [ + "OneNote" + ], + "resources": [ + "notebook", + "onenote", + "onenoteOperation", + "onenotePage", + "onenoteResource", + "onenoteSection", + "recentNotebook", + "sectionGroup" + ], + "complexTypes": [ + "externalLink", + "identity", + "identitySet", + "notebookLinks", + "onenoteEntityBaseModel", + "onenoteEntityHierarchyModel", + "onenoteEntitySchemaObjectModel", + "onenoteOperationError", + "operation", + "pageLinks", + "recentNotebookLinks", + "sectionLinks" + ] + }, + { + "name": "People and workplace intelligence", + "overview": "../../resources/social-overview.md", + "resources": [ + "person", + "peopleAdminSettings" + ], + "childNodes": [ + { + "name": "Insights", + "resources": [ + "sharedInsight", + "trending", + "usedInsight" + ], + "complexTypes": [ + "insightIdentity", + "officeGraphInsights", + "resourceReference", + "resourceVisualization", + "sharingDetail", + "usageDetails" + ] + } + ] + }, + { + "name": "Personal contacts", + "keywords": [ + "Outlook", + "Outlook contacts", + "Outlook contact", + "People" + ], + "resources": [ + "contact", + "contactFolder", + "outlookCategory" + ], + "childNodes": [ + { + "name": "Extended properties", + "overview": "../../resources/extended-properties-overview.md", + "resources": [ + "singleValueLegacyExtendedProperty", + "multiValueLegacyExtendedProperty" + ] + } + ] + }, + { + "name": "Reports", + "childNodes": [ + { + "name": "Identity and access reports", + "childNodes": [ + { + "name": "Microsoft Entra activity reports", + "childNodes": [ + { + "name": "AD FS application activity", + "resources": [ + "relyingPartyDetailedSummary" + ] + }, + { + "name": "Registration and usage", + "overview": "../../resources/authenticationmethods-usage-insights-overview.md", + "resources": [ + "userRegistrationDetails", + "userRegistrationFeatureSummary", + "userRegistrationMethodSummary" + ] + } + ] + }, + { + "name": "Microsoft Entra audit logs", + "overview": "../../resources/azure-ad-auditlog-overview.md", + "resources": [ + "directoryAudit", + "signIn", + "provisioningObjectSummary" + ] + } + ] + }, + { + "name": "Microsoft 365 usage reports", + "overview": "../../resources/report.md", + "resources": [ + "reportRoot" + ] + }, + { + "name": "Microsoft Defender for Office 365 security reports", + "overview": "../../resources/report-m365defender-reports-overview.md", + "resources": [ + "attackSimulationRepeatOffender", + "attackSimulationSimulationUserCoverage", + "attackSimulationTrainingUserCoverage" + ] + }, + { + "name": "Partner billing reports", + "overview": "../../resources/partners-billing-api-overview.md", + "resources": [ + "microsoft.graph.partners.billing.billedReconciliation", + "microsoft.graph.partners.billing.billedUsage", + "microsoft.graph.partners.billing.manifest", + "microsoft.graph.partners.billing.operation", + "microsoft.graph.partners.billing.unbilledUsage" + ] + } + ] + }, + { + "name": "Search", + "childNodes": [ + { + "name": "Answer", + "overview": "../../api/resources/search-api-answers-overview.md", + "resources": [ + "microsoft.graph.search.acronym", + "microsoft.graph.search.bookmark", + "microsoft.graph.search.qna" + ] + }, + { + "name": "Query", + "overview": "../../resources/search-api-overview.md", + "resources": [ + "searchEntity", + "searchRequest", + "searchResponse" + ], + "complexTypes": [ + "Json", + "aggregationOption", + "alterationResponse", + "alteredQueryToken", + "bucketAggregationDefinition", + "bucketAggregationRange", + "collapseProperty", + "resultTemplate", + "resultTemplateOption", + "searchAlteration", + "searchAlterationOptions", + "searchBucket", + "searchHit", + "searchHitsContainer", + "searchQuery", + "sharePointOneDriveOptions", + "sortProperty" + ] + } + ] + }, + { + "name": "Security", + "overview": "../../resources/security-api-overview.md", + "additionalLinks": [ + { + "name": "Errors", + "href": "../../resources/security-error-codes.md" + } + ], + "childNodes": [ + { + "name": "Advanced hunting", + "resources": [ + "security", + "microsoft.graph.security.huntingQueryResults", + "microsoft.graph.security.huntingRowResult", + "microsoft.graph.security.singlePropertySchema" + ] + }, + { + "name": "Alerts and incidents", + "resources": [ + "microsoft.graph.security.alert", + "microsoft.graph.security.alertEvidence", + "microsoft.graph.security.incident" + ] + }, + { + "name": "Attack simulation and training", + "resources": [ + "simulation", + "attackSimulationOperation", + "endUserNotification", + "landingPage", + "loginPage", + "payload", + "simulationAutomation", + "simulationAutomationRun", + "training", + "trainingLanguageDetail" + ], + "childNodes": [ + { + "name": "Reports", + "overview": "../../resources/report-m365defender-reports-overview.md", + "resources": [ + "attackSimulationRepeatOffender", + "attackSimulationSimulationUserCoverage", + "attackSimulationTrainingUserCoverage" + ] + } + ] + }, + { + "name": "eDiscovery", + "resources": [ + "microsoft.graph.security.ediscoveryCase", + "microsoft.graph.security.ediscoveryCaseSettings", + "microsoft.graph.security.caseOperation", + "microsoft.graph.security.ediscoveryCustodian", + "microsoft.graph.security.ediscoveryNoncustodialDataSource", + "microsoft.graph.security.ediscoverySearch", + "microsoft.graph.security.ediscoveryReviewSet", + "microsoft.graph.security.ediscoveryReviewTag" + ] + }, + { + "name": "Information protection", + "childNodes": [ + { + "name": "Threat assessment", + "overview": "../../resources/threatassessment-api-overview.md", + "resources": [ + "emailFileAssessmentRequest", + "fileAssessmentRequest", + "mailAssessmentRequest", + "threatAssessmentRequest", + "urlAssessmentRequest" + ], + "complexTypes": [ + "identity", + "identitySet", + "threatAssessmentResult" + ] + } + ] + }, + { + "name": "Legacy alert (deprecated)", + "resources": [ + "alert" + ] + }, + { + "name": "Records management", + "overview": "../../resources/security-recordsmanagement-overview.md", + "resources": [ + "microsoft.graph.security.retentionLabel", + "microsoft.graph.security.retentionEvent", + "microsoft.graph.security.retentionEventType" + ], + "complexTypes": [ + "microsoft.graph.security.eventPropagationResult", + "microsoft.graph.security.eventQuery", + "microsoft.graph.security.filePlanDescriptorBase", + "microsoft.graph.security.filePlanDescriptorTemplate", + "identity", + "identitySet", + "publicError", + "publicErrorDetail", + "publicInnerError", + "microsoft.graph.security.retentionDuration", + "microsoft.graph.security.retentionDurationForever", + "microsoft.graph.security.retentionDurationInDays", + "microsoft.graph.security.retentionEventStatus" + ], + "childNodes": [ + { + "name": "File plan descriptors", + "childNodes": [ + { + "name": "File plan descriptors", + "resources": [ + "microsoft.graph.security.filePlanDescriptor", + "microsoft.graph.security.filePlanAppliedCategory", + "microsoft.graph.security.filePlanAuthority", + "microsoft.graph.security.filePlanCitation", + "microsoft.graph.security.filePlanDepartment", + "microsoft.graph.security.filePlanReference", + "microsoft.graph.security.filePlanSubcategory" + ] + }, + { + "name": "File plan descriptor templates", + "resources": [ + "microsoft.graph.security.categoryTemplate", + "microsoft.graph.security.authorityTemplate", + "microsoft.graph.security.citationTemplate", + "microsoft.graph.security.departmentTemplate", + "microsoft.graph.security.filePlanReferenceTemplate", + "microsoft.graph.security.subcategoryTemplate" + ] + } + ] + } + ] + }, + { + "name": "Secure score", + "resources": [ + "secureScore", + "secureScoreControlProfile" + ] + }, + { + "name": "Threat intelligence", + "overview": "../../resources/security-threatintelligence-overview.md", + "resources": [ + "microsoft.graph.security.article", + "microsoft.graph.security.articleIndicator", + "microsoft.graph.security.host", + "microsoft.graph.security.hostComponent", + "microsoft.graph.security.hostCookie", + "microsoft.graph.security.hostPair", + "microsoft.graph.security.hostPort", + "microsoft.graph.security.hostSslCertificate", + "microsoft.graph.security.hostTracker", + "microsoft.graph.security.intelligenceProfile", + "microsoft.graph.security.intelligenceProfileIndicator", + "microsoft.graph.security.passiveDnsRecord", + "microsoft.graph.security.sslCertificate", + "microsoft.graph.security.subdomain", + "microsoft.graph.security.vulnerability", + "microsoft.graph.security.vulnerabilityComponent", + "microsoft.graph.security.whoisHistoryRecord", + "microsoft.graph.security.whoisRecord" + ], + "complexTypes": [ + "microsoft.graph.security.artifact", + "microsoft.graph.security.autonomousSystem", + "microsoft.graph.security.cvssSummary", + "microsoft.graph.security.formattedContent", + "microsoft.graph.security.hostPortBanner", + "microsoft.graph.security.hostPortComponent", + "microsoft.graph.security.hostReputationRule", + "microsoft.graph.security.hostSslCertificatePort", + "microsoft.graph.security.hyperlink", + "microsoft.graph.security.indicator", + "microsoft.graph.security.intelligenceProfileCountryOrRegionOfOrigin", + "physicalAddress", + "microsoft.graph.security.sslCertificateEntity", + "microsoft.graph.security.unclassifiedArtifact", + "microsoft.graph.security.whoisBaseRecord", + "microsoft.graph.security.whoisContact", + "microsoft.graph.security.whoisNameserver" + ] + } + ] + }, + { + "name": "Sites and lists", + "overview": "../../resources/sharepoint.md", + "keywords": [ + "SharePoint", + "OneDrive", + "OneDrive for Business", + "OneDrive business" + ], + "resources": [ + "site", + "list", + "columnDefinition", + "contentType", + "listItem", + "documentSetVersion", + "richLongRunningOperation", + "sharepointSettings" + ], + "childNodes": [ + { + "name": "Taxonomy", + "resources": [ + "microsoft.graph.termStore.store", + "microsoft.graph.termStore.group", + "microsoft.graph.termStore.set", + "microsoft.graph.termStore.term", + "microsoft.graph.termStore.relation" + ] + } + ] + }, + { + "name": "Tasks and plans", + "overview": "../../resources/planner-overview.md", + "keywords": [ + "Planner" + ], + "resources": [ + "plannerAssignedToTaskBoardTaskFormat", + "plannerBucket", + "plannerBucketTaskBoardTaskFormat", + "plannerPlan", + "plannerPlanDetails", + "plannerProgressTaskBoardTaskFormat", + "plannerTask", + "plannerTaskDetails" + ], + "complexTypes": [ + "identity", + "identitySet", + "plannerAppliedCategories", + "plannerAssignment", + "plannerAssignments", + "plannerCategoryDescriptions", + "plannerChecklistItem", + "plannerChecklistItems", + "plannerExternalReference", + "plannerExternalReferences", + "plannerOrderHintsByAssignee", + "plannerPlanContainer", + "plannerUserIds" + ] + }, + { + "name": "Teamwork and communications", + "overview": "../../resources/teams-api-overview.md", + "keywords": [ + "Microsoft Teams" + ], + "childNodes": [ + { + "name": "Apps", + "resources": [ + "teamsApp", + "teamsAppInstallation", + "teamsAppSettings", + "teamsTab", + "resourceSpecificPermissionGrant" + ] + }, + { + "name": "Calls and online meetings", + "overview": "../../resources/communications-api-overview.md", + "shouldSort": true, + "resources": [ + "presence" + ], + "childNodes": [ + { + "name": "Calls", + "resources": [ + "call", + "audioRoutingGroup", + "contentSharingSession", + "participant", + "addLargeGalleryViewOperation" + ] + }, + { + "name": "Call records", + "overview": "../../resources/callrecords-api-overview.md", + "resources": [ + "microsoft.graph.callRecords.callRecord", + "microsoft.graph.callRecords.directRoutingLogRow", + "microsoft.graph.callRecords.pstnCallLogRow", + "microsoft.graph.callRecords.session" + ] + }, + { + "name": "Online meetings", + "resources": [ + "meetingAttendanceReport", + "attendanceRecord", + "onlineMeeting", + "callRecording", + "callTranscript" + ], + "childNodes": [ + { + "name": "Virtual appointment", + "additionalLinks": [ + { + "name": "Get virtual appointment join link", + "href": "../../api/virtualappointment-getvirtualappointmentjoinweburl.md" + }, + { + "name": "Send virtual appointment reminder SMS", + "href": "../../api/virtualappointment-sendvirtualappointmentremindersms.md" + }, + { + "name": "Send virtual appointment SMS", + "href": "../../api/virtualappointment-sendvirtualappointmentsms.md" + } + ] + } + ] + }, + { + "name": "Virtual events", + "resources": [ + "virtualEventWebinar", + "virtualEventRegistration", + "virtualEventSession" + ] + } + ] + }, + { + "name": "Employee learning", + "overview": "../../resources/viva-learning-api-overview.md", + "keywords": [ + "Viva Learning" + ], + "resources": [ + "learningContent", + "learningCourseActivity", + "learningProvider" + ], + "complexTypes": [ + "learningAssignment", + "learningSelfInitiatedCourse" + ] + }, + { + "name": "Messaging", + "resources": [ + "channel", + "chat", + "chatMessage", + "pinnedChatMessageInfo", + "deletedChat", + "team", + "teamworkTag", + "teamworkTagMember" + ], + "childNodes": [ + { + "name": "Activity feed", + "additionalLinks": [ + { + "name": "Send notification to user in chat", + "href": "../../api/chat-sendactivitynotification.md" + }, + { + "name": "Send notification to user in team", + "href": "../../api/team-sendactivitynotification.md" + }, + { + "name": "Send notification to user", + "href": "../../api/userteamwork-sendactivitynotification.md" + }, + { + "name": "Send notification to multiple users in bulk", + "href": "../../api/teamwork-sendactivitynotificationtorecipients.md" + } + ] + } + ] + }, + { + "name": "Settings", + "resources": [ + "licenseDetails" + ], + "childNodes": [ + { + "name": "Organization settings", + "resources": [ + "teamwork" + ] + }, + { + "name": "User settings", + "resources": [ + "userTeamwork" + ] + } + ] + }, + { + "name": "Shift management", + "resources": [ + "offerShiftRequest", + "openShift", + "openShiftChangeRequest", + "schedule", + "schedulingGroup", + "shift", + "shiftPreferences", + "swapShiftsChangeRequest", + "timeOff", + "timeOffReason", + "timeOffRequest", + "workforceIntegration" + ], + "complexTypes": [ + "changeTrackedEntity", + "identity", + "identitySet", + "openShiftItem", + "patternedRecurrence", + "recurrencePattern", + "recurrenceRange", + "shiftActivity", + "shiftAvailability", + "shiftItem", + "timeOffItem", + "timeRange", + "workforceIntegrationEncryption" + ] + } + ] + }, + { + "name": "To-do tasks", + "overview": "../../resources/todo-overview.md", + "keywords": [ + "Microsoft To Do" + ], + "resources": [ + "todoTaskList", + "todoTask", + "taskFileAttachment", + "checklistItem", + "linkedResource" + ] + }, + { + "name": "Workbooks and charts", + "overview": "../../resources/excel.md", + "keywords": [ + "Excel" + ], + "resources": [ + "workbook", + "workbookApplication", + "workbookChart", + "workbookChartAxis", + "workbookChartAxisTitle", + "workbookChartDataLabels", + "workbookChartFill", + "workbookChartFont", + "workbookChartGridlines", + "workbookChartLegend", + "workbookChartLineFormat", + "workbookChartPoint", + "workbookChartSeries", + "workbookChartTitle", + "workbookComment", + "workbookCommentReply", + "workbookFilter", + "workbookFormatProtection", + "workbookIcon", + "workbookNamedItem", + "workbookOperation", + "workbookPivotTable", + "workbookRange", + "workbookRangeBorder", + "workbookRangeFill", + "workbookRangeFont", + "workbookRangeFormat", + "workbookRangeSort", + "workbookRangeView", + "workbookTable", + "workbookTableColumn", + "workbookTableRow", + "workbookTableSort", + "workbookWorksheet", + "workbookWorksheetProtection" + ], + "complexTypes": [ + "Json", + "workbookChartAreaFormat", + "workbookChartAxes", + "workbookChartAxisFormat", + "workbookChartAxisTitleFormat", + "workbookChartDataLabelFormat", + "workbookChartGridlinesFormat", + "workbookChartLegendFormat", + "workbookChartPointFormat", + "workbookChartSeriesFormat", + "workbookChartTitleFormat", + "workbookFilterCriteria", + "workbookFilterDatetime", + "workbookOperationError", + "workbookSessionInfo", + "workbookSortField", + "workbookWorksheetProtectionOptions" + ] + } + ], + "resourceOverviews": [ + { + "resource": "federatedIdentityCredential", + "overview": "../../resources/federatedidentitycredentials-overview.md" + }, + { + "resource": "subjectRightsRequest", + "overview": "../../resources/subjectrightsrequest-subjectrightsrequestapioverview.md" + } + ] +} |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/users/toc.yml | +items: +- name: Overview + href: ../../resources/users.md +- name: User + href: ../../resources/user.md + items: + - name: List + href: ../../api/user-list.md + - name: Create + href: ../../api/user-post-users.md + - name: Get + href: ../../api/user-get.md + - name: Update + href: ../../api/user-update.md + - name: Delete + href: ../../api/user-delete.md + - name: Change password + href: ../../api/user-changepassword.md + - name: Get delta + href: ../../api/user-delta.md + - name: Get delta for directory object + href: ../../api/directoryobject-delta.md + - name: Retry service provisioning + href: ../../api/user-retryserviceprovisioning.md +- name: App role assignment + href: ../../resources/approleassignment.md + items: + - name: List + href: ../../api/user-list-approleassignments.md + - name: Add + href: ../../api/user-post-approleassignments.md + - name: Get + href: ../../api/approleassignment-get.md + - name: Remove + href: ../../api/user-delete-approleassignments.md + - name: Get delta for directory object + href: ../../api/directoryobject-delta.md +- name: Calendar + href: ../../resources/calendar.md + displayName: Outlook, Outlook calendar + items: + - name: Create + href: ../../api/user-post-calendars.md + - name: Create calendar group + href: ../../api/user-post-calendargroups.md + - name: Create event + href: ../../api/user-post-events.md + - name: Find meeting times + href: ../../api/user-findmeetingtimes.md + - name: Get free/busy schedule + href: ../../api/calendar-getschedule.md + - name: List calendars + href: ../../api/user-list-calendars.md + - name: List calendar groups + href: ../../api/user-list-calendargroups.md + - name: List calendar view + href: ../../api/user-list-calendarview.md + - name: List events + href: ../../api/user-list-events.md + - name: Reminder view + href: ../../api/user-reminderview.md +- name: Delegated permission grant + items: + - name: OAuth 2.0 permission grant + href: ../../resources/oauth2permissiongrant.md + - name: List + href: ../../api/user-list-oauth2permissiongrants.md +- name: Directory object + href: ../../resources/directoryobject.md + items: + - name: Get delta + href: ../../api/directoryobject-delta.md + - name: Assign license + href: ../../api/user-assignlicense.md + - name: Export personal data + href: ../../api/user-exportpersonaldata.md + - name: Check member groups + href: ../../api/directoryobject-checkmembergroups.md + - name: Get member groups + href: ../../api/directoryobject-getmembergroups.md + - name: Check member objects + href: ../../api/directoryobject-checkmemberobjects.md + - name: Get member objects + href: ../../api/directoryobject-getmemberobjects.md + - name: Get objects by IDs + href: ../../api/directoryobject-getbyids.md + - name: List created objects + href: ../../api/user-list-createdobjects.md + - name: List license details + href: ../../api/user-list-licensedetails.md + - name: List owned devices + href: ../../api/user-list-owneddevices.md + - name: List owned objects + href: ../../api/user-list-ownedobjects.md + - name: List registered devices + href: ../../api/user-list-registereddevices.md + - name: Reprocess license assignment + href: ../../api/user-reprocesslicenseassignment.md + - name: Revoke sign-in session + href: ../../api/user-revokesigninsessions.md + - name: List deleted items + href: ../../api/directory-deleteditems-list.md + - name: Get deleted item + href: ../../api/directory-deleteditems-get.md + - name: Permanently delete item + href: ../../api/directory-deleteditems-delete.md + - name: Restore deleted item + href: ../../api/directory-deleteditems-restore.md +- name: Drive + href: ../../resources/drive.md + items: + - name: Get drive + href: ../../api/drive-get.md + - name: List children + href: ../../api/driveitem-list-children.md +- name: Group + href: ../../resources/group.md + items: + - name: List joined teams + href: ../../api/user-list-joinedteams.md + - name: List associated teams + href: ../../api/associatedteaminfo-list.md + - name: List member of + href: ../../api/user-list-memberof.md + - name: List transitive member of + href: ../../api/user-list-transitivememberof.md + - name: Retry service provisioning + href: ../../api/group-retryserviceprovisioning.md +- name: Insights + items: + - name: Office Graph insights + items: + - name: Office Graph insights + href: ../../resources/officegraphinsights.md + - name: List shared + href: ../../api/insights-list-shared.md + - name: List trending + href: ../../api/insights-list-trending.md + - name: List used + href: ../../api/insights-list-used.md + - name: Content discovery settings + items: + - name: User settings + href: ../../resources/usersettings.md + - name: Get settings + href: ../../api/usersettings-get.md + - name: Update settings + href: ../../api/usersettings-update.md +- name: Mail + items: + - name: Message + href: ../../resources/message.md + - name: Create mail folder + href: ../../api/user-post-mailfolders.md + - name: Create draft message + href: ../../api/user-post-messages.md + - name: Create message rule + href: ../../api/mailfolder-post-messagerules.md + - name: Create override + href: ../../api/inferenceclassification-post-overrides.md + - name: Get mail tips + href: ../../api/user-getmailtips.md + - name: List mail folders + href: ../../api/user-list-mailfolders.md + - name: List messages + href: ../../api/user-list-messages.md + - name: List overrides + href: ../../api/inferenceclassification-list-overrides.md + - name: List rules + href: ../../api/mailfolder-list-messagerules.md + - name: Send mail + href: ../../api/user-sendmail.md +- name: Notes + items: + - name: OneNote root + href: ../../resources/onenote.md + - name: List notebooks + href: ../../api/onenote-list-notebooks.md + - name: Create notebook + href: ../../api/onenote-post-notebooks.md +- name: Org hierarchy + items: + - name: List direct reports + href: ../../api/user-list-directreports.md + - name: Get manager + href: ../../api/user-list-manager.md + - name: Assign manager + href: ../../api/user-post-manager.md + - name: Remove manager + href: ../../api/user-delete-manager.md +- name: Outlook settings + items: + - name: Mailbox settings + expanded: true + items: + - name: Mailbox settings + href: ../../resources/mailboxsettings.md + - name: Get mailbox settings + href: ../../api/user-get-mailboxsettings.md + - name: Update mailbox settings + href: ../../api/user-update-mailboxsettings.md + - name: Outlook user services + expanded: true + items: + - name: Outlook user + href: ../../resources/outlookuser.md + - name: Create category + href: ../../api/outlookuser-post-mastercategories.md + - name: Get language choices + href: ../../api/outlookuser-supportedlanguages.md + - name: Get time zone choices + href: ../../api/outlookuser-supportedtimezones.md + - name: List categories + href: ../../api/outlookuser-list-mastercategories.md + - name: Translate IDs + href: ../../api/user-translateexchangeids.md +- name: People + items: + - name: Person + href: ../../resources/person.md + - name: List people + href: ../../api/user-list-people.md +- name: Personal contact + items: + - name: Contact + href: ../../resources/contact.md + - name: Create + href: ../../api/user-post-contacts.md + - name: Create contact folder + href: ../../api/user-post-contactfolders.md + - name: List + href: ../../api/user-list-contacts.md + - name: List contact folders + href: ../../api/user-list-contactfolders.md +- name: Photo + items: + - name: Profile photo + href: ../../resources/profilephoto.md + - name: Get photo + href: ../../api/profilephoto-get.md + - name: Update photo + href: ../../api/profilephoto-update.md + - name: Delete photo + href: ../../api/profilephoto-delete.md +- name: Planner + items: + - name: Planner task + href: ../../resources/plannertask.md + - name: List tasks + href: ../../api/planneruser-list-tasks.md +- name: Sponsors + items: + - name: Add sponsor + href: ../../api/user-post-sponsors.md + - name: List sponsors + href: ../../api/user-list-sponsors.md + - name: Remove sponsor + href: ../../api/user-delete-sponsors.md +- name: Teamwork and communications + items: + - name: Installed app + href: ../../resources/teamsappinstallation.md + - name: List apps for user + href: ../../api/userteamwork-list-installedapps.md + - name: List permission grants for user + href: ../../api/user-list-permissiongrants.md + - name: Add app for user + href: ../../api/userteamwork-post-installedapps.md + - name: Gets installed app for user + href: ../../api/userteamwork-get-installedapps.md + - name: Upgrade installed app for user + href: ../../api/userteamwork-teamsappinstallation-upgrade.md + - name: Remove app for user + href: ../../api/userteamwork-delete-installedapps.md + - name: Get chat between user and app + href: ../../api/userscopeteamsappinstallation-get-chat.md + - name: Get chat for user + href: ../../api/chat-get.md + - name: List chats for user + href: ../../api/chat-list.md +- name: To-do task + items: + - name: To-do task + href: ../../resources/todotask.md + - name: Create task + href: ../../api/todotasklist-post-tasks.md + - name: Create task list + href: ../../api/todo-post-lists.md + - name: List tasks + href: ../../api/todotasklist-list-tasks.md + - name: List task lists + href: ../../api/todo-list-lists.md +- name: User settings + items: + - name: User settings + href: ../../resources/usersettings.md + - name: Get settings + href: ../../api/usersettings-get.md + - name: Update settings + href: ../../api/usersettings-update.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/workbooks-and-charts/toc.yml | +items: +- name: Overview + href: ../../resources/excel.md +- name: Workbook + items: + - name: Workbook + href: ../../resources/workbook.md + - name: Create session + href: ../../api/workbook-createsession.md + - name: Close session + href: ../../api/workbook-closesession.md + - name: Refresh session + href: ../../api/workbook-refreshsession.md +- name: Workbook application + items: + - name: Workbook application + href: ../../resources/workbookapplication.md + - name: Get workbookApplication + href: ../../api/workbookapplication-get.md + - name: Calculate + href: ../../api/workbookapplication-calculate.md +- name: Workbook chart + items: + - name: Workbook chart + href: ../../resources/chart.md + - name: Get Chart + href: ../../api/chart-get.md + - name: Create ChartSeries + href: ../../api/chart-post-series.md + - name: List series + href: ../../api/chart-list-series.md + - name: Update + href: ../../api/chart-update.md + - name: Image + href: ../../api/chart-image.md + - name: Delete + href: ../../api/chart-delete.md + - name: Setdata + href: ../../api/chart-setdata.md + - name: Setposition + href: ../../api/chart-setposition.md + - name: List + href: ../../api/chart-list.md + - name: Itemat + href: ../../api/chartcollection-itemat.md + - name: Add + href: ../../api/chartcollection-add.md +- name: Workbook chart axis + items: + - name: Workbook chart axis + href: ../../resources/chartaxis.md + - name: Get ChartAxis + href: ../../api/chartaxis-get.md + - name: Update + href: ../../api/chartaxis-update.md +- name: Workbook chart axis title + items: + - name: Workbook chart axis title + href: ../../resources/chartaxistitle.md + - name: Get ChartAxisTitle + href: ../../api/chartaxistitle-get.md + - name: Update + href: ../../api/chartaxistitle-update.md +- name: Workbook chart data labels + items: + - name: Workbook chart data labels + href: ../../resources/chartdatalabels.md + - name: Get ChartDataLabels + href: ../../api/chartdatalabels-get.md + - name: Update + href: ../../api/chartdatalabels-update.md +- name: Workbook chart fill + items: + - name: Workbook chart fill + href: ../../resources/chartfill.md + - name: Clear + href: ../../api/chartfill-clear.md + - name: Setsolidcolor + href: ../../api/chartfill-setsolidcolor.md +- name: Workbook chart font + items: + - name: Workbook chart font + href: ../../resources/chartfont.md + - name: Get ChartFont + href: ../../api/chartfont-get.md + - name: Update + href: ../../api/chartfont-update.md +- name: Workbook chart gridlines + items: + - name: Workbook chart gridlines + href: ../../resources/chartgridlines.md + - name: Get ChartGridlines + href: ../../api/chartgridlines-get.md + - name: Update + href: ../../api/chartgridlines-update.md +- name: Workbook chart legend + items: + - name: Workbook chart legend + href: ../../resources/chartlegend.md + - name: Get ChartLegend + href: ../../api/chartlegend-get.md + - name: Update + href: ../../api/chartlegend-update.md +- name: Workbook chart line format + items: + - name: Workbook chart line format + href: ../../resources/chartlineformat.md + - name: Get ChartLineFormat + href: ../../api/chartlineformat-get.md + - name: Update + href: ../../api/chartlineformat-update.md + - name: Clear + href: ../../api/chartlineformat-clear.md +- name: Workbook chart point + items: + - name: Workbook chart point + href: ../../resources/chartpoint.md + - name: Get ChartPoint + href: ../../api/chartpoint-get.md + - name: List + href: ../../api/chartpoint-list.md + - name: ItemAt + href: ../../api/chartpointscollection-itemat.md +- name: Workbook chart series + items: + - name: Workbook chart series + href: ../../resources/chartseries.md + - name: Get ChartSeries + href: ../../api/chartseries-get.md + - name: Create ChartPoints + href: ../../api/chartseries-post-points.md + - name: List points + href: ../../api/chartseries-list-points.md + - name: Update + href: ../../api/chartseries-update.md + - name: List + href: ../../api/chartseries-list.md + - name: ItemAt + href: ../../api/chartseriescollection-itemat.md +- name: Workbook chart title + items: + - name: Workbook chart title + href: ../../resources/charttitle.md + - name: Get ChartTitle + href: ../../api/charttitle-get.md + - name: Update + href: ../../api/charttitle-update.md +- name: Workbook comment + items: + - name: Workbook comment + href: ../../resources/workbookcomment.md + - name: List workbookComments + href: ../../api/workbook-list-comments.md + - name: Get workbookComment + href: ../../api/workbookcomment-get.md +- name: Workbook comment reply + items: + - name: Workbook comment reply + href: ../../resources/workbookcommentreply.md + - name: List workbookCommentReplies + href: ../../api/workbookcomment-list-replies.md + - name: Get workbookCommentReply + href: ../../api/workbookcommentreply-get.md + - name: Create workbookCommentReply + href: ../../api/workbookcomment-post-replies.md +- name: Workbook filter + items: + - name: Workbook filter + href: ../../resources/filter.md + - name: Apply + href: ../../api/filter-apply.md + - name: Clear + href: ../../api/filter-clear.md +- name: Workbook format protection + items: + - name: Workbook format protection + href: ../../resources/formatprotection.md + - name: Get workbookFormatProtection + href: ../../api/formatprotection-get.md + - name: Update + href: ../../api/formatprotection-update.md +- name: Workbook icon + items: + - name: Workbook icon + href: ../../resources/icon.md + - name: Get Icon + href: ../../api/icon-get.md + - name: Update + href: ../../api/icon-update.md +- name: Workbook named item + items: + - name: Workbook named item + href: ../../resources/nameditem.md + - name: Add + href: ../../api/nameditem-add.md + - name: AddFormulaLocal + href: ../../api/nameditem-addformulalocal.md + - name: Get NamedItem + href: ../../api/nameditem-get.md + - name: Update + href: ../../api/nameditem-update.md + - name: Range + href: ../../api/nameditem-range.md + - name: List + href: ../../api/nameditem-list.md +- name: Workbook operation + items: + - name: Workbook operation + href: ../../resources/workbookoperation.md + - name: Get workbookOperation + href: ../../api/workbookoperation-get.md +- name: Workbook pivot table + items: + - name: Workbook pivot table + href: ../../resources/workbookpivottable.md + - name: Get workbookPivotTable + href: ../../api/workbookpivottable-get.md + - name: Refresh + href: ../../api/workbookpivottable-refresh.md + - name: Refreshall + href: ../../api/workbookpivottable-refreshall.md +- name: Workbook range + items: + - name: Workbook range + href: ../../resources/range.md + - name: Get Range + href: ../../api/range-get.md + - name: Update + href: ../../api/range-update.md + - name: Boundingrect + href: ../../api/range-boundingrect.md + - name: Cell + href: ../../api/range-cell.md + - name: Column + href: ../../api/range-column.md + - name: Columnsafter + href: ../../api/workbookrange-columnsafter.md + - name: Columnsbefore + href: ../../api/workbookrange-columnsbefore.md + - name: Entirecolumn + href: ../../api/range-entirecolumn.md + - name: Entirerow + href: ../../api/range-entirerow.md + - name: Intersection + href: ../../api/range-intersection.md + - name: Lastcell + href: ../../api/range-lastcell.md + - name: Lastcolumn + href: ../../api/range-lastcolumn.md + - name: Lastrow + href: ../../api/range-lastrow.md + - name: Offsetrange + href: ../../api/range-offsetrange.md + - name: Row + href: ../../api/range-row.md + - name: Rowsabove + href: ../../api/workbookrange-rowsabove.md + - name: Rowsbelow + href: ../../api/workbookrange-rowsbelow.md + - name: Usedrange + href: ../../api/range-usedrange.md + - name: Clear + href: ../../api/range-clear.md + - name: Delete + href: ../../api/range-delete.md + - name: Insert + href: ../../api/range-insert.md + - name: Merge + href: ../../api/range-merge.md + - name: Resizedrange + href: ../../api/workbookrange-resizedrange.md + - name: Unmerge + href: ../../api/range-unmerge.md + - name: Visibleview + href: ../../api/workbookrange-visibleview.md +- name: Workbook range border + items: + - name: Workbook range border + href: ../../resources/rangeborder.md + - name: Get RangeBorder + href: ../../api/rangeborder-get.md + - name: Update + href: ../../api/rangeborder-update.md + - name: List + href: ../../api/rangeborder-list.md + - name: Itemat + href: ../../api/rangebordercollection-itemat.md +- name: Workbook range fill + items: + - name: Workbook range fill + href: ../../resources/rangefill.md + - name: Get RangeFill + href: ../../api/rangefill-get.md + - name: Update + href: ../../api/rangefill-update.md + - name: Clear + href: ../../api/rangefill-clear.md +- name: Workbook range font + items: + - name: Workbook range font + href: ../../resources/rangefont.md + - name: Get RangeFont + href: ../../api/rangefont-get.md + - name: Update + href: ../../api/rangefont-update.md +- name: Workbook range format + items: + - name: Workbook range format + href: ../../resources/rangeformat.md + - name: Get RangeFormat + href: ../../api/rangeformat-get.md + - name: Create RangeBorder + href: ../../api/rangeformat-post-borders.md + - name: List borders + href: ../../api/rangeformat-list-borders.md + - name: Update + href: ../../api/rangeformat-update.md + - name: Autofitcolumns + href: ../../api/rangeformat-autofitcolumns.md + - name: Autofitrows + href: ../../api/rangeformat-autofitrows.md +- name: Workbook range sort + items: + - name: Workbook range sort + href: ../../resources/rangesort.md + - name: Apply + href: ../../api/rangesort-apply.md +- name: Workbook range view + items: + - name: Workbook range view + href: ../../resources/workbookrangeview.md + - name: List rows + href: ../../api/workbookrangeview-list-rows.md + - name: Itemat + href: ../../api/workbookrangeview-itemat.md + - name: Range + href: ../../api/workbookrangeview-range.md +- name: Workbook table + items: + - name: Workbook table + href: ../../resources/table.md + - name: Get Table + href: ../../api/table-get.md + - name: Create TableColumn + href: ../../api/table-post-columns.md + - name: List columns + href: ../../api/table-list-columns.md + - name: Create TableRow + href: ../../api/table-post-rows.md + - name: List rows + href: ../../api/table-list-rows.md + - name: Update + href: ../../api/table-update.md + - name: Databodyrange + href: ../../api/table-databodyrange.md + - name: Headerrowrange + href: ../../api/table-headerrowrange.md + - name: Range + href: ../../api/table-range.md + - name: Totalrowrange + href: ../../api/table-totalrowrange.md + - name: Clearfilters + href: ../../api/table-clearfilters.md + - name: Converttorange + href: ../../api/table-converttorange.md + - name: Delete + href: ../../api/table-delete.md + - name: Reapplyfilters + href: ../../api/table-reapplyfilters.md + - name: List + href: ../../api/table-list.md + - name: Add + href: ../../api/tablecollection-add.md +- name: Workbook table column + items: + - name: Workbook table column + href: ../../resources/workbooktablecolumn.md + - name: Get TableColumn + href: ../../api/tablecolumn-get.md + - name: Update + href: ../../api/tablecolumn-update.md + - name: Databodyrange + href: ../../api/tablecolumn-databodyrange.md + - name: Headerrowrange + href: ../../api/tablecolumn-headerrowrange.md + - name: Range + href: ../../api/tablecolumn-range.md + - name: Totalrowrange + href: ../../api/tablecolumn-totalrowrange.md + - name: Delete + href: ../../api/tablecolumn-delete.md + - name: List + href: ../../api/tablecolumn-list.md + - name: Itemat + href: ../../api/tablecolumncollection-itemat.md + - name: Add + href: ../../api/tablecolumncollection-add.md +- name: Workbook table row + items: + - name: Workbook table row + href: ../../resources/workbooktablerow.md + - name: List + href: ../../api/tablerow-list.md + - name: Create + href: ../../api/table-post-rows.md + - name: Get + href: ../../api/tablerow-get.md + - name: Update + href: ../../api/tablerow-update.md + - name: Delete + href: ../../api/tablerow-delete.md + - name: Range + href: ../../api/tablerow-range.md + - name: Itemat + href: ../../api/tablerowcollection-itemat.md + - name: Add + href: ../../api/tablerowcollection-add.md +- name: Workbook table sort + items: + - name: Workbook table sort + href: ../../resources/tablesort.md + - name: Get TableSort + href: ../../api/tablesort-get.md + - name: Apply + href: ../../api/tablesort-apply.md + - name: Clear + href: ../../api/tablesort-clear.md + - name: Reapply + href: ../../api/tablesort-reapply.md +- name: Workbook worksheet + items: + - name: Workbook worksheet + href: ../../resources/worksheet.md + - name: Get Worksheet + href: ../../api/worksheet-get.md + - name: Create Chart + href: ../../api/worksheet-post-charts.md + - name: List names + href: ../../api/worksheet-list-names.md + - name: List charts + href: ../../api/worksheet-list-charts.md + - name: Create Table + href: ../../api/worksheet-post-tables.md + - name: List tables + href: ../../api/worksheet-list-tables.md + - name: Update + href: ../../api/worksheet-update.md + - name: Cell + href: ../../api/worksheet-cell.md + - name: Range + href: ../../api/worksheet-range.md + - name: Usedrange + href: ../../api/worksheet-usedrange.md + - name: Delete + href: ../../api/worksheet-delete.md + - name: List + href: ../../api/worksheet-list.md + - name: Add + href: ../../api/worksheetcollection-add.md + - name: List pivotTables + href: ../../api/workbookworksheet-list-pivottables.md +- name: Workbook worksheet protection + items: + - name: Workbook worksheet protection + href: ../../resources/worksheetprotection.md + - name: Get WorksheetProtection + href: ../../api/worksheetprotection-get.md + - name: Protect + href: ../../api/worksheetprotection-protect.md + - name: Unprotect + href: ../../api/worksheetprotection-unprotect.md +- name: Complex types + items: + - name: Json + href: ../../resources/json.md + - name: Workbook chart area format + href: ../../resources/chartareaformat.md + - name: Workbook chart axes + href: ../../resources/chartaxes.md + - name: Workbook chart axis format + href: ../../resources/chartaxisformat.md + - name: Workbook chart axis title format + href: ../../resources/chartaxistitleformat.md + - name: Workbook chart data label format + href: ../../resources/chartdatalabelformat.md + - name: Workbook chart gridlines format + href: ../../resources/chartgridlinesformat.md + - name: Workbook chart legend format + href: ../../resources/chartlegendformat.md + - name: Workbook chart point format + href: ../../resources/chartpointformat.md + - name: Workbook chart series format + href: ../../resources/chartseriesformat.md + - name: Workbook chart title format + href: ../../resources/charttitleformat.md + - name: Workbook filter criteria + href: ../../resources/filtercriteria.md + - name: Workbook filter datetime + href: ../../resources/filterdatetime.md + - name: Workbook operation error + href: ../../resources/workbookoperationerror.md + - name: Workbook session info + href: ../../resources/workbooksessioninfo.md + - name: Workbook sort field + href: ../../resources/sortfield.md + - name: Workbook worksheet protection options + href: ../../resources/worksheetprotectionoptions.md |