| Service | Microsoft Docs article | Related commit history on GitHub | Change details |
|---|---|---|---|
| v1.0 | Accessreviewset Post Historydefinitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewset-post-historydefinitions.md | The following table shows the required properties used to create an [accessRevie |reviewHistoryPeriodStartDateTime | DateTimeOffset | A timestamp. Reviews starting on or after this date will be included in the fetched history data. Only required if **scheduleSettings** is not defined. | |reviewHistoryPeriodEndDateTime | DateTimeOffset | A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if **scheduleSettings** is not defined. | |scopes|[accessReviewQueryScope](../resources/accessreviewqueryscope.md) collection| Used to filter which reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required. <br> For more, see [Supported scope queries for accessReviewHistoryDefinition](#supported-scope-queries-for-accessreviewhistorydefinition). |-| scheduleSettings |[accessReviewHistoryScheduleSettings](../resources/accessReviewHistoryScheduleSettings.md)| The settings for a recurring access review history definition series. Only required if **reviewHistoryPeriodStartDateTime** or **reviewHistoryPeriodEndDateTime** are not defined. Not supported yet.| +| scheduleSettings |[accessReviewHistoryScheduleSettings](../resources/accessReviewHistoryScheduleSettings.md)| **Not supported yet.** The settings for a recurring access review history definition series. Only required if **reviewHistoryPeriodStartDateTime** or **reviewHistoryPeriodEndDateTime** are not defined. | ### Supported scope queries for accessReviewHistoryDefinition Content-Type: application/json "notReviewed", "notNotified" ],- "scheduleSettings": { - "reportRange": "P1M", - "recurrence": { - "pattern": { - "type": "monthly", - "interval": 1 - }, - "range": { - "type": "noEnd", - "startDate": "2018-08-03T21:02:30.667Z", - "count": 0 - } - } - }, + "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z", + "reviewHistoryPeriodEndDateTime": "2021-04-30T23:59:59Z", "scopes": [ { "@odata.type": "#microsoft.graph.accessReviewQueryScope", Content-Type: application/json "@odata.type": "#microsoft.graph.accessReviewHistoryDefinition", "id": "b2cb022f-b7e1-40f3-9854-c65a40861c38", "displayName": "Last quarter's group reviews April 2021",- "scheduleSettings": { - "reportRange": "P1M", - "recurrence": { - "pattern": { - "type": "monthly", - "interval": 1 - }, - "range": { - "type": "noEnd", - "startDate": "2018-08-03T21:02:30.667Z", - "count": 0 - } - } - }, + "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z", + "reviewHistoryPeriodEndDateTime": "2021-04-30T23:59:59Z", "decisions": [ "approve", "deny", |
| v1.0 | Administrativeunit Delta | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-delta.md | One of the following permissions is required to call this API. To learn more, in |:--|:| |Delegated (work or school account) | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |-|administrativeunit | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All | +|Application | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All | ## HTTP request GET /administrativeUnits/delta ## Query parameters -Tracking changes incurs a round of one or more **delta** function calls. If you use any query parameter -(other than `$deltatoken` and `$skiptoken`), you must specify -it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters -into the token portion of the `@odata.nextLink` or `@odata.deltaLink` URL provided in the response. -You only need to specify any query parameters once up front. -In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response. That URL already +Tracking changes incurs a round of one or more **delta** function calls. If you use any query parameter +(other than `$deltatoken` and `$skiptoken`), you must specify +it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters +into the token portion of the `@odata.nextLink` or `@odata.deltaLink` URL provided in the response. +You only need to specify any query parameters once up front. +In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response. That URL already includes the encoded parameters. | Query parameter | Type |Description| includes the encoded parameters. This method supports the following OData query parameters to help customize the response: -- You can use a `$select` query parameter as in any GET request to specify only the properties your need for best performance. The -**id** property is always returned. +- You can use a `$select` query parameter as in any GET request to specify only the properties your need for best performance. The +**id** property is always returned. - There is limited support for `$filter`: * The only supported `$filter` expression is for tracking changes for specific resources, by their ID: `$filter=id+eq+{value}` or `$filter=id+eq+{value1}+or+id+eq+{value2}`. The number of IDs you can specify is limited by the maximum URL length. Do not supply a request body for this method. ## Response -If successful, this method returns `200 OK` response code and an [administrativeUnit](../resources/administrativeunit.md) collection object in the response body. The response also includes a `@odata.nextLink` URL or a `@odata.deltaLink` URL. +If successful, this method returns `200 OK` response code and an [administrativeUnit](../resources/administrativeunit.md) collection object in the response body. The response also includes a `@odata.nextLink` URL or a `@odata.deltaLink` URL. - If a `@odata.nextLink` URL is returned, there are additional pages of data to be retrieved in the session. The **administrativeUnit** continues making requests using the `@odata.nextLink` URL until a `@odata.deltaLink` URL is included in the response. GET https://graph.microsoft.com/beta/administrativeUnits/delta ### Response >**Note:** The response object shown here might be shortened for readability.-<!-- { +<!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.administrativeUnit",- "isCollection": true -} --> + "isCollection": true +} --> ```http HTTP/1.1 200 OK Content-type: application/json |
| v1.0 | Chatmessage Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chatmessage-post.md | One of the following permissions is required to call this API. To learn more, in |:|:--| | Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All** | | Delegated (personal Microsoft account) | Not supported. |-| Application | Teamwork.Migrate.All, ChannelMessage.ReadWrite.All | +| Application | Teamwork.Migrate.All | > **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. Content-type: application/json #### Request The following is an example of the request. -> **Note:** The attachment's ID must be unique and can be a new randomly generated GUID. However, the attachment's ID must be the same in the _body_ and _attachments_ elements. +> **Note:** The attachment ID must be unique and can be a new randomly generated GUID. However, the attachment ID must be the same in the _body_ and _attachments_ elements. # [HTTP](#tab/http) Content-type: application/json #### Request The following is an example of the request. -> **Note:** The **temporaryId** in the **hostedContents** collection is a random ID, but must be same across the **body** and **hostedContents** elements. (Notice the **temporaryId** set to **1** and the reference in body as `../hostedContents/1/$value`.) +> **Note:** The **temporaryId** in the **hostedContents** collection is a random ID, but must be same across the **body** and **hostedContents** elements. (Notice the **temporaryId** set to `1` and the reference in body as `../hostedContents/1/$value`.). -**contentBytes** must be set to binary string Base64-encoded bytes. You can do this in C# by using `Convert.ToBase64String(File.ReadAllBytes("image.png"));` +**contentBytes** must be set to binary string Base64-encoded bytes. You can do this in C# by using `Convert.ToBase64String(File.ReadAllBytes("image.png"));`. # [HTTP](#tab/http) Content-type: application/json #### Request The following is an example of the request. -> **Note:** The **temporaryId** in the **hostedContents** collection is a random ID, but must be same across the **content** (in **attachments**) and **hostedContents** elements. (Notice the **temporaryId** set to **1** and the reference in content as `../hostedContents/1/$value`.) +> **Note:** The **temporaryId** in the **hostedContents** collection is a random ID, but must be same across the **content** (in **attachments**) and **hostedContents** elements. (Notice the **temporaryId** set to `1` and the reference in content as `../hostedContents/1/$value`.). -**contentBytes** must be set to binary string Base64-encoded bytes. You can do this in C# by using `Convert.ToBase64String(File.ReadAllBytes("image.png"));` +**contentBytes** must be set to binary string Base64-encoded bytes. You can do this in C# by using `Convert.ToBase64String(File.ReadAllBytes("image.png"));`. # [HTTP](#tab/http) Content-type: application/json #### Response +The following is an example of the response. + <!-- { "blockType": "response", "truncated": true, Content-type: application/json } ``` -### Example 8 : @mention a team in a channel message +### Example 8: @mention a team in a channel message #### Request The following is an example of the request. |
| v1.0 | Chatmessage Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chatmessage-update.md | ms.prod: "microsoft-teams" Update a [chatMessage](../resources/chatMessage.md) object. -With the exception of the **policyViolation** property, all properties of a **chatMessage** can be updated in delegated permissions scenarios. +All properties of a **chatMessage** can be updated in delegated permissions scenarios, +except for read-only properties and the **policyViolation** property. Only the **policyViolation** property of a **chatMessage** can be updated in application permissions scenarios. The update only works for chats where members are Microsoft Teams users. If one of the participants is using Skype, the operation will fail. |
| v1.0 | Ediscovery Legalhold Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/ediscovery-legalhold-update.md | In the request body, supply the values for relevant fields that should be update |Property|Type|Description| |:|:|:|-|contentQuery|String|KQL query that specifies content to be held in the specified locations. For more information about KQL in eDiscovery, see [Keyword queries and search conditions for Content Search and eDiscovery](/microsoft-365/compliance/keyword-queries-and-search-conditions). To hold all content in the specified locations, leave **contentQuery** blank. | |description|String| The legal hold description. | |displayName|String| The display name of the legal hold. | |isEnabled|Boolean|Indicates whether the hold is enabled and actively holding content. | |
| v1.0 | Intune Partnerintegration Devicemanagement Getorganizationalmessagetenantconsent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-devicemanagement-getorganizationalmessagetenantconsent.md | - Title: "getOrganizationalMessageTenantConsent function" -description: "Not yet documented" --localization_priority: Normal -doc_type: apiPageType ---# getOrganizationalMessageTenantConsent function --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Not yet documented --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, 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/getOrganizationalMessageTenantConsent -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this function returns a `200 OK` response code and a [organizationalMessageTenantConsent](../resources/intune-partnerintegration-organizationalmessagetenantconsent.md) in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/getOrganizationalMessageTenantConsent -``` --### 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: 135 --{ - "value": { - "@odata.type": "microsoft.graph.organizationalMessageTenantConsent", - "firstPartyMessageAllowed": true - } -} -``` ----- |
| v1.0 | Intune Partnerintegration Devicemanagement Postorganizationalmessagetenantconsent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-devicemanagement-postorganizationalmessagetenantconsent.md | - Title: "postOrganizationalMessageTenantConsent action" -description: "Not yet documented" --localization_priority: Normal -doc_type: apiPageType ---# postOrganizationalMessageTenantConsent 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. --Not yet documented --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementApps.Read.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementApps.Read.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/postOrganizationalMessageTenantConsent -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|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| -|:|:|:| -|firstPartyMessageAllowed|Boolean|Not yet documented| ----## Response -If successful, this action returns a `200 OK` response code and a [organizationalMessageTenantConsent](../resources/intune-partnerintegration-organizationalmessagetenantconsent.md) in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/postOrganizationalMessageTenantConsent --Content-type: application/json -Content-length: 40 --{ - "firstPartyMessageAllowed": 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: 135 --{ - "value": { - "@odata.type": "microsoft.graph.organizationalMessageTenantConsent", - "firstPartyMessageAllowed": true - } -} -``` ----- |
| v1.0 | Intune Partnerintegration Devicemanagement Updateorganizationalmessagetenantconsent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-devicemanagement-updateorganizationalmessagetenantconsent.md | - Title: "updateOrganizationalMessageTenantConsent action" -description: "Not yet documented" --localization_priority: Normal -doc_type: apiPageType ---# updateOrganizationalMessageTenantConsent 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. --Not yet documented --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementApps.Read.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementApps.Read.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/updateOrganizationalMessageTenantConsent -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|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| -|:|:|:| -|firstPartyMessageAllowed|Boolean|Not yet documented| ----## Response -If successful, this action returns a `200 OK` response code and a [organizationalMessageTenantConsent](../resources/intune-partnerintegration-organizationalmessagetenantconsent.md) in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/updateOrganizationalMessageTenantConsent --Content-type: application/json -Content-length: 40 --{ - "firstPartyMessageAllowed": 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: 135 --{ - "value": { - "@odata.type": "microsoft.graph.organizationalMessageTenantConsent", - "firstPartyMessageAllowed": true - } -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagedetail Create | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-organizationalmessagedetail-create.md | - Title: "Create organizationalMessageDetail" -description: "Create a new organizationalMessageDetail object." --localization_priority: Normal -doc_type: apiPageType ---# Create organizationalMessageDetail --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) object. --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/organizationalMessageDetails -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the organizationalMessageDetail object. --The following table shows the properties that are required when you create the organizationalMessageDetail. --|Property|Type|Description| -|:|:|:| -|id|String|A unique identifier for the organizational message| -|scenario|[organizationalMessageScenario](../resources/intune-partnerintegration-organizationalmessagescenario.md)|Indicates the scenario for the message. Possible values are: `onboarding`, `lifecycle`, `unknownFutureValue`.| -|surface|[organizationalMessageSurface](../resources/intune-partnerintegration-organizationalmessagesurface.md)|Indicates the area where content will be displayed to customers. Possible values are: `actionCenter`, `getStarted`, `softLanding`, `unknownFutureValue`.| -|status|[organizationalMessageStatus](../resources/intune-partnerintegration-organizationalmessagestatus.md)|Indicates the deployment status of the message. Possible values are: `scheduled`, `active`, `completed`, `cancelled`, `unknownFutureValue`.| -|startDateTime|DateTimeOffset|The date and time of when the message will start being displayed to clients| -|endDateTime|DateTimeOffset|The date and time of when the message will stop being displayed to clients| -|createdDateTime|DateTimeOffset|The date and time of when the message was created| -|lastModifiedDateTime|DateTimeOffset|The date and time of when the message was last modified| -|userEngagementStatistics|[organizationalMessageInsights](../resources/intune-partnerintegration-organizationalmessageinsights.md)|The statistics containing how the message was interacted with by clients. This includes the number of impressions, clicks, and dismisses from targeted clients.| -|frequency|[organizationalMessageFrequency](../resources/intune-partnerintegration-organizationalmessagefrequency.md)|The frequency at which a client will see the message. Possible values are: `weeklyOnce`, `monthlyOnce`, `monthlyTwice`, `unknownFutureValue`.| -|targeting|[organizationalMessageTargeting](../resources/intune-partnerintegration-organizationalmessagetargeting.md)|The groups of devices that will receive the message. This also contains a list of excluded groups that will not receive the message regardless of the device being part of an included group| -|content|[organizationalMessageContent](../resources/intune-partnerintegration-organizationalmessagecontent.md)|The content that will be displayed to clients for the message. This includes the text portion of the message and the displayed logo| -|theme|[organizationalMessageTheme](../resources/intune-partnerintegration-organizationalmessagetheme.md)|Indicates the theme for the experience. Possible values are: `update`, `training`, `welcomeToWindows`, `explore`, `unknownFutureValue`.| -|variant|String|Indicates the corresponding variant for the experience| ----## Response -If successful, this method returns a `201 Created` response code and a [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/organizationalMessageDetails -Content-type: application/json -Content-length: 2049 --{ - "@odata.type": "#microsoft.graph.organizationalMessageDetail", - "scenario": "lifecycle", - "surface": "getStarted", - "status": "active", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "userEngagementStatistics": { - "@odata.type": "microsoft.graph.organizationalMessageInsights", - "impressions": 11, - "clicks": 6, - "dismisses": 9 - }, - "frequency": "monthlyOnce", - "targeting": { - "@odata.type": "microsoft.graph.organizationalMessageTargeting", - "targetingType": "unknownFutureValue", - "includeIds": [ - "Include Ids value" - ], - "excludeIds": [ - "Exclude Ids value" - ] - }, - "content": { - "@odata.type": "microsoft.graph.organizationalMessageContent", - "guidedContentId": "Guided Content Id value", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logoInfo": { - "@odata.type": "microsoft.graph.organizationalMessageLogo", - "logo": "bG9nbw==", - "contentType": "unknownFutureValue", - "logoCdnUrl": "https://example.com/logoCdnUrl/" - } - }, - "theme": "training", - "variant": "Variant 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: 2221 --{ - "@odata.type": "#microsoft.graph.organizationalMessageDetail", - "id": "affbf3ad-f3ad-affb-adf3-fbafadf3fbaf", - "scenario": "lifecycle", - "surface": "getStarted", - "status": "active", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "userEngagementStatistics": { - "@odata.type": "microsoft.graph.organizationalMessageInsights", - "impressions": 11, - "clicks": 6, - "dismisses": 9 - }, - "frequency": "monthlyOnce", - "targeting": { - "@odata.type": "microsoft.graph.organizationalMessageTargeting", - "targetingType": "unknownFutureValue", - "includeIds": [ - "Include Ids value" - ], - "excludeIds": [ - "Exclude Ids value" - ] - }, - "content": { - "@odata.type": "microsoft.graph.organizationalMessageContent", - "guidedContentId": "Guided Content Id value", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logoInfo": { - "@odata.type": "microsoft.graph.organizationalMessageLogo", - "logo": "bG9nbw==", - "contentType": "unknownFutureValue", - "logoCdnUrl": "https://example.com/logoCdnUrl/" - } - }, - "theme": "training", - "variant": "Variant value" -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagedetail Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-organizationalmessagedetail-delete.md | - Title: "Delete organizationalMessageDetail" -description: "Deletes a organizationalMessageDetail." --localization_priority: Normal -doc_type: apiPageType ---# Delete organizationalMessageDetail --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md). --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -DELETE /deviceManagement/organizationalMessageDetails/{organizationalMessageDetailId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `204 No Content` response code. --## Example --### Request -Here is an example of the request. -``` http -DELETE https://graph.microsoft.com/beta/deviceManagement/organizationalMessageDetails/{organizationalMessageDetailId} -``` --### 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 Partnerintegration Organizationalmessagedetail Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-organizationalmessagedetail-get.md | - Title: "Get organizationalMessageDetail" -description: "Read properties and relationships of the organizationalMessageDetail object." --localization_priority: Normal -doc_type: apiPageType ---# Get organizationalMessageDetail --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) object. --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, 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/organizationalMessageDetails/{organizationalMessageDetailId} -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/organizationalMessageDetails/{organizationalMessageDetailId} -``` --### 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: 2368 --{ - "value": { - "@odata.type": "#microsoft.graph.organizationalMessageDetail", - "id": "affbf3ad-f3ad-affb-adf3-fbafadf3fbaf", - "scenario": "lifecycle", - "surface": "getStarted", - "status": "active", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "userEngagementStatistics": { - "@odata.type": "microsoft.graph.organizationalMessageInsights", - "impressions": 11, - "clicks": 6, - "dismisses": 9 - }, - "frequency": "monthlyOnce", - "targeting": { - "@odata.type": "microsoft.graph.organizationalMessageTargeting", - "targetingType": "unknownFutureValue", - "includeIds": [ - "Include Ids value" - ], - "excludeIds": [ - "Exclude Ids value" - ] - }, - "content": { - "@odata.type": "microsoft.graph.organizationalMessageContent", - "guidedContentId": "Guided Content Id value", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logoInfo": { - "@odata.type": "microsoft.graph.organizationalMessageLogo", - "logo": "bG9nbw==", - "contentType": "unknownFutureValue", - "logoCdnUrl": "https://example.com/logoCdnUrl/" - } - }, - "theme": "training", - "variant": "Variant value" - } -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagedetail List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-organizationalmessagedetail-list.md | - Title: "List organizationalMessageDetails" -description: "List properties and relationships of the organizationalMessageDetail objects." --localization_priority: Normal -doc_type: apiPageType ---# List organizationalMessageDetails --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) objects. --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, 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/organizationalMessageDetails -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/organizationalMessageDetails -``` --### 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: 2510 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.organizationalMessageDetail", - "id": "affbf3ad-f3ad-affb-adf3-fbafadf3fbaf", - "scenario": "lifecycle", - "surface": "getStarted", - "status": "active", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "userEngagementStatistics": { - "@odata.type": "microsoft.graph.organizationalMessageInsights", - "impressions": 11, - "clicks": 6, - "dismisses": 9 - }, - "frequency": "monthlyOnce", - "targeting": { - "@odata.type": "microsoft.graph.organizationalMessageTargeting", - "targetingType": "unknownFutureValue", - "includeIds": [ - "Include Ids value" - ], - "excludeIds": [ - "Exclude Ids value" - ] - }, - "content": { - "@odata.type": "microsoft.graph.organizationalMessageContent", - "guidedContentId": "Guided Content Id value", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logoInfo": { - "@odata.type": "microsoft.graph.organizationalMessageLogo", - "logo": "bG9nbw==", - "contentType": "unknownFutureValue", - "logoCdnUrl": "https://example.com/logoCdnUrl/" - } - }, - "theme": "training", - "variant": "Variant value" - } - ] -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagedetail Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-organizationalmessagedetail-update.md | - Title: "Update organizationalMessageDetail" -description: "Update the properties of a organizationalMessageDetail object." --localization_priority: Normal -doc_type: apiPageType ---# Update organizationalMessageDetail --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) object. --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -PATCH /deviceManagement/organizationalMessageDetails/{organizationalMessageDetailId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) object. --The following table shows the properties that are required when you create the [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md). --|Property|Type|Description| -|:|:|:| -|id|String|A unique identifier for the organizational message| -|scenario|[organizationalMessageScenario](../resources/intune-partnerintegration-organizationalmessagescenario.md)|Indicates the scenario for the message. Possible values are: `onboarding`, `lifecycle`, `unknownFutureValue`.| -|surface|[organizationalMessageSurface](../resources/intune-partnerintegration-organizationalmessagesurface.md)|Indicates the area where content will be displayed to customers. Possible values are: `actionCenter`, `getStarted`, `softLanding`, `unknownFutureValue`.| -|status|[organizationalMessageStatus](../resources/intune-partnerintegration-organizationalmessagestatus.md)|Indicates the deployment status of the message. Possible values are: `scheduled`, `active`, `completed`, `cancelled`, `unknownFutureValue`.| -|startDateTime|DateTimeOffset|The date and time of when the message will start being displayed to clients| -|endDateTime|DateTimeOffset|The date and time of when the message will stop being displayed to clients| -|createdDateTime|DateTimeOffset|The date and time of when the message was created| -|lastModifiedDateTime|DateTimeOffset|The date and time of when the message was last modified| -|userEngagementStatistics|[organizationalMessageInsights](../resources/intune-partnerintegration-organizationalmessageinsights.md)|The statistics containing how the message was interacted with by clients. This includes the number of impressions, clicks, and dismisses from targeted clients.| -|frequency|[organizationalMessageFrequency](../resources/intune-partnerintegration-organizationalmessagefrequency.md)|The frequency at which a client will see the message. Possible values are: `weeklyOnce`, `monthlyOnce`, `monthlyTwice`, `unknownFutureValue`.| -|targeting|[organizationalMessageTargeting](../resources/intune-partnerintegration-organizationalmessagetargeting.md)|The groups of devices that will receive the message. This also contains a list of excluded groups that will not receive the message regardless of the device being part of an included group| -|content|[organizationalMessageContent](../resources/intune-partnerintegration-organizationalmessagecontent.md)|The content that will be displayed to clients for the message. This includes the text portion of the message and the displayed logo| -|theme|[organizationalMessageTheme](../resources/intune-partnerintegration-organizationalmessagetheme.md)|Indicates the theme for the experience. Possible values are: `update`, `training`, `welcomeToWindows`, `explore`, `unknownFutureValue`.| -|variant|String|Indicates the corresponding variant for the experience| ----## Response -If successful, this method returns a `200 OK` response code and an updated [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -PATCH https://graph.microsoft.com/beta/deviceManagement/organizationalMessageDetails/{organizationalMessageDetailId} -Content-type: application/json -Content-length: 2049 --{ - "@odata.type": "#microsoft.graph.organizationalMessageDetail", - "scenario": "lifecycle", - "surface": "getStarted", - "status": "active", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "userEngagementStatistics": { - "@odata.type": "microsoft.graph.organizationalMessageInsights", - "impressions": 11, - "clicks": 6, - "dismisses": 9 - }, - "frequency": "monthlyOnce", - "targeting": { - "@odata.type": "microsoft.graph.organizationalMessageTargeting", - "targetingType": "unknownFutureValue", - "includeIds": [ - "Include Ids value" - ], - "excludeIds": [ - "Exclude Ids value" - ] - }, - "content": { - "@odata.type": "microsoft.graph.organizationalMessageContent", - "guidedContentId": "Guided Content Id value", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logoInfo": { - "@odata.type": "microsoft.graph.organizationalMessageLogo", - "logo": "bG9nbw==", - "contentType": "unknownFutureValue", - "logoCdnUrl": "https://example.com/logoCdnUrl/" - } - }, - "theme": "training", - "variant": "Variant 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: 2221 --{ - "@odata.type": "#microsoft.graph.organizationalMessageDetail", - "id": "affbf3ad-f3ad-affb-adf3-fbafadf3fbaf", - "scenario": "lifecycle", - "surface": "getStarted", - "status": "active", - "startDateTime": "2016-12-31T23:58:46.7156189-08:00", - "endDateTime": "2017-01-01T00:03:30.9241974-08:00", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "userEngagementStatistics": { - "@odata.type": "microsoft.graph.organizationalMessageInsights", - "impressions": 11, - "clicks": 6, - "dismisses": 9 - }, - "frequency": "monthlyOnce", - "targeting": { - "@odata.type": "microsoft.graph.organizationalMessageTargeting", - "targetingType": "unknownFutureValue", - "includeIds": [ - "Include Ids value" - ], - "excludeIds": [ - "Exclude Ids value" - ] - }, - "content": { - "@odata.type": "microsoft.graph.organizationalMessageContent", - "guidedContentId": "Guided Content Id value", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logoInfo": { - "@odata.type": "microsoft.graph.organizationalMessageLogo", - "logo": "bG9nbw==", - "contentType": "unknownFutureValue", - "logoCdnUrl": "https://example.com/logoCdnUrl/" - } - }, - "theme": "training", - "variant": "Variant value" -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessageguidedcontent Create | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-organizationalmessageguidedcontent-create.md | - Title: "Create organizationalMessageGuidedContent" -description: "Create a new organizationalMessageGuidedContent object." --localization_priority: Normal -doc_type: apiPageType ---# Create organizationalMessageGuidedContent --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) object. --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/organizationalMessageGuidedContents -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the organizationalMessageGuidedContent object. --The following table shows the properties that are required when you create the organizationalMessageGuidedContent. --|Property|Type|Description| -|:|:|:| -|id|String|A unique identifier for the guided content| -|scenario|[organizationalMessageScenario](../resources/intune-partnerintegration-organizationalmessagescenario.md)|Indicates the scenario for the guided content. Possible values are: `onboarding`, `lifecycle`, `unknownFutureValue`.| -|theme|[organizationalMessageTheme](../resources/intune-partnerintegration-organizationalmessagetheme.md)|Indicates the theme for the guided content. Possible values are: `update`, `training`, `welcomeToWindows`, `explore`, `unknownFutureValue`.| -|surface|[organizationalMessageSurface](../resources/intune-partnerintegration-organizationalmessagesurface.md)|Indicates the area where content will be displayed to customers. Possible values are: `actionCenter`, `getStarted`, `softLanding`, `unknownFutureValue`.| -|placementDetails|[organizationalMessagePlacementDetail](../resources/intune-partnerintegration-organizationalmessageplacementdetail.md) collection|Contains the different types of text content that can be displayed to customers along with their localized values| -|logo|[organizationalMessageLogoGuide](../resources/intune-partnerintegration-organizationalmessagelogoguide.md)|Example of the logo that will be displayed to customers and its size requirements| ----## Response -If successful, this method returns a `201 Created` response code and a [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/organizationalMessageGuidedContents -Content-type: application/json -Content-length: 1403 --{ - "@odata.type": "#microsoft.graph.organizationalMessageGuidedContent", - "scenario": "lifecycle", - "theme": "training", - "surface": "getStarted", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logo": { - "@odata.type": "microsoft.graph.organizationalMessageLogoGuide", - "logoCdnUrl": "https://example.com/logoCdnUrl/", - "assetName": "Asset Name value", - "dimensions": { - "@odata.type": "microsoft.graph.organizationalMessageLogoDimensions", - "minWidth": 8, - "maxWidth": 8, - "minHeight": 9, - "maxHeight": 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. -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 1452 --{ - "@odata.type": "#microsoft.graph.organizationalMessageGuidedContent", - "id": "13e64843-4843-13e6-4348-e6134348e613", - "scenario": "lifecycle", - "theme": "training", - "surface": "getStarted", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logo": { - "@odata.type": "microsoft.graph.organizationalMessageLogoGuide", - "logoCdnUrl": "https://example.com/logoCdnUrl/", - "assetName": "Asset Name value", - "dimensions": { - "@odata.type": "microsoft.graph.organizationalMessageLogoDimensions", - "minWidth": 8, - "maxWidth": 8, - "minHeight": 9, - "maxHeight": 9 - } - } -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessageguidedcontent Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-organizationalmessageguidedcontent-delete.md | - Title: "Delete organizationalMessageGuidedContent" -description: "Deletes a organizationalMessageGuidedContent." --localization_priority: Normal -doc_type: apiPageType ---# Delete organizationalMessageGuidedContent --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md). --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -DELETE /deviceManagement/organizationalMessageGuidedContents/{organizationalMessageGuidedContentId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `204 No Content` response code. --## Example --### Request -Here is an example of the request. -``` http -DELETE https://graph.microsoft.com/beta/deviceManagement/organizationalMessageGuidedContents/{organizationalMessageGuidedContentId} -``` --### 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 Partnerintegration Organizationalmessageguidedcontent Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-organizationalmessageguidedcontent-get.md | - Title: "Get organizationalMessageGuidedContent" -description: "Read properties and relationships of the organizationalMessageGuidedContent object." --localization_priority: Normal -doc_type: apiPageType ---# Get organizationalMessageGuidedContent --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) object. --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, 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/organizationalMessageGuidedContents/{organizationalMessageGuidedContentId} -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/organizationalMessageGuidedContents/{organizationalMessageGuidedContentId} -``` --### 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: 1557 --{ - "value": { - "@odata.type": "#microsoft.graph.organizationalMessageGuidedContent", - "id": "13e64843-4843-13e6-4348-e6134348e613", - "scenario": "lifecycle", - "theme": "training", - "surface": "getStarted", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logo": { - "@odata.type": "microsoft.graph.organizationalMessageLogoGuide", - "logoCdnUrl": "https://example.com/logoCdnUrl/", - "assetName": "Asset Name value", - "dimensions": { - "@odata.type": "microsoft.graph.organizationalMessageLogoDimensions", - "minWidth": 8, - "maxWidth": 8, - "minHeight": 9, - "maxHeight": 9 - } - } - } -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessageguidedcontent List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-organizationalmessageguidedcontent-list.md | - Title: "List organizationalMessageGuidedContents" -description: "List properties and relationships of the organizationalMessageGuidedContent objects." --localization_priority: Normal -doc_type: apiPageType ---# List organizationalMessageGuidedContents --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) objects. --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, 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/organizationalMessageGuidedContents -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/organizationalMessageGuidedContents -``` --### 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: 1657 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.organizationalMessageGuidedContent", - "id": "13e64843-4843-13e6-4348-e6134348e613", - "scenario": "lifecycle", - "theme": "training", - "surface": "getStarted", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logo": { - "@odata.type": "microsoft.graph.organizationalMessageLogoGuide", - "logoCdnUrl": "https://example.com/logoCdnUrl/", - "assetName": "Asset Name value", - "dimensions": { - "@odata.type": "microsoft.graph.organizationalMessageLogoDimensions", - "minWidth": 8, - "maxWidth": 8, - "minHeight": 9, - "maxHeight": 9 - } - } - } - ] -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessageguidedcontent Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-partnerintegration-organizationalmessageguidedcontent-update.md | - Title: "Update organizationalMessageGuidedContent" -description: "Update the properties of a organizationalMessageGuidedContent object." --localization_priority: Normal -doc_type: apiPageType ---# Update organizationalMessageGuidedContent --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) object. --## Prerequisites -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -PATCH /deviceManagement/organizationalMessageGuidedContents/{organizationalMessageGuidedContentId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer <token> Required.| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) object. --The following table shows the properties that are required when you create the [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md). --|Property|Type|Description| -|:|:|:| -|id|String|A unique identifier for the guided content| -|scenario|[organizationalMessageScenario](../resources/intune-partnerintegration-organizationalmessagescenario.md)|Indicates the scenario for the guided content. Possible values are: `onboarding`, `lifecycle`, `unknownFutureValue`.| -|theme|[organizationalMessageTheme](../resources/intune-partnerintegration-organizationalmessagetheme.md)|Indicates the theme for the guided content. Possible values are: `update`, `training`, `welcomeToWindows`, `explore`, `unknownFutureValue`.| -|surface|[organizationalMessageSurface](../resources/intune-partnerintegration-organizationalmessagesurface.md)|Indicates the area where content will be displayed to customers. Possible values are: `actionCenter`, `getStarted`, `softLanding`, `unknownFutureValue`.| -|placementDetails|[organizationalMessagePlacementDetail](../resources/intune-partnerintegration-organizationalmessageplacementdetail.md) collection|Contains the different types of text content that can be displayed to customers along with their localized values| -|logo|[organizationalMessageLogoGuide](../resources/intune-partnerintegration-organizationalmessagelogoguide.md)|Example of the logo that will be displayed to customers and its size requirements| ----## Response -If successful, this method returns a `200 OK` response code and an updated [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -PATCH https://graph.microsoft.com/beta/deviceManagement/organizationalMessageGuidedContents/{organizationalMessageGuidedContentId} -Content-type: application/json -Content-length: 1403 --{ - "@odata.type": "#microsoft.graph.organizationalMessageGuidedContent", - "scenario": "lifecycle", - "theme": "training", - "surface": "getStarted", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logo": { - "@odata.type": "microsoft.graph.organizationalMessageLogoGuide", - "logoCdnUrl": "https://example.com/logoCdnUrl/", - "assetName": "Asset Name value", - "dimensions": { - "@odata.type": "microsoft.graph.organizationalMessageLogoDimensions", - "minWidth": 8, - "maxWidth": 8, - "minHeight": 9, - "maxHeight": 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. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 1452 --{ - "@odata.type": "#microsoft.graph.organizationalMessageGuidedContent", - "id": "13e64843-4843-13e6-4348-e6134348e613", - "scenario": "lifecycle", - "theme": "training", - "surface": "getStarted", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "card0", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "Variant Id value", - "name": "Name value", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "Locale value", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "Title value", - "message": "Message value", - "clickUrl": "https://example.com/clickUrl/", - "buttonText": "Button Text value" - } - } - ] - } - ] - } - ], - "logo": { - "@odata.type": "microsoft.graph.organizationalMessageLogoGuide", - "logoCdnUrl": "https://example.com/logoCdnUrl/", - "assetName": "Asset Name value", - "dimensions": { - "@odata.type": "microsoft.graph.organizationalMessageLogoDimensions", - "minWidth": 8, - "maxWidth": 8, - "minHeight": 9, - "maxHeight": 9 - } - } -} -``` ----- |
| v1.0 | Managedtenants Auditevent Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-auditevent-get.md | Title: "Get auditEvent" description: "Read the properties and relationships of an auditEvent object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Cloudpcconnection Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-cloudpcconnection-get.md | Title: "Get cloudPcConnection" description: "Read the properties and relationships of a cloudPcConnection object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Cloudpcdevice Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-cloudpcdevice-get.md | Title: "Get cloudPcDevice" description: "Read the properties and relationships of a cloudPcDevice object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Cloudpcoverview Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-cloudpcoverview-get.md | Title: "Get cloudPcOverview" description: "Read the properties and relationships of a cloudPcOverview object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Conditionalaccesspolicycoverage Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-conditionalaccesspolicycoverage-get.md | Title: "Get conditionalAccessPolicyCoverage" description: "Read the properties and relationships of a conditionalAccessPolicyCoverage object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Credentialuserregistrationssummary Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-credentialuserregistrationssummary-get.md | Title: "Get credentialUserRegistrationsSummary" description: "Read the properties and relationships of a credentialUserRegistrationsSummary object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Devicecompliancepolicysettingstatesummary Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-devicecompliancepolicysettingstatesummary-get.md | Title: "Get deviceCompliancePolicySettingStateSummary" description: "Read the properties and relationships of a deviceCompliancePolicySettingStateSummary object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Manageddevicecompliance Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-manageddevicecompliance-get.md | Title: "Get managedDeviceCompliance" description: "Read the properties and relationships of a managedDeviceCompliance object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Manageddevicecompliancetrend Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-manageddevicecompliancetrend-get.md | Title: "Get managedDeviceComplianceTrend" description: "Read the properties and relationships of a managedDeviceComplianceTrend object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Aggregatedpolicycompliances | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-aggregatedpolicycompliances.md | Title: "List aggregatedPolicyCompliances" description: "Get a list of the aggregatedPolicyCompliance objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Auditevents | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-auditevents.md | Title: "List auditEvents" description: "Get a list of the auditEvent objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Cloudpcconnections | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-cloudpcconnections.md | Title: "List cloudPcConnections" description: "Get a list of the cloudPcConnection objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Cloudpcdevices | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-cloudpcdevices.md | Title: "List cloudPcDevices" description: "Get a list of the cloudPcDevice objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Cloudpcsoverview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-cloudpcsoverview.md | Title: "List cloudPcOverviews" description: "Get a list of the cloudPcOverview objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Conditionalaccesspolicycoverages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-conditionalaccesspolicycoverages.md | Title: "List conditionalAccessPolicyCoverages" description: "Get a list of the conditionalAccessPolicyCoverage objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Credentialuserregistrationssummaries | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-credentialuserregistrationssummaries.md | Title: "List credentialUserRegistrationsSummaries" description: "Get a list of the credentialUserRegistrationsSummary objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Devicecompliancepolicysettingstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-devicecompliancepolicysettingstatesummary.md | Title: "List deviceCompliancePolicySettingStateSummary" description: "Get a list of the deviceCompliancePolicySettingStateSummary objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Manageddevicecompliances | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-manageddevicecompliances.md | Title: "List managedDeviceCompliances" description: "Get a list of the managedDeviceCompliance objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Manageddevicecompliancetrends | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-manageddevicecompliancetrends.md | Title: "List managedDeviceComplianceTrends" description: "Get a list of the managedDeviceComplianceTrend objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Managementactions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-managementactions.md | Title: "List managementActions" description: "Get a list of the managementAction objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Managementactiontenantdeploymentstatuses | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-managementactiontenantdeploymentstatuses.md | Title: "List managementActionTenantDeploymentStatus" description: "Get a list of the managementActionTenantDeploymentStatus objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Managementintents | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-managementintents.md | Title: "List managementIntents" description: "Get a list of the managementIntent objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Managementtemplates | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-managementtemplates.md | Title: "List managementTemplates" description: "Get a list of the managementTemplate objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Myroles | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-myroles.md | Title: "List myRoles" description: "Get the roles that a signed-in user has through a delegated relationship across managed tenants." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Tenantgroups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenantgroups.md | Title: "List tenantGroups" description: "Get a list of the tenantGroup objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Tenants | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenants.md | Title: "List tenants" description: "Get a list of the tenant objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Tenantscustomizedinformation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenantscustomizedinformation.md | Title: "List tenantCustomizedInformation" description: "Get a list of the tenantCustomizedInformation objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Tenantsdetailedinformation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenantsdetailedinformation.md | Title: "List tenantDetailedInformation" description: "Get a list of the tenantDetailedInformation objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Tenanttags | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenanttags.md | Title: "List tenantTags" description: "Get a list of the tenantTag objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Tenantusage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenantusage.md | Title: "List tenantUsage" description: "Get a list of the tenantUsage objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Windowsdevicemalwarestates | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-windowsdevicemalwarestates.md | Title: "List windowsDeviceMalwareStates" description: "Get a list of the windowsDeviceMalwareState objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant List Windowsprotectionstates | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-windowsprotectionstates.md | Title: "List windowsProtectionStates" description: "Get a list of the windowsProtectionState objects and their properties." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managedtenant Post Tenanttags | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-post-tenanttags.md | Title: "Create tenantTag" description: "Create a new tenantTag object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managementaction Apply | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managementaction-apply.md | Title: "managementAction: apply" description: "Applies a management action against a specific managed tenant. By performing this operation the appropriate configurations will be made and policies created. As example when applying the require multi-factor authentication for admins management action will create an Azure Active Directory conditional access policy that requires multi-factor authentication for all users that have been assigned an administrative directory role." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managementaction Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managementaction-get.md | Title: "Get managementAction" description: "Read the properties and relationships of a managementAction object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managementactiontenantdeploymentstatus Changedeploymentstatus | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managementactiontenantdeploymentstatus-changedeploymentstatus.md | Title: "managementActionTenantDeploymentStatus: changeDeploymentStatus" description: "Changes the tenant level deployment status for the management action. This information is used to provide insights into what management actions are in a specific state. As example there might be a plan to apply the require multi-factor authentication for admins, so it would be ideal to change the status to planned to reflect the appropriate status." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managementactiontenantdeploymentstatus Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managementactiontenantdeploymentstatus-get.md | Title: "Get managementActionTenantDeploymentStatus" description: "Read the properties and relationships of a managementActionTenantDeploymentStatus object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managementintent Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managementintent-get.md | Title: "Get managementIntent" description: "Read the properties and relationships of a managementIntent object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Managementtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managementtemplate-get.md | Title: "Get managementTemplate" description: "Read the properties and relationships of a managementTemplate object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenant Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenant-get.md | Title: "Get tenant" description: "Read the properties and relationships of a tenant object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenant Offboardtenant | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenant-offboardtenant.md | Title: "tenant: offboardTenant" description: "Carries out the appropriate procedures to remove a managed tenant from the multi-tenant management platform. No relationships, such as commerce and delegate administrative privileges, will be impacted. The only change made by invoking this action is the tenant will be deprovisioned from the multi-tenant management platform." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenant Resettenantonboardingstatus | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenant-resettenantonboardingstatus.md | Title: "tenant: resetTenantOnboardingStatus" description: "Carries out the appropriate procedures to reset the onboarding status for the managed tenant that was removed from the multi-tenant management platform using the offboardTenant action. By invoking this action the platform will attempt to onboard the managed tenant for management." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenantcustomizedinformation Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenantcustomizedinformation-get.md | Title: "Get tenantCustomizedInformation" description: "Read the properties and relationships of a tenantCustomizedInformation object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenantcustomizedinformation Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenantcustomizedinformation-update.md | Title: "Update tenantCustomizedInformation" description: "Update the properties of a tenantCustomizedInformation object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenantdetailedinformation Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenantdetailedinformation-get.md | Title: "Get tenantDetailedInformation" description: "Read the properties and relationships of a tenantDetailedInformation object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenantgroup Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenantgroup-get.md | Title: "Get tenantGroup" description: "Read the properties and relationships of a tenantGroup object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenantgroup Tenantsearch | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenantgroup-tenantsearch.md | Title: "tenantGroup: tenantSearch" description: "Searches for the specified managed tenants across tenant groups." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenanttag Assigntag | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenanttag-assigntag.md | Title: "tenantTag: assignTag" description: "Assign the tenant tag to the specified managed tenants." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenanttag Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenanttag-delete.md | Title: "Delete tenantTag" description: "Delete a tenantTag object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenanttag Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenanttag-get.md | Title: "Get tenantTag" description: "Read the properties and relationships of a tenantTag object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenanttag Unassigntag | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenanttag-unassigntag.md | Title: "tenantTag: unassignTag" description: "Un-assigns the tenant tag from the specified managed tenants." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Tenanttag Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenanttag-update.md | Title: "Update tenantTag" description: "Update the properties of a tenantTag object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Windowsdevicemalwarestate Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-windowsdevicemalwarestate-get.md | Title: "Get windowsDeviceMalwareState" description: "Read the properties and relationships of a windowsDeviceMalwareState object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Managedtenants Windowsprotectionstate Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-windowsprotectionstate-get.md | Title: "Get windowsProtectionState" description: "Read the properties and relationships of a windowsProtectionState object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Oauth2permissiongrant Delta | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/oauth2permissiongrant-delta.md | One of the following permissions is required to call this API. To learn more, in |:--|:| |Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |-|oauth2permissiongrant | Directory.Read.All, DelegatedPermissionGrant.ReadWrite.All, Directory.ReadWrite.All | +|Application | Directory.Read.All, DelegatedPermissionGrant.ReadWrite.All, Directory.ReadWrite.All | ## HTTP request GET /oauth2PermissionGrants/delta ## Query parameters -Tracking changes incurs a round of one or more **delta** function calls. If you use any query parameter -(other than `$deltatoken` and `$skiptoken`), you must specify -it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters -into the token portion of the `@odata.nextLink` or `@odata.deltaLink` URL provided in the response. -You only need to specify any query parameters once up front. -In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response. That URL already +Tracking changes incurs a round of one or more **delta** function calls. If you use any query parameter +(other than `$deltatoken` and `$skiptoken`), you must specify +it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters +into the token portion of the `@odata.nextLink` or `@odata.deltaLink` URL provided in the response. +You only need to specify any query parameters once up front. +In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response. That URL already includes the encoded parameters. | Query parameter | Type |Description| GET https://graph.microsoft.com/beta/oauth2PermissionGrants/delta ### Response >**Note:** The response object shown here might be shortened for readability.-<!-- { +<!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.oAuth2PermissionGrant",- "isCollection": true -} --> + "isCollection": true +} --> ```http HTTP/1.1 200 OK Content-type: application/json |
| v1.0 | Plannerbucket List Tasks | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerbucket-list-tasks.md | Title: "List tasks" -description: "Retrieve a list of **plannerTask** objects associated to a plannerBucket object." +description: "Retrieve a list of plannerTask objects associated to a plannerBucket object." ms.localizationpriority: medium ms.prod: "planner" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve a list of **plannerTask** objects associated to a [plannerBucket](../resources/plannerbucket.md) object. +Retrieve a list of [plannerTask](../resources/plannertask.md) objects associated to a [plannerBucket](../resources/plannerbucket.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). Do not 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. +If successful, this method returns a `200 OK` response code and a 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). ## Example-##### Request -Here is an example of the request. +### Request +The following is an example of the request. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/beta/planner/buckets/gcrYAaAkgU2EQUvpkNNXLGQAGTt -##### Response -Here is an example of the response. Note: The response object shown here might be shortened for readability. +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, |
| v1.0 | Plannertask Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannertask-get.md | Title: "Get plannerTask" -description: "Retrieve the properties and relationships of **plannertask** object." +description: "Retrieve the properties and relationships of plannerTask object." ms.localizationpriority: medium ms.prod: "planner" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve the properties and relationships of **plannertask** object. +Retrieve the properties and relationships of [plannerTask](../resources/plannertask.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). Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [plannerTask](../resources/plannertask.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [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 403 and 404 responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions). ## Example-##### Request -Here is an example of the request. +### Request +The following is an example of the request. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/beta/planner/tasks/01gzSlKkIUSUl6DF_EilrmQAKDhh -##### Response -Here is an example of the response. Note: The response object shown here might be shortened for readability. +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, |
| v1.0 | Presence Setpresence | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/presence-setpresence.md | Similarly, an application can have its own presence session for a user and be ab The following is the precedence for how session states are aggregated, with "A > B" representing A having precedence over B: * User-preferred state > session-level states (user-preferred state overrides session-level states)-* Among session-level states: DoNotDisturb (currently not supported for **setPresence**) > Busy > Available > Away +* Among session-level states: DoNotDisturb > Busy > Available > Away ### Timeout, expiration, and keep alive A presence session may **time out** and **expire**, so the application needs to call this API before the **timeout**, to maintain the state for the session; or before the **expiration**, to keep the session alive. In the request body, provide a JSON object with the following parameters. Supported combinations of `availability` and `activity` are: -| availability | activity | Description | -| :-- | :- | :- | -| Available | Available | Updates the presence session as Available. | -| Busy | InACall | Updates the presence session as Busy, InACall. | -| Busy | InAConferenceCall | Updates the presence session as Busy, InAConferenceCall. | -| Away | Away | Updates the presence session as Away. | +| availability | activity | Description | +| :-- | :- | :-- | +| Available | Available | Updates the presence session as Available. | +| Busy | InACall | Updates the presence session as Busy, InACall. | +| Busy | InAConferenceCall | Updates the presence session as Busy, InAConferenceCall. | +| Away | Away | Updates the presence session as Away. | +| DoNotDisturb | Presenting | Updates the presence session as DoNotDisturb, Presenting. | ## Response If successful, this method returns a `200 OK` response code. |
| v1.0 | Security Ediscoverycase Post Legalholds | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-ediscoverycase-post-legalholds.md | You can specify the following properties when you create an **ediscoveryHoldPoli |:|:|:| |displayName|String|The display name of the legal hold policy. Required.| |description|String|The description of the legal hold policy. Optional.|-|contentQuery|String|The content query of the legal hold policy. Optional.| ## Response Content-Type: application/json { "displayname": "My legalHold with sources", "description": "Created from Graph API",- "contentQuery": "Bazooka", "userSources@odata.bind": [ { "@odata.type": "microsoft.graph.security.userSource", Content-Type: application/json "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/legalHolds/$entity", "isEnabled": true, "errors": [],- "contentQuery": "Bazooka", "description": "Created from Graph API", "createdDateTime": "2022-05-23T03:54:11.1Z", "lastModifiedDateTime": "2022-05-23T03:54:11.1Z", |
| v1.0 | Security Ediscoveryholdpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-ediscoveryholdpolicy-update.md | PATCH /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryH |Property|Type|Description| |:|:|:| |description|String|The description of the legal hold policy. Optional.|-|contentQuery|String|The content query of the legal hold policy. Optional.| ## Response PATCH https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4 { "description": "updated description",- "contentQuery": "bazooka bazooka" } ``` |
| v1.0 | Sites List Followed | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/sites-list-followed.md | Namespace: microsoft.graph List the [sites](../resources/site.md) that have been followed by the signed in user. +>**Note:** This API has a [known issue](/graph/known-issues#sites-and-lists-sharepoint) and might return incorrect results. + ## Permissions 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 | Team Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/team-get.md | One of the following permissions is required to call this API. To learn more, in |Delegated (work or school account) | Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All, Group.Read.All**, Group.ReadWrite.All**, Directory.Read.All**, Directory.ReadWrite.All** | |Delegated (personal Microsoft account) | Not supported. | |Application | TeamSettings.Read.Group*, TeamSettings.ReadWrite.Group*, Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All, Group.Read.All**, Group.ReadWrite.All**, Directory.Read.All**, Directory.ReadWrite.All** |+ [!INCLUDE [teamwork-permissions-note](../../../includes/teamwork-permissions-note.md)] > **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. |
| v1.0 | User List People | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-list-people.md | This method supports the following OData query parameters to help customize the |:|:--|:-| |$filter|string|Limits the response to only those people whose record contains the specified criteria.| |$orderby|string|By default the people in the response are sorted by their relevance to your query. You can change the order of the people in the response using the *$orderby* parameter.|-|$search|string|Search for people by name or alias. Supports Fuzzy matching. Parameter only works for searching the signed-in user's relevant people, not for searching people relevant to other users. Also supports the `topic` keyword to find people based on topics extracted from e-mail conversations with that person. See the *Perform a fuzzy search* section at [Get relevant information about people](/graph/people-example#perform-a-fuzzy-search) for information and examples.| +|$search|string|Search for people by name or alias. Supports Fuzzy matching. Parameter only works for searching the signed-in user's relevant people, not for searching people relevant to other users. Also supports the `topic` keyword to find people based on topics extracted from e-mail conversations with that person. For information and examples, see the *Perform a fuzzy search* section at [Use the People API to get information about the people most relevant to you](/graph/people-insights-overview#perform-a-fuzzy-search).| |$select|string|Comma-separated list of properties to include in the response. For optimal performance, only select the subset of properties needed.| |$skip|int|Skip the first n results, useful for paging. This is not supported when using *$search*.| |$top|int|Number of results to be returned.| |
| v1.0 | Enums Managedtenants | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/enums-managedtenants.md | Title: "Multi-tenant management enumeration values" description: "Microsoft Graph multi-tenant management enumeration values" ms.localizationpriority: medium doc_type: enumTypes |
| v1.0 | Group | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/group.md | This resource supports: | [List deleted groups](../api/directory-deleteditems-list.md) | [directoryObject](directoryobject.md) collection | Retrieve the groups deleted in the tenant in the last 30 days. | | [List deleted groups owned by user](../api/directory-deleteditems-getuserownedobjects.md) | [directoryObject](directoryobject.md) collection | Retrieve the groups deleted in the tenant in the last 30 days and that are owned by a user. | | [Get deleted group](../api/directory-deleteditems-get.md) | [directoryObject](directoryobject.md) collection | Retrieve a deleted group by ID. |-| [Restore deleted group](../api/directory-deleteditems-delete.md) | [directoryObject](directoryobject.md) collection | Restore a group deleted in the tenant in the last 30 days. | -| [Permanently delete group](../api/directory-deleteditems-restore.md) | [directoryObject](directoryobject.md) collection | Permanently delete a deleted group from the tenant. | +| [Restore deleted group](../api/directory-deleteditems-restore.md) | [directoryObject](directoryobject.md) collection | Restore a group deleted in the tenant in the last 30 days. | +| [Permanently delete group](../api/directory-deleteditems-delete.md) | [directoryObject](directoryobject.md) collection | Permanently delete a deleted group from the tenant. | | [checkMemberGroups](../api/directoryobject-checkmembergroups.md) | String collection | Check for membership in a list of groups. The function is transitive. | | [getMemberGroups](../api/directoryobject-getmembergroups.md) | String collection | Return all the groups that the group is a member of. The function is transitive. | | [checkMemberObjects](../api/directoryobject-checkmemberobjects.md) | String collection | Check for membership in a list of group, directory role, or administrative unit objects. The function is transitive. | |
| v1.0 | Intune Partnerintegration Organizationalmessagecontent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagecontent.md | - Title: "organizationalMessageContent resource type" -description: "Contains the entire content of the message that will be displayed to the clients" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageContent resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Contains the entire content of the message that will be displayed to the clients --## Properties -|Property|Type|Description| -|:|:|:| -|guidedContentId|String|The ID of the guided content that this content is using| -|placementDetails|[organizationalMessagePlacementDetail](../resources/intune-partnerintegration-organizationalmessageplacementdetail.md) collection|Contains the different types of text content that can be displayed to customers along with their localized values| -|logoInfo|[organizationalMessageLogo](../resources/intune-partnerintegration-organizationalmessagelogo.md)|The logo that will be displayed to the clients. This will contain ether the binary contents of the logo or a url to the logo's location| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessageContent" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageContent", - "guidedContentId": "String", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "String", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "String", - "name": "String", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "String", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "String", - "message": "String", - "clickUrl": "String", - "buttonText": "String" - } - } - ] - } - ] - } - ], - "logoInfo": { - "@odata.type": "microsoft.graph.organizationalMessageLogo", - "logo": "binary", - "contentType": "String", - "logoCdnUrl": "String" - } -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagedetail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagedetail.md | - Title: "organizationalMessageDetail resource type" -description: "This will allow the admin to see the specific details of an organizational message that has been created for their tenant" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageDetail resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --This will allow the admin to see the specific details of an organizational message that has been created for their tenant --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List organizationalMessageDetails](../api/intune-partnerintegration-organizationalmessagedetail-list.md)|[organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) collection|List properties and relationships of the [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) objects.| -|[Get organizationalMessageDetail](../api/intune-partnerintegration-organizationalmessagedetail-get.md)|[organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md)|Read properties and relationships of the [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) object.| -|[Create organizationalMessageDetail](../api/intune-partnerintegration-organizationalmessagedetail-create.md)|[organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md)|Create a new [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) object.| -|[Delete organizationalMessageDetail](../api/intune-partnerintegration-organizationalmessagedetail-delete.md)|None|Deletes a [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md).| -|[Update organizationalMessageDetail](../api/intune-partnerintegration-organizationalmessagedetail-update.md)|[organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md)|Update the properties of a [organizationalMessageDetail](../resources/intune-partnerintegration-organizationalmessagedetail.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|A unique identifier for the organizational message| -|scenario|[organizationalMessageScenario](../resources/intune-partnerintegration-organizationalmessagescenario.md)|Indicates the scenario for the message. Possible values are: `onboarding`, `lifecycle`, `unknownFutureValue`.| -|surface|[organizationalMessageSurface](../resources/intune-partnerintegration-organizationalmessagesurface.md)|Indicates the area where content will be displayed to customers. Possible values are: `actionCenter`, `getStarted`, `softLanding`, `unknownFutureValue`.| -|status|[organizationalMessageStatus](../resources/intune-partnerintegration-organizationalmessagestatus.md)|Indicates the deployment status of the message. Possible values are: `scheduled`, `active`, `completed`, `cancelled`, `unknownFutureValue`.| -|startDateTime|DateTimeOffset|The date and time of when the message will start being displayed to clients| -|endDateTime|DateTimeOffset|The date and time of when the message will stop being displayed to clients| -|createdDateTime|DateTimeOffset|The date and time of when the message was created| -|lastModifiedDateTime|DateTimeOffset|The date and time of when the message was last modified| -|userEngagementStatistics|[organizationalMessageInsights](../resources/intune-partnerintegration-organizationalmessageinsights.md)|The statistics containing how the message was interacted with by clients. This includes the number of impressions, clicks, and dismisses from targeted clients.| -|frequency|[organizationalMessageFrequency](../resources/intune-partnerintegration-organizationalmessagefrequency.md)|The frequency at which a client will see the message. Possible values are: `weeklyOnce`, `monthlyOnce`, `monthlyTwice`, `unknownFutureValue`.| -|targeting|[organizationalMessageTargeting](../resources/intune-partnerintegration-organizationalmessagetargeting.md)|The groups of devices that will receive the message. This also contains a list of excluded groups that will not receive the message regardless of the device being part of an included group| -|content|[organizationalMessageContent](../resources/intune-partnerintegration-organizationalmessagecontent.md)|The content that will be displayed to clients for the message. This includes the text portion of the message and the displayed logo| -|theme|[organizationalMessageTheme](../resources/intune-partnerintegration-organizationalmessagetheme.md)|Indicates the theme for the experience. Possible values are: `update`, `training`, `welcomeToWindows`, `explore`, `unknownFutureValue`.| -|variant|String|Indicates the corresponding variant for the experience| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.organizationalMessageDetail" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageDetail", - "id": "String (identifier)", - "scenario": "String", - "surface": "String", - "status": "String", - "startDateTime": "String (timestamp)", - "endDateTime": "String (timestamp)", - "createdDateTime": "String (timestamp)", - "lastModifiedDateTime": "String (timestamp)", - "userEngagementStatistics": { - "@odata.type": "microsoft.graph.organizationalMessageInsights", - "impressions": 1024, - "clicks": 1024, - "dismisses": 1024 - }, - "frequency": "String", - "targeting": { - "@odata.type": "microsoft.graph.organizationalMessageTargeting", - "targetingType": "String", - "includeIds": [ - "String" - ], - "excludeIds": [ - "String" - ] - }, - "content": { - "@odata.type": "microsoft.graph.organizationalMessageContent", - "guidedContentId": "String", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "String", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "String", - "name": "String", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "String", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "String", - "message": "String", - "clickUrl": "String", - "buttonText": "String" - } - } - ] - } - ] - } - ], - "logoInfo": { - "@odata.type": "microsoft.graph.organizationalMessageLogo", - "logo": "binary", - "contentType": "String", - "logoCdnUrl": "String" - } - }, - "theme": "String", - "variant": "String" -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagefrequency | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagefrequency.md | - Title: "organizationalMessageFrequency enum type" -description: "Indicates the frequency at which a client will see the message" --localization_priority: Normal -doc_type: enumPageType ---# organizationalMessageFrequency enum type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Indicates the frequency at which a client will see the message --## Members -|Member|Value|Description| -|:|:|:| -|weeklyOnce|0|Indicates that the message will be displayed once a week| -|monthlyOnce|1|Indicates that the message will be displayed once a month| -|monthlyTwice|2|Indicates that the message will be displayed twice a month| -|unknownFutureValue|3|UnknownFutureValue, Evolvable enumeration sentinel value. Do not use.| ----- |
| v1.0 | Intune Partnerintegration Organizationalmessageguidedcontent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessageguidedcontent.md | - Title: "organizationalMessageGuidedContent resource type" -description: "This will allow the admin to see the different templated organizational messages that can be created" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageGuidedContent resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --This will allow the admin to see the different templated organizational messages that can be created --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List organizationalMessageGuidedContents](../api/intune-partnerintegration-organizationalmessageguidedcontent-list.md)|[organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) collection|List properties and relationships of the [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) objects.| -|[Get organizationalMessageGuidedContent](../api/intune-partnerintegration-organizationalmessageguidedcontent-get.md)|[organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md)|Read properties and relationships of the [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) object.| -|[Create organizationalMessageGuidedContent](../api/intune-partnerintegration-organizationalmessageguidedcontent-create.md)|[organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md)|Create a new [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) object.| -|[Delete organizationalMessageGuidedContent](../api/intune-partnerintegration-organizationalmessageguidedcontent-delete.md)|None|Deletes a [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md).| -|[Update organizationalMessageGuidedContent](../api/intune-partnerintegration-organizationalmessageguidedcontent-update.md)|[organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md)|Update the properties of a [organizationalMessageGuidedContent](../resources/intune-partnerintegration-organizationalmessageguidedcontent.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|A unique identifier for the guided content| -|scenario|[organizationalMessageScenario](../resources/intune-partnerintegration-organizationalmessagescenario.md)|Indicates the scenario for the guided content. Possible values are: `onboarding`, `lifecycle`, `unknownFutureValue`.| -|theme|[organizationalMessageTheme](../resources/intune-partnerintegration-organizationalmessagetheme.md)|Indicates the theme for the guided content. Possible values are: `update`, `training`, `welcomeToWindows`, `explore`, `unknownFutureValue`.| -|surface|[organizationalMessageSurface](../resources/intune-partnerintegration-organizationalmessagesurface.md)|Indicates the area where content will be displayed to customers. Possible values are: `actionCenter`, `getStarted`, `softLanding`, `unknownFutureValue`.| -|placementDetails|[organizationalMessagePlacementDetail](../resources/intune-partnerintegration-organizationalmessageplacementdetail.md) collection|Contains the different types of text content that can be displayed to customers along with their localized values| -|logo|[organizationalMessageLogoGuide](../resources/intune-partnerintegration-organizationalmessagelogoguide.md)|Example of the logo that will be displayed to customers and its size requirements| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.organizationalMessageGuidedContent" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageGuidedContent", - "id": "String (identifier)", - "scenario": "String", - "theme": "String", - "surface": "String", - "placementDetails": [ - { - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail", - "placement": "String", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "String", - "name": "String", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "String", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "String", - "message": "String", - "clickUrl": "String", - "buttonText": "String" - } - } - ] - } - ] - } - ], - "logo": { - "@odata.type": "microsoft.graph.organizationalMessageLogoGuide", - "logoCdnUrl": "String", - "assetName": "String", - "dimensions": { - "@odata.type": "microsoft.graph.organizationalMessageLogoDimensions", - "minWidth": 1024, - "maxWidth": 1024, - "minHeight": 1024, - "maxHeight": 1024 - } - } -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessageinsights | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessageinsights.md | - Title: "organizationalMessageInsights resource type" -description: "Contains statistics into how the organizational message was interacted with by clients" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageInsights resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is 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 statistics into how the organizational message was interacted with by clients --## Properties -|Property|Type|Description| -|:|:|:| -|impressions|Int32|The number of times this message was shown to all clients| -|clicks|Int32|The number of times this message was clicked on| -|dismisses|Int32|The number of times this message was dismissed by a user. This may not be collected for some surfaces and will be null| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessageInsights" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageInsights", - "impressions": 1024, - "clicks": 1024, - "dismisses": 1024 -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagelocalizedtext | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagelocalizedtext.md | - Title: "organizationalMessageLocalizedText resource type" -description: "Contains the text to be displayed for a given locale" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageLocalizedText resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Contains the text to be displayed for a given locale --## Properties -|Property|Type|Description| -|:|:|:| -|locale|String|The locale for this text| -|text|[organizationalMessageText](../resources/intune-partnerintegration-organizationalmessagetext.md)|The text that will be displayed to a user from this specific locale| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageLocalizedText", - "locale": "String", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "String", - "message": "String", - "clickUrl": "String", - "buttonText": "String" - } -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagelogo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagelogo.md | - Title: "organizationalMessageLogo resource type" -description: "Contains the logo's binary content or a url to the logo's downloadable location. Either both logo and contentType contain valid values or logoCdnUrl contains a valid url" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageLogo resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Contains the logo's binary content or a url to the logo's downloadable location. Either both logo and contentType contain valid values or logoCdnUrl contains a valid url --## Properties -|Property|Type|Description| -|:|:|:| -|logo|Binary|The binary contents of the logo. This is null when logoCdnUrl is used to send the logo| -|contentType|[organizationalMessageLogoType](../resources/intune-partnerintegration-organizationalmessagelogotype.md)|The content type of the logo that is contained in the logo array. This is null when logoCdnUrl is used to send the logo. Possible values are: `png`, `unknownFutureValue`.| -|logoCdnUrl|String|The url at which the logo resides. This is null when logo and contentType are used to send the logo| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessageLogo" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageLogo", - "logo": "binary", - "contentType": "String", - "logoCdnUrl": "String" -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagelogodimensions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagelogodimensions.md | - Title: "organizationalMessageLogoDimensions resource type" -description: "Contains the required size dimensions of a logo" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageLogoDimensions resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Contains the required size dimensions of a logo --## Properties -|Property|Type|Description| -|:|:|:| -|minWidth|Int32|Minimum width of the logo| -|maxWidth|Int32|Maximum width of the logo| -|minHeight|Int32|Minimum height of the logo| -|maxHeight|Int32|Maximum height of the logo| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessageLogoDimensions" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageLogoDimensions", - "minWidth": 1024, - "maxWidth": 1024, - "minHeight": 1024, - "maxHeight": 1024 -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagelogoguide | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagelogoguide.md | - Title: "organizationalMessageLogoGuide resource type" -description: "Example logo and its size requirements" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageLogoGuide resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Example logo and its size requirements --## Properties -|Property|Type|Description| -|:|:|:| -|logoCdnUrl|String|The url at which the logo resides| -|assetName|String|The asset name is the key for this specific logo. This is used to compute the required token when accessing the logoCdnUrl to fetch the logo| -|dimensions|[organizationalMessageLogoDimensions](../resources/intune-partnerintegration-organizationalmessagelogodimensions.md)|The required size dimensions of the logo| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessageLogoGuide" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageLogoGuide", - "logoCdnUrl": "String", - "assetName": "String", - "dimensions": { - "@odata.type": "microsoft.graph.organizationalMessageLogoDimensions", - "minWidth": 1024, - "maxWidth": 1024, - "minHeight": 1024, - "maxHeight": 1024 - } -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagelogotype | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagelogotype.md | - Title: "organizationalMessageLogoType enum type" -description: "Indicates the content type of the logo" --localization_priority: Normal -doc_type: enumPageType ---# organizationalMessageLogoType enum type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Indicates the content type of the logo --## Members -|Member|Value|Description| -|:|:|:| -|png|0|Indicates that logo is a png file| -|unknownFutureValue|1|UnknownFutureValue, Evolvable enumeration sentinel value. Do not use.| ----- |
| v1.0 | Intune Partnerintegration Organizationalmessageplacement | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessageplacement.md | - Title: "organizationalMessagePlacement enum type" -description: "Indicates the name of the placement" --localization_priority: Normal -doc_type: enumPageType ---# organizationalMessagePlacement enum type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Indicates the name of the placement --## Members -|Member|Value|Description| -|:|:|:| -|default|0|Indicates the default area for text to be displayed. This is the only valid placement value for the actionCenter and softLanding surfaces| -|card0|1|Indicates the area where the first card is displayed. Only applies to the getStarted surface| -|card1|2|Indicates the area where the second card is displayed. Only applies to the getStarted surface| -|card2|3|Indicates the area where the third card is displayed. Only applies to the getStarted surface| -|card3|4|Indicates the area where the fourth card is displayed. Only applies to the getStarted surface| -|unknownFutureValue|5|UnknownFutureValue, Evolvable enumeration sentinel value. Do not use.| ----- |
| v1.0 | Intune Partnerintegration Organizationalmessageplacementdetail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessageplacementdetail.md | - Title: "organizationalMessagePlacementDetail resource type" -description: "Contains the different variants of text that can be displayed for a given placement within a surface" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessagePlacementDetail resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Contains the different variants of text that can be displayed for a given placement within a surface --## Properties -|Property|Type|Description| -|:|:|:| -|placement|[organizationalMessagePlacement](../resources/intune-partnerintegration-organizationalmessageplacement.md)|Indicates the name of the placement. Possible values are: `default`, `card0`, `card1`, `card2`, `card3`, `unknownFutureValue`.| -|variants|[organizationalMessageVariant](../resources/intune-partnerintegration-organizationalmessagevariant.md) collection|The list of different variants that can be displayed for this placement| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessagePlacementDetail" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessagePlacementDetail", - "placement": "String", - "variants": [ - { - "@odata.type": "microsoft.graph.organizationalMessageVariant", - "variantId": "String", - "name": "String", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "String", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "String", - "message": "String", - "clickUrl": "String", - "buttonText": "String" - } - } - ] - } - ] -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagescenario | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagescenario.md | - Title: "organizationalMessageScenario enum type" -description: "Indicates the scenario for the message" --localization_priority: Normal -doc_type: enumPageType ---# organizationalMessageScenario enum type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Indicates the scenario for the message --## Members -|Member|Value|Description| -|:|:|:| -|onboarding|0|Indicates onboarding scenario| -|lifecycle|1|Indicates lifecycle scenario| -|unknownFutureValue|2|UnknownFutureValue, Evolvable enumeration sentinel value. Do not use.| ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagestatus | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagestatus.md | - Title: "organizationalMessageStatus enum type" -description: "Indicates the deployment status of the message" --localization_priority: Normal -doc_type: enumPageType ---# organizationalMessageStatus enum type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Indicates the deployment status of the message --## Members -|Member|Value|Description| -|:|:|:| -|scheduled|0|Indicates that the message has been scheduled for a future date| -|active|1|Indicates that the message is currently live and being presented to clients| -|completed|2|Indicates that the message has been displayed to users already and is no longer active| -|cancelled|3|Indicates that the message has been cancelled and will not be shown| -|unknownFutureValue|4|UnknownFutureValue, Evolvable enumeration sentinel value. Do not use.| ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagesurface | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagesurface.md | - Title: "organizationalMessageSurface enum type" -description: "Indicates the area where content will be displayed to customers" --localization_priority: Normal -doc_type: enumPageType ---# organizationalMessageSurface enum type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Indicates the area where content will be displayed to customers --## Members -|Member|Value|Description| -|:|:|:| -|actionCenter|0|Indicates the message will be displayed on the Window's Action Center| -|getStarted|1|Indicates the message will be displayed on the Get Started page| -|softLanding|2|Indicates the message will be displayed to the Soft Landing which is anchored to the Windows taskbar| -|unknownFutureValue|3|UnknownFutureValue, Evolvable enumeration sentinel value. Do not use.| ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagetargeting | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagetargeting.md | - Title: "organizationalMessageTargeting resource type" -description: "Contains the groups of devices that will be targeted to receive the organizational message. If a device is part of the excluded group, then it will not receive the message, regardless of the device being part of an included group" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageTargeting resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Contains the groups of devices that will be targeted to receive the organizational message. If a device is part of the excluded group, then it will not receive the message, regardless of the device being part of an included group --## Properties -|Property|Type|Description| -|:|:|:| -|targetingType|[organizationalMessageTargetingType](../resources/intune-partnerintegration-organizationalmessagetargetingtype.md)|Indicates the type of targeting. Possible values are: `aadGroup`, `unknownFutureValue`.| -|includeIds|String collection|The groups that will be targeted and receive the message| -|excludeIds|String collection|The groups that will not receive the message. If a user from an excluded group is part of an included group, it will not receive the message| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessageTargeting" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageTargeting", - "targetingType": "String", - "includeIds": [ - "String" - ], - "excludeIds": [ - "String" - ] -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagetargetingtype | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagetargetingtype.md | - Title: "organizationalMessageTargetingType enum type" -description: "Indicates the type of targeting" --localization_priority: Normal -doc_type: enumPageType ---# organizationalMessageTargetingType enum type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Indicates the type of targeting --## Members -|Member|Value|Description| -|:|:|:| -|aadGroup|0|Indicates that client devices are targeted by their AAD group| -|unknownFutureValue|1|UnknownFutureValue, Evolvable enumeration sentinel value. Do not use.| ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagetenantconsent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagetenantconsent.md | - Title: "organizationalMessageTenantConsent resource type" -description: "This will allow the admin to see tenant consent info for specific tenant" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageTenantConsent resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --This will allow the admin to see tenant consent info for specific tenant --## Properties -|Property|Type|Description| -|:|:|:| -|firstPartyMessageAllowed|Boolean|Indicates if first party message is allowed| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessageTenantConsent" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageTenantConsent", - "firstPartyMessageAllowed": true -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagetext | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagetext.md | - Title: "organizationalMessageText resource type" -description: "Contains the text that will be displayed to users for a particular variant" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageText resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Contains the text that will be displayed to users for a particular variant --## Properties -|Property|Type|Description| -|:|:|:| -|title|String|Indicates the title that will be displayed| -|message|String|Indicates the message that will be displayed| -|clickUrl|String|Indicates the url that the user will be directed to when the message is clicked| -|buttonText|String|Indicates the text that will be displayed on the button of the message. This field applies to the softLanding surface| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessageText" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageText", - "title": "String", - "message": "String", - "clickUrl": "String", - "buttonText": "String" -} -``` ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagetheme | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagetheme.md | - Title: "organizationalMessageTheme enum type" -description: "Indicates the theme for the guided content" --localization_priority: Normal -doc_type: enumPageType ---# organizationalMessageTheme enum type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Indicates the theme for the guided content --## Members -|Member|Value|Description| -|:|:|:| -|update|0|Indicates the Update theme| -|training|1|Indicates the Training theme| -|welcomeToWindows|2|Indicates the Welcome to Windows theme| -|explore|3|Indicates the Explore| -|unknownFutureValue|4|UnknownFutureValue, Evolvable enumeration sentinel value. Do not use.| ----- |
| v1.0 | Intune Partnerintegration Organizationalmessagevariant | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/intune-partnerintegration-organizationalmessagevariant.md | - Title: "organizationalMessageVariant resource type" -description: "Contains the localized text to be displayed for a given variant" --localization_priority: Normal -doc_type: resourcePageType ---# organizationalMessageVariant resource type --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Contains the localized text to be displayed for a given variant --## Properties -|Property|Type|Description| -|:|:|:| -|variantId|String|A unique identifier for this variant| -|name|String|The name of the variant| -|localizedTexts|[organizationalMessageLocalizedText](../resources/intune-partnerintegration-organizationalmessagelocalizedtext.md) collection|The list of localized texts for this variant| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.organizationalMessageVariant" -} >-``` json -{ - "@odata.type": "#microsoft.graph.organizationalMessageVariant", - "variantId": "String", - "name": "String", - "localizedTexts": [ - { - "@odata.type": "microsoft.graph.organizationalMessageLocalizedText", - "locale": "String", - "text": { - "@odata.type": "microsoft.graph.organizationalMessageText", - "title": "String", - "message": "String", - "clickUrl": "String", - "buttonText": "String" - } - } - ] -} -``` ----- |
| v1.0 | Invitationparticipantinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/invitationparticipantinfo.md | Represents an entity that is being invited to a group call. | identity | [identitySet](identityset.md) | The [identitySet](identityset.md) associated with this invitation. | | participantId | String | Optional. The ID of the target participant. | | replacesCallId | String | Optional. The call which the target identity is currently a part of. For peer-to-peer case, the call will be dropped once the participant is added successfully. |+| removeFromDefaultAudioRoutingGroup | Boolean | Optional. Whether to remove them from the main mixer. | +| hidden | Boolean | Optional. Whether to hide the participant from the roster. | ## JSON representation The following is a JSON representation of the resource. "endpointType": "String", "identity": {"@odata.type": "#microsoft.graph.identitySet"}, "participantId": "String", - "replacesCallId": "String" + "replacesCallId": "String", + "removeFromDefaultAudioRoutingGroup": "Boolean", + "hidden": "Boolean" } ``` |
| v1.0 | Managedtenants Aggregatedpolicycompliance | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-aggregatedpolicycompliance.md | Title: "aggregatedPolicyCompliance resource type" description: "Represents an aggregate view of device compliance for a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Auditevent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-auditevent.md | Title: "auditEvent resource type" description: "Represents an audit event for managed tenants in Microsoft 365 Lighthouse." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Cloudpcconnection | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-cloudpcconnection.md | Title: "cloudPcConnection resource type" description: "Represents a cloud PC connection for a given managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Cloudpcdevice | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-cloudpcdevice.md | Title: "cloudPcDevice resource type" description: "Represents a cloud PC device that belongs to a given managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Cloudpcoverview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-cloudpcoverview.md | Title: "cloudPcOverview resource type" description: "Represents an overview of cloud PCs for a given managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Conditionalaccesspolicycoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-conditionalaccesspolicycoverage.md | Title: "conditionalAccessPolicyCoverage resource type" description: "Represents information about any Azure Active Directory policy that defines access rules of a resource for a given managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Credentialuserregistrationssummary | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-credentialuserregistrationssummary.md | Title: "credentialUserRegistrationsSummary resource type" description: "Represents a summary of Azure Active Directory credential user registrations for a given managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Devicecompliancepolicysettingstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-devicecompliancepolicysettingstatesummary.md | Title: "deviceCompliancePolicySettingStateSummary resource type" description: "Represents a summary of device compliance policy setting states for a given managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Manageddevicecompliance | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-manageddevicecompliance.md | Title: "managedDeviceCompliance resource type" description: "Represents the state of device compliance for each managed device belonging to a given managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Manageddevicecompliancetrend | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-manageddevicecompliancetrend.md | Title: "managedDeviceComplianceTrend resource type" description: "Represents a trend of compliant and non-compliant devices for a given managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managedtenant | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managedtenant.md | Title: "managedTenant resource type" description: "Represent the available operations that interact with the multi-tenant management platform." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managedtenantexecutionerror | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managedtenantexecutionerror.md | Title: "managedTenantExecutionError resource type" description: "Represents an exception for a managed tenant operation." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managedtenantgenericerror | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managedtenantgenericerror.md | Title: "managedTenantGenericError resource type" description: "Represents a generic error for a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managedtenantoperationerror | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managedtenantoperationerror.md | Title: "managedTenantOperationError resource type" description: "An abstract type that represents an error for a managed tenant operation." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managementaction | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managementaction.md | Title: "managementAction resource type" description: "Represents a baseline management action for a given managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managementactiondeploymentstatus | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managementactiondeploymentstatus.md | Title: "managementActionDeploymentStatus resource type" description: "Represents the deployment status for a given managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managementactioninfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managementactioninfo.md | Title: "managementActionInfo resource type" description: "Represents reference information for a management action." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managementactiontenantdeploymentstatus | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managementactiontenantdeploymentstatus.md | Title: "managementActionTenantDeploymentStatus resource type" description: "Represents tenant level deployment status for the management action." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managementintent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managementintent.md | Title: "managementIntent resource type" description: "Represents metadata for a baseline and what management templates are included." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managementintentinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managementintentinfo.md | Title: "managementIntentInfo resource type" description: "Represents relationship information for a management intent." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managementtemplate | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managementtemplate.md | Title: "managementTemplate resource type" description: "Represents a group of actions and setting that can be performed against a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Managementtemplatedetailedinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-managementtemplatedetailedinfo.md | Title: "managementTemplateDetailedInfo resource type" description: "Represents detailed information for the management template." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Myrole | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-myrole.md | Title: "myRole resource type" description: "Represents the role assignments to a signed-in user for a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Roleassignment | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-roleassignment.md | Title: "roleAssignment resource type" description: "Represents the role assignment to a signed-in user for a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Roledefinition | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-roledefinition.md | Title: "roleDefinition resource type" description: "Represents detailed information for the role definition." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Serviceusage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-serviceusage.md | Title: "serviceUsage resource type" description: "Represents monthly active usage data for a service in a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Setting | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-setting.md | Title: "setting resource type" description: "Represents a setting that is used within a baseline." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Templateparameter | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-templateparameter.md | Title: "templateParameter resource type" description: "Represents a parameter utilized in a management template." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Tenant | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-tenant.md | Title: "tenant resource type" description: "Represents a tenant associated with the managing entity." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Tenantcontactinformation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-tenantcontactinformation.md | Title: "tenantContactInformation resource type" description: "Represents a contact at a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Tenantcontract | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-tenantcontract.md | Title: "tenantContract resource type" description: "Represents relationship information between a tenant and the managing entity." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Tenantcustomizedinformation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-tenantcustomizedinformation.md | Title: "tenantCustomizedInformation resource type" description: "Represents customizable information for a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Tenantdetailedinformation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-tenantdetailedinformation.md | Title: "tenantDetailedInformation resource type" description: "Represents detailed information for a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Tenantgroup | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-tenantgroup.md | Title: "tenantGroup resource type" description: "Represents a logical group of managed tenants." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Tenantinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-tenantinfo.md | Title: "tenantInfo resource type" description: "Represents information for a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Tenantstatusinformation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-tenantstatusinformation.md | Title: "tenantStatusInformation resource type" description: "Represents onboarding status information for a managed tenant." ms.localizationpriority: medium doc_type: resourcePageType Represents onboarding status information for a managed tenant. ## Properties |Property|Type|Description| |:|:|:|-|delegatedPrivilegeStatus|delegatedPrivilegeStatus|The status of the delegated admin privilege relationship between the managing entity and the managed tenant. Possible values are: `none`, `delegatedAdminPrivileges`, `unknownFutureValue`. Optional. Read-only.| +|delegatedPrivilegeStatus|delegatedPrivilegeStatus|The status of the delegated admin privilege relationship between the managing entity and the managed tenant. Possible values are: `none`, `delegatedAdminPrivileges`, `unknownFutureValue`, `granularDelegatedAdminPrivileges`, `delegatedAndGranularDelegetedAdminPrivileges`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `granularDelegatedAdminPrivileges` , `delegatedAndGranularDelegetedAdminPrivileges`. Optional. Read-only.| |lastDelegatedPrivilegeRefreshDateTime|DateTimeOffset|The date and time the delegated admin privileges status was updated. Optional. Read-only.| |offboardedByUserId|String|The identifier for the account that offboarded the managed tenant. Optional. Read-only.| |offboardedDateTime|DateTimeOffset|The date and time when the managed tenant was offboarded. Optional. Read-only.| |
| v1.0 | Managedtenants Tenanttag | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-tenanttag.md | Title: "tenantTag resource type" description: "Represents a tag that can be assigned to managed tenant." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Tenantusage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-tenantusage.md | Title: "tenantUsage resource type" description: "Represents the number of monthly active users per service in a managed tenant for the previous month. The time period for the data is a sliding window that takes a snapshot once a day." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Windowsdevicemalwarestate | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-windowsdevicemalwarestate.md | Title: "windowsDeviceMalwareState resource type" description: "Represents the state of discovered malware for devices runnings Windows that have been registered for management." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Windowsprotectionstate | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-windowsprotectionstate.md | Title: "windowsProtectionState resource type" description: "Represent the Windows protection state for managed devices running Windows." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Workloadaction | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-workloadaction.md | Title: "workloadAction resource type" description: "Represents an action that will be performed for a specific workload." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Workloadactiondeploymentstatus | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-workloadactiondeploymentstatus.md | Title: "workloadActionDeploymentStatus resource type" description: "Represents the deployment status for the workload action." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Managedtenants Workloadstatus | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/managedtenants-workloadstatus.md | Title: "workloadStatus resource type" description: "Represent the status for a workload." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Microsoft Teams Team Usage Reports | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/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." + 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." ms.localizationpriority: medium ms.prod: "reports" doc_type: conceptualPageType -# Microsoft Teams team usage reports +# Microsoft Teams team activity reports Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Use the Microsoft Teams team usage reports to get insights into the usage of teams in your organization. +Use the Microsoft Teams team activity reports to get insights into the usage of teams in your organization. ## Reports |
| v1.0 | Plannerassignedtotaskboardtaskformat | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerassignedtotaskboardtaskformat.md | Title: "plannerAssignedToTaskBoardTaskFormat resource type" -description: "The **plannerAssignedToTaskBoardTaskFormat** resource represents the information used to render a task correctly in the AssignedTo view of the Task Board (a view organized by users to whom tasks are assigned to). Each task will have one **plannerAssignedToTaskBoardTaskFormat** object associated with it." +description: "Represents the information used to render a task correctly in the AssignedTo view of the Task Board (a view organized by users to whom tasks are assigned to)." ms.localizationpriority: medium ms.prod: "planner" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The **plannerAssignedToTaskBoardTaskFormat** resource represents the information used to render a task correctly in the AssignedTo view of the Task Board (a view organized by users to whom tasks are assigned to). Each [task](plannertask.md) will have one **plannerAssignedToTaskBoardTaskFormat** object associated with it. +Represents the information used to render a task correctly in the **AssignedTo** view of the task board (a view organized by users to whom tasks are assigned to). Each [task](plannertask.md) will have one **plannerAssignedToTaskBoardTaskFormat** object associated with it. ## Methods The **plannerAssignedToTaskBoardTaskFormat** resource represents the information ## Properties | Property | Type |Description| |:|:--|:-|-|id|String| Read-only. ID of the resource. It is 28 characters long and case-sensitive. [Format validation](tasks-identifiers-disclaimer.md) is done on the service.| +|id|String| ID of the resource. It is 28 characters long and case-sensitive. [Format validation](tasks-identifiers-disclaimer.md) is done on the service. Read-only.| |orderHintsByAssignee|[plannerOrderHintsByAssignee](plannerorderhintsbyassignee.md)|Dictionary of hints used to order tasks on the AssignedTo view of the Task Board. The key of each entry is one of the users the task is assigned to and the value is the order hint. The format of each value is defined as outlined [here](planner-order-hint-format.md).| |unassignedOrderHint|String|Hint value used to order the task on the AssignedTo view of the Task Board when the task is not assigned to anyone, or if the orderHintsByAssignee dictionary does not provide an order hint for the user the task is assigned to. The format is defined as outlined [here](planner-order-hint-format.md).| ## Relationships-None -+None. ## JSON representation-Here is a JSON representation of the resource. +The following is a JSON representation of the resource. <!-- { "blockType": "resource", Here is a JSON representation of the resource. "orderHintsByAssignee": {"@odata.type": "microsoft.graph.plannerOrderHintsByAssignee"}, "unassignedOrderHint": "String" }- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
| v1.0 | Report | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/report.md | Microsoft Graph controls access to resources via permissions. You must specify t ## Settings -In Microsoft 365 reports, user information such as usernames, groups, and sites is concealed; actual values are not displayed. You can use the [adminReportSettings ](../resources/adminreportsettings.md) API to control the display of user information in the reports. +In Microsoft 365 reports, user information such as usernames, groups, and sites is concealed; actual values are not displayed. You can use the [adminReportSettings](/graph/api/resources/resources/adminreportsettings.md) API to control the display of user information in the reports. ## Cloud deployments The following table shows the availability for each API across all cloud deploym | APIs | Microsoft Graph global service | **Microsoft Cloud for US Government** | **Microsoft Cloud China operated by 21Vianet** | **Microsoft Cloud Germany** | **Microsoft Cloud for USNat and USSec** | | | | - | - | | |-| [Microsoft 365 activations](/graph/api/resources/office-365-activations-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | Γ₧û | +| [Admin Report Settings](/graph/api/resources/resources/adminreportsettings.md) | Γ£ö | Γ£ö | Γ£ö | Γ₧û | Γ£ö | +| [Microsoft 365 activations](/graph/api/resources/office-365-activations-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | Γ₧û | | [Microsoft 365 active users](/graph/api/resources/office-365-active-users-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | Γ₧û | | [Microsoft 365 Apps usage](/graph/api/resources/microsoft-365-apps-usage-report?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | Γ₧û | | [Microsoft 365 browser usage](/graph/api/resources/microsoft-365-browser-usage-report?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | Γ₧û | |
| v1.0 | Tenantrelationship | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/tenantrelationship.md | Title: "tenantRelationship resource type" description: "Represent the various type of tenant relationships." ms.localizationpriority: medium doc_type: resourcePageType |
| v1.0 | Accesspackageassignment Reprocess | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/accesspackageassignment-reprocess.md | doc_type: "apiPageType" Namespace: microsoft.graph -In [Azure AD entitlement management](../resources/entitlementmanagement-overview.md), callers can automatically reevaluate and enforce an [accessPackageAssignment](../resources/accesspackageassignment.md) object of a userΓÇÖs assignments for a specific access package. The **assignmentState** of the access package must be `Delivered` for the administrator to reprocess the user's assignment. Only admins with the Access Package Assignment Manager role, or higher, in Azure AD entitlement management can perform this action. +In [Azure AD entitlement management](../resources/entitlementmanagement-overview.md), callers can automatically reevaluate and enforce an [accessPackageAssignment](../resources/accesspackageassignment.md) object of a userΓÇÖs assignments for a specific access package. The **state** of the access package assignment must be `Delivered` for the administrator to reprocess the user's assignment. Only admins with the Access Package Assignment Manager role, or higher, in Azure AD entitlement management can perform this action. ## Permissions |
| v1.0 | Accessreviewset Post Historydefinitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/accessreviewset-post-historydefinitions.md | The following table shows the required properties used to create an [accessRevie |reviewHistoryPeriodStartDateTime | DateTimeOffset | A timestamp. Reviews starting on or after this date will be included in the fetched history data. Only required if **scheduleSettings** is not defined. | |reviewHistoryPeriodEndDateTime | DateTimeOffset | A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if **scheduleSettings** is not defined. | |scopes|[accessReviewQueryScope](../resources/accessreviewqueryscope.md) collection| Used to filter which reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required. <br> For more, see [Supported scope queries for accessReviewHistoryDefinition](#supported-scope-queries-for-accessreviewhistorydefinition). |-| scheduleSettings |[accessReviewHistoryScheduleSettings](../resources/accessReviewHistoryScheduleSettings.md)| The settings for a recurring access review history definition series. Only required if **reviewHistoryPeriodStartDateTime** or **reviewHistoryPeriodEndDateTime** are not defined. Not supported yet.| +| scheduleSettings |[accessReviewHistoryScheduleSettings](../resources/accessReviewHistoryScheduleSettings.md)| **Not supported yet.** The settings for a recurring access review history definition series. Only required if **reviewHistoryPeriodStartDateTime** or **reviewHistoryPeriodEndDateTime** are not defined. | ### Supported scope queries for accessReviewHistoryDefinition Content-Type: application/json "notReviewed", "notNotified" ],- "scheduleSettings": { - "reportRange": "P1M", - "recurrence": { - "pattern": { - "type": "monthly", - "interval": 1 - }, - "range": { - "type": "noEnd", - "startDate": "2018-08-03T21:02:30.667Z", - "count": 0 - } - } - }, + "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z", + "reviewHistoryPeriodEndDateTime": "2021-04-30T23:59:59Z", "scopes": [ { "@odata.type": "#microsoft.graph.accessReviewQueryScope", Content-Type: application/json "@odata.type": "#microsoft.graph.accessReviewHistoryDefinition", "id": "b2cb022f-b7e1-40f3-9854-c65a40861c38", "displayName": "Last quarter's group reviews April 2021",- "scheduleSettings": { - "reportRange": "P1M", - "recurrence": { - "pattern": { - "type": "monthly", - "interval": 1 - }, - "range": { - "type": "noEnd", - "startDate": "2018-08-03T21:02:30.667Z", - "count": 0 - } - } - }, + "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z", + "reviewHistoryPeriodEndDateTime": "2021-04-30T23:59:59Z", "decisions": [ "approve", "deny", |
| v1.0 | Chatmessage Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chatmessage-post.md | One of the following permissions is required to call this API. To learn more, in |:|:--| | Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All** | | Delegated (personal Microsoft account) | Not supported. |-| Application | Teamwork.Migrate.All, ChannelMessage.ReadWrite.All | +| Application | Teamwork.Migrate.All | > **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. Content-type: application/json #### Request The following is an example of the request. -> **Note:** The **temporaryId** in the **hostedContents** collection is a random ID, but must be same across the **body** and **hostedContents** elements. (Notice the **temporaryId** set to **1** and the reference in body as `../hostedContents/1/$value`.) +> **Note:** The **temporaryId** in the **hostedContents** collection is a random ID, but must be same across the **body** and **hostedContents** elements. (Notice the **temporaryId** set to `1` and the reference in body as `../hostedContents/1/$value`.) -**contentBytes** must be set to binary string Base64-encoded bytes. You can do this in C# by using `Convert.ToBase64String(File.ReadAllBytes("image.png"));`. .NET SDK users do not need to perform the conversion to Base64 encoded bytes as the SDK handles it for you. +**contentBytes** must be set to binary string Base64-encoded bytes. You can do this in C# by using `Convert.ToBase64String(File.ReadAllBytes("image.png"));`. Microsoft .NET SDK users do not need to perform the conversion to Base64 encoded bytes as the SDK handles it for you. # [HTTP](#tab/http) Content-type: application/json #### Request The following is an example of the request. -> **Note:** The **temporaryId** in the **hostedContents** collection is a random ID, but must be same across the **content** (in **attachments**) and **hostedContents** elements. (Notice the **temporaryId** set to **1** and the reference in content as `../hostedContents/1/$value`.) +> **Note:** The **temporaryId** in the **hostedContents** collection is a random ID, but must be same across the **content** (in **attachments**) and **hostedContents** elements. (Notice the **temporaryId** set to `1` and the reference in content as `../hostedContents/1/$value`.) -**contentBytes** must be set to binary string Base64-encoded bytes. You can do this in C# by using `Convert.ToBase64String(File.ReadAllBytes("image.png"));`. .NET SDK users do not need to perform the conversion to Base64 encoded bytes as the SDK handles it for you. +**contentBytes** must be set to binary string Base64-encoded bytes. You can do this in C# by using `Convert.ToBase64String(File.ReadAllBytes("image.png"));`. Microsoft .NET SDK users do not need to perform the conversion to Base64 encoded bytes as the SDK handles it for you. # [HTTP](#tab/http) Content-type: application/json #### Response +The following is an example of the response. + <!-- { "blockType": "response", "truncated": true, |
| v1.0 | Entitlementmanagement List Assignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/entitlementmanagement-list-assignments.md | If the user or app is assigned only to catalog-specific administrative roles, th ### Example scenarios for using query parameters - To return the target subject and access package, include `$expand=target,accessPackage`.-- To retrieve only delivered assignments, you can include a query `$filter=assignmentState eq 'Delivered'`.+- To retrieve only delivered assignments, you can include a query `$filter=state eq 'Delivered'`. - To retrieve only assignments for a particular user, you can include a query with assignments targeting the object ID of that user: `$expand=target&$filter=target/objectid+eq+'7deff43e-1f17-44ef-9e5f-d516b0ba11d4'`. - To retrieve only assignments for a particular user and a particular access package, you can include a query with assignments targeting that access package and the object ID of that user: `$expand=accessPackage,target&$filter=accessPackage/id eq '9bbe5f7d-f1e7-4eb1-a586-38cdf6f8b1ea' and target/objectid eq '7deff43e-1f17-44ef-9e5f-d516b0ba11d4'`. |
| v1.0 | Plannerbucket List Tasks | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/plannerbucket-list-tasks.md | Title: "List tasks" -description: "Retrieve a list of **plannerTask** objects associated to a plannerBucket object." +description: "Retrieve a list of plannerTask objects associated to a plannerBucket object." ms.localizationpriority: medium ms.prod: "planner" doc_type: apiPageType Namespace: microsoft.graph -Retrieve a list of **plannerTask** objects associated to a [plannerBucket](../resources/plannerbucket.md) object. +Retrieve a list of [plannerTask](../resources/plannertask.md) objects associated to a [plannerBucket](../resources/plannerbucket.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). Do not 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. +If successful, this method returns a `200 OK` response code and a 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). ## Example-##### Request -Here is an example of the request. +### Request +The following is an example of the request. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/v1.0/planner/buckets/{bucket-id}/tasks -##### Response -Here is an example of the response. Note: The response object shown here might be shortened for readability. +### Response +The following is an example of the response. +> **Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, |
| v1.0 | Plannertask Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/plannertask-get.md | Title: "Get plannerTask" -description: "Retrieve the properties and relationships of **plannertask** object." +description: "Retrieve the properties and relationships of plannerTask object." ms.localizationpriority: medium ms.prod: "planner" doc_type: apiPageType Namespace: microsoft.graph -Retrieve the properties and relationships of **plannertask** object. +Retrieve the properties and relationships of [plannerTask](../resources/plannertask.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). Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [plannerTask](../resources/plannertask.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [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 403 and 404 responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions). ## Example-##### Request -Here is an example of the request. +### Request +The following is an example of the request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "get_plannertask" + "name": "get_plannertask", + "sampleKeys": ["01gzSlKkIUSUl6DF_EilrmQAKDhh"] }--> ```msgraph-interactive-GET https://graph.microsoft.com/v1.0/planner/tasks/{task-id} +GET https://graph.microsoft.com/v1.0/planner/tasks/01gzSlKkIUSUl6DF_EilrmQAKDhh ``` # [C#](#tab/csharp) GET https://graph.microsoft.com/v1.0/planner/tasks/{task-id} -##### Response -Here is an example of the response. Note: The response object shown here might be shortened for readability. +### Response +The following is an example of the response. +> **Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, |
| v1.0 | Presence Setpresence | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/presence-setpresence.md | Similarly, an application can have its own presence session for a user and be ab The following is the precedence for how session states are aggregated: * User-configured > app-configured (user-configured state overrides others)-* Among app-configured: DoNotDisturb (currently not supported for set presence) > Busy > Available > Away +* Among app-configured: DoNotDisturb > Busy > Available > Away ### Timeout, expiration, and keep alive A presence session may **time out** and **expire**, so the application needs to call this API before the **timeout**, to maintain the state for the session; or before the **expiration**, to keep the session alive. In the request body, provide a JSON object with the following parameters. Supported combinations of `availability` and `activity` are: -| availability | activity | Description | -| :-- | :- | :- | -| Available | Available | Updates the presence session as Available. | -| Busy | InACall | Updates the presence session as Busy, InACall. | -| Busy | InAConferenceCall | Updates the presence session as Busy, InAConferenceCall. | -| Away | Away | Updates the presence session as Away. | +| availability | activity | Description | +| :-- | :- | :-- | +| Available | Available | Updates the presence session as Available. | +| Busy | InACall | Updates the presence session as Busy, InACall. | +| Busy | InAConferenceCall | Updates the presence session as Busy, InAConferenceCall. | +| Away | Away | Updates the presence session as Away. | +| DoNotDisturb | Presenting | Updates the presence session as DoNotDisturb, Presenting. | ## Response If successful, this method returns a `200 OK` response code. |
| v1.0 | Sites List Followed | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/sites-list-followed.md | Namespace: microsoft.graph List the [sites](../resources/site.md) that have been followed by the signed in user. +>**Note:** This API has a [known issue](/graph/known-issues#sites-and-lists-sharepoint) and might return incorrect results. + ## Permissions 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 | User List People | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/user-list-people.md | Namespace: microsoft.graph Retrieve a collection of [person](../resources/person.md) objects ordered by their relevance to the [user](../resources/user.md), which is determined by the user's communication and collaboration patterns, and business relationships. -You can get this information via the People API. For examples, see the [Examples](#examples) section and the article [Get relevant information about people](/graph/people-example). +You can get this information via the People API. For examples, see the [Examples](#examples) section and the article [Use the People API to get information about the people most relevant to you](/graph/people-insights-overview). ## Permissions GET /users/{id | userPrincipalName}/people ## Optional query parameters -This method supports the [OData query parameters](/graph/query-parameters) to help customize the response, as shown in the examples in the article [Get relevant information about people](/graph/people-example). +This method supports the [OData query parameters](/graph/query-parameters) to help customize the response. |Name|Value|Description| |:|:--|:-| |$filter|string|Limits the response to only those people whose record contains the specified criteria.| |$orderby|string|By default the people in the response are sorted by their relevance to your query. You can change the order of the people in the response using the *$orderby* parameter.|-|$search|string|Search for people by name or alias. Supports Fuzzy matching. Parameter only works for searching the signed-in user's relevant people, not for searching people relevant to other users. Also supports the `topic` keyword to find people based on topics extracted from e-mail conversations with that person. See the *Perform a fuzzy search* section at [Get relevant information about people](/graph/people-example#perform-a-fuzzy-search) for information and examples. | +|$search|string|Search for people by name or alias. Supports Fuzzy matching. Parameter only works for searching the signed-in user's relevant people, not for searching people relevant to other users. Also supports the `topic` keyword to find people based on topics extracted from e-mail conversations with that person. For information and examples, see the *Perform a fuzzy search* section at [Use the People API to get information about the people most relevant to you](/graph/people-insights-overview#perform-a-fuzzy-search). | |$select|string|Comma-separated list of properties to include in the response. For optimal performance, only select the subset of properties needed.| |$skip|int|Skip the first n results, useful for paging. This is not supported when using *$search*.| |$top|int|Number of results to be returned.| If successful, this method returns a `200 OK` response code and a collection of ## Examples -#### Request +### Request The following is an example of the request. GET https://graph.microsoft.com/v1.0/me/people -#### Response +### Response The following is an example of the response. Content-type: application/json } ``` -For more examples, see the article [Get relevant information about people](/graph/people-example). +## See also +- For details about the People API and more examples, see [Use the People API to get information about the people most relevant to you](/graph/people-insights-overview). <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
| v1.0 | Group | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/group.md | This resource supports: | [List deleted groups](../api/directory-deleteditems-list.md) | [directoryObject](directoryobject.md) collection | Retrieve the groups deleted in the tenant in the last 30 days. | | [List deleted groups owned by user](../api/directory-deleteditems-getuserownedobjects.md) | [directoryObject](directoryobject.md) collection | Retrieve the groups deleted in the tenant in the last 30 days and that are owned by a user. | | [Get deleted group](../api/directory-deleteditems-get.md) | [directoryObject](directoryobject.md) collection | Retrieve a deleted group by ID. |-| [Restore deleted group](../api/directory-deleteditems-delete.md) | [directoryObject](directoryobject.md) collection | Restore a group deleted in the tenant in the last 30 days. | -| [Permanently delete group](../api/directory-deleteditems-restore.md) | [directoryObject](directoryobject.md) collection | Permanently delete a deleted group from the tenant. | +| [Restore deleted group](../api/directory-deleteditems-restore.md) | [directoryObject](directoryobject.md) collection | Restore a group deleted in the tenant in the last 30 days. | +| [Permanently delete group](../api/directory-deleteditems-delete.md) | [directoryObject](directoryobject.md) collection | Permanently delete a deleted group from the tenant. | | [checkMemberGroups](../api/directoryobject-checkmembergroups.md) | String collection | Check for membership in a list of groups. The function is transitive. | | [getMemberGroups](../api/directoryobject-getmembergroups.md) | String collection | Return all the groups that the group is a member of. The function is transitive. | | [checkMemberObjects](../api/directoryobject-checkmemberobjects.md) | String collection | Check for membership in a list of group, directory role, or administrative unit objects. The function is transitive. | |
| v1.0 | Invitationparticipantinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/invitationparticipantinfo.md | This resource is used to represent the entity that is being invited to a group c | identity | [identitySet](identityset.md) | The [identitySet](identityset.md) associated with this invitation. | | participantId | String | Optional. The ID of the target participant. | | replacesCallId | String | Optional. The call which the target identity is currently a part of. For peer-to-peer case, the call will be dropped once the participant is added successfully. |+| removeFromDefaultAudioRoutingGroup | Boolean | Optional. Whether to remove them from the main mixer. | +| hidden | Boolean | Optional. Whether to hide the participant from the roster. | ## JSON representation The following is a JSON representation of the resource. { "identity": {"@odata.type": "#microsoft.graph.identitySet"}, "participantId": "String", - "replacesCallId": "String" + "replacesCallId": "String", + "removeFromDefaultAudioRoutingGroup": "Boolean", + "hidden": "Boolean" } ``` |
| v1.0 | Plannerassignedtotaskboardtaskformat | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/plannerassignedtotaskboardtaskformat.md | Title: "plannerAssignedToTaskBoardTaskFormat resource type" -description: "The **plannerAssignedToTaskBoardTaskFormat** resource represents the information used to render a task correctly in the AssignedTo view of the Task Board (a view organized by users to whom tasks are assigned to). Each task will have one **plannerAssignedToTaskBoardTaskFormat** object associated with it." +description: "Represents the information used to render a task correctly in the AssignedTo view of the Task Board (a view organized by users to whom tasks are assigned to)." ms.localizationpriority: medium ms.prod: "planner" doc_type: resourcePageType Namespace: microsoft.graph -The **plannerAssignedToTaskBoardTaskFormat** resource represents the information used to render a task correctly in the AssignedTo view of the Task Board (a view organized by users to whom tasks are assigned to). Each [task](plannertask.md) will have one **plannerAssignedToTaskBoardTaskFormat** object associated with it. +Represents the information used to render a task correctly in the **AssignedTo** view of the task board (a view organized by users to whom tasks are assigned to). Each [task](plannertask.md) will have one **plannerAssignedToTaskBoardTaskFormat** object associated with it. ## Methods The **plannerAssignedToTaskBoardTaskFormat** resource represents the information ## Properties | Property | Type |Description| |:|:--|:-|-|id|String| Read-only. ID of the resource. It is 28 characters long and case-sensitive. [Format validation](planner-identifiers-disclaimer.md) is done on the service.| +|id|String| ID of the resource. It is 28 characters long and case-sensitive. [Format validation](planner-identifiers-disclaimer.md) is done on the service. Read-only.| |orderHintsByAssignee|[plannerOrderHintsByAssignee](plannerorderhintsbyassignee.md)|Dictionary of hints used to order tasks on the AssignedTo view of the Task Board. The key of each entry is one of the users the task is assigned to and the value is the order hint. The format of each value is defined as outlined [here](planner-order-hint-format.md).| |unassignedOrderHint|String|Hint value used to order the task on the AssignedTo view of the Task Board when the task is not assigned to anyone, or if the orderHintsByAssignee dictionary does not provide an order hint for the user the task is assigned to. The format is defined as outlined [here](planner-order-hint-format.md).| ## Relationships-None -+None. ## JSON representation-Here is a JSON representation of the resource. +The following is a JSON representation of the resource. <!--{ "blockType": "resource", Here is a JSON representation of the resource. "orderHintsByAssignee": {"@odata.type": "microsoft.graph.plannerOrderHintsByAssignee"}, "unassignedOrderHint": "String" }- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |