Updates from: 09/14/2021 03:11:31
Service Microsoft Docs article Related commit history on GitHub Change details
v1.0 Channel Provisionemail https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/channel-provisionemail.md
Title: "channel: provisionEmail"
-description: "Provision a channel's email."
+description: "Provision an email address for a channel."
ms.localizationpriority: medium ms.prod: "microsoft-teams"
Namespace: microsoft.graph
Provision an email address for a [channel](../resources/channel.md).
-Microsoft Teams does not automatically provision an email address for a channel by default. To have Teams provision an email address, you can call **provisionEmail**, or through the Teams user interface, select **Get email address**, which triggers Teams to generate an email address if it has not already provisioned one.
+Microsoft Teams doesn't automatically provision an email address for a **channel** by default. To have Teams provision an email address, you can call **provisionEmail**, or through the Teams user interface, select **Get email address**, which triggers Teams to generate an email address if it has not already provisioned one.
-To remove a channel's provisioned email address, use the [removeEmail](channel-removeemail.md) method.
+To remove the email address of a **channel**, use the [removeEmail](channel-removeemail.md) method.
## Permissions
Do not supply a request body for this method.
## Response
-If the channel's email is provisioned successfully, this method returns a `200 OK` response code and a [provisionChannelEmailResult](../resources/provisionChannelEmailResult.md) object in the response body. The provisioned email address is in the **email** property.
+If successful, this method returns a `200 OK` response code and a [provisionChannelEmailResult](../resources/provisionChannelEmailResult.md) object in the response body. The provisioned email address is in the `email` property.
## Example ### Request
v1.0 Channel Removeemail https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/channel-removeemail.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Remove the provisioned email address of a [channel](../resources/channel.md).
+Remove the email address of a [channel](../resources/channel.md).
You can remove an email address only if it was provisioned using the [provisionEmail](channel-provisionemail.md) method or through the Microsoft Teams client.
v1.0 Ediscovery Case Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/ediscovery-case-post.md
Namespace: microsoft.graph.ediscovery
Create a new [case](../resources/ediscovery-case.md) object.
+>[!NOTE]
+>Starting in September 2021, this API will create a large case type. To learn more about large cases, see [Use large cases in Advanced eDiscovery](/microsoft-365/compliance/advanced-ediscovery-large-cases). For details, see the [Changes to the Microsoft 365 advanced eDiscovery create case API](https://go.microsoft.com/fwlink/?linkid=2172604) blog post.
+ ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
v1.0 Invitation Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/invitation-post.md
The following table shows the properties that are required when you create a inv
If successful, this method returns `201 Created` response code and [invitation](../resources/invitation.md) object in the response body. ## Example
-##### Request
-Here is an example of the request.
+### Request
+The following is an example of the request.
# [HTTP](#tab/http) <!-- {
Here is an example of the request.
```http POST https://graph.microsoft.com/beta/invitations Content-type: application/json
-Content-length: 551
{
- "invitedUserEmailAddress": "yyy@test.com",
+ "invitedUserEmailAddress": "admin@fabrikam.com",
"inviteRedirectUrl": "https://myapp.contoso.com" } ```
Content-length: 551
-##### 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,
Here is an example of the response. Note: The response object shown here might b
```http HTTP/1.1 201 OK Content-type: application/json
-Content-length: 551
{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#invitations/$entity",
"id": "7b92124c-9fa9-406f-8b8e-225df8376ba9", "inviteRedeemUrl": "https://invitations.microsoft.com/redeem/?tenant=04dcc6ab-388a-4559-b527-fbec656300ea&user=7b92124c-9fa9-406f-8b8e-225df8376ba9&ticket=VV9dmiExBsfRIVNFjb9ITj9VXAd07Ypv4gTg%2f8PiuJs%3d&lc=1033&ver=2.0",
- "invitedUserDisplayName": "yyy",
- "invitedUserEmailAddress": "yyy@test.com",
+ "invitedUserDisplayName": "Fabrikam Admin",
+ "invitedUserEmailAddress": "admin@fabrikam.com",
+ "resetRedemption": false,
"sendInvitationMessage": false, "invitedUserMessageInfo": { "messageLanguage": null,
v1.0 Search Query https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/search-query.md
Title: "searchEntity: query"
-description: "Runs the query specified in the request body. Search results are provided in the response."
+description: "Runs the query specified in the request body. Search results are provided in the response"
ms.localizationpriority: medium ms.prod: "search"
v1.0 Aggregationoption https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/aggregationoption.md
Title: "aggregationOption resource type"
-description: "Specifies the aggregationOption entity"
+description: "Specifies which aggregations should be returned alongside the search results"
ms.localizationpriority: medium ms.prod: "search"
Specifies which aggregations should be returned alongside the search results.
## Properties | Property | Type | Description |
-|:-|:|:|
-|field|String|Specifies the field in the schema of the specified entity type that aggregation should be computed on. Required.|
-|size|Int32|The number of [searchBucket](searchBucket.md) resources to be returned. This is not required when the range is provided manually in the search request. Optional.|
+|:-|:|:|
|bucketDefinition|[bucketAggregationDefinition](bucketaggregationdefinition.md)|Specifies the criteria to compute an aggregation. Optional.|
+|field|String|Computes aggregation on the field while the field exists in current entity type. Required.|
+|size|Int32|The number of [searchBucket](searchBucket.md) resources to be returned. This is not required when the range is provided manually in the search request. Optional.|
## JSON representation
The following is a JSON representation of the resource.
"keywords": "", "section": "documentation", "tocPath": ""
-}-->
+}-->
v1.0 Bucketaggregationdefinition https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/bucketaggregationdefinition.md
Title: "bucketAggregationDefinition resource type"
-description: "Provides the details on how the agregations should be generated in the results"
+description: "Provides the details on how to generate the agregations in the results"
ms.localizationpriority: medium ms.prod: "search"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Specifies details to aggregate search results.
+Provides the details on how to generate the agregations in the results.
## Properties | Property | Type | Description | |:-|:|:|
-|sortBy|bucketAggregationSortProperty| The possible values are `count` to sort by the number of matches in the aggregation, `keyAsString`to sort alphabeticaly based on the key in the aggregation, `keyAsNumber` for numerical sorting based on the key in the aggregation. Required.
|isDescending|Boolean|`True` to specify the sort order as descending. The default is `false`, with the sort order as ascending. Optional.|
-|prefixFilter|String|A filter to define a matching criteria. The key should start with the specified prefix to be returned in the response. Optional.|
|minimumCount|Int32|The minimum number of items that should be present in the aggregation to be returned in a bucket. Optional.|
+|prefixFilter|String|A filter to define a matching criteria. The key should start with the specified prefix to be returned in the response. Optional.|
|ranges|[bucketAggregationRange](bucketaggregationrange.md) collection|Specifies the manual ranges to compute the aggregations. This is only valid for non-string refiners of date or numeric type. Optional.|
+|sortBy|bucketAggregationSortProperty| The possible values are `count` to sort by the number of matches in the aggregation, `keyAsString`to sort alphabeticaly based on the key in the aggregation, `keyAsNumber` for numerical sorting based on the key in the aggregation. Required.
## JSON representation
The following is a JSON representation of the resource.
"keywords": "", "section": "documentation", "tocPath": ""
-}-->
+}-->
v1.0 Bucketaggregationrange https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/bucketaggregationrange.md
Title: "bucketAggregationRange resource type"
-description: "Enables to specify some manual ranges in the aggregation request. This in only applicable to non string refiners : numeric and dates."
+description: "Specifies the lower and upper limit to a range for aggregating search results. Applies only to refiners of the date or numeric type"
ms.localizationpriority: medium ms.prod: "search"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Specifies the lower and upper limit to a range for aggregating search results. Applies to only refiners of the date or numeric type.
+Specifies the lower and upper limit to a range for aggregating search results. Applies only to refiners of the date or numeric type.
## Properties
v1.0 Channel https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/channel.md
where files are shared, and where tabs are added.
|[Get tab in channel](../api/channel-get-tabs.md) | [teamsTab](teamstab.md) | Get a specific tab pinned to a channel.| |[Update tab in channel](../api/channel-patch-tabs.md) | [teamsTab](teamstab.md) | Updates the properties of a tab in a channel.| |[Remove tab from channel](../api/channel-delete-tabs.md) | None | Remove (unpin) a tab from a channel.|
-|[Provision channel email address](../api/channel-provisionemail.md) |[provisionChannelEmailResult](../resources/provisionchannelemailresult.md)| Provision email address.|
-|[Remove channel email address](../api/channel-removeemail.md) | None | Remove email address.|
+|[Provision channel email address](../api/channel-provisionemail.md) |[provisionChannelEmailResult](../resources/provisionchannelemailresult.md)| Provision an email address for the channel.|
+|[Remove channel email address](../api/channel-removeemail.md) | None | Remove the email address of the channel.|
## Properties
v1.0 Ediscovery Case https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/ediscovery-case.md
Namespace: microsoft.graph.ediscovery
In the context of eDiscovery, contains custodians, holds, collections, review sets, and exports. For details, see [Advanced eDiscovery](/microsoft-365/compliance/overview-ediscovery-20).
+>[!NOTE]
+>Starting in September 2021, POST operations will create large cases. To learn more about large cases, see [Use large cases in Advanced eDiscovery](/microsoft-365/compliance/advanced-ediscovery-large-cases). For details, see the [Changes to the Microsoft 365 advanced eDiscovery create case API](https://go.microsoft.com/fwlink/?linkid=2172604) blog post.
+ ## Methods | Method | Return Type | Description |
v1.0 Invitation https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/invitation.md
Creating an invitation will return a redemption URL in the response (*inviteRede
|invitedUserDisplayName|String|The display name of the user being invited.| |invitedUserEmailAddress|String|The email address of the user being invited. Required. The following special characters are not permitted in the email address:<br><ul><li>Tilde (~)</li><li>Exclamation point (`!`)</li><li>At sign (`@`)</li><li>Number sign (`#`)</li><li>Dollar sign (`$`)</li><li>Percent (`%`)</li><li>Circumflex (`^`)</li><li>Ampersand (`&`)</li><li>Asterisk (`*`)</li><li>Parentheses (`( )`)</li><li>Hyphen (`-`)</li><li>Plus sign (`+`)</li><li>Equal sign (`=`)</li><li>Brackets (`[ ]`)</li><li>Braces (`{ }`)</li><li>Backslash (`\`)</li><li>Slash mark (`/`)</li><li>Pipe (`|`)</li><li>Semicolon (`;`)</li><li>Colon (`:`)</li><li>Quotation marks (`"`)</li><li>Angle brackets (`< >`)</li><li>Question mark (`?`)</li><li>Comma (`,`)</li></ul><br>However, the following exceptions apply:<br><ul><li>A period (`.`) or a hyphen (`-`) is permitted anywhere in the user name, except at the beginning or end of the name.</li><li>An underscore (`_`) is permitted anywhere in the user name. This includes at the beginning or end of the name.</li></ul>| |invitedUserMessageInfo|[invitedUserMessageInfo](invitedusermessageinfo.md)|Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.|
-|sendInvitationMessage|Boolean|Indicates whether an email should be sent to the user being invited. The default is `false`.|
|inviteRedirectUrl|String|The URL user should be redirected to once the invitation is redeemed. Required.| |inviteRedeemUrl|String|The URL the user can use to redeem their invitation. Read-only.|
-|invitedUserType|String|The userType of the user being invited. By default, this is `Guest`. You can invite as `Member` if you're are company administrator. |
+|invitedUserType|String|The userType of the user being invited. By default, this is `Guest`. You can invite as `Member` if you're are company administrator. The default is `false`. |
+|resetRedemption|Boolean|Reset the user's redemption status and reinvite a user while retaining their user identifier, group memberships, and app assignments. This property allows you to enable a user to sign-in using a different email address from the one in the previous invitation. For more information about using this property, see [Reset redemption status for a guest user (Preview)](/azure/active-directory/external-identities/reset-redemption-status#use-microsoft-graph-api-to-reset-redemption-status).|
+|sendInvitationMessage|Boolean|Indicates whether an email should be sent to the user being invited. The default is `false`.|
|status|String|The status of the invitation. Possible values: `PendingAcceptance`, `Completed`, `InProgress`, and `Error`| ## Relationships
Here is a JSON representation of the resource
--> ```json {
- "id": "string",
- "invitedUserDisplayName": "string",
- "invitedUserEmailAddress": "string",
+ "id": "String",
+ "invitedUserDisplayName": "String",
+ "invitedUserEmailAddress": "String",
"invitedUserMessageInfo": {"@odata.type": "microsoft.graph.invitedUserMessageInfo"}, "sendInvitationMessage": false,
- "inviteRedirectUrl": "string",
- "inviteRedeemUrl": "string",
- "status": "string",
+ "inviteRedirectUrl": "String",
+ "inviteRedeemUrl": "String",
+ "resetRedemption": false,
+ "status": "String",
"invitedUser": {"@odata.type": "microsoft.graph.user"},
- "invitedUserType": "string"
+ "invitedUserType": "String"
} ```
v1.0 Objectidentity https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/objectidentity.md
The **identities** property of the [user](user.md) resource is an **objectIdenti
| Property | Type |Description| |:|:--|:-|
-|signInType|string| Specifies the user sign-in types in your directory, such as `emailAddress`, `userName` or `federated`. Here, `federated` represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Additional validation is enforced on **issuerAssignedId** when the sign-in type is set to `emailAddress` or `userName`. This property can also be set to any custom string.|
+|signInType|String| Specifies the user sign-in types in your directory, such as `emailAddress`, `userName`, `federated`, or `userPrincipalName`. `federated` represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Setting or updating a `userPrincipalName` identity will update the value of the **userPrincipalName** property on the user object. The validations performed on the `userPrincipalName` property on the user object, for example, verified domains and acceptable characters, will be performed when setting or updating a `userPrincipalName` identity. Additional validation is enforced on **issuerAssignedId** when the sign-in type is set to `emailAddress` or `userName`. This property can also be set to any custom string.|
|issuer|string|Specifies the issuer of the identity, for example `facebook.com`.<br>For local accounts (where **signInType** is not `federated`), this property is the local B2C tenant default domain name, for example `contoso.onmicrosoft.com`.<br>For external users from other Azure AD organization, this will be the domain of the federated organization, for example `contoso.com`.<br><br>Supports `$filter`. 512 character limit.| |issuerAssignedId|string|Specifies the unique identifier assigned to the user by the issuer. The combination of **issuer** and **issuerAssignedId** must be unique within the organization. Represents the sign-in name for the user, when **signInType** is set to `emailAddress` or `userName` (also known as local accounts).<br>When **signInType** is set to: <ul><li>`emailAddress`, (or a custom string that starts with `emailAddress` like `emailAddress1`) **issuerAssignedId** must be a valid email address</li><li>`userName`, **issuerAssignedId** must be a valid [local part of an email address](https://tools.ietf.org/html/rfc3696#section-3)</li></ul>Supports `$filter`. 100 character limit.|
v1.0 Searchbucket https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/searchbucket.md
Title: "searchBucket resource type"
-description: "Provides for a specific aggregation in the response, the value of a particular bucket."
+description: "Represents a container for one or more search results that share the same value for the entity field that aggregates them"
ms.localizationpriority: medium ms.prod: "search"
Represents a container for one or more search results that share the same value
| Property | Type | Description | |:-|:|:|
-|key|String| The discrete value of the field that an aggregation was computed on.|
-|count|Int32| The approximate number of search matches that share the same value specified in the **key** property. Note that this number is not the exact number of matches.|
|aggregationFilterToken|String| A token containing the encoded filter to aggregate search matches by the specific **key** value. To use the filter, pass the token as part of the **aggregationFilter** property in a **searchRequest** object, in the format **"{field}:\\"{aggregationFilterToken}\\""**. See an [example](/graph/search-concept-aggregation#example-2-apply-an-aggregation-filter-based-on-a-previous-request).|
+|count|Int32| The approximate number of search matches that share the same value specified in the **key** property. Note that this number is not the exact number of matches.|
+|key|String| The discrete value of the field that an aggregation was computed on.|
## JSON representation
v1.0 Sortproperty https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/sortproperty.md
Title: "sortProperty resource type"
-description: "Provides the option to sort search results."
+description: "Indicates the order to sort search results"
ms.localizationpriority: medium ms.prod: "search"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the sort options to order search results.
+Indicates the order to sort search results.
## Properties
The following is a JSON representation of the resource.
"keywords": "", "section": "documentation", "tocPath": ""
-}-->
+}-->
v1.0 Channel Provisionemail https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/channel-provisionemail.md
+
+ Title: "channel: provisionEmail"
+description: "Provision an email address for a channel."
+
+ms.localizationpriority: medium
++
+# channel: provisionEmail
+
+Namespace: microsoft.graph
+
+Provision an email address for a [channel](../resources/channel.md).
+
+Microsoft Teams doesn't automatically provision an email address for a **channel** by default. To have Teams provision an email address, you can call **provisionEmail**, or through the Teams user interface, select **Get email address**, which triggers Teams to generate an email address if it has not already provisioned one.
+
+To remove the email address of a **channel**, use the [removeEmail](channel-removeemail.md) method.
+
+## Permissions
+
+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) | ChannelSettings.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
+
+## HTTP request
+<!-- { "blockType": "ignored" } -->
+```http
+POST /teams/{team-id}/channels/{channel-id}/provisionEmail
+```
+## Request headers
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [provisionChannelEmailResult](../resources/provisionChannelEmailResult.md) object in the response body. The provisioned email address is in the `email` property.
+
+## Example
+### Request
+The following is an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "sampleKeys": ["893075dd-2487-4122-925f-022c42e20265", "19:561fbdbbfca848a484f0a6f00ce9dbbd@thread.tacv2"],
+ "name": "channel_provisionemail"
+}
+-->
+```http
+POST https://graph.microsoft.com/v1.0/teams/893075dd-2487-4122-925f-022c42e20265/channels/19:561fbdbbfca848a484f0a6f00ce9dbbd@thread.tacv2/provisionEmail
+```
+
+### Response
+The following is an example of a response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.provisionChannelEmailResult"
+}
+-->
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.provisionChannelEmailResult",
+ "email": "1df8f174.teamsgraph.onmicrosoft.com@amer.teams.ms"
+}
+```
+<!-- uuid: e848414b-4669-4484-ac36-1504c58a3fb8
+2015-10-25 14:57:30 UTC -->
+<!--
+{
+ "type": "#page.annotation",
+ "description": "Provision channel email",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": []
+}
+-->
++
v1.0 Channel Removeemail https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/channel-removeemail.md
+
+ Title: "channel: removeEmail"
+description: "Remove a channel's provisioned email."
+
+ms.localizationpriority: medium
++
+# channel: removeEmail
+
+Namespace: microsoft.graph
+
+Remove the email address of a [channel](../resources/channel.md).
+
+You can remove an email address only if it was provisioned using the [provisionEmail](channel-provisionemail.md) method or through the Microsoft Teams client.
+
+## Permissions
+
+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) | ChannelSettings.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
+
+## HTTP request
+<!-- { "blockType": "ignored" } -->
+```http
+POST /teams/{team-id}/channels/{channel-id}/removeEmail
+```
+## Request headers
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this action returns a `204 No Content` response code.
+
+## Example
+### Request
+
+<!-- {
+ "blockType": "request",
+ "sampleKeys": ["893075dd-2487-4122-925f-022c42e20265", "19:561fbdbbfca848a484f0a6f00ce9dbbd@thread.tacv2"],
+ "name": "channel_removeemail"
+}
+-->
+```http
+POST https://graph.microsoft.com/beta/teams/893075dd-2487-4122-925f-022c42e20265/channels/19:561fbdbbfca848a484f0a6f00ce9dbbd@thread.tacv2/removeEmail
+```
+
+### Response
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+<!-- uuid: e848414b-4669-4484-ac36-1504c58a3fb8
+2015-10-25 14:57:30 UTC -->
+<!--
+{
+ "type": "#page.annotation",
+ "description": "Remove channel email",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": []
+}
+-->
++
v1.0 Invitation Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/invitation-post.md
The following table shows the properties that are required when you create a inv
If successful, this method returns `201 Created` response code and [invitation](../resources/invitation.md) object in the response body. ## Example
-##### Request
-Here is an example of the request.
+
+### Request
+
+The following is an example of the request.
# [HTTP](#tab/http) <!-- {
Here is an example of the request.
```http POST https://graph.microsoft.com/v1.0/invitations Content-type: application/json
-Content-length: 551
{
- "invitedUserEmailAddress": "yyy@test.com",
+ "invitedUserEmailAddress": "admin@fabrikam.com",
"inviteRedirectUrl": "https://myapp.contoso.com" } ```
Content-length: 551
-##### 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,
Here is an example of the response. Note: The response object shown here might b
```http HTTP/1.1 201 OK Content-type: application/json
-Content-length: 551
{
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#invitations/$entity",
"id": "7b92124c-9fa9-406f-8b8e-225df8376ba9", "inviteRedeemUrl": "https://invitations.microsoft.com/redeem/?tenant=04dcc6ab-388a-4559-b527-fbec656300ea&user=7b92124c-9fa9-406f-8b8e-225df8376ba9&ticket=VV9dmiExBsfRIVNFjb9ITj9VXAd07Ypv4gTg%2f8PiuJs%3d&lc=1033&ver=2.0",
- "invitedUserDisplayName": "yyy",
- "invitedUserEmailAddress": "yyy@test.com",
+ "invitedUserDisplayName": "Fabrikam Admin",
+ "invitedUserEmailAddress": "admin@fabrikam.com",
"sendInvitationMessage": false, "invitedUserMessageInfo": { "messageLanguage": null,
v1.0 Search Query https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/search-query.md
Title: "searchEntity: query"
-description: "Runs the query specified in the request body. Search results are provided in the response."
+description: "Runs the query specified in the request body. Search results are provided in the response"
ms.localizationpriority: medium ms.prod: "search"
Content-type: application/json
- Search [calendar events](/graph/search-concept-events) - Search content in SharePoint and OneDrive ([files, lists and sites](/graph/search-concept-files)) - Search [custom types (Graph Connectors)](/graph/search-concept-custom-types) data
+- [Sort](/graph/search-concept-sort) search results
+- Use [aggregations](/graph/search-concept-aggregations) to refine search results
<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
v1.0 Aggregationoption https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/aggregationoption.md
+
+ Title: "aggregationOption resource type"
+description: "Specifies which aggregations should be returned alongside the search results"
+ms.localizationpriority: medium
+++
+# aggregationOption resource type
+
+Namespace: microsoft.graph
+
+Specifies which aggregations should be returned alongside the search results.
+
+## Properties
+
+| Property | Type | Description |
+|:-|:|:|
+|bucketDefinition|[bucketAggregationDefinition](bucketaggregationdefinition.md)|Specifies the criteria to compute an aggregation. Optional.|
+|field|String|Computes aggregation on the field while the field exists in current entity type. Required.|
+|size|Int32|The number of [searchBucket](searchBucket.md) resources to be returned. This is not required when the range is provided manually in the search request. Optional.|
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.aggregationOption",
+ "baseType": null
+}-->
+
+```json
+{
+ "field": "String",
+ "size": 1024,
+ "bucketDefinition": {"@odata.type": "microsoft.graph.bucketAggregationDefinition"}
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "sortProperty resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Bucketaggregationdefinition https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/bucketaggregationdefinition.md
+
+ Title: "bucketAggregationDefinition resource type"
+description: "Provides the details on how to generate the agregations in the results"
+ms.localizationpriority: medium
+++
+# bucketAggregationDefinition resource type
+
+Namespace: microsoft.graph
+
+Provides the details on how to generate the agregations in the results.
+
+## Properties
+
+| Property | Type | Description |
+|:-|:|:|
+|isDescending|Boolean|`True` to specify the sort order as descending. The default is `false`, with the sort order as ascending. Optional.|
+|minimumCount|Int32|The minimum number of items that should be present in the aggregation to be returned in a bucket. Optional.|
+|prefixFilter|String|A filter to define a matching criteria. The key should start with the specified prefix to be returned in the response. Optional.|
+|ranges|[bucketAggregationRange](bucketaggregationrange.md) collection|Specifies the manual ranges to compute the aggregations. This is only valid for non-string refiners of date or numeric type. Optional.|
+|sortBy|bucketAggregationSortProperty| The possible values are `count` to sort by the number of matches in the aggregation, `keyAsString`to sort alphabeticaly based on the key in the aggregation, `keyAsNumber` for numerical sorting based on the key in the aggregation. Required.
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.bucketAggregationDefinition",
+ "baseType": null
+}-->
+
+```json
+{
+ "sortBy": "String",
+ "isDescending": true,
+ "prefixFilter": "String",
+ "minimumCount": 1024,
+ "ranges": [{"@odata.type": "microsoft.graph.bucketAggregationRange"}]
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "sortProperty resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Bucketaggregationrange https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/bucketaggregationrange.md
+
+ Title: "bucketAggregationRange resource type"
+description: "Specifies the lower and upper limit to a range for aggregating search results. Applies only to refiners of the date or numeric type"
+ms.localizationpriority: medium
+++
+# bucketAggregationRange resource type
+
+Namespace: microsoft.graph
+
+Specifies the lower and upper limit to a range for aggregating search results. Applies only to refiners of the date or numeric type.
+
+## Properties
+
+| Property | Type | Description |
+|:-|:|:|
+|from|String| Defines the lower bound from which to compute the aggregation. This can be a numeric value or a string representation of a date using the `YYYY-MM-DDTHH:mm:ss.sssZ` format. Required.|
+|to|String| Defines the upper bound up to which to compute the aggregation. This can be a numeric value or a string representation of a date using the `YYYY-MM-DDTHH:mm:ss.sssZ` format. Required.|
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.bucketAggregationRange",
+ "baseType": null
+}-->
+
+```json
+{
+ "from": "String",
+ "to": "String"
+}
+```
v1.0 Channel https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/channel.md
where files are shared, and where tabs are added.
|[Get tab in channel](../api/channel-get-tabs.md) | [teamsTab](teamstab.md) | Get a specific tab pinned to a channel.| |[Update tab in channel](../api/channel-patch-tabs.md) | [teamsTab](teamstab.md) | Updates the properties of a tab in a channel.| |[Remove tab from channel](../api/channel-delete-tabs.md) | None | Remove (unpin) a tab from a channel.|-
+|[Provision channel email address](../api/channel-provisionemail.md) |[provisionChannelEmailResult](../resources/provisionchannelemailresult.md)| Provision an email address for the channel.|
+|[Remove channel email address](../api/channel-removeemail.md) | None | Remove the email address of the channel.|
## Properties
v1.0 Objectidentity https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/objectidentity.md
The **identities** property of the [user](user.md) resource is an **objectIdenti
| Property | Type |Description| |:|:--|:-|
-|signInType|string| Specifies the user sign-in types in your directory, such as `emailAddress`, `userName` or `federated`. Here, `federated` represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Additional validation is enforced on **issuerAssignedId** when the sign-in type is set to `emailAddress` or `userName`. This property can also be set to any custom string.|
+|signInType|String| Specifies the user sign-in types in your directory, such as `emailAddress`, `userName`, `federated`, or `userPrincipalName`. `federated` represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Setting or updating a `userPrincipalName` identity will update the value of the **userPrincipalName** property on the user object. The validations performed on the `userPrincipalName` property on the user object, for example, verified domains and acceptable characters, will be performed when setting or updating a `userPrincipalName` identity. Additional validation is enforced on **issuerAssignedId** when the sign-in type is set to `emailAddress` or `userName`. This property can also be set to any custom string. |
|issuer|string|Specifies the issuer of the identity, for example `facebook.com`.<br>For local accounts (where **signInType** is not `federated`), this property is the local B2C tenant default domain name, for example `contoso.onmicrosoft.com`.<br>For external users from other Azure AD organization, this will be the domain of the federated organization, for example `contoso.com`.<br><br>Supports `$filter`. 512 character limit.| |issuerAssignedId|string|Specifies the unique identifier assigned to the user by the issuer. The combination of **issuer** and **issuerAssignedId** must be unique within the organization. Represents the sign-in name for the user, when **signInType** is set to `emailAddress` or `userName` (also known as local accounts).<br>When **signInType** is set to: <ul><li>`emailAddress`, (or a custom string that starts with `emailAddress` like `emailAddress1`) **issuerAssignedId** must be a valid email address</li><li>`userName`, **issuerAssignedId** must be a valid [local part of an email address](https://tools.ietf.org/html/rfc3696#section-3)</li></ul>Supports `$filter`. 100 character limit.|
v1.0 Provisionchannelemailresult https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/provisionchannelemailresult.md
+
+ Title: "provisionChannelEmailResult resource type"
+description: "Represents the result of a channel email provisioning operation."
+
+ms.localizationpriority: medium
++
+# provisionChannelEmailResult resource type
+
+Namespace: microsoft.graph
+
+Represents the email address [provisioned](..\api\channel-provisionemail.md) for a [channel](channel.md).
+
+## Properties
+| Property | Type | Description |
+| :- | :-- | :- |
+| email | String | Represents the provisioned email address. |
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.provisionChannelEmailResult"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.provisionChannelEmailResult",
+ "email": "String"
+}
+```
v1.0 Search Api Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/search-api-overview.md
Search requests run on behalf of the user. Search results are scoped to enforce
|[Get the most relevant emails](#get-the-most-relevant-emails) | **enableTopResults** | |[Get selected properties](#get-selected-properties) | **fields** | |[Use KQL in query terms](#keyword-query-language-kql-support) | **query** |
+|[Sort search results](#sort-search-results)| **sort** |
+|[Refine results using aggregations](#refine-results-using-aggregations)| **aggregations** |
## Scope search based on entity types
Depending on the entity type, the searchable properties vary. For details, see:
- [Email properties](/microsoft-365/compliance/keyword-queries-and-search-conditions#searchable-email-properties) - [Site properties](/microsoft-365/compliance/keyword-queries-and-search-conditions#searchable-site-properties)
+## Sort search results
+
+Search results in the response are sorted in the following default sort order:
+
+- **message** and **event** are sorted by date.
+- All SharePoint, OneDrive, person and connector types are sorted by relevance.
+
+The [query](../api/search-query.md) method lets you customize the search order by specifying the **sortProperties** on the `requests` parameter, which is a collection of [searchRequest](./searchrequest.md) objects. This allows you to specify a list of one or more sortable properties and the sort order.
+
+Note that sorting results is currently only supported on the following SharePoint and OneDrive types: [driveItem](driveitem.md), [listItem](listitem.md), [list](list.md), [site](site.md).
+
+The properties on which the sort clause are applied need to be sortable in the SharePoint [search schema](/sharepoint/manage-search-schema). If the property specified in the request is not sortable or does not exist, the response will return an error, `HTTP 400 Bad Request`. Note that you cannot specify to sort documents by relevance using [sortProperty](sortproperty.md).
+
+When specifying the **name** of a [sortProperty](sortproperty.md) object, you can either use the property name from the Microsoft Graph type (for example, in [driveItem](driveitem.md)), or the name of the managed property in the search index.
+
+See [sort search results](/graph/search-concept-sort) for examples that show how to sort results.
+
+## Refine results using aggregations
+
+Aggregations (also known as refiners in SharePoint) are a very popular way to enhance a search experience. In addition to the results, they provide some level of aggregate information on the matching set of search results. For example, you can provide information on the most represented authors of the documents matching the query, or the most represented file types, etc.
+
+In the [searchRequest](./searchrequest.md), specify the aggregations that should be returned in addition to the search results. The description of each aggregation is defined in the [aggregationOption](./aggregationoption.md), which specifies the property on which the aggregation should be computed, and the number of [searchBucket](searchBucket.md) to be returned in the response.
+
+The properties on which the aggregation is requested need to be refinable in the SharePoint [search schema](/sharepoint/manage-search-schema). If the property specified is not refinable or does not exist, the response returns `HTTP 400 Bad Request`.
+
+Once the response is returned containing the collection of [searchBucket](searchBucket.md) objects, it is possible to refine the search request to only the matching elements contained in one [searchBucket](searchBucket.md). This is achieved by passing back the **aggregationsFilterToken** value in the **aggregationFilters** property of the subsequent [searchRequest](./searchrequest.md).
+
+Aggregations are currently supported for any refinable property on the following SharePoint and OneDrive types: [driveItem](driveitem.md), [listItem](listitem.md), [list](list.md), [site](site.md), and on Microsoft Graph connectors [externalItem](externalconnectors-externalitem.md).
+
+See [refine search results](/graph/search-concept-aggregation) for examples that show using aggregation to enhance and narrow down search results.
+ ## Error handling The search API returns error responses as defined by [OData error object definition](http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_ErrorResponse), each of which is a JSON object containing a code and a message.
Any combinations involving **message**, **event**, SharePoint and OneDrive types
- [Search Outlook messages](/graph/search-concept-messages) - [Search calendar events](/graph/search-concept-events) - [Search content in SharePoint and OneDrive](/graph/search-concept-files)
+ - [Sort search results](/graph/search-concept-sort)
+ - [Refine search results](/graph/search-concept-aggregation)
- Explore the search APIs in [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). - Find out about the [latest new features and updates](/graph/whats-new-overview) for this API set.
v1.0 Searchbucket https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/searchbucket.md
+
+ Title: "searchBucket resource type"
+description: "Represents a container for one or more search results that share the same value for the entity field that aggregates them"
+ms.localizationpriority: medium
+++
+# searchBucket resource type
+
+Namespace: microsoft.graph
+
+Represents a container for one or more search results that share the same value for the entity field that aggregates them.
+
+## Properties
+
+| Property | Type | Description |
+|:-|:|:|
+|aggregationFilterToken|String| A token containing the encoded filter to aggregate search matches by the specific **key** value. To use the filter, pass the token as part of the **aggregationFilter** property in a **searchRequest** object, in the format **"{field}:\\"{aggregationFilterToken}\\""**. See an [example](/graph/search-concept-aggregation#example-2-apply-an-aggregation-filter-based-on-a-previous-request).|
+|count|Int32| The approximate number of search matches that share the same value specified in the **key** property. Note that this number is not the exact number of matches.|
+|key|String| The discrete value of the field that an aggregation was computed on.|
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.searchBucket",
+ "baseType": null
+}-->
+
+```json
+{
+ "key": "String",
+ "count": "10",
+ "aggregationFilterToken": "String"
+}
+```
v1.0 Searchrequest https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/searchrequest.md
The JSON blob contains the types of resources expected in the response, the unde
## Properties
-| Property | Type | Description | |
-|:-|:|:|:|
+| Property | Type | Description
+|:-|:|:
+|aggregations|[aggregationOption](aggregationOption.md) collection|Specifies aggregations (also known as refiners) to be returned alongside search results. Optional.|
+|aggregationFilters|String collection|Contains one or more filters to obtain search results aggregated and filtered to a specific value of a field. Optional.<br>Build this filter based on a prior search that aggregates by the same field. From the response of the prior search, identify the [searchBucket](searchBucket.md) that filters results to the specific value of the field, use the string in its **aggregationFilterToken** property, and build an aggregation filter string in the format **"{field}:\\"{aggregationFilterToken}\\""**. <br>If multiple values for the same field need to be provided, use the strings in its **aggregationFilterToken** property and build an aggregation filter string in the format **"{field}:or(\\"{aggregationFilterToken1}\\",\\"{aggregationFilterToken2}\\")"**. <br>For example, searching and aggregating drive items by file type returns a **searchBucket** for the file type `docx` in the response. You can conveniently use the **aggregationFilterToken** returned for this **searchBucket** in a subsequent search query and filter matches down to drive items of the `docx` file type. [Example 1](/graph/search-concept-aggregation#example-1-request-aggregations-by-string-fields) and [example 2](/graph/search-concept-aggregation#example-2-apply-an-aggregation-filter-based-on-a-previous-request) show the actual requests and responses.|
|contentSources|String collection|Contains the connection to be targeted.| |enableTopResults|Boolean|This triggers hybrid sort for messages : the first 3 messages are the most relevant. This property is only applicable to entityType=`message`. Optional.| |entityTypes|entityType collection| One or more types of resources expected in the response. Possible values are: `list`, `site`, `listItem`, `message`, `event`, `drive`, `driveItem`, `externalItem`. See [known limitations](search-api-overview.md#known-limitations) for those combinations of two or more entity types that are supported in the same search request. Required.|
The JSON blob contains the types of resources expected in the response, the unde
|from|Int32|Specifies the offset for the search results. Offset 0 returns the very first result. Optional.| |query|[searchQuery](searchquery.md)|Contains the query terms. Required.| |size|Int32|The size of the page to be retrieved. Optional.|
+|sortProperties|[sortProperty](sortProperty.md) collection|Contains the ordered collection of fields and direction to sort results. There can be at most 5 sort properties in the collection. Optional.|
## JSON representation
The following is a JSON representation of the resource.
- Search [mail messages](/graph/search-concept-messages) - Search [calendar events](/graph/search-concept-events) - Search content in SharePoint and OneDrive ([files, lists and sites](/graph/search-concept-files))
+- [Sort](/graph/search-concept-sort) search results
+- Use [aggregations](/graph/search-concept-aggregations) to refine search results
v1.0 Sortproperty https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/sortproperty.md
+
+ Title: "sortProperty resource type"
+description: "Indicates the order to sort search results"
+ms.localizationpriority: medium
+++
+# sortProperty resource type
+
+Namespace: microsoft.graph
+
+Indicates the order to sort search results.
+
+## Properties
+
+| Property | Type | Description |
+|:-|:|:|
+|name|String|The name of the property to sort on. Required.|
+|isDescending|Boolean|`True` if the sort order is descending. Default is `false`, with the sort order as ascending. Optional.|
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.sortProperty",
+ "baseType": null
+}-->
+
+```json
+{
+ "name": "String",
+ "isDescending": "true"
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "sortProperty resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Toc.Yml https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/toc.yml a/api-reference/v1.0/toc.yml
items:
href: api/channel-list-members.md - name: List message replies href: api/chatmessage-list-replies.md
+ - name: Provision email address
+ href: api/channel-provisionemail.md
+ - name: Remove email address
+ href: api/channel-removeemail.md
- name: Remove member href: api/channel-delete-members.md - name: Reply to message