externalConnection resource type

Namespace: microsoft.graph.externalConnectors


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

A logical container to add content from an external source into Microsoft Graph.


Method Return Type Description
Create externalConnection externalConnection Create a new externalConnection by posting to the connections collection.
List externalConnections externalConnection collection Get an externalConnection object collection.
Get externalConnection externalConnection Read properties and relationships of an externalConnection object.
Update externalConnection externalConnection Update an externalConnection object.
Delete externalConnection None Delete an externalConnection object.
Create schema None or schema Register connection schema.
Get operation connectionOperation Get the status of an asynchronous request to create the connection schema.
Create externalItem externalItem Create a new externalItem by posting to the items collection.
Get connectionQuota connectionQuota Retrieve the properties and relationships of a connectionQuota.


Property Type Description
activitySettings microsoft.graph.externalConnectors.activitySettings Collects configurable settings related to activities involving connector content.
configuration microsoft.graph.externalConnectors.configuration Specifies additional application IDs that are allowed to manage the connection and to index content in the connection. Optional.
connectorId String The Teams App ID. Optional.
description String Description of the connection displayed in the Microsoft 365 admin center. Optional.
enabledContentExperiences microsoft.graph.externalConnectors.contentExperienceType collection The list of content experiences the connection will participate in. Possible values are search.
id String Developer-provided unique ID of the connection within the Microsoft Entra 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.
ingestedItemsCount Int64 The number of items ingested into a connection. This value is refreshed every 15 minutes. If the connection state is draft, then ingestedItemsCount will be null.
name String The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. Required.
searchSettings microsoft.graph.externalConnectors.searchSettings The settings configuring the search experience for content in this connection, such as the display templates for search results.
state microsoft.graph.externalConnectors.connectionState Indicates the current state of the connection. Possible values are draft, ready, obsolete, and limitExceeded. Required.


Relationship Type Description
groups microsoft.graph.externalConnectors.externalGroup collection Read-only. Nullable.
items microsoft.graph.externalConnectors.externalItem collection Read-only. Nullable.
operations microsoft.graph.externalConnectors.connectionOperation collection Read-only. Nullable.
quota microsoft.graph.externalConnectors.connectionQuota Read-only. Nullable.
schema microsoft.graph.externalConnectors.schema Read-only. Nullable.

JSON representation

The following is a JSON representation of the resource.

  "activitySettings": {"@odata.type": "microsoft.graph.externalConnectors.activitySettings"},
  "configuration": {"@odata.type": "microsoft.graph.externalConnectors.configuration"},
  "connectorId": "String",
  "description": "String",
  "enabledContentExperiences": "[String]",
  "id": "String (identifier)",
  "ingestedItemsCount": "Int64",
  "name": "String",
  "searchSettings": {"@odata.type": "microsoft.graph.externalConnectors.searchSettings"},
  "state": "String"