Microsoft Graph External is the set of Microsoft Graph capabilities (the /external namespace) that lets you bring content from third‑party apps and line‑of‑business systems into Microsoft 365. You create external connections, define a schema, and push items (with ACLs and properties) so Microsoft indexes them and makes them available in Microsoft Search, Viva, and Copilot alongside native M365 data.
openapi: 3.1.0
info:
title: Microsoft Graph External
description: Needs a description.
paths:
/external:
description: Provides operations to manage the external singleton.
get:
tags:
- External.external
summary: Microsoft Graph Get external
operationId: external.external.GetExternal
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.external
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- External.external
summary: Microsoft Graph Update external
operationId: external.external.UpdateExternal
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.externalConnectors.external'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.external
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/external/connections:
description: >-
Provides operations to manage the connections property of the
microsoft.graph.externalConnectors.external entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph List externalConnections
description: Get a list of the externalConnection objects and their properties.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-list?view=graph-rest-1.0
operationId: external.ListConnections
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.externalConnectors.externalConnectionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- external.externalConnection
summary: Microsoft Graph Create externalConnection
description: Create a new externalConnection object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-external-post-connections?view=graph-rest-1.0
operationId: external.CreateConnections
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalConnection
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalConnection
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/external/connections/{externalConnection-id}:
description: >-
Provides operations to manage the connections property of the
microsoft.graph.externalConnectors.external entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get externalConnection
description: Read the properties and relationships of an externalConnection object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-get?view=graph-rest-1.0
operationId: external.GetConnections
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalConnection
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- external.externalConnection
summary: Microsoft Graph Update externalConnection
description: Update the properties of an externalConnection object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-update?view=graph-rest-1.0
operationId: external.UpdateConnections
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalConnection
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalConnection
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- external.externalConnection
summary: Microsoft Graph Delete externalConnection
description: Deletes an externalConnection object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-delete?view=graph-rest-1.0
operationId: external.DeleteConnections
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
/external/connections/{externalConnection-id}/groups:
description: >-
Provides operations to manage the groups property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get externalGroup
description: Get an externalGroup object.
operationId: external.connections.ListGroups
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.externalConnectors.externalGroupCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- external.externalConnection
summary: Microsoft Graph Create externalGroup
description: Create a new externalGroup object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-post-groups?view=graph-rest-1.0
operationId: external.connections.CreateGroups
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
/external/connections/{externalConnection-id}/groups/{externalGroup-id}:
description: >-
Provides operations to manage the groups property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get externalGroup
description: Get an externalGroup object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalgroup-get?view=graph-rest-1.0
operationId: external.connections.GetGroups
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- external.externalConnection
summary: Microsoft Graph Update externalGroup
description: Update the properties of an externalGroup object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalgroup-update?view=graph-rest-1.0
operationId: external.connections.UpdateGroups
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- external.externalConnection
summary: Microsoft Graph Delete externalGroup
description: Delete an externalGroup object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalgroup-delete?view=graph-rest-1.0
operationId: external.connections.DeleteGroups
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
/external/connections/{externalConnection-id}/groups/{externalGroup-id}/members:
description: >-
Provides operations to manage the members property of the
microsoft.graph.externalConnectors.externalGroup entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get members from external
description: >-
A member added to an externalGroup. You can add Microsoft Entra users,
Microsoft Entra groups, or an externalGroup as members.
operationId: external.connections.groups.ListMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.externalConnectors.identityCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- external.externalConnection
summary: Microsoft Graph Create identity
description: Create an identity resource for a new member in an externalGroup.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalgroup-post-members?view=graph-rest-1.0
operationId: external.connections.groups.CreateMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.externalConnectors.identity'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.identity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
/external/connections/{externalConnection-id}/groups/{externalGroup-id}/members/{identity-id}:
description: >-
Provides operations to manage the members property of the
microsoft.graph.externalConnectors.externalGroup entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get members from external
description: >-
A member added to an externalGroup. You can add Microsoft Entra users,
Microsoft Entra groups, or an externalGroup as members.
operationId: external.connections.groups.GetMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.identity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- external.externalConnection
summary: Microsoft Graph Update the navigation property members in external
operationId: external.connections.groups.UpdateMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.externalConnectors.identity'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.identity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- external.externalConnection
summary: Microsoft Graph Delete identity
description: >-
Delete an identity resource to remove the corresponding member from an
externalGroup.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalgroupmember-delete?view=graph-rest-1.0
operationId: external.connections.groups.DeleteMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
- name: identity-id
in: path
description: The unique identifier of identity
required: true
schema:
type: string
x-ms-docs-key-type: identity
/external/connections/{externalConnection-id}/groups/{externalGroup-id}/members/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get the number of the resource
operationId: external.connections.groups.members.GetCount-482b
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
/external/connections/{externalConnection-id}/groups/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get the number of the resource
operationId: external.connections.groups.GetCount-51f5
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
/external/connections/{externalConnection-id}/items:
description: >-
Provides operations to manage the items property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get externalItem
description: Read the properties and relationships of an externalItem object.
operationId: external.connections.ListItems
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.externalConnectors.externalItemCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- external.externalConnection
summary: Microsoft Graph Create new navigation property to items for external
operationId: external.connections.CreateItems
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalItem
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalItem
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
/external/connections/{externalConnection-id}/items/{externalItem-id}:
description: >-
Provides operations to manage the items property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get externalItem
description: Read the properties and relationships of an externalItem object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalitem-get?view=graph-rest-1.0
operationId: external.connections.GetItems
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalItem
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- external.externalConnection
summary: Microsoft Graph Create externalItem
description: Create a new externalItem object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-put-items?view=graph-rest-1.0
operationId: external.connections.SetItems
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalItem
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalItem
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- external.externalConnection
summary: Microsoft Graph Delete externalItem
description: Delete an externalItem object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalitem-delete?view=graph-rest-1.0
operationId: external.connections.DeleteItems
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalItem-id
in: path
description: The unique identifier of externalItem
required: true
schema:
type: string
x-ms-docs-key-type: externalItem
/external/connections/{externalConnection-id}/items/{externalItem-id}/activities:
description: >-
Provides operations to manage the activities property of the
microsoft.graph.externalConnectors.externalItem entity.
get:
tags:
- external.externalConne
# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/external-openapi-original.yml