Updates from: 07/17/2021 03:09:21
Service Microsoft Docs article Related commit history on GitHub Change details
v1.0 Accesspackage Post Accesspackageresourcerolescopes https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/accesspackage-post-accesspackageresourcerolescopes.md
POST /identityGovernance/entitlementManagement/accessPackages/{id}/accessPackage
## Request body
-In the request body, supply a JSON representation of an [accessPackageResourceRoleScope](../resources/accesspackageresourcerolescope.md) object. Include in the object the relationships to an [accessPackageResourceRole](../resources/accesspackageresourcerole.md) and [accessPackageResourceScope](../resources/accesspackageresourcescope.md).
+In the request body, supply a JSON representation of an [accessPackageResourceRoleScope](../resources/accesspackageresourcerolescope.md) object. Include in the object the relationships to an [accessPackageResourceRole](../resources/accesspackageresourcerole.md) object, which can be obtained from a request to [list access package resource roles of a resource in a catalog](accesspackagecatalog-list-accesspackageresourceroles.md), and an [accessPackageResourceScope](../resources/accesspackageresourcescope.md) object, which can be obtained from a request to [list access package resources](accesspackagecatalog-list-accesspackageresources.md) with `$expand=accessPackageResourceScopes`.
## Response
If successful, this method returns a 200-series response code and a new [accessP
#### Request
-The following is an example of the request. The access package resource for the group must already have been added to the access package catalog containing this access package.
+The following is an example of the request. Prior to this request, the access package resource `1d08498d-72a1-403f-8511-6b1f875746a0` for the group `b31fe1f1-3651-488f-bd9a-1711887fd4ca` must already have been added to the access package catalog containing this access package. The resource could have been added to the catalog by [creating an access package resource request](accesspackageresourcerequest-post.md).
# [HTTP](#tab/http) <!-- {
v1.0 Accesspackageassignmentpolicy Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/accesspackageassignmentpolicy-post.md
Content-type: application/json
"approvalStages": [{ "approvalStageTimeOutInDays": 14, "isApproverJustificationRequired": true,
- "isEscalationEnabled": true,
+ "isEscalationEnabled": false,
"escalationTimeInMinutes": 11520, "primaryApprovers": [{ "@odata.type": "#microsoft.graph.groupMembers",
Content-type: application/json
} ] },
- "accessReviewSettings": {
- "isEnabled": false
- },
"questions": [{ "isRequired": false, "text": {
v1.0 Accesspackageassignmentpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/accesspackageassignmentpolicy-update.md
Content-length: 1000
"approvalStages": [{ "approvalStageTimeOutInDays": 14, "isApproverJustificationRequired": true,
- "isEscalationEnabled": true,
+ "isEscalationEnabled": false,
"escalationTimeInMinutes": 11520, "primaryApprovers": [{ "@odata.type": "#microsoft.graph.groupMembers",
Content-length: 1000
} ] },
- "accessReviewSettings": {
- "isEnabled": false
- },
"questions": [{ "isRequired": false, "text": {
v1.0 Accesspackageassignmentrequest List https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/accesspackageassignmentrequest-list.md
If successful, this method returns a `200 OK` response code and a collection of
### Request
-The following is an example of the request.
+The following is an example of the request. The request URI includes `$filter` to only return requests in a particular state, and `$expand` to return details of the requestor and their connected organization as well.
# [HTTP](#tab/http) <!-- {
The following is an example of the request.
}--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentRequests
+GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentRequests?$expand=requestor($expand=connectedOrganization)&$filter=(requestState eq 'PendingApproval')
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/get-accesspackageassignmentrequests-csharp-snippets.md)]
Content-type: application/json
"value": [ { "id": "433dafca-5047-4614-95f7-a03510b1ded3",
- "requestType": "AdminAdd",
- "requestState": "Delivered",
- "requestStatus": "Fulfilled",
- "isValidationOnly": false,
- "createdDateTime": "2019-10-25T22:55:11.623Z"
+ "requestType": "UserAdd",
+ "requestState": "PendingApproval",
+ "createdDateTime": "2019-10-25T22:55:11.623Z",
+ "justification": "Need access",
+ "answers": [],
+ "requestor": {
+ "connectedOrganizationId": "c3c2adbc-a863-437f-9383-ee578665317d",
+ "id": "ba7ef0fb-e16f-474b-87aa-02815d061e67",
+ "displayName": "displayname",
+ "email": "displayname@example.com",
+ "type": "User",
+ "connectedOrganization": {
+ "id": "c3c2adbc-a863-437f-9383-ee578665317d",
+ "displayName": "example"
+ }
+ }
} ] }
v1.0 Accesspackagecatalog List Accesspackageresources https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/accesspackagecatalog-list-accesspackageresources.md
GET /identityGovernance/entitlementManagement/accessPackageCatalogs/{id}/accessP
## Optional query parameters
-This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+This method supports OData query parameters to help customize the response. For example, to retrieve the access package resource scopes and environments for each resource, include `$expand=accessPackageResourceScopes,accessPackageResourceEnvironment` in the query. To retrieve the available roles of a resource, include `$expand=accessPackageResourceRoles`. To retrieve only resources for applications and not groups or sites, include `$filter=resourceType eq 'Application'` in the query. For general information, see [OData query parameters](/graph/query-parameters).
## Request headers
If successful, this method returns a `200 OK` response code and a collection of
### Request
-The following is an example of the request.
+The following is an example of the request, using a filter to select resources of a particular type and `$expand` to return resource scopes of each resource.
# [HTTP](#tab/http) <!-- {
The following is an example of the request.
}--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/{id}/accessPackageResources
+GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/{id}/accessPackageResources?$filter=resourceType eq 'Application'&$expand=accessPackageResourceScopes
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/get-accesspackageresources-csharp-snippets.md)]
Content-type: application/json
"description": "Example application", "url": "https://myapps.microsoft.com/example.com/signin/Faculty%20cafeteria%20ordering/f1e3b407-942d-4934-9a3f-cef1975cb988/", "resourceType": "Application",
- "originId": "2f1099a6-d4fc-4cc9-a0ef-ddd3f1bf0b7e"
+ "originId": "2f1099a6-d4fc-4cc9-a0ef-ddd3f1bf0b7e",
+ "accessPackageResourceScopes": [
+ {
+ "id": "452d78a7-69a5-482d-a82f-859a5169c55e",
+ "displayName": "Root",
+ "description": "Root Scope",
+ "originId": "2f1099a6-d4fc-4cc9-a0ef-ddd3f1bf0b7e",
+ "originSystem": "AadApplication",
+ "isRootScope": true
+ }
+ ]
} ] } ```
+https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/e71fafe7-9ccb-4c5a-a7b3-77ec35e83e3c/accessPackageResources
+ <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 2019-02-04 14:57:30 UTC --> <!-- {
v1.0 Contenttype Publish https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/contenttype-publish.md
ms.prod: "sites-and-lists"
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Publishes a [contentType][] present in content type hub site.
+Publishes a [contentType][] present in a content type hub site.
## Permissions
One of the following permissions is required to call this API. To learn more, in
POST /sites/{siteId}/contentTypes/{contentTypeId}/publish ```
->**Note:** The siteId represents a content type hub site.
+>**Note:** `siteId` represents a content type hub site.
## Request headers |Name|Description|
v1.0 Externalconnectors Connectionoperation Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-connectionoperation-get.md
+
+ Title: "Get connectionOperation"
+description: "Retrieve the properties of a connectionOperation."
+localization_priority: Normal
+++
+# Get connectionOperation
+
+Namespace: microsoft.graph.externalConnectors
++
+Retrieve the properties of a [connectionOperation](../resources/externalconnectors-connectionoperation.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalConnection.ReadWrite.OwnedBy |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /external/connections/{connection-id}/operations/{operation-id}
+```
+
+## Request headers
+
+| Name | Description |
+|:--|:--|
+| 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 the requested [connectionOperation](../resources/externalconnectors-connectionoperation.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_connectionoperation"
+}-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/connections/contosohr/operations/3ed1595a-4bae-43c2-acda-ef973e581323
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "expectError": true,
+ "@odata.type": "microsoft.graph.externalConnectors.connectionOperation"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "id": "3ed1595a-4bae-43c2-acda-ef973e581323",
+ "status": "failed",
+ "error": {
+ "message": "Server error, something went wrong"
+ }
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Get connectionOperation",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors External Post Connections https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-external-post-connections.md
+
+ Title: "Create connection"
+description: "Use this API to create a new externalConnection."
+localization_priority: Normal
+++
+# Create connection
+
+Namespace: microsoft.graph.externalConnectors
++
+Create a new [externalConnection](../resources/externalconnectors-externalconnection.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalConnection.ReadWrite.OwnedBy |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+POST /external/connections
+```
+
+## Request headers
+
+| Name | Description |
+|:--|:-|
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, supply a JSON representation of an [externalConnection](../resources/externalconnectors-externalconnection.md) object.
+
+## Response
+
+If successful, this method returns `201 Created` response code and a new [externalConnection](../resources/externalconnectors-externalconnection.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_connection_from_external"
+}-->
+
+```http
+POST https://graph.microsoft.com/beta/external/connections
+Content-type: application/json
+
+{
+ "id": "contosohr",
+ "name": "Contoso HR",
+ "description": "Connection to index Contoso HR system"
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalConnection"
+} -->
+
+```http
+HTTP/1.1 201 Created
+Content-type: application/json
+
+{
+ "id": "contosohr",
+ "name": "Contoso HR",
+ "description": "Connection to index Contoso HR system",
+ "state": "draft",
+ "configuration": {
+ "authorizedAppIds": [
+ "d310d35d-72ec-47dd-92f2-fb9c40936555"
+ ]
+ }
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Create connection",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
++
v1.0 Externalconnectors Externalconnection Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalconnection-delete.md
+
+ Title: "Delete externalConnection"
+description: "Delete an externalConnection."
+localization_priority: Normal
+++
+# Delete externalConnection
+
+Namespace: microsoft.graph.externalConnectors
++
+Delete an [externalConnection](../resources/externalconnectors-externalconnection.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalConnection.ReadWrite.OwnedBy |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+DELETE /external/connections/{id}
+```
+
+## Request headers
+
+| Name | Description |
+|:--|:--|
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns `202 Accepted` response code. It does not return anything in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "delete_connection"
+}-->
+
+```http
+DELETE https://graph.microsoft.com/beta/connections/contosohr
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 202 Accepted
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Delete externalConnection",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
++
v1.0 Externalconnectors Externalconnection Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalconnection-get.md
+
+ Title: "Get connection"
+description: "Retrieve the properties and relationships of an externalConnection."
+localization_priority: Normal
+++
+# Get connection
+
+Namespace: microsoft.graph.externalConnectors
++
+Retrieve the properties and relationships of an [externalConnection](../resources/externalconnectors-externalconnection.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalConnection.ReadWrite.OwnedBy |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /external/connections/{id}
+```
+
+## Optional query parameters
+
+This method supports the [OData query parameters](/graph/query-parameters) to help customize the response.
+
+## Request headers
+
+| Name | Description |
+|:--|:--|
+| 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 the requested [externalConnection](../resources/externalconnectors-externalconnection.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_connection"
+}-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/connections/contosohr
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalConnection"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "id": "contosohr",
+ "name": "Contoso HR",
+ "description": "Connection to index Contoso HR system",
+ "state": "ready",
+ "configuration": {
+ "authorizedAppIds": [
+ "d310d35d-72ec-47dd-92f2-fb9c40936555"
+ ]
+ }
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Get connection",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Externalconnection List https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalconnection-list.md
+
+ Title: "List connections"
+description: "Retrieve a list of externalConnections."
+localization_priority: Normal
+++
+# List connections
+
+Namespace: microsoft.graph.externalConnectors
++
+Retrieve a list of [externalConnections](../resources/externalconnectors-externalconnection.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalConnection.ReadWrite.OwnedBy |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /external/connections
+```
+
+## Optional query parameters
+
+This method supports the [OData query parameters](/graph/query-parameters) to help customize the response.
+
+## Request headers
+
+| Name | Description |
+|:--|:--|
+| 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 collection of [externalConnection](../resources/externalconnectors-externalconnection.md) objects in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_connections"
+}-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/external/connections
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalConnection",
+ "isCollection": true
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "value": [
+ {
+ "id": "contosohr",
+ "name": "Contoso HR",
+ "description": "Connection to index Contoso HR system",
+ "state": "ready",
+ "configuration": {
+ "authorizedAppIds": [
+ "d310d35d-72ec-47dd-92f2-fb9c40936555"
+ ]
+ }
+ },
+ {
+ "id": "contosofinance",
+ "name": "Contoso Finance",
+ "description": "Connection to index Contoso Finance system",
+ "state": "ready",
+ "configuration": {
+ "authorizedAppIds": [
+ "fbdc7d4e-07f4-4143-8258-e5a2fcebeadb"
+ ]
+ }
+ }
+ ]
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "List connections",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Externalconnection Post Groups https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalconnection-post-groups.md
+
+ Title: "Create externalGroup"
+description: "Create a new externalGroup object."
+
+localization_priority: Normal
++
+# Create externalGroup
+
+Namespace: microsoft.graph.externalConnectors
++
+Create a new [externalGroup](../resources/externalconnectors-externalgroup.md) object.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported |
+| Delegated (personal Microsoft account) | Not supported |
+| Application | ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+``` http
+POST /external/connections/{connectionId}/groups
+```
+
+## Request headers
+
+| Name | Description |
+|:--|:-|
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, supply a JSON representation of the [externalGroup](../resources/externalconnectors-externalgroup.md) object.
+
+The following table shows the properties that are required when you create the [externalGroup](../resources/externalconnectors-externalgroup.md).
+
+| Property | Type | Description |
+|:|:-|:-|
+| id | String | The unique ID of the external group within a connection. It must be alphanumeric and can be up to 128 characters long. |
+| displayName | String | The friendly name of the external group. Optional. |
+| description | String | The description of the external group. Optional. |
+
+## Response
+
+If successful, this method returns a `201 Created` response code and an [externalGroup](../resources/externalconnectors-externalgroup.md) object in the response body.
+
+## Examples
+
+### Request
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_externalgroup_from_connection"
+}
+-->
+
+``` http
+POST https://graph.microsoft.com/beta/external/connections/contosohr/groups
+Content-Type: application/json
+
+{
+ "id": "31bea3d537902000",
+ "displayName": "Contoso Marketing",
+ "description": "The product marketing team"
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+
+**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalGroup"
+}
+-->
+
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "id": "31bea3d537902000",
+ "displayName": "Contoso Marketing",
+ "description": "The product marketing team"
+}
+```
v1.0 Externalconnectors Externalconnection Post Schema https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalconnection-post-schema.md
+
+ Title: "Create schema"
+description: "Create the schema for a Microsoft Search connection."
+localization_priority: Normal
+++
+# Create schema
+
+Namespace: microsoft.graph.externalConnectors
++
+Create the schema for a Microsoft Search [connection](../resources/externalconnectors-externalconnection.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalConnection.ReadWrite.OwnedBy |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+POST /external/connections/{id}/schema
+```
+
+## Request headers
+
+| Name | Description |
+|:-|:-|
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+| Prefer: respond-async | Use this to cause the request to execute asynchronously. Optional. |
+
+## Request body
+
+In the request body, supply a JSON representation of a [schema](../resources/externalconnectors-schema.md) object.
+
+When registering a custom item schema, the `schema` object MUST have the `baseType` property set to `microsoft.graph.externalItem` and MUST contain the `properties` property. The `properties` object must contain at least one property, up to a maximum of 64.
+
+## Response
+
+With the `Prefer: respond-async` header included in the request, if successful, this method returns a `202 Accepted` response code and a URL in the `Location` response header that can be used to [get the operation status](../api/externalconnectors-connectionoperation-get.md).
+
+Without the `Prefer: respond-async` header included in the request, if successful, this method returns a `201 Created` response code and a new [schema](../resources/externalconnectors-schema.md) object in the response body.
+
+> [!NOTE]
+> Creating a schema is a long-running process prone to gateway timeouts. We recommend using the `Prefer: respond-async` header to avoid timeout errors.
+
+## Examples
+
+### Example: Register custom schema asynchronously
+
+#### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_schema_from_connection_async",
+ "@odata.type": "microsoft.graph.externalConnectors.schema"
+}-->
+
+```http
+POST https://graph.microsoft.com/beta/external/connections/contosohr/schema
+Content-type: application/json
+Prefer: respond-async
+
+{
+ "baseType": "microsoft.graph.externalItem",
+ "properties": [
+ {
+ "name": "ticketTitle",
+ "type": "string",
+ "isSearchable": "true",
+ "isRetrievable": "true",
+ "labels": [
+ "title"
+ ]
+ },
+ {
+ "name": "priority",
+ "type": "string",
+ "isQueryable": "true",
+ "isRetrievable": "true",
+ "isSearchable": "false"
+ },
+ {
+ "name": "assignee",
+ "type": "string",
+ "isRetrievable": "true"
+ }
+ ]
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+++
+<!-- markdownlint-disable MD024 -->
+#### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 202 Accepted
+Location: https://graph.microsoft.com/beta/external/connections/contosohr/operations/616bfeed-666f-4ce0-8cd9-058939010bfc
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Create externalItem",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Externalconnection Put Items https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalconnection-put-items.md
+
+ Title: "Create externalItem"
+description: "Create a new externalItem."
+localization_priority: Normal
+++
+# Create externalItem
+
+Namespace: microsoft.graph.externalConnectors
++
+Create a new [externalItem](../resources/externalconnectors-externalitem.md).
+
+This API can be used to create a custom item. The containing [externalConnection](../resources/externalconnectors-externalconnection.md) must have a [schema](../resources/externalconnectors-schema.md) registered of the corresponding type.
+
+## Permissions
+
+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) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+PUT /external/connections/{connection-id}/items/{item-id}
+```
+
+## Path parameters
+
+| Parameter | Type | Description |
+|:--|:-|:-|
+| connection-id | string | The `id` property of the containing [externalConnection](../resources/externalconnectors-externalconnection.md) |
+| item-id | string | The developer-provided `id` property of the [externalItem](../resources/externalconnectors-externalitem.md). If no item already exists with this `id`, a new item is created. If an item already exists with this `id`, it is overwritten by the object sent in the body. |
+
+## Request headers
+
+| Name | Description |
+|:--|:-|
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, supply a JSON representation of an [externalItem](../resources/externalconnectors-externalitem.md) object. The payload is limited to 4 MB.
+
+### Creating an externalItem
+
+When creating an `externalItem`, the following fields are required: `acl`, and `properties`. The `properties` object must contain at least one property.
+
+All `DateTime` type properties must be in ISO 8601 format.
+
+Properties on an `externalItem` should use type specifiers in the payload in the following scenarios:
+
+- For `String` type properties, if the value contains non-ASCII characters.
+
+ ```json
+ "description@odata.type": "String",
+ "description": "Kandierte Äpfel"
+ ```
+
+- For all collection types.
+
+ ```json
+ "categories@odata.type": "Collection(String)"
+ "categories": [
+ "red",
+ "blue"
+ ]
+ ```
+
+ > [!IMPORTANT]
+ > When including a property of type `Collection(DateTime)`, you must use the type specifier `Collection(DateTimeOffset)`.
+
+## Response
+
+If successful, this method returns `200 OK` response code.
+
+## Examples
+
+### Example: Create a custom item
+
+#### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_externalitem_from_connections",
+ "@odata.type": "microsoft.graph.externalConnectors.externalItem"
+}-->
+
+```http
+PUT https://graph.microsoft.com/beta/external/connections/contosohr/items/TSP228082938
+Content-type: application/json
+
+{
+ "acl": [
+ {
+ "type": "user",
+ "value": "e811976d-83df-4cbd-8b9b-5215b18aa874",
+ "accessType": "grant",
+ "identitySource": "azureActiveDirectory"
+ },
+ {
+ "type": "group",
+ "value": "14m1b9c38qe647f6a",
+ "accessType": "deny",
+ "identitySource": "external"
+ }
+ ],
+ "properties": {
+ "title": "Error in the payment gateway",
+ "priority": 1,
+ "assignee": "john@contoso.com"
+ },
+ "content": {
+ "value": "Error in payment gateway...",
+ "type": "text"
+ }
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
++++
+<!-- markdownlint-disable MD024 -->
+#### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 200 OK
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Create externalItem",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Externalconnection Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalconnection-update.md
+
+ Title: "Update externalConnection"
+description: "Update the properties of an externalConnection."
+localization_priority: Normal
+++
+# Update connection
+
+Namespace: microsoft.graph.externalConnectors
++
+Update the properties of an [externalConnection](../resources/externalconnectors-externalconnection.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalConnection.ReadWrite.OwnedBy |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+PATCH /external/connections/{id}
+```
+
+## Request headers
+
+| Name | Description |
+|:--|:-|
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. The following properties can be updated.
+
+| Property | Type | Description |
+|:--|:--|:|
+| configuration | [microsoft.graph.externalConnectors.configuration](../resources/externalconnectors-configuration.md) | Specifies additional application IDs that are allowed to manage the connection and to index content in the connection. |
+| description | String | Description of the connection displayed in the Microsoft 365 admin center. |
+| name | String | The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. |
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_connection",
+ "@odata.type": "microsoft.graph.externalConnectors.externalConnection"
+}-->
+
+```http
+PATCH https://graph.microsoft.com/beta/connections/contosohr
+Content-type: application/json
+
+{
+ "name": "Contoso HR Service Tickets",
+ "description": "Connection to index HR service tickets"
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Update connection",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Externalgroup Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalgroup-delete.md
+
+ Title: "Delete externalGroup"
+description: "Deletes an externalGroup object."
+
+localization_priority: Normal
++
+# Delete externalGroup
+
+Namespace: microsoft.graph.externalConnectors
++
+Delete an [externalGroup](../resources/externalconnectors-externalgroup.md) object.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported |
+| Delegated (personal Microsoft account) | Not supported |
+| Application | ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+``` http
+DELETE /external/connections/{connectionId}/groups/{externalGroupId}
+```
+
+## Request headers
+
+| Name | Description |
+|:--|:--|
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "delete_externalgroup"
+}
+-->
+
+``` http
+DELETE https://graph.microsoft.com/beta/external/connections/contosohr/groups/31bea3d537902000
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+
+``` http
+HTTP/1.1 204 No Content
+```
v1.0 Externalconnectors Externalgroup Post Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalgroup-post-members.md
+
+ Title: "Create externalGroupMember"
+description: "Create a new externalGroupMember object."
+
+localization_priority: Normal
++
+# Create externalGroupMember
+
+Namespace: microsoft.graph.externalConnectors
++
+Create a new [externalGroupMember](../resources/externalconnectors-externalgroupmember.md) object.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported |
+| Delegated (personal Microsoft account) | Not supported |
+| Application | ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+``` http
+POST /external/connections/{connectionsId}/groups/{externalGroupId}/members
+```
+
+## Request headers
+
+| Name | Description |
+|:--|:-|
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, supply a JSON representation of the [externalGroupMember](../resources/externalconnectors-externalgroupmember.md) object.
+
+The following table shows the properties that are required when you create the [externalGroupMember](../resources/externalconnectors-externalgroupmember.md).
+
+| Property | Type | Description |
+|:|:|:|
+| id | String | The unique `id` of the member. It would be the objectId in case of Azure Active Directory users or groups and the externalGroupId in case of external groups. |
+| type | microsoft.graph.externalConnectors.externalGroupMemberType | The type of member added to the external group. Possible values are: `user` or `group` when the identitySource is `azureActiveDirectory` and just `group` when the identitySource is `external`. |
+| identitySource | microsoft.graph.externalConnectors.identitySourceType | The identity source that the member belongs to. Possible values are: `azureActiveDirectory`, `external`. |
+
+## Response
+
+If successful, this method returns a `201 Created` response code and an [externalGroupMember](../resources/externalconnectors-externalgroupmember.md) object in the response body.
+
+## Examples
+
+### Example 1: Add an Azure Active Directory user as a member
+
+### Request
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_externalgroupmember_from__1"
+}
+-->
+
+``` http
+POST https://graph.microsoft.com/beta/external/connections/contosohr/groups/31bea3d537902000/members
+Content-Type: application/json
+
+{
+ "id": "e811976d-83df-4cbd-8b9b-5215b18aa874",
+ "type": "user",
+ "identitySource": "azureActiveDirectory"
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+
+**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalGroupMember"
+}
+-->
+
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "id": "e811976d-83df-4cbd-8b9b-5215b18aa874",
+ "type": "user",
+ "identitySource": "azureActiveDirectory"
+}
+```
+
+### Example 2: Add an Azure Active Directory group as a member
+
+### Request
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_externalgroupmember_from__2"
+}
+-->
+
+``` http
+POST https://graph.microsoft.com/beta/external/connections/contosohr/groups/31bea3d537902000/members
+Content-Type: application/json
+
+{
+ "id": "e5477431-1038-484e-bf69-1dfedb97a110",
+ "type": "group",
+ "identitySource": "azureActiveDirectory"
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+### Response
+
+**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalGroupMember"
+}
+-->
+
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "id": "e5477431-1038-484e-bf69-1dfedb97a110",
+ "type": "group",
+ "identitySource": "azureActiveDirectory"
+}
+```
+
+### Example 3: Add another external group as a member
+
+### Request
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_externalgroupmember_from__3"
+}
+-->
+
+``` http
+POST https://graph.microsoft.com/beta/external/connections/contosohr/groups/31bea3d537902000/members
+Content-Type: application/json
+
+{
+ "id": "1431b9c38ee647f6a",
+ "type": "group",
+ "identitySource": "external"
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+### Response
+
+**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalGroupMember"
+}
+-->
+
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "id": "14m1b9c38qe647f6a",
+ "type": "group",
+ "identitySource": "external"
+}
+```
v1.0 Externalconnectors Externalgroupmember Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalgroupmember-delete.md
+
+ Title: "Delete externalGroupMember"
+description: "Delete an externalGroupMember object."
+
+localization_priority: Normal
++
+# Delete externalGroupMember
+
+Namespace: microsoft.graph.externalConnectors
++
+Delete an [externalGroupMember](../resources/externalconnectors-externalgroupmember.md) object.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported |
+| Delegated (personal Microsoft account) | Not supported |
+| Application | ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+``` http
+DELETE /external/connections/{connectionId}/groups/{externalGroupId}/members/{externalGroupMemberId}
+```
+
+## Request headers
+
+| Name | Description |
+|:--|:--|
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "delete_externalgroupmember"
+}
+-->
+
+``` http
+DELETE https://graph.microsoft.com/beta/external/connections/contosohr/groups/31bea3d537902000/members/14m1b9c38qe647f6a
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+++
+<!-- markdownlint-disable MD024 -->
+### Response
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+
+``` http
+HTTP/1.1 204 No Content
+```
v1.0 Externalconnectors Externalitem Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalitem-delete.md
+
+ Title: "Delete externalItem"
+description: "Delete an externalItem."
+localization_priority: Normal
+++
+# Delete externalItem
+
+Namespace: microsoft.graph.externalConnectors
++
+Delete an [externalitem](../resources/externalconnectors-externalitem.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+DELETE /external/connections/{connection-id}/items/{item-id}
+```
+
+## Path parameters
+
+| Parameter | Type | Description |
+|:--|:-|:-|
+| connection-id | string | The `id` property of the containing [externalConnection](../resources/externalconnectors-externalconnection.md) |
+| item-id | string | The developer-provided `id` property of the [externalItem](../resources/externalconnectors-externalitem.md). |
+
+## Request headers
+
+| Name | Description |
+|:--|:--|
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns `204 No Content` response code. It does not return anything in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "delete_externalitem"
+}-->
+
+```http
+DELETE https://graph.microsoft.com/beta/connections/contosohr/items/TSP228082938
+```
+# [Objective-C](#tab/objc)
+
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Delete externalItem",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
++
v1.0 Externalconnectors Externalitem Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalitem-get.md
+
+ Title: "Get externalItem"
+description: "Get an externalItem."
+localization_priority: Normal
+++
+# Get externalItem
+
+Namespace: microsoft.graph.externalConnectors
++
+Get the properties and relationships of an [externalitem](../resources/externalconnectors-externalitem.md) object.
+
+This API is provided for diagnostic purposes only. It is not intended to be used for any other purpose. Repeated requests to this API might result in `429` HTTP errors.
+
+## Permissions
+
+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) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /external/connections/{connection-id}/items/{item-id}
+```
+
+## Path parameters
+
+| Parameter | Type | Description |
+|:--|:-|:-|
+| connection-id | string | The `id` property of the containing [externalConnection](../resources/externalconnectors-externalconnection.md) |
+| item-id | string | The developer-provided `id` property of the [externalItem](../resources/externalconnectors-externalitem.md). |
+
+## Optional query parameters
+
+This method does not support optional query parameters to customize the response.
+
+## Request headers
+
+| Name | Description |
+|:--|:--|
+| 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 an [externalItem](../resources/externalconnectors-externalitem.md) object in the response body.
+
+## Example
+
+### Request
+
+The following is an example of the request.
+
+```http
+GET https://graph.microsoft.com/beta/connections/contosohr/items/TSP228082938
+```
+
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalItem"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "acl": [
+ {
+ "type": "user",
+ "value": "e811976d-83df-4cbd-8b9b-5215b18aa874",
+ "accessType": "grant",
+ "identitySource": "azureActiveDirectory"
+ },
+ {
+ "type": "group",
+ "value": "14m1b9c38qe647f6a",
+ "accessType": "deny",
+ "identitySource": "external"
+ }
+ ],
+ "properties": {
+ "title": "Error in the payment gateway",
+ "priority": 1,
+ "assignee": "john@contoso.com"
+ },
+ "content": {
+ "value": "Error in payment gateway...",
+ "type": "text"
+ }
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Get externalItem",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Externalitem Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-externalitem-update.md
+
+ Title: "Update externalItem"
+description: "Update the properties of an externalitem."
+localization_priority: Normal
+++
+# Update externalItem
+
+Namespace: microsoft.graph.externalConnectors
++
+Update the properties of an [externalitem](../resources/externalconnectors-externalitem.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+PATCH /external/connections/{connection-id}/items/{item-id}
+```
+
+## Path parameters
+
+| Parameter | Type | Description |
+|:--|:-|:-|
+| connection-id | string | The `id` property of the containing [externalConnection](../resources/externalconnectors-externalconnection.md) |
+| item-id | string | The developer-provided `id` property of the [externalItem](../resources/externalconnectors-externalitem.md). |
+
+## Request headers
+
+| Name | Description |
+|:--|:-|
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, supply the values for relevant fields that should be updated. Existing properties (excluding properties inside the `properties` object) that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. The following properties can be updated.
+
+| Property | Type | Description |
+|:--|:--|:--|
+| acl | [microsoft.graph.externalConnectors.acl](../resources/externalconnectors-acl.md) collection | An array of access control entries. Each entry specifies the access granted to a user or group. |
+| content | [microsoft.graph.externalConnectors.externalItemContent](../resources/externalconnectors-externalitemcontent.md) | A plain-text representation of the contents of the item. The text in this property is full-text indexed. |
+| properties | Object | A property bag with the properties of the item. The properties MUST conform to the [schema](../resources/externalconnectors-schema.md) defined for the [externalConnection](../resources/externalconnectors-externalconnection.md). |
+
+### Updating the acl collection
+
+If the `acl` property is included in an update request, the existing ACL collection is overwritten with the collection included in the request.
+
+### Updating the properties object
+
+If the `properties` property is included in an update request, the existing property bag is overwritten with the value included in the request.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and an updated [externalItem](../resources/externalconnectors-externalitem.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_externalitem",
+ "@odata.type": "microsoft.graph.externalConnectors.acl"
+}-->
+
+```http
+PATCH https://graph.microsoft.com/beta/connections/contosohr/items/TSP228082938
+Content-type: application/json
+
+{
+ "acl": [
+ {
+ "type": "everyone",
+ "value": "67a141d8-cf4e-4528-ba07-bed21bfacd2d",
+ "accessType": "grant",
+ "identitySource": "azureActiveDirectory"
+ }
+ ]
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalItem"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "id": "TSP228082938",
+ "acl": [
+ {
+ "type": "everyone",
+ "value": "67a141d8-cf4e-4528-ba07-bed21bfacd2d",
+ "accessType": "grant",
+ "identitySource": "azureActiveDirectory"
+ }
+ ],
+ "properties": {
+ "title": "Error in the payment gateway",
+ "priority": 1,
+ "assignee": "john@contoso.com"
+ },
+ "content": {
+ "@odata.type": "microsoft.graph.externalConnectors.externalItemContent",
+ "value": "<h1>Error in payment gateway</h1><p>Error details...</p>",
+ "type": "html"
+ }
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Update externalitem",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": [
+ "Error: update_externalitem/properties:\r\n Referenced type microsoft.graph.object is not defined in the doc set! Potential suggestion: microsoft.graph.directoryObject"
+ ]
+}-->
++
v1.0 Externalconnectors Schema Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/externalconnectors-schema-get.md
+
+ Title: "Get schema"
+description: "Retrieve the properties of a schema for an externalConnection."
+localization_priority: Normal
+++
+# Get schema
+
+Namespace: microsoft.graph.externalConnectors
++
+Retrieve the properties of a [schema](../resources/externalconnectors-schema.md) for an [externalConnection](../resources/externalconnectors-externalconnection.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalConnection.ReadWrite.OwnedBy |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /external/connections/{id}/schema
+```
+
+## Optional query parameters
+
+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+
+| Name | Description |
+|:--|:--|
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and the requested [schema](../resources/externalconnectors-schema.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_schema"
+}-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/external/connections/contosohr/schema
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
++++
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.schema"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "baseType": "microsoft.graph.externalItem",
+ "properties": [
+ {
+ "name": "ticketTitle",
+ "type": "string",
+ "isSearchable": true,
+ "isRetrievable": true,
+ "labels": [
+ "title"
+ ]
+ },
+ {
+ "name": "priority",
+ "type": "string",
+ "isQueryable": true,
+ "isRetrievable": true,
+ "isRefinable": true,
+ "isSearchable": false
+ },
+ {
+ "name": "assignee",
+ "type": "string",
+ "isRetrievable": true
+ }
+ ]
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Get schema",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
++
v1.0 Sitepage List https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/sitepage-list.md
One of the following permissions is required to call this API. To learn more, in
```msgraph-interactive GET /sites/{site-id}/pages- ``` ## Example
-#### Request
+### Request
<!-- {
GET /sites/{site-id}/pages
GET /sites/{site-id}/pages ```
-#### Response
+### Response
<!-- {
v1.0 Accesspackageresource https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/accesspackageresource.md
In [Azure AD Entitlement Management](entitlementmanagement-root.md), an access p
| Relationship | Type | Description | |:-|:|:|
-|accessPackageResourceEnvironment|[accessPackageResourceEnvironment](accesspackageresourceenvironment.md)| Nullable.|
-|accessPackageResourceRoles|[accessPackageResourceRole](accesspackageresourcerole.md) collection| Read-only. Nullable.|
-|accessPackageResourceScopes|[accessPackageResourceScope](accesspackageresourcescope.md) collection| Read-only. Nullable.|
+|accessPackageResourceEnvironment|[accessPackageResourceEnvironment](accesspackageresourceenvironment.md)| Nullable. Supports `$expand`.|
+|accessPackageResourceRoles|[accessPackageResourceRole](accesspackageresourcerole.md) collection| Read-only. Nullable. Supports `$expand`.|
+|accessPackageResourceScopes|[accessPackageResourceScope](accesspackageresourcescope.md) collection| Read-only. Nullable. Supports `$expand`.|
## JSON representation
v1.0 Accesspackageresourcescope https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/accesspackageresourcescope.md
Namespace: microsoft.graph
In [Azure AD entitlement management](entitlementmanagement-root.md), an access package resource scope is a reference to a scope within a resource, for those resources that have multiple scopes.
-You can determine the access package resource scope, for a resource that has already been added to an access package, by using [list accessPackageResourceRoleScopes](../api/accesspackage-list-accesspackageresourcerolescopes.md) to return a collection of [accessPackageResourceRoleScope](accesspackageresourcerolescope.md) objects.
+You can determine the access package resource scope, for a resource which has roles already added to an access package, by using [list accessPackageResourceRoleScopes](../api/accesspackage-list-accesspackageresourcerolescopes.md) to return a collection of [accessPackageResourceRoleScope](accesspackageresourcerolescope.md) objects.
+
+If the resource is in an access package catalog but has not yet had its roles added to an access package, you can determine the access package resource scope by using [list accessPackageResources](../api/accesspackagecatalog-list-accesspackageresources.md) and including `$expand=accessPackageResourceScopes,accessPackageResourceEnvironment` in the query.
## Properties
v1.0 Accesspackagesubject https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/accesspackagesubject.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-In [Azure AD entitlement management](entitlementmanagement-root.md), an access package subject is a user, service principal, or other entity that can be configured to request or be assigned an access package.
+In [Azure AD entitlement management](entitlementmanagement-root.md), an access package subject is a user, service principal, or other entity that can be configured to request or be assigned an access package. It may represent a requestor from a connected organization who is not yet in the tenant.
## Properties
In [Azure AD entitlement management](entitlementmanagement-root.md), an access p
|displayName|String|The display name of the subject.| |email|String|The email address of the subject.| |id|String| Read-only.|
-|objectId|String|The object ID of the subject.|
+|objectId|String|The object identifier of the subject. `null` if the subject is not yet a user in the tenant.|
|principalName|String|The principal name, if known, of the subject.| |type|String|The resource type of the subject.|
+|connectedOrganizationId|String|The identifier of the connected organization of the subject.|
## Relationships
-None.
+| Relationship | Type | Description |
+|:-|:|:|
+|connectedOrganization|[connectedOrganization](connectedorganization.md)| The connected organization of the subject. Read-only. Nullable.|
+ ## JSON representation
The following is a JSON representation of the resource.
"tocPath": "" }--> -
v1.0 Enums Externalconnectors https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/enums-externalconnectors.md
+
+ Title: "External connectors enum values"
+description: "Microsoft Graph external connectors enumeration values"
+localization_priority: Normal
++++
+# External connectors enum values
+
+Namespace: microsoft.graph.externalConnectors
+
+### accessType values
+
+| Member
+|:--
+| grant
+| deny
+| unknownFutureValue
+
+### aclType values
+
+| Member
+|:--
+| user
+| group
+| everyone
+| everyoneExceptGuests
+| externalGroup
+| unknownFutureValue
++
+### connectionOperationStatus values
+
+| Member
+|:--
+| unspecified
+| inprogress
+| completed
+| failed
+| unknownFutureValue
++
+### connectionState values
+
+|Member
+|:--
+| draft
+| ready
+| obsolete
+| limitExceeded
+| unknownFutureValue
++
+### externalGroupMemberType values
+
+| Member
+|:--
+| user
+| group
+| unknownFutureValue
++
+### externalItemContentType values
+
+| Member
+|:--
+| text
+| html
+| unknownFutureValue
+
+### identitySourceType values
+
+| Member
+|:--
+| azureActiveDirectory
+| external
++
+### label values
+
+| Member
+|:--
+| title
+| url
+| createdBy
+| lastModifiedBy
+| authors
+| createdDateTime
+| lastModifiedDateTime
+| fileName
+| fileExtension
+| unknownFutureValue
+| iconUrl
+| containerName
+| containerUrl
++
+### propertyType values
+
+| Member
+|:--
+| string
+| int64
+| double
+| dateTime
+| boolean
+| stringCollection
+| int64Collection
+| doubleCollection
+| dateTimeCollection
+| unknownFutureValue
+
+<!--
+{
+ "type": "#page.annotation",
+ "namespace": "microsoft.graph.externalConnectors"
+}
+-->
++
v1.0 Enums https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/enums.md
Possible values for user account types (group membership), per Windows definitio
| proposed | 1 | Connected Organizations that are automatically created by the system have this state value. They are not included in assignment policies with requestor scope type `AllConfiguredConnectedOrganizationSubjects`. | | unknownFutureValue | 2 | A sentinel member. |
-### identitySourceType values
-
-|Member|
-|:|
-|azureActiveDirectory|
-|external|
-
-### externalGroupMemberType values
-
-|Member|
-|:|
-|user|
-|group|
- ### identityUserFlowAttributeDataType values | Member | Value | Description |
Possible values for user account types (group membership), per Windows definitio
|required|3|| | unknownFutureValue | 4 | A sentinel member. |
-### connectionState values
-
-|Member|
-|:|
-|draft|
-|ready|
-|obsolete|
-|limitExceeded|
- ### permissionClassificationType values | Member
v1.0 Errordetail https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/errordetail.md
- Title: "errorDetail resource type"
-description: "Describes an error for a failed request to create a Microsoft Search connection schema asynchronously."
-localization_priority: Normal
-
-doc_type: "resourcePageType"
--
-# errorDetail resource type
-
-Namespace: microsoft.graph
--
-Describes an error for a failed request to create a Microsoft Search connection [schema](schema.md) asynchronously.
--
-## Properties
-
-| Property | Type | Description |
-|:-|:|:|
-| details | [innerErrorDetail](innererrordetail.md) collection | A collection of inner errors, if any. Read-only, nullable. |
-| errorCode | String | The error code associated with the error, if any. Read-only, nullable. |
-| message | String | The human-readable error message. Read-only. |
-
-## JSON representation
-
-The following is a JSON representation of the resource.
-
-<!-- {
- "blockType": "resource",
- "optionalProperties": [
- "details",
- "errorCode"
- ],
- "@odata.type": "microsoft.graph.errorDetail",
- "baseType": null
-}-->
-
-```json
-{
- "details": [{"@odata.type": "microsoft.graph.innerErrorDetail"}],
- "errorCode": "String",
- "message": "String"
-}
-```
-
-<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
-2019-02-04 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "errorDetail resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": ""
-}-->
--
v1.0 Externalconnection https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnection.md
- Title: "externalConnection resource type"
-description: "A connection is a logical container for your external content in Microsoft Graph"
-localization_priority: Normal
-
-doc_type: "resourcePageType"
--
-# externalConnection resource type
-
-Namespace: microsoft.graph
--
-A logical container to add content from an external source into Microsoft Graph.
-
-## Methods
-
-| Method | Return Type | Description |
-|:--|:-|:--|
-| [Create externalConnection](../api/external-post-connections.md) | externalConnection | Create a new externalConnection by posting to the connections collection. |
-| [List externalConnections](../api/externalconnection-list.md) | externalConnection collection | Get a externalConnection object collection. |
-| [Get externalConnection](../api/externalconnection-get.md) | externalConnection | Read properties and relationships of a externalConnection object. |
-| [Update externalConnection](../api/externalconnection-update.md) | externalConnection | Update a externalConnection object. |
-| [Delete externalConnection](../api/externalconnection-delete.md) | None | Delete a externalConnection object. |
-| [Create schema](../api/externalconnection-post-schema.md) | None *or* [schema](schema.md) | Register connection schema. |
-| [Get operation](../api/connectionoperation-get.md) | [connectionOperation](connectionoperation.md) | Get the status of an asynchronous request to create the connection schema. |
-| [Create externalItem](../api/externalconnection-put-items.md) | [externalItem](externalitem.md) | Create a new externalItem by posting to the items collection. |
-
-## Properties
-
-| Property | Type | Description |
-|:--|:-|:|
-| configuration | [configuration](configuration.md) | Specifies additional application IDs that are allowed to manage the connection and to index content in the connection. Optional. |
-| description | String | Description of the connection displayed in the Microsoft 365 admin center. Optional. |
-| id | String | Developer-provided unique ID of the connection within the Azure Active Directory tenant. Maximum length of 32 characters. Must only contain alphanumeric characters. Cannot begin with `Microsoft` or be one of the following values: `None`, `Directory`, `Exchange`, `ExchangeArchive`, `LinkedIn`, `Mailbox`, `MicrosoftSearch`, `OneDriveBusiness`, `SharePoint`, `Teams`, `Yammer`, `Connectors`. Required. |
-| name | String | The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. Required. |
-| state | connectionState | Indicates the current state of the connection. Possible values are `draft`, `ready`, `obsolete`, and `limitExceeded`. Required. |
-
-## Relationships
-
-| Relationship | Type | Description |
-|:-|:|:|
-| items | [externalItem](externalitem.md) collection | Read-only. Nullable. |
-| operations | [connectionOperation](connectionoperation.md) collection | Read-only. Nullable. |
-| schema | [schema](schema.md) | Read-only. Nullable. |
-
-## JSON representation
-
-The following is a JSON representation of the resource.
-
-<!-- {
- "blockType": "resource",
- "optionalProperties": [
-
- ],
- "@odata.type": "microsoft.graph.externalConnection",
- "keyProperty": "id"
-}-->
-
-```json
-{
- "configuration": {"@odata.type": "microsoft.graph.configuration"},
- "description": "String",
- "id": "String (identifier)",
- "name": "String",
- "state": "String"
-}
-```
-
-<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
-2019-02-04 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "connection resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": ""
-}-->
v1.0 Externalconnectors Acl https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnectors-acl.md
+
+ Title: "acl resource type"
+description: "An access control entry for an item indexed by a Microsoft Search externalConnection."
+localization_priority: Normal
+++
+# acl resource type
+
+Namespace: microsoft.graph.externalConnectors
++
+An access control entry for an item indexed by a Microsoft Search [externalConnection](externalconnectors-externalconnection.md).
+
+## Properties
+
+| Property | Type | Description |
+|:|:-|:|
+| accessType | String | The access granted to the identity. Possible values are: `grant`, `deny`. |
+| identitySource | String | The source of identity. Possible values are `azureActiveDirectory` or `external`. |
+| type | String | The type of identity. Possible values are: `user`, `group`, `everyone`, `everyoneExceptGuests` if the identitySource is `azureActiveDirectory` and just `group` if the identitySource is `external`. |
+| value | String | The unique identifer of the identity. In case of Azure Active Directory identities, `value` is set to the object identifier of the user, group or tenant for types user, group and everyone (and everyoneExceptGuests) respectively. In case of external groups `value` is set to the ID of the [externalGroup](externalconnectors-externalgroup.md).|
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.externalConnectors.acl",
+ "baseType": null
+}-->
+
+```json
+{
+ "accessType": "String",
+ "identitySource": "String",
+ "type": "String",
+ "value": "String"
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "acl resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Configuration https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnectors-configuration.md
+
+ Title: "configuration resource type"
+description: "Specifies additional application IDs that are allowed to manage the externalConnection and to index content in a externalConnection."
+localization_priority: Normal
+++
+# configuration resource type
+
+Namespace: microsoft.graph.externalConnectors
++
+Specifies additional application IDs that are allowed to manage the externalConnection and to index content in a [externalConnection](../resources/externalconnectors-externalconnection.md).
+
+## Properties
+
+| Property | Type | Description |
+|:|:|:|
+| authorizedAppIds | String collection | A collection of application IDs for registered Azure Active Directory apps that are allowed to manage the externalConnection and to index content in the externalConnection. |
+
+> [!NOTE]
+> The `authorizedAppIds` property was previously named `authorizedApps`.
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.externalConnectors.configuration",
+ "baseType": null
+}-->
+
+```json
+{
+ "authorizedAppIds": ["String"]
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "configuration resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Connectionoperation https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnectors-connectionoperation.md
+
+ Title: "connectionOperation resource type"
+description: "Describes status of an asynchronous request to create a Microsoft Search connection schema."
+localization_priority: Normal
+++
+# connectionOperation resource type
+
+Namespace: microsoft.graph.externalConnectors
++
+Describes status of an asynchronous request to create a Microsoft Search connection [schema](externalconnectors-schema.md).
+
+## Methods
+
+| Method | Return Type | Description |
+|:-|:|:|
+| [Get connectionOperation](../api/externalconnectors-connectionoperation-get.md) | [connectionOperation](externalconnectors-connectionoperation.md) | Read properties of a connectionOperation object. |
+
+## Properties
+
+| Property | Type | Description |
+|:|:|:-|
+| error | [publicError](publicerror.md) | If `status` is `failed`, provides more information about the error that caused the failure. |
+| id | String | Unique identifier for the connectionOperation. Read-only. |
+| status | String | Indicates the status of the asynchronous operation. Possible values are: `unspecified`, `inprogress`, `completed`, `failed`. |
+
+## Relationships
+
+None
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.externalConnectors.connectionOperation",
+ "keyProperty": "id"
+}-->
+
+```json
+{
+ "id": "String (identifier)",
+ "status": "String"
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "connectionOperation resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Externalconnection https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnectors-externalconnection.md
+
+ Title: "externalConnection resource type"
+description: "A connection is a logical container for your external content in Microsoft Graph"
+localization_priority: Normal
+++
+# externalConnection resource type
+
+Namespace: microsoft.graph.externalConnectors
++
+A logical container to add content from an external source into Microsoft Graph.
+
+## Methods
+
+| Method | Return Type | Description |
+|:--|:-|:--|
+| [Create externalConnection](../api/externalconnectors-external-post-connections.md) | externalConnection | Create a new externalConnection by posting to the connections collection. |
+| [List externalConnections](../api/externalconnectors-externalconnection-list.md) | externalConnection collection | Get a externalConnection object collection. |
+| [Get externalConnection](../api/externalconnectors-externalconnection-get.md) | externalConnection | Read properties and relationships of a externalConnection object. |
+| [Update externalConnection](../api/externalconnectors-externalconnection-update.md) | externalConnection | Update a externalConnection object. |
+| [Delete externalConnection](../api/externalconnectors-externalconnection-delete.md) | None | Delete a externalConnection object. |
+| [Create schema](../api/externalconnectors-externalconnection-post-schema.md) | None *or* [schema](externalconnectors-schema.md) | Register connection schema. |
+| [Get operation](../api/externalconnectors-connectionoperation-get.md) | [connectionOperation](externalconnectors-connectionoperation.md) | Get the status of an asynchronous request to create the connection schema. |
+| [Create externalItem](../api/externalconnectors-externalconnection-put-items.md) | [externalItem](externalconnectors-externalitem.md) | Create a new externalItem by posting to the items collection. |
+
+## Properties
+
+| Property | Type | Description |
+|:--|:-|:|
+| configuration | [microsoft.graph.externalConnectors.configuration](externalconnectors-configuration.md) | Specifies additional application IDs that are allowed to manage the connection and to index content in the connection. Optional. |
+| description | String | Description of the connection displayed in the Microsoft 365 admin center. Optional. |
+| id | String | Developer-provided unique ID of the connection within the Azure Active Directory tenant. Must be between 3 and 32 characters in length. Must only contain alphanumeric characters. Cannot begin with `Microsoft` or be one of the following values: `None`, `Directory`, `Exchange`, `ExchangeArchive`, `LinkedIn`, `Mailbox`, `OneDriveBusiness`, `SharePoint`, `Teams`, `Yammer`, `Connectors`, `TaskFabric`, `PowerBI`, `Assistant`, `TopicEngine`, `MSFT_All_Connectors`. Required. |
+| name | String | The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. Required. |
+| state | microsoft.graph.externalConnectors.connectionState | Indicates the current state of the connection. Possible values are `draft`, `ready`, `obsolete`, and `limitExceeded`. Required. |
+
+## Relationships
+
+| Relationship | Type | Description |
+|:-|:|:|
+| items | [microsoft.graph.externalConnectors.externalItem](externalconnectors-externalitem.md) collection | Read-only. Nullable. |
+| operations | [microsoft.graph.externalConnectors.connectionOperation](externalconnectors-connectionoperation.md) collection | Read-only. Nullable. |
+| schema | [microsoft.graph.externalConnectors.schema](externalconnectors-schema.md) | Read-only. Nullable. |
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.externalConnectors.externalConnection",
+ "keyProperty": "id"
+}-->
+
+```json
+{
+ "description": "String",
+ "id": "String (identifier)",
+ "name": "String",
+ "state": "String"
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "connection resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Externalgroup https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnectors-externalgroup.md
+
+ Title: "externalGroup resource type"
+description: "Represents an external group used to set permissions on externalItems added to a Microsoft Graph connection."
+
+localization_priority: Normal
++
+# externalGroup resource type
+
+Namespace: microsoft.graph.externalConnectors
++
+Represents an external group. External groups (along with Azure Active Directory users and groups) are used to set permissions on **externalItems** added to a Microsoft Graph connection. Use **externalGroups** to represent non-Azure Active Directory groups or group-like constructs (such as Business units, Teams, and son on) that determine permission over the content in your external data source.
+
+## Methods
+
+|Method|Return type|Description|
+|:|:|:|
+|[Create externalGroup](../api/externalconnectors-externalconnection-post-groups.md)|[microsoft.graph.externalConnectors.externalGroup](../resources/externalconnectors-externalgroup.md)|Create a new **externalGroup** object.|
+|[Delete externalGroup](../api/externalconnectors-externalgroup-delete.md)|None|Delete an **externalGroup** object.|
+|[Create members](../api/externalconnectors-externalgroup-post-members.md)|[microsoft.graph.externalConnectors.externalGroupMember](../resources/externalconnectors-externalgroupmember.md)|Create a new **externalGroupMember** object.|
+
+## Properties
+
+| Property | Type | Description |
+|:|:-|:-|
+| id | String | The unique ID of the external group within a connection. It must be alphanumeric and can be up to 128 characters long. |
+| displayName | String | The friendly name of the external group. Optional. |
+| description | String | The description of the external group. Optional.
+
+## Relationships
+
+| Relationship | Type | Description |
+|:-|:-|:-|
+| members | [microsoft.graph.externalConnectors.externalGroupMember](../resources/externalconnectors-externalgroupmember.md) collection | A member added to an **externalGroup**. You can add Azure Active Directory users, Azure Active Directory groups, or other **externalGroups** as members. |
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.externalConnectors.externalGroup",
+ "openType": false
+}
+-->
+
+``` json
+{
+ "id": "String (identifier)",
+ "displayName": "String",
+ "description": "String"
+}
+```
v1.0 Externalconnectors Externalgroupmember https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnectors-externalgroupmember.md
+
+ Title: "externalGroupMember resource type"
+description: "Represents a member of an externalGroup used to set permissions on external content added to Microsoft Graph."
+
+localization_priority: Normal
++
+# externalGroupMember resource type
+
+Namespace: microsoft.graph.externalConnectors
++
+Represents a member of an [externalGroup](externalconnectors-externalgroup.md) used to set permissions on external content added to Microsoft Graph.
+
+## Methods
+
+| Method | Return type | Description |
+|:--|:--|:--|
+| [Create externalGroupMember](../api/externalconnectors-externalgroup-post-members.md) | [externalGroupMember](../resources/externalconnectors-externalgroupmember.md) | Create a new **externalGroupMember** object. |
+| [Delete externalGroupMember](../api/externalconnectors-externalgroupmember-delete.md) | None | Delete an **externalGroupMember** object. |
+
+## Properties
+
+| Property | Type | Description |
+|:|:|:|
+| id | String | The unique ID of the member. It would be the objectId in case of Azure Active Directory users or groups and the **id** property of the **externalGroup** in case of external groups. |
+| type | microsoft.graph.externalConnectors.externalGroupMemberType | The type of member added to the external group. Possible values are: `user` or `group` when the **identitySource** is `azureActiveDirectory` and just `group` when the **identitySource** is `external`. |
+| identitySource | microsoft.graph.externalConnectors.identitySourceType | The identity source that the member belongs to. Possible values are: `azureActiveDirectory`, `external`. |
+
+## Relationships
+
+None.
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.externalConnectors.externalGroupMember",
+ "openType": false
+}
+-->
+
+``` json
+{
+ "id": "String (identifier)",
+ "type": "String",
+ "identitySource": "String"
+}
+```
v1.0 Externalconnectors Externalitem https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnectors-externalitem.md
+
+ Title: "externalItem resource type"
+description: "An item added to a Microsoft Graph connection."
+localization_priority: Normal
+++
+# externalItem resource type
+
+Namespace: microsoft.graph.externalConnectors
++
+An item added to a Microsoft Graph [connection](externalconnectors-externalconnection.md).
+
+## Methods
+
+| Method | Return Type | Description |
+|:--|:--|:--|
+| [Create externalItem](../api/externalconnectors-externalconnection-put-items.md) | [externalItem](externalconnectors-externalitem.md) | Create an externalItem. |
+| [Get externalItem](../api/externalconnectors-externalitem-get.md) | [externalItem](externalconnectors-externalitem.md) | Get an externalItem. |
+| [Update externalItem](../api/externalconnectors-externalitem-update.md) | [externalItem](externalconnectors-externalitem.md) | Update an externalItem. |
+| [Delete externalItem](../api/externalconnectors-externalitem-delete.md) | None | Delete an externalItem. |
+
+## Properties
+
+| Property | Type | Description |
+|:--|:-|:-|
+| acl | [microsoft.graph.externalConnectors.acl](externalconnectors-acl.md) collection | An array of access control entries. Each entry specifies the access granted to a user or group. Required. |
+| content | [microsoft.graph.externalConnectors.externalItemContent](externalconnectors-externalitemcontent.md) | A plain-text representation of the contents of the item. The text in this property is full-text indexed. Optional. |
+| id | String | Developer-provided unique ID of the item within the containing [externalConnection](externalconnectors-externalconnection.md). Must be alphanumeric and a maximum of 128 characters. Required. |
+| properties | Object | A property bag with the properties of the item. The properties MUST conform to the [schema](externalconnectors-schema.md) defined for the [externalConnection](externalconnectors-externalconnection.md). Required. |
+
+## Relationships
+
+None.
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+ ],
+ "@odata.type": "microsoft.graph.externalConnectors.externalItem",
+ "keyProperty": "id"
+}-->
+
+```json
+{
+ "acl": [
+ {
+ "type": "everyone",
+ "value": "67a141d8-cf4e-4528-ba07-bed21bfacd2d",
+ "accessType": "grant",
+ "identitySource": "azureActiveDirectory"
+ }
+ ],
+ "id": "String (identifier)",
+ "properties": "Object",
+ "content": { "@odata.type": "microsoft.graph.externalConnectors.externalItemContent" }
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "externalItem resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": [
+ "Error: microsoft.graph.externalConnectors.externalItem/properties:\r\n Referenced type microsoft.graph.object is not defined in the doc set! Potential suggestion: microsoft.graph.directoryObject"
+ ]
+}-->
v1.0 Externalconnectors Externalitemcontent https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnectors-externalitemcontent.md
+
+ Title: "externalItemContent resource type"
+description: "The content of an item indexed via a Microsoft Search connection."
+localization_priority: Normal
+++
+# externalItemContent resource type
+
+Namespace: microsoft.graph.externalConnectors
++
+The content of an [externalItem](externalconnectors-externalitem.md) indexed via a Microsoft Search [connection](externalconnectors-externalconnection.md).
+
+## Properties
+
+| Property | Type | Description |
+|:|:-|:--|
+| value | String | The content for the externalItem. Required. |
+| type | String | The type of content in the value property. Possible values are `text` and `html`. Required. |
+
+## Relationships
+
+None
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.externalConnectors.externalItemContent"
+}-->
+
+```json
+{
+ "value": "String",
+ "type": "String"
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "externalItemContent resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": []
+}-->
v1.0 Externalconnectors Property https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnectors-property.md
+
+ Title: "property resource type"
+description: "A schema property definition for a Microsoft Search connection."
+localization_priority: Normal
+++
+# property resource type
+
+Namespace: microsoft.graph.externalConnectors
++
+A [schema](externalconnectors-schema.md) property definition for a Microsoft Search [connection](externalconnectors-externalconnection.md).
+
+## Properties
+
+| Property | Type | Description |
+|:--|:|:|
+| aliases | String collection | A set of aliases or a friendly names for the property. Maximum 32 characters. Each string must not contain control characters, whitespace, or any of the following: `:`, `;`, `,`, `(`, `)`, `[`, `]`, `{`, `}`, `%`, `$`, `+`, `!`, `*`, `=`, `&`, `?`, `@`, `#`, `\`, `~`, `'`, `"`, `<`, `>`, `|`, `` ` ``, `^`. Optional. |
+| isQueryable | boolean | Specifies if the property is queryable. Queryable properties can be used in [Keyword Query Language (KQL) queries](/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). Optional. |
+| isRefinable | boolean | Specifies if the property is refinable. Refinable properties can be used to filter search results in the [Search API](search-api-overview.md) and add a refiner control in the Microsoft Search user experience. Optional. |
+| isRetrievable | boolean | Specifies if the property is retrievable. Retrievable properties are returned in the result set when items are returned by the search API. Retrievable properties are also available to add to the display template used to render search results. Optional. |
+| isSearchable | boolean | Specifies if the property is searchable. Only properties of type `string` or `stringCollection` can be searchable. Non-searchable properties are not added to the search index. Optional. |
+| labels | String collection | Specifies one or more well-known tags added against a property. Labels help Microsoft Search understand the semantics of the data in the connection. Adding appropriate labels would result in an enhanced search experience (e.g. better relevance). Supported labels: `title`, `url`, `createdBy`, `lastModifiedBy`, `authors`, `createdDateTime`, `lastModifiedDateTime`, `fileName`, `fileExtension`, `iconUrl`, `containerName`, and `containerUrl`. Optional. |
+| name | String | The name of the property. Maximum 32 characters. Must not contain control characters, whitespace, or any of the following: `:`, `;`, `,`, `(`, `)`, `[`, `]`, `{`, `}`, `%`, `$`, `+`, `!`, `*`, `=`, `&`, `?`, `@`, `#`, `\`, `~`, `'`, `"`, `<`, `>`, `|`, `` ` ``, `^`. Required. |
+| type | String | The data type of the property. Possible values are: `string`, `int64`, `double`, `dateTime`, `boolean`, `stringCollection`, `int64Collection`, `doubleCollection`, `dateTimeCollection`. Required. |
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.externalConnectors.property",
+ "baseType": null
+}-->
+
+```json
+{
+ "aliases": [ "String" ],
+ "isQueryable": true,
+ "isRefinable": true,
+ "isRetrievable": true,
+ "isSearchable": true,
+ "labels": [ "string" ],
+ "name": "string",
+ "type": "string"
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "property resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalconnectors Schema https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalconnectors-schema.md
+
+ Title: "schema resource type"
+description: "The connection schema determines how your content added into a connection will be used in various Microsoft Graph experiences."
+localization_priority: Normal
+++
+# schema resource type
+
+Namespace: microsoft.graph.externalConnectors
++
+The [connection](externalconnectors-externalconnection.md) schema determines how your external content will be used in various Microsoft Graph experiences. Schema is a flat list of all the properties that you plan to add to the connection along with their attributes, labels, and aliases. You must register the schema before adding items into the connection.
+
+## Methods
+
+| Method | Return Type | Description |
+|:-|:|:--|
+| [Create schema](../api/externalconnectors-externalconnection-post-schema.md) | None *or* [schema](externalconnectors-schema.md) | Register connection schema. |
+| [Get schema](../api/externalconnectors-schema-get.md) | [schema](externalconnectors-schema.md) | Read properties of a schema object. |
+
+## Properties
+
+| Property | Type | Description |
+|:--|:--|:|
+| baseType | String | Must be set to `microsoft.graph.externalItem`. Required. |
+| properties | [property](externalconnectors-property.md) collection | The properties defined for the items in the connection. The minimum number of properties is one, the maximum is 128. |
+
+## Relationships
+
+None.
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+ ],
+ "@odata.type": "microsoft.graph.externalConnectors.schema",
+ "keyProperty": "id"
+}-->
+
+```json
+{
+ "baseType": "String",
+ "id": "String (identifier)",
+ "properties": [
+ {
+ "name": "String",
+ "type": "String",
+ }
+ ]
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "schema resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Externalfile https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalfile.md
- Title: "externalFile resource type"
-description: "A file indexed via a Microsoft Search connection."
-localization_priority: Normal
-
-doc_type: "resourcePageType"
--
-# externalFile resource type
-
-Namespace: microsoft.graph
-
-> [!CAUTION]
-> The `externalFile` type has been deprecated. Developers should not use this type. External files may still be indexed using the [externalItem](externalitem.md) type.
--
-An item indexed via a Microsoft Search [connection](externalconnection.md). This type derives from the [externalItem](externalitem.md) type.
-
-## Methods
-
-| Method | Return Type | Description |
-|:--|:-|:--|
-| [Create externalFile](../api/externalconnection-put-items.md) | externalFile | Create an externalFile. |
-| [Update externalFile](../api/externalitem-update.md) | externalFile | Update an externalFile. |
-| [Delete](../api/externalitem-delete.md) | None | Delete an externalFile. |
-
-## Properties
-
-| Property | Type | Description |
-|:--|:-|:-|
-| acl | [acl](acl.md) collection | An array of access control entries. Each entry specifies the access granted to a user or group. Required. |
-| content | String | A plain-text representation of the contents of the item. The text in this property is full-text indexed. Optional. |
-| id | String | Developer-provided unique ID of the item within the containing [externalConnection](externalconnection.md). Must be alphanumeric and a maximum of 128 characters. Required. |
-| createdBy | String | The name of the user that created the file. |
-| createdDateTime | DateTimeOffset | The date and time that the file was created. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z` |
-| extension | String | The file extension. |
-| lastModifiedBy | String | The name of the user that last modified the file. |
-| modifiedDateTime | DateTimeOffset | The date and time that the file was last modified. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z` |
-| name | String | The file name. Required. |
-| size | Int64 | The size of the file in bytes. |
-| title | String | The title of the file. |
-| url | String | The URL to access the file. Required. |
-
-## Relationships
-
-None
-
-## JSON representation
-
-The following is a JSON representation of the resource.
-
-<!-- {
- "blockType": "resource",
- "optionalProperties": [
-
- ],
- "@odata.type": "microsoft.graph.externalFile",
- "baseType": "microsoft.graph.externalItem"
-}-->
-
-```json
-{
- "acl": [{"@odata.type": "microsoft.graph.acl"}],
- "content": "String",
- "id": "String (identifier)",
- "createdBy": "String",
- "createdDateTime": "String (timestamp)",
- "extension": "String",
- "lastModifiedBy": "String",
- "modifiedDateTime": "String (timestamp)",
- "name": "String",
- "size": 1024,
- "title": "String",
- "url": "String"
-}
-```
-
-<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
-2019-02-04 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "externalFile resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": ""
-}-->
--
v1.0 Externalitem https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/externalitem.md
- Title: "externalItem resource type"
-description: "An item added to a Microsoft Graph connection."
-localization_priority: Normal
-
-doc_type: "resourcePageType"
--
-# externalItem resource type
-
-Namespace: microsoft.graph
--
-An item added to a Microsoft Graph [connection](externalconnection.md).
-
-## Methods
-
-| Method | Return Type | Description |
-|:--|:--|:--|
-| [Create externalItem](../api/externalconnection-put-items.md) | [externalItem](externalitem.md) | Create an externalItem. |
-| [Get externalItem](../api/externalitem-get.md) | [externalItem](externalitem.md) | Get an externalItem. |
-| [Update externalItem](../api/externalitem-update.md) | [externalItem](externalitem.md) | Update an externalItem. |
-| [Delete externalItem](../api/externalitem-delete.md) | None | Delete an externalItem. |
-
-## Properties
-
-| Property | Type | Description |
-|:--|:-|:-|
-| acl | [acl](acl.md) collection | An array of access control entries. Each entry specifies the access granted to a user or group. Required. |
-| content | [externalItemContent](externalitemcontent.md) | A plain-text representation of the contents of the item. The text in this property is full-text indexed. Optional. |
-| id | String | Developer-provided unique ID of the item within the containing [externalConnection](externalconnection.md). Must be alphanumeric and a maximum of 128 characters. Required. |
-| properties | Object | A property bag with the properties of the item. The properties MUST conform to the [schema](schema.md) defined for the [externalConnection](externalconnection.md). Required. |
-
-## Relationships
-
-None.
-
-## JSON representation
-
-The following is a JSON representation of the resource.
-
-<!-- {
- "blockType": "resource",
- "optionalProperties": [
-
- ],
- "@odata.type": "microsoft.graph.externalItem",
- "keyProperty": "id"
-}-->
-
-```json
-{
- "acl": [{"@odata.type": "microsoft.graph.acl"}],
- "content": {"@odata.type": "microsoft.graph.externalItemContent"},
- "id": "String (identifier)",
- "properties": "Object"
-}
-```
-
-<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
-2019-02-04 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "externalItem resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- "Error: microsoft.graph.externalItem/properties:\r\n Referenced type microsoft.graph.object is not defined in the doc set! Potential suggestion: microsoft.graph.directoryObject"
- ]
-}-->
v1.0 Indexing Api Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/indexing-api-overview.md
Requests to index data are performed on behalf of an application without the pre
The use cases for the APIs in this section involve building [Microsoft Graph connectors](/microsoftsearch/connectors-overview), which involves the following primary steps:
-1. [Create a connection](../api/external-post-connections.md) to an external data source.
-2. [Create and register a schema](../api/externalconnection-post-schema.md) that describes the type and how to index the external data.
-3. [Index the data](../api/externalconnection-put-items.md) as an external item.
+1. [Create a connection](../api/externalconnectors-external-post-connections.md) to an external data source.
+2. [Create and register a schema](../api/externalconnectors-externalconnection-post-schema.md) that describes the type and how to index the external data.
+3. [Index the data](../api/externalconnectors-externalconnection-put-items.md) as an external item.
| Use cases | REST resources | See also | |:-|:--|:--| | **Configuration actions** | | |
-| Create, update, or delete a connection | [externalConnection](externalconnection.md) | [externalConnection methods](externalconnection.md#methods) |
-| Register a schema for the external data | [schema](schema.md) | [schema methods](schema.md#methods) |
+| Create, update, or delete a connection | [externalConnection](externalconnectors-externalconnection.md) | [externalConnection methods](externalconnectors-externalconnection.md#methods) |
+| Register a schema for the external data | [schema](externalconnectors-schema.md) | [schema methods](externalconnectors-schema.md#methods) |
| **Indexing actions** | | |
-| Add, update or delete a custom item in the index | [externalItem](externalitem.md) | [externalItem methods](externalItem.md#methods) |
+| Add, update or delete a custom item in the index | [externalItem](externalconnectors-externalitem.md) | [externalItem methods](externalconnectors-externalitem.md#methods) |
## Known limitations The following are current known limitations: - Organizations are limited to a maximum of 10 connections.-- Only Azure Active Directory identities are supported. - You can create only four `externalItem` resources items per second. - An application is limited to four concurrent operations on a connection. - Connections have a capacity limit of 700,000 items or ~70 GB of data. - Maximum size of an `externalItem` entity is 4 MB. - Sorting results is not supported.-- Result ranking is best effort. ## What's new Find out about the [latest new features and updates](/graph/whats-new-overview) for this API set.
Find out about the [latest new features and updates](/graph/whats-new-overview)
## Next steps - See the [Microsoft Search API overview](/graph/search-concept-overview).-- Drill down on the methods, properties, and relationships of the [externalConnection](externalconnection.md), [schema](schema.md), and [externalItem](externalitem.md) resources.
+- Drill down on the methods, properties, and relationships of the [externalConnection](externalconnectors-externalconnection.md), [schema](externalconnectors-schema.md), and [externalItem](externalconnectors-externalitem.md) resources.
+- Check out the [Microsoft Graph postman collection](https://www.postman.com/microsoftgraph/workspace/microsoft-graph/folder/455214-66cbb476-ad94-448e-ba5a-ef58e1da7a90?ctx=documentation) ([learn more](https://developer.microsoft.com/en-us/graph/blogs/postman-collections))
- Check out the [sample search connector](https://github.com/microsoftgraph/msgraph-search-connector-sample) from GitHub.
v1.0 Innererrordetail https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/innererrordetail.md
- Title: "innerErrorDetail resource type"
-description: "An inner error contained in an errorDetail object."
-localization_priority: Normal
-
-doc_type: "resourcePageType"
--
-# innerErrorDetail resource type
-
-Namespace: microsoft.graph
--
-An inner error contained in an [errorDetail](errordetail.md) object.
--
-## Properties
-
-| Property | Type | Description |
-|:|:-|:|
-| message | String | The human-readable error message. Read-only. |
-| source | String | The source of the error. Read-only. |
-
-## JSON representation
-
-The following is a JSON representation of the resource.
-
-<!-- {
- "blockType": "resource",
- "optionalProperties": [
-
- ],
- "@odata.type": "microsoft.graph.innerErrorDetail",
- "baseType": null
-}-->
-
-```json
-{
- "message": "String",
- "source": "String"
-}
-```
-
-<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
-2019-02-04 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "innerErrorDetail resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": ""
-}-->
--
v1.0 Search Api Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/search-api-overview.md
The following table describes the types available to query and the supported per
|[list](list.md)|Sites.Read.All, Sites.ReadWrite.All| SharePoint and OneDrive | Lists. Note that document libraries are also returned as lists. | |[listItem](listitem.md)|Sites.Read.All, Sites.ReadWrite.All| SharePoint and OneDrive | List items. Note that files and folders are also returned as list items; **listItem** is the super class of **driveItem**. | |[site](site.md)|Sites.Read.All, Sites.ReadWrite.All| SharePoint | Sites in SharePoint.|
-|[externalItem](externalitem.md)|ExternalItem.Read.All| Microsoft Graph connectors| All content ingested with the Microsoft Graph connectors API.|
+|[externalItem](externalconnectors-externalitem.md)|ExternalItem.Read.All| Microsoft Graph connectors| All content ingested with the Microsoft Graph connectors API.|
|[person](person.md)|People.Read|Exchange Online|Personal contacts and contacts or addressable objects in your organization.| ## Page search results
The properties on which the aggregation is requested need to be refinable in the
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](externalItem.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.
v1.0 Externalconnectors Connectionoperation Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-connectionoperation-get.md
+
+ Title: "Get connectionOperation"
+description: "Read the properties and relationships of a connectionOperation object."
+
+localization_priority: Normal
++
+# Get connectionOperation
+
+Namespace: microsoft.graph.externalConnectors
+
+Read the properties and relationships of a [connectionOperation](../resources/externalconnectors-connectionoperation.md) object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalConnection.ReadWrite.OwnedBy |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /connections/{connectionsId}/operations/{connectionOperationId}
+```
+
+## Optional query parameters
+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [connectionOperation](../resources/externalconnectors-connectionoperation.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "get_connectionoperation"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/connections/contosohr/operations/3ed1595a-4bae-43c2-acda-ef973e581323
+```
++
+### Response
+**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.connectionOperation"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "id": "3ed1595a-4bae-43c2-acda-ef973e581323",
+ "status": "failed",
+ "error": {
+ "message": "Server error, something went wrong"
+ }
+}
+```
+
v1.0 Externalconnectors External Post Connections https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-external-post-connections.md
+
+ Title: "Create externalConnection"
+description: "Create a new externalConnection object."
+
+localization_priority: Normal
++
+# Create externalConnection
+Namespace: microsoft.graph.externalConnectors
+++
+Create a new externalConnection object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalConnection.ReadWrite.OwnedBy|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /external/connections
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+In the request body, supply a JSON representation of the [externalConnection](../resources/externalconnectors-externalconnection.md) object.
+
+The following table shows the properties that are required when you create the [externalConnection](../resources/externalconnectors-externalconnection.md).
+
+|Property|Type|Required (Y/N) |Description|
+|:|:|:|:|
+|id|String|Y|The connection ID|
+|name|String|Y|The connection name|
+|description|String|Y|The connection description|
+|configuration|[microsoft.graph.externalConnectors.configuration](../resources/externalconnectors-configuration.md)|N|The connection configurations|
+++
+## Response
+
+If successful, this method returns a `201 Created` response code and an [externalConnection](../resources/externalconnectors-externalconnection.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "create_externalconnection_from_connections"
+}
+-->
+``` http
+POST https://graph.microsoft.com/v1.0/external/connections
+Content-Type: application/json
+
+{
+ "id": "contosohr",
+ "name": "Contoso HR",
+ "description": "Connection to index Contoso HR system"
+}
+```
++
+### Response
+The following is an example of the response.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalConnection"
+}
+-->
+``` http
+HTTP/1.1 200 Created
+Content-Type: application/json
+
+{
+ "id": "0a4f4e74-4e74-0a4f-744e-4f0a744e4f0a",
+ "name": "String",
+ "description": "String",
+ "state": "ready",
+ "configuration": {
+ "authorizedAppIds": [
+ "d310d35d-72ec-47dd-92f2-fb9c40936555"
+ ]
+ }
+}
+```
+
v1.0 Externalconnectors Externalconnection Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-externalconnection-delete.md
+
+ Title: "Delete externalConnection"
+description: "Deletes an externalConnection object."
+
+localization_priority: Normal
++
+# Delete externalConnection
+Namespace: microsoft.graph.externalConnectors
+++
+Deletes an [externalConnection](../resources/externalconnectors-externalconnection.md) object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalConnection.ReadWrite.OwnedBy|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /connections/{connectionsId}
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns `202 Accepted` response code. It does not return anything in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "delete_externalconnection"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/v1.0/connections/contosohr
+```
++
+### Response
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 202 Accepted
+```
+
v1.0 Externalconnectors Externalconnection Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-externalconnection-get.md
+
+ Title: "Get externalConnection"
+description: "Read the properties and relationships of an externalConnection object."
+
+localization_priority: Normal
++
+# Get externalConnection
+Namespace: microsoft.graph.externalConnectors
+++
+Read the properties and relationships of an [externalConnection](../resources/externalconnectors-externalconnection.md) object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalConnection.ReadWrite.OwnedBy|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /connections/{connectionsId}
+```
+
+## Optional query parameters
+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and an [externalConnection](../resources/externalconnectors-externalconnection.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "get_externalconnection"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/connections/contosohr
+```
++
+### Response
+**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalConnection"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "id": "contosohr",
+ "name": "Contoso HR",
+ "description": "Connection to index Contoso HR system",
+ "state": "ready",
+ "configuration": {
+ "authorizedAppIds": [
+ "d310d35d-72ec-47dd-92f2-fb9c40936555"
+ ]
+ }
+}
+```
+
v1.0 Externalconnectors Externalconnection List https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-externalconnection-list.md
+
+ Title: "List externalConnections"
+description: "Get a list of the externalConnection objects and their properties."
+
+localization_priority: Normal
++
+# List externalConnections
+Namespace: microsoft.graph.externalConnectors
+++
+Get a list of the [externalConnection](../resources/externalconnectors-externalconnection.md) objects and their properties.
+
+## Permissions
+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)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalConnection.ReadWrite.OwnedBy|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /connections
+```
+
+## Optional query parameters
+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [externalConnection](../resources/externalconnectors-externalconnection.md) objects in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "list_externalconnection"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/connections
+```
++
+### Response
+**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.externalConnectors.externalConnection)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "id": "contosohr",
+ "name": "Contoso HR",
+ "description": "Connection to index Contoso HR system",
+ "state": "ready",
+ "configuration": {
+ "authorizedAppIds": [
+ "d310d35d-72ec-47dd-92f2-fb9c40936555"
+ ]
+ }
+ },
+ {
+ "id": "contosofinance",
+ "name": "Contoso Finance",
+ "description": "Connection to index Contoso Finance system",
+ "state": "ready",
+ "configuration": {
+ "authorizedAppIds": [
+ "d310d35d-72ec-47dd-92f2-fb9c40936555"
+ ]
+ }
+ }
+ ]
+}
+```
+
v1.0 Externalconnectors Externalconnection Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-externalconnection-update.md
+
+ Title: "Update externalConnection"
+description: "Update the properties of an externalConnection object."
+
+localization_priority: Normal
++
+# Update externalConnection
+
+Namespace: microsoft.graph.externalConnectors
+
+Update the properties of an [externalConnection](../resources/externalconnectors-externalconnection.md) object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | ExternalConnection.ReadWrite.OwnedBy |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /connections/{connectionsId}
+```
+
+## Request headers
+
+| Name | Description |
+|:--|:-|
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. The following properties can be updated.
+
+| Property | Type | Description |
+|:--|:--|:|
+| configuration | [microsoft.graph.externalConnectors.configuration](../resources/externalconnectors-configuration.md) | Specifies additional application IDs that are allowed to manage the connection and to index content in the connection. |
+| description | String | Description of the connection displayed in the Microsoft 365 admin center. |
+| name | String | The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. |
++
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "update_externalconnection"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/v1.0/connections/contosohr
+Content-type: application/json
+
+{
+ "name": "Contoso HR Service Tickets",
+ "description": "Connection to index HR service tickets"
+}
+```
+
+<!-- markdownlint-disable MD024 -->
+### Response
+<!-- markdownlint-enable MD024 -->
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
v1.0 Externalconnectors Externalitem Create https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-externalitem-create.md
+
+ Title: "Create externalItem"
+description: "Create a new externalItem."
+
+localization_priority: Normal
++
+# Create externalItem
+
+Namespace: microsoft.graph.externalConnectors
+
+Create a new [externalItem](../resources/externalconnectors-externalitem.md) object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /connections/{connectionsId}/items
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+In the request body, supply a JSON representation of the [externalItem](../resources/externalconnectors-externalitem.md) object.
+
+The following table shows the properties that are required when you create the [externalItem](../resources/externalconnectors-externalitem.md).
+
+|Property|Type| Required (Y/N) | Description|
+|:|:|:|:|
+|id|String|Y|The item ID|
+|properties|[microsoft.graph.externalConnectors.properties](../resources/externalconnectors-properties.md)|Y|The item properties. The `properties` object must contain at least one property. All `DateTime` type properties must be in ISO 8601 format.|
+|content|[microsoft.graph.externalConnectors.externalItemContent](../resources/externalconnectors-externalitemcontent.md)|N|The external item content|
+|acl|[microsoft.graph.externalConnectors.acl](../resources/externalconnectors-acl.md) collection|Y|The access control list|
+
+Properties on an `externalItem` should use type specifiers in the payload in the following scenarios:
+
+- For `String` type properties, if the value contains non-ASCII characters.
+
+ ```json
+ "description@odata.type": "String",
+ "description": "Kandierte Äpfel"
+ ```
+
+- For all collection types.
+
+ ```json
+ "categories@odata.type": "Collection(String)"
+ "categories": [
+ "red",
+ "blue"
+ ]
+ ```
+
+ > [!IMPORTANT]
+ > When including a property of type `Collection(DateTime)`, you must use the type specifier `Collection(DateTimeOffset)`.
+
+## Response
+
+If successful, this method returns `200 OK` response code.
+
+## Examples
+
+### Example: Create a custom item
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "create_externalitem_from_externalConnections"
+}
+-->
+``` http
+PUT https://graph.microsoft.com/v1.0/connections/contosohr/items/TSP228082938
+Content-type: application/json
+
+{
+ "acl": [
+ {
+ "type": "user",
+ "value": "e811976d-83df-4cbd-8b9b-5215b18aa874",
+ "accessType": "grant"
+ },
+ {
+ "type": "externalGroup",
+ "value": "14m1b9c38qe647f6a",
+ "accessType": "deny"
+ }
+ ],
+ "properties": {
+ "title": "Error in the payment gateway",
+ "priority": 1,
+ "assignee": "john@contoso.com"
+ },
+ "content": {
+ "value": "Error in payment gateway...",
+ "type": "text"
+ }
+}
+```
++
+### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 200 OK
+```
+
v1.0 Externalconnectors Externalitem Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-externalitem-delete.md
+
+ Title: "Delete externalItem"
+description: "Deletes an externalItem object."
+
+localization_priority: Normal
++
+# Delete externalItem
+Namespace: microsoft.graph.externalConnectors
+++
+Deletes an [externalItem](../resources/externalconnectors-externalitem.md) object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /connections/{connectionsId}/items/{externalItemId}
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "delete_externalitem"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/v1.0/connections/contosohr/items/TSP228082938
+```
++
+### Response
+**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Externalconnectors Externalitem Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-externalitem-get.md
+
+ Title: "Get externalItem"
+description: "Read the properties and relationships of an externalItem object."
+
+localization_priority: Normal
++
+# Get externalItem
+Namespace: microsoft.graph.externalConnectors
+++
+Read the properties and relationships of an [externalItem](../resources/externalconnectors-externalitem.md) object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /connections/{connectionsId}/items/{externalItemId}
+```
+
+## Optional query parameters
+This method does not support optional query parameters to customize the response.
+
+## Request headers
+|Name|Description|
+|:|:|
+|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 an [externalItem](../resources/externalconnectors-externalitem.md) object in the response body.
+
+## Examples
+
+### Request
+The following is an example of the request.
+
+```http
+GET https://graph.microsoft.com/beta/connections/contosohr/items/TSP228082938
+```
++
+### Response
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "acl": [
+ {
+ "type": "user",
+ "value": "e811976d-83df-4cbd-8b9b-5215b18aa874",
+ "accessType": "grant"
+ },
+ {
+ "type": "externalGroup",
+ "value": "14m1b9c38qe647f6a",
+ "accessType": "deny"
+ }
+ ],
+ "properties": {
+ "title": "Error in the payment gateway",
+ "priority": 1,
+ "assignee": "john@contoso.com"
+ },
+ "content": {
+ "value": "Error in payment gateway...",
+ "type": "text"
+ }
+}
+```
+
v1.0 Externalconnectors Externalitem Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-externalitem-update.md
+
+ Title: "Update externalItem"
+description: "Update the properties of an externalItem object."
+
+localization_priority: Normal
++
+# Update externalItem
+Namespace: microsoft.graph.externalConnectors
+++
+Update the properties of an [externalItem](../resources/externalconnectors-externalitem.md) object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All|
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+PATCH /external/connections/{connection-id}/items/{item-id}
+```
+
+## Path parameters
+
+| Parameter | Type | Description |
+|:--|:-|:-|
+| connection-id | string | The `id` property of the containing [externalConnection](../resources/externalconnectors-externalconnection.md) |
+| item-id | string | The developer-provided `id` property of the [externalItem](../resources/externalconnectors-externalitem.md). |
+
+## Request headers
+
+| Name | Description |
+|:--|:-|
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, supply the values for relevant fields that should be updated. Existing properties (excluding properties inside the `properties` object) that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. The following properties can be updated.
+
+| Property | Type | Description |
+|:--|:--|:--|
+| acl | [microsoft.graph.externalConnectors.acl](../resources/externalconnectors-acl.md) collection | An array of access control entries. Each entry specifies the access granted to a user or group. |
+| content | [microsoft.graph.externalConnectors.externalItemContent](../resources/externalconnectors-externalitemcontent.md) | A plain-text representation of the contents of the item. The text in this property is full-text indexed. |
+| properties | Object | A property bag with the properties of the item. The properties MUST conform to the [schema](../resources/externalconnectors-schema.md) defined for the [externalConnection](../resources/externalconnectors-externalconnection.md). |
+
+### Updating the acl collection
+
+If the `acl` property is included in an update request, the existing ACL collection is overwritten with the collection included in the request.
+
+### Updating the properties object
+
+If the `properties` property is included in an update request, the existing property bag is overwritten with the value included in the request.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and an updated [externalItem](../resources/externalconnectors-externalitem.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "update_externalitem",
+ "@odata.type": "microsoft.graph.externalConnectors.externalItem"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/v1.0/connections/contosohr/items/TSP228082938
+Content-Type: application/json
+Content-length: 360
+
+{
+ "acl": [
+ {
+ "type": "everyone",
+ "value": "67a141d8-cf4e-4528-ba07-bed21bfacd2d",
+ "accessType": "grant"
+ }
+ ]
+}
+```
++
+### Response
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.externalItem"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "id": "TSP228082938",
+ "acl": [
+ {
+ "type": "everyone",
+ "value": "67a141d8-cf4e-4528-ba07-bed21bfacd2d",
+ "accessType": "grant"
+ }
+ ],
+ "properties": {
+ "title": "Error in the payment gateway",
+ "priority": 1,
+ "assignee": "john@contoso.com"
+ },
+ "content": {
+ "@odata.type": "microsoft.graph.externalConnectors.externalItemContent",
+ "value": "<h1>Error in payment gateway</h1><p>Error details...</p>",
+ "type": "html"
+ }
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Update externalitem",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": [
+ "Error: update_externalitem/properties:\r\n Referenced type microsoft.graph.object is not defined in the doc set! Potential suggestion: microsoft.graph.directoryObject"
+ ]
+}-->
v1.0 Externalconnectors Schema Create https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-schema-create.md
+
+ Title: "Create schema"
+description: "Create the schema for a Microsoft Search connection."
+
+localization_priority: Normal
++
+# Create schema
+Namespace: microsoft.graph.externalConnectors
+++
+Create a new [schema](../resources/externalconnectors-schema.md) object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalConnection.ReadWrite.OwnedBy|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+```http
+POST /external/connections/{id}/schema
+```
+In the request body, supply a JSON representation of a [schema](../resources/externalconnectors-schema.md) object.
+
+When registering a custom item schema, the `schema` object MUST have the `baseType` property set to `microsoft.graph.externalItem` and MUST contain the `properties` property. The `properties` object must contain at least one property, up to a maximum of 64.
+
+## Response
+
+With the `Prefer: respond-async` header included in the request, if successful, this method returns a `202 Accepted` response code and a URL in the `Location` response header that can be used to [get the operation status](../api/externalconnectors-connectionoperation-get.md).
+
+Without the `Prefer: respond-async` header included in the request, if successful, this method returns a `201 Created` response code and a new [schema](../resources/externalconnectors-schema.md) object in the response body.
+
+> [!NOTE]
+> Creating a schema is a long-running process prone to gateway timeouts. We recommend using the `Prefer: respond-async` header to avoid timeout errors.
+
+## Examples
+
+### Example: Register custom schema asynchronously
+
+#### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_schema_from_connection_async",
+ "@odata.type": "microsoft.graph.externalConnectors.schema"
+}-->
+
+```http
+POST https://graph.microsoft.com/v1.0/external/connections/contosohr/schema
+Content-type: application/json
+Prefer: respond-async
+
+{
+ "baseType": "microsoft.graph.externalItem",
+ "properties": [
+ {
+ "name": "ticketTitle",
+ "type": "String",
+ "isSearchable": "true",
+ "isRetrievable": "true",
+ "labels": [
+ "title"
+ ]
+ },
+ {
+ "name": "priority",
+ "type": "String",
+ "isQueryable": "true",
+ "isRetrievable": "true",
+ "isSearchable": "false"
+ },
+ {
+ "name": "assignee",
+ "type": "String",
+ "isRetrievable": "true"
+ }
+ ]
+}
+```
+
+#### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 202 Accepted
+Location: https://graph.microsoft.com/v1.0/external/connections/contosohr/operations/616bfeed-666f-4ce0-8cd9-058939010bfc
+```
v1.0 Externalconnectors Schema Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/externalconnectors-schema-get.md
+
+ Title: "Get schema"
+description: "Read the properties and relationships of a schema object."
+
+localization_priority: Normal
++
+# Get schema
+Namespace: microsoft.graph.externalConnectors
+++
+Read the properties and relationships of a [schema](../resources/externalconnectors-schema.md) object.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|Not applicable|
+|Delegated (personal Microsoft account)|Not applicable|
+|Application| ExternalConnection.ReadWrite.OwnedBy|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /connections/{connectionsId}/schema
+```
+
+## Optional query parameters
+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [schema](../resources/externalconnectors-schema.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "get_schema"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/connections/contosohr/schema
+```
++
+### Response
+**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalConnectors.schema"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "baseType": "String",
+ "properties": [
+ {
+ "name": "ticketTitle",
+ "type": "string",
+ "isSearchable": true,
+ "isRetrievable": true,
+ "labels": [
+ "title"
+ ]
+ },
+ {
+ "name": "priority",
+ "type": "string",
+ "isQueryable": true,
+ "isRetrievable": true,
+ "isRefinable": true,
+ "isSearchable": false
+ },
+ {
+ "name": "assignee",
+ "type": "string",
+ "isRetrievable": true
+ }
+ ]
+ }
+}
+```
+
v1.0 Enums Externalconnectors https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/enums-externalConnectors.md
+
+ Title: "External connectors enum values"
+description: "Microsoft Graph external connectors enumeration values"
+localization_priority: Normal
+++
+# External connectors enum values
+
+Namespace: microsoft.graph.externalConnectors
+
+### accessType values
+
+| Member
+|:--
+| grant
+| deny
+| unknownFutureValue
+
+### aclType values
+
+| Member
+|:--
+| user
+| group
+| everyone
+| everyoneExceptGuests
+| externalGroup
+| unknownFutureValue
++
+### connectionOperationStatus values
+
+| Member
+|:--
+| unspecified
+| inprogress
+| completed
+| failed
+| unknownFutureValue
+
+### connectionState values
+
+|Member
+|:--
+| draft
+| ready
+| obsolete
+| limitExceeded
+| unknownFutureValue
+
+### externalItemContentType values
+
+| Member
+|:--
+| text
+| html
+| unknownFutureValue
+
+### label values
+
+| Member
+|:--
+| title
+| url
+| createdBy
+| lastModifiedBy
+| authors
+| createdDateTime
+| lastModifiedDateTime
+| fileName
+| fileExtension
+| unknownFutureValue
+
+### propertyType values
+
+| Member
+|:--
+| string
+| int64
+| double
+| dateTime
+| boolean
+| stringCollection
+| int64Collection
+| doubleCollection
+| dateTimeCollection
+| unknownFutureValue
+
+<!--
+{
+ "type": "#page.annotation",
+ "namespace": "microsoft.graph.externalConnectors"
+}
+-->
++
v1.0 Externalconnectors Acl https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/externalconnectors-acl.md
+
+ Title: "acl resource type"
+description: "An access control entry for an item indexed by a Microsoft Search externalConnection."
+
+localization_priority: Normal
++
+# acl resource type
+
+Namespace: microsoft.graph.externalConnectors
+
+An access control entry for an item indexed by a Microsoft Search externalConnection.
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|accessType|microsoft.graph.externalConnectors.accessType|The access granted to the identity. Possible values are: `grant`, `deny`, `unknownFutureValue`.|
+|type|microsoft.graph.externalConnectors.aclType|The type of identity. Possible values are: `user`, `group`, `everyone`, `everyoneExceptGuests`, `externalGroup`, `unknownFutureValue`.|
+|value|String|The unique identifer of the identity. In case of Azure Active Directory identities, `value` is set to the object identifier of the user, group or tenant for types user, group and everyone (and everyoneExceptGuests) respectively. In case of external groups `value` is set to the ID of the externalGroup |
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.externalConnectors.acl"
+}
+-->
+``` json
+{
+ "type": "String",
+ "value": "String",
+ "accessType": "String"
+}
+```
+
v1.0 Externalconnectors Configuration https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/externalconnectors-configuration.md
+
+ Title: "configuration resource type"
+description: "Specifies additional application IDs that are allowed to manage the externalConnection and to index content in a externalConnection."
+
+localization_priority: Normal
++
+# configuration resource type
+
+Namespace: microsoft.graph.externalConnectors
+++
+Specifies additional application IDs that are allowed to manage the externalConnection and to index content in a [externalConnection](../resources/externalconnectors-externalconnection.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|authorizedAppIds|String collection|A collection of application IDs for registered Azure Active Directory apps that are allowed to manage the externalConnection and to index content in the externalConnection.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.externalConnectors.configuration"
+}
+-->
+``` json
+{
+ "authorizedAppIds": [
+ "String"
+ ]
+}
+```
+
v1.0 Externalconnectors Connectionoperation https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/externalconnectors-connectionoperation.md
+
+ Title: "connectionOperation resource type"
+description: "Describes status of an asynchronous request to create a Microsoft Search connection schema."
+
+localization_priority: Normal
++
+# connectionOperation resource type
+
+Namespace: microsoft.graph.externalConnectors
+++
+Describes status of an asynchronous request to create a Microsoft Search connection [schema](externalconnectors-schema.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[Get connectionOperation](../api/externalconnectors-connectionoperation-get.md)|[connectionOperation](../resources/externalconnectors-connectionoperation.md)|Read the properties and relationships of a [connectionOperation](../resources/externalconnectors-connectionoperation.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|error|publicError| If `status` is `failed`, provides more information about the error that caused the failure.|
+|id|String| Unique identifier for the connectionOperation. Read-only. |
+|status|microsoft.graph.externalConnectors.connectionOperationStatus| Indicates the status of the asynchronous operation. Possible values are: `unspecified`, `inprogress`, `completed`, `failed`, `unknownFutureValue`.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.externalConnectors.connectionOperation",
+ "openType": false
+}
+-->
+``` json
+{
+ "id": "String (identifier)",
+ "status": "String"
+}
+```
+
v1.0 Externalconnectors Externalconnection https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/externalconnectors-externalconnection.md
+
+ Title: "externalConnection resource type"
+description: "A connection is a logical container for your external content in Microsoft Graph"
+
+localization_priority: Normal
++
+# externalConnection resource type
+
+Namespace: microsoft.graph.externalConnectors
+
+A logical container to add content from an external source into Microsoft Graph.
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[Create externalConnection](../api/externalconnectors-external-post-connections.md)|[externalConnection](../resources/externalconnectors-externalconnection.md)|Create a new [externalConnection](../resources/externalconnectors-externalconnection.md) object.|
+|[List externalConnections](../api/externalconnectors-externalconnection-list.md)|[externalConnection](../resources/externalconnectors-externalconnection.md) collection|Get a list of the [externalConnection](../resources/externalconnectors-externalconnection.md) objects and their properties.|
+|[Get externalConnection](../api/externalconnectors-externalconnection-get.md)|[externalConnection](../resources/externalconnectors-externalconnection.md)|Read the properties and relationships of an [externalConnection](../resources/externalconnectors-externalconnection.md) object.|
+|[Update externalConnection](../api/externalconnectors-externalconnection-update.md)|[externalConnection](../resources/externalconnectors-externalconnection.md)|Update the properties of an [externalConnection](../resources/externalconnectors-externalconnection.md) object.|
+|[Delete externalConnection](../api/externalconnectors-externalconnection-delete.md)|None|Deletes an [externalConnection](../resources/externalconnectors-externalconnection.md) object.|
+|[Create schema](../api/externalconnectors-schema-create.md)|[schema](../resources/externalconnectors-schema.md)|Create a new schema object.|
+|[Create externalItem](../api/externalconnectors-externalitem-create.md)|[externalItem](../resources/externalconnectors-externalitem.md)|Create a new externalItem object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|configuration|[microsoft.graph.externalConnectors.configuration](../resources/externalconnectors-configuration.md)|Specifies additional application IDs that are allowed to manage the connection and to index content in the connection. Optional.|
+|description|String|Description of the connection displayed in the Microsoft 365 admin center. Optional.|
+|id|String| Developer-provided unique ID of the connection within the Azure Active Directory tenant. Must be between 3 and 32 characters in length. Must only contain alphanumeric characters. Cannot begin with `Microsoft` or be one of the following values: `None`, `Directory`, `Exchange`, `ExchangeArchive`, `LinkedIn`, `Mailbox`, `OneDriveBusiness`, `SharePoint`, `Teams`, `Yammer`, `Connectors`, `TaskFabric`, `PowerBI`, `Assistant`, `TopicEngine`, `MSFT_All_Connectors`. Required. |
+|name|String|The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. Required.|
+|state|microsoft.graph.externalConnectors.connectionState|Indicates the current state of the connection. Possible values are: `draft`, `ready`, `obsolete`, `limitExceeded`, `unknownFutureValue`.|
+
+## Relationships
+|Relationship|Type|Description|
+|:|:|:|
+|items|[microsoft.graph.externalConnectors.externalItem](../resources/externalconnectors-externalitem.md) collection|Read-only. Nullable.|
+|operations|[microsoft.graph.externalConnectors.connectionOperation](../resources/externalconnectors-connectionoperation.md) collection|Read-only. Nullable.|
+|schema|[microsoft.graph.externalConnectors.schema](../resources/externalconnectors-schema.md)|Read-only. Nullable.|
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.externalConnectors.externalConnection",
+ "openType": false
+}
+-->
+``` json
+{
+ "id": "String (identifier)",
+ "name": "String",
+ "description": "String",
+ "state": "String"
+}
+```
+
v1.0 Externalconnectors Externalitem https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/externalconnectors-externalitem.md
+
+ Title: "externalItem resource type"
+description: "An item added to a Microsoft Graph connection."
+
+localization_priority: Normal
++
+# externalItem resource type
+
+Namespace: microsoft.graph.externalConnectors
+
+An item added to a Microsoft Graph [connection](externalconnectors-externalconnection.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[Create externalItem](../api/externalconnectors-externalitem-create.md)|[externalItem](../resources/externalconnectors-externalitem.md)|Create a new [externalItem](../resources/externalconnectors-externalitem.md) object.|
+|[Get externalItem](../api/externalconnectors-externalitem-get.md)|[externalItem](../resources/externalconnectors-externalitem.md)|Read the properties and relationships of an [externalItem](../resources/externalconnectors-externalitem.md) object.|
+|[Update externalItem](../api/externalconnectors-externalitem-update.md)|[externalItem](../resources/externalconnectors-externalitem.md)|Update the properties of an [externalItem](../resources/externalconnectors-externalitem.md) object.|
+|[Delete externalItem](../api/externalconnectors-externalitem-delete.md)|None|Deletes an [externalItem](../resources/externalconnectors-externalitem.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|acl|[microsoft.graph.externalConnectors.acl](../resources/externalconnectors-acl.md) collection|An array of access control entries. Each entry specifies the access granted to a user or group. Required.|
+|content|[microsoft.graph.externalConnectors.externalItemContent](../resources/externalconnectors-externalitemcontent.md)|A plain-text representation of the contents of the item. The text in this property is full-text indexed. Optional.|
+|id|String|Developer-provided unique ID of the item within the containing [externalConnection](externalconnectors-externalconnection.md). Must be alphanumeric and a maximum of 128 characters. Required.|
+|properties|[microsoft.graph.externalConnectors.properties](../resources/externalconnectors-properties.md)|A property bag with the properties of the item. The properties MUST conform to the [schema](externalconnectors-schema.md) defined for the [externalConnection](externalconnectors-externalconnection.md). Required.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.externalConnectors.externalItem",
+ "openType": false
+}
+-->
+```json
+{
+ "acl": [
+ {
+ "type": "everyone",
+ "value": "67a141d8-cf4e-4528-ba07-bed21bfacd2d",
+ "accessType": "grant"
+ }
+ ],
+ "id": "String (identifier)",
+ "properties": {
+ "@odata.type": "microsoft.graph.externalConnectors.properties"
+ },
+ "content": {
+ "@odata.type": "microsoft.graph.externalConnectors.externalItemContent"
+ }
+}
+```
+
v1.0 Externalconnectors Externalitemcontent https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/externalconnectors-externalitemcontent.md
+
+ Title: "externalItemContent resource type"
+description: "The content of an item indexed via a Microsoft Search connection."
+
+localization_priority: Normal
++
+# externalItemContent resource type
+
+Namespace: microsoft.graph.externalConnectors
+
+The content of an [externalItem](externalconnectors-externalitem.md) indexed via a Microsoft Search [connection](externalconnectors-externalconnection.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|type|microsoft.graph.externalConnectors.externalItemContentType|The type of content in the value property. Possible values are: `text`, `html`, `unknownFutureValue`.|
+|value|String|The content for the externalItem. Required.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.externalConnectors.externalItemContent"
+}
+-->
+``` json
+{
+ "value": "String",
+ "type": "String"
+}
+```
+
v1.0 Externalconnectors Properties https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/externalconnectors-properties.md
+
+ Title: "properties resource type"
+description: "The properties defined for the items in the connection."
+
+localization_priority: Normal
++
+# properties resource type
+
+Namespace: microsoft.graph.externalConnectors
+
+A [schema](externalconnectors-schema.md) property definition for a Microsoft Search [connection](externalconnectors-externalconnection.md).
+
+## Properties
+None.
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.externalConnectors.properties"
+}
+-->
+``` json
+{
+ "@odata.type": "microsoft.graph.externalConnectors.properties"
+}
+```
+
v1.0 Externalconnectors Property https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/externalconnectors-property.md
+
+ Title: "property resource type"
+description: "A schema property definition for a Microsoft Search connection."
+
+localization_priority: Normal
++
+# property resource type
+
+Namespace: microsoft.graph.externalConnectors
+++
+A [schema](externalconnectors-schema.md) property definition for a Microsoft Search [connection](externalconnectors-externalconnection.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|aliases|String collection|A set of aliases or a friendly names for the property. Maximum 32 characters. Each string must not contain control characters, whitespace, or any of the following: `:`, `;`, `,`, `(`, `)`, `[`, `]`, `{`, `}`, `%`, `$`, `+`, `!`, `*`, `=`, `&`, `?`, `@`, `#`, `\`, `~`, `'`, `"`, `<`, `>`, `|`, `` ` ``, `^`. Optional.|
+|isQueryable|Boolean|Specifies if the property is queryable. Queryable properties can be used in [Keyword Query Language (KQL) queries](/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). Optional.|
+|isRefinable|Boolean|Specifies if the property is refinable. Refinable properties can be used to filter search results in the [Search API](search-api-overview.md) and add a refiner control in the Microsoft Search user experience. Optional.|
+|isRetrievable|Boolean|Specifies if the property is retrievable. Retrievable properties are returned in the result set when items are returned by the search API. Retrievable properties are also available to add to the display template used to render search results. Optional.|
+|isSearchable|Boolean|Specifies if the property is searchable. Only properties of type `String` or `StringCollection` can be searchable. Non-searchable properties are not added to the search index. Optional.|
+|labels|microsoft.graph.externalConnectors.label collection|Specifies one or more well-known tags added against a property. Labels help Microsoft Search understand the semantics of the data in the connection. Adding appropriate labels would result in an enhanced search experience (e.g. better relevance). Supported labels: `title`, `url`, `createdBy`, `lastModifiedBy`, `authors`, `createdDateTime`, `lastModifiedDateTime`, `fileName` and `fileExtension`. Optional.|
+|name|String|The name of the property. Maximum 32 characters. Must not contain control characters, whitespace, or any of the following: `:`, `;`, `,`, `(`, `)`, `[`, `]`, `{`, `}`, `%`, `$`, `+`, `!`, `*`, `=`, `&`, `?`, `@`, `#`, `\`, `~`, `'`, `"`, `<`, `>`, `|`, `` ` ``, `^`. Required.|
+|type|microsoft.graph.externalConnectors.propertyType|The data type of the property. Possible values are: `string`, `int64`, `double`, `dateTime`, `boolean`, `stringCollection`, `int64Collection`, `doubleCollection`, `dateTimeCollection`, `unknownFutureValue`.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.externalConnectors.property"
+}
+-->
+``` json
+{
+ "name": "String",
+ "type": "String",
+ "isSearchable": "Boolean",
+ "isRetrievable": "Boolean",
+ "isQueryable": "Boolean",
+ "isRefinable": "Boolean",
+ "aliases": [
+ "String"
+ ],
+ "labels": [
+ "String"
+ ]
+}
+```
+
v1.0 Externalconnectors Schema https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/externalconnectors-schema.md
+
+ Title: "schema resource type"
+description: "The connection schema determines how your content added into a connection will be used in various Microsoft Graph experiences."
+
+localization_priority: Normal
++
+# schema resource type
+
+Namespace: microsoft.graph.externalConnectors
+
+The [connection](externalconnectors-externalconnection.md) schema determines how your external content will be used in various Microsoft Graph experiences. Schema is a flat list of all the properties that you plan to add to the connection along with their attributes, labels, and aliases. You must register the schema before adding items into the connection.
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[Create schema](../api/externalconnectors-schema-create.md)|[schema](../resources/externalconnectors-schema.md)|Create a new [schema](../resources/externalconnectors-schema.md) object.|
+|[Get schema](../api/externalconnectors-schema-get.md)|[schema](../resources/externalconnectors-schema.md)|Read the properties and relationships of a [schema](../resources/externalconnectors-schema.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|baseType|String|Must be set to `microsoft.graph.externalConnector.externalItem`. Required.|
+|properties|[property](../resources/externalconnectors-property.md) collection|The properties defined for the items in the connection. The minimum number of properties is one, the maximum is 128.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.externalConnectors.schema",
+ "openType": false
+}
+-->
+``` json
+{
+ "baseType": "String",
+ "properties": [
+ {
+ "name": "String",
+ "type": "String",
+ }
+ ]
+}
+```
+
v1.0 Indexing Api Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/indexing-api-overview.md
+
+ Title: "Use the Microsoft Search API to index data"
+description: "Use Microsoft Graph to index custom items in the Microsoft Search service."
+localization_priority: Priority
+++
+# Use the Microsoft Search API to index data
+
+You can use Microsoft Graph to add custom items to search results in the [Microsoft Search](/microsoftsearch/overview-microsoft-search) experience.
+
+Requests to index data are performed on behalf of an application without the presence of a signed-in user, identified using an [access token with application permission](/graph/auth-v2-service).
+
+## Common use cases
+
+The use cases for the APIs in this section involve building [Microsoft Graph connectors](/microsoftsearch/connectors-overview), which involves the following primary steps:
+
+1. [Create a connection](../api/externalconnectors-external-post-connections.md) to an external data source.
+2. [Create and register a schema](../api/externalconnectors-schema-create.md) that describes the type and how to index the external data.
+3. [Index the data](../api/externalconnectors-externalitem-create.md) as an external item.
+
+| Use cases | REST resources | See also |
+|:-|:--|:--|
+| **Configuration actions** | | |
+| Create, update, or delete a connection | [externalConnection](externalconnectors-externalconnection.md) | [externalConnection methods](externalconnectors-externalconnection.md#methods) |
+| Register a schema for the external data | [schema](externalconnectors-schema.md) | [schema methods](externalconnectors-schema.md#methods) |
+| **Indexing actions** | | |
+| Add, update or delete a custom item in the index | [externalItem](externalconnectors-externalitem.md) | [externalItem methods](externalconnectors-externalitem.md#methods) |
+
+## Known limitations
+
+The following are current known limitations:
+
+- Organizations are limited to a maximum of 10 connections.
+- You can create only four `externalItem` resources items per second.
+- An application is limited to four concurrent operations on a connection.
+- Connections have a capacity limit of 700,000 items or ~70 GB of data.
+- Maximum size of an `externalItem` entity is 4 MB.
+- Sorting results is not supported.
+
+## What's new
+Find out about the [latest new features and updates](/graph/whats-new-overview) for this API set.
+
+## Next steps
+
+- See the [Microsoft Search API overview](/graph/search-concept-overview).
+- Drill down on the methods, properties, and relationships of the [externalConnection](externalconnectors-externalconnection.md), [schema](externalconnectors-schema.md), and [externalItem](externalconnectors-externalitem.md) resources.
+- Check out the [Microsoft Graph postman collection](https://www.postman.com/microsoftgraph/workspace/microsoft-graph/folder/455214-66cbb476-ad94-448e-ba5a-ef58e1da7a90?ctx=documentation) ([learn more](https://developer.microsoft.com/en-us/graph/blogs/postman-collections))
+- Check out the [sample search connector](https://github.com/microsoftgraph/msgraph-search-connector-sample) from GitHub.
++
v1.0 Publicerror https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/publicerror.md
+
+ Title: "publicError resource type"
+description: "Represent a generic error and its details."
+localization_priority: Normal
+++
+# publicError resource type
+
+Namespace: microsoft.graph
+
+Represents a generic error and its details.
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|code|string| Represents the error code.
+|details|[publicErrorDetail](publicerrordetail.md) collection|Details of the error.|
+|innerError|[publicInnerError](publicinnererror.md)|Details of the inner error.|
+|message|string| A non-localized message for the developer.
+|target|String|The target of the error.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.publicError"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.publicError",
+ "code": "String",
+ "message": "String",
+ "target": "String",
+ "details": [
+ {
+ "@odata.type": "microsoft.graph.publicErrorDetail"
+ }
+ ],
+ "innerError": {
+ "@odata.type": "microsoft.graph.publicInnerError"
+ }
+}
+```
v1.0 Publicerrordetail https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/publicerrordetail.md
+
+ Title: "publicErrorDetail resource type"
+description: "Represents the details of an error."
+
+localization_priority: Normal
++
+# publicErrorDetail resource type
+
+Namespace: microsoft.graph
+
+Represents the details of [publicError](../resources/publicerror.md) or [publicInnerError](../resources/publicinnererror.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|code|String|The error code.|
+|message|String|The error message.|
+|target|String|The target of the error.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.publicErrorDetail"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.publicErrorDetail",
+ "code": "String",
+ "message": "String",
+ "target": "String"
+}
+```
v1.0 Publicinnererror https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/publicinnererror.md
+
+ Title: "publicInnerError resource type"
+description: "Represents the inner details of an error."
+
+localization_priority: Normal
++
+# publicInnerError resource type
+
+Namespace: microsoft.graph
+
+Represents the inner details of a [publicError](../resources/publicerrordetail.md).
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|code|String|The error code.|
+|details|[publicErrorDetail](../resources/publicerrordetail.md) collection|A collection of error details.|
+|message|String|The error message.|
+|target|String|The target of the error.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.publicInnerError"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.publicInnerError",
+ "code": "String",
+ "message": "String",
+ "target": "String",
+ "details": [
+ {
+ "@odata.type": "microsoft.graph.publicErrorDetail"
+ }
+ ]
+}
+```
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: resources/searchresponse.md - name: Query data href: api/search-query.md
+ - name: Index
+ items:
+ - name: Overview
+ href: resources/indexing-api-overview.md
+ - name: External connection
+ items:
+ - name: External connection
+ href: resources/externalconnectors-externalconnection.md
+ - name: List external connections
+ href: api/externalconnectors-externalconnection-list.md
+ - name: Create external connection
+ href: api/externalconnectors-external-post-connections.md
+ - name: Get external connection
+ href: api/externalconnectors-externalconnection-get.md
+ - name: Update external connection
+ href: api/externalconnectors-externalconnection-update.md
+ - name: Delete external connection
+ href: api/externalconnectors-externalconnection-delete.md
+ - name: Get operation
+ href: api/externalconnectors-connectionoperation-get.md
+ - name: Schema
+ items:
+ - name: Schema
+ href: resources/externalconnectors-schema.md
+ - name: Create schema
+ href: api/externalconnectors-schema-create.md
+ - name: Get schema
+ href: api/externalconnectors-schema-get.md
+ - name: External item
+ items:
+ - name: External item
+ href: resources/externalconnectors-externalitem.md
+ - name: Create external item
+ href: api/externalconnectors-externalitem-create.md
+ - name: Get external item
+ href: api/externalconnectors-externalitem-get.md
+ - name: Update external item
+ href: api/externalconnectors-externalitem-update.md
+ - name: Delete external item
+ href: api/externalconnectors-externalitem-delete.md
- name: Security displayname: Security API, Microsoft Intelligent Security Graph items: