You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-reference/v1.0/resources/externalconnectors-externalconnection.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,7 @@ A logical container to add content from an external source into Microsoft Graph.
31
31
| activitySettings |[microsoft.graph.externalConnectors.activitySettings](../resources/externalconnectors-activitysettings.md)| Collects configurable settings related to activities involving connector content.|
32
32
| 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.|
33
33
| connectorId | String | The Teams app ID. Optional.|
34
+
| contentCategory | microsoft.graph.externalConnectors.contentCategory | Specifies the domain category of the content associated with the external connection. This property helps Microsoft Graph optimize relevance, ranking, and semantic understanding by signaling the nature of the ingested content. For example, setting this value correctly ensures better query interpretation and improves Copilot experiences. Possible values are: `uncategorized`, `knowledgeBase`, `wikis`, `fileRepository`, `qna`, `crm`, `dashboard`, `people`, `media`, `email`, `messaging`, `meetingTranscripts`, `taskManagement`, `learningManagement`, `unknownFutureValue`. Optional. The default value is `uncategorized`. |
34
35
| description |String|Description of the connection displayed in the Microsoft 365 admin center. Optional.|
35
36
| 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. |
36
37
| name |String|The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. Required.|
description: "Represents a complex data type used to add people-related properties to items indexed by externalConnection."
4
+
ms.localizationpriority: medium
5
+
author: "bak"
6
+
ms.subservice: "search"
7
+
doc_type: "resourcePageType"
8
+
ms.date: 02/10/2026
9
+
---
10
+
11
+
# principal resource type
12
+
13
+
Namespace: microsoft.graph.externalConnectors
14
+
15
+
Represents a complex data type used to add people-related properties to items indexed by an [externalConnection](../resources/externalconnectors-externalconnection.md). You can also use the principalCollection data type when there's list of people.
| externalName | String | The name associated with the person in the external data source.|
22
+
| externalId | String | The ID associated with the person in the external data source. It could also be an email associated with the person on the external source. |
23
+
| entraDisplayName | String | The name of the person as mentioned on Microsoft Entra. |
24
+
| entraId | String | The ID of the person as mentioned on Microsoft Entra.|
25
+
| email | String | The email of the person as mentioned on Microsoft Entra.|
26
+
| upn | String | The User Principal Name (UPN) of the person as mentioned on Azure Active directory or Microsoft Entra. |
27
+
| tenantId | String | The ID of the tenant where the person belongs. Tenant ID is a unique GUID that identifies your organization’s Azure Active Directory (Entra ID) tenant. |
28
+
29
+
## Relationships
30
+
31
+
None.
32
+
33
+
## JSON representation
34
+
35
+
You can use the principal or principalCollection data types.
| principal | Use this datatype when the property has information about one person. Example: Assignee property for a JIRA ticket where there's only one assignee.|
40
+
| principalCollection | Use this datatype when the property refers to a list of people. Example: Contributors property for a GitHub PR where there can be multiple people.|
41
+
42
+
Using principal or principalCollection type properties instead of a string or string collection for people related properties while ingesting ExternalItems can provide better and more relevant results in Copilot Search or chat.
43
+
44
+
The following JSON representation shows the resource type for principal data type.
Copy file name to clipboardExpand all lines: api-reference/v1.0/resources/externalconnectors-property.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,13 +20,14 @@ A [schema](externalconnectors-schema.md) property definition for a Microsoft Sea
20
20
|Property|Type|Description|
21
21
|:---|:---|:---|
22
22
|aliases|String collection|A set of aliases or a friendly name for the property. Maximum 32 characters. Only alphanumeric characters allowed. For example, each string may not contain control characters, whitespace, or any of the following: `:`, `;`, `,`, `(`, `)`, `[`, `]`, `{`, `}`, `%`, `$`, `+`, `!`, `*`, `=`, `&`, `?`, `@`, `#`, `\`, `~`, `'`, `"`, `<`, `>`, `` ` ``, `^`. Optional.|
23
+
| description| String| Specifies a human-readable description that explains the purpose, usage, or guidance related to the property. This property enhances semantic understanding by helping Copilot interpret queries and accurately map them to properties that results in more relevant and precise responses. Optional but we recommend that you use this property for queryable properties. The maximum supported length is 200 characters.|
23
24
|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.|
24
25
|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.|
25
26
|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.|
26
27
|isSearchable|Boolean|Specifies if the property is searchable. Only properties of type `String` or `StringCollection` can be searchable. Nonsearchable properties aren't added to the search index. Optional.|
27
-
|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 (for example, better relevance). Optional.<br><br>The possible values are: `title`, `url`, `createdBy`, `lastModifiedBy`, `authors`, `createdDateTime`, `lastModifiedDateTime`, `fileName`, `fileExtension`, `unknownFutureValue`, `iconUrl`. Use the `Prefer: include-unknown-enum-members` request header to get the following members in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `iconUrl`.|
28
+
| 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 (for example, better relevance). Optional.<br><br>The possible values are: `title`, `url`, `createdBy`, `lastModifiedBy`, `authors`, `createdDateTime`, `lastModifiedDateTime`, `fileName`, `fileExtension`, `unknownFutureValue`, `containerName`, `containerUrl`, `iconUrl`, `assignedTo`, `dueDate`, `closedDate`, `closedBy`, `reportedBy`, `sprintName`, `severity`, `state`, `priority`, `secondaryId`, `itemParentId`, `parentUrl`, `tags`, `itemType`, `itemPath`, `numReactions`. Use the `Prefer: include-unknown-enum-members` request header to get the following values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `containerName`, `containerUrl`, `iconUrl`, `assignedTo`, `dueDate`, `closedDate`, `closedBy`, `reportedBy`, `sprintName`, `severity`, `state`, `priority`, `secondaryId`, `itemParentId`, `parentUrl`, `tags`, `itemType`, `itemPath`, `numReactions`.|
28
29
|name|String|The name of the property. Maximum 32 characters. Only alphanumeric characters allowed. For example, each string may not contain control characters, whitespace, or any of the following: `:`, `;`, `,`, `(`, `)`, `[`, `]`, `{`, `}`, `%`, `$`, `+`, `!`, `*`, `=`, `&`, `?`, `@`, `#`, `\`, `~`, `'`, `"`, `<`, `>`, `` ` ``, `^`. Required.|
29
-
|type|microsoft.graph.externalConnectors.propertyType|The data type of the property. The possible values are: `string`, `int64`, `double`, `dateTime`, `boolean`, `stringCollection`, `int64Collection`, `doubleCollection`, `dateTimeCollection`, `unknownFutureValue`.|
30
+
|type|microsoft.graph.externalConnectors.propertyType|The data type of the property. The possible values are: `string`, `int64`, `double`, `dateTime`, `boolean`, `stringCollection`, `int64Collection`, `doubleCollection`, `dateTimeCollection`, `principal`, `principalCollection`, `unknownFutureValue`.|
30
31
31
32
## Relationships
32
33
None.
@@ -43,6 +44,7 @@ The following JSON representation shows the resource type.
0 commit comments