Microsoft Graph Connections lets organizations bring external business data—like content from Salesforce, ServiceNow, Confluence, file shares, or custom line‑of‑business apps—into Microsoft 365 by indexing it in Microsoft Graph.
openapi: 3.1.0
info:
title: Microsoft Graph Connections
description: Needs a description.
paths:
/connections:
description: >-
Provides operations to manage the collection of externalConnection
entities.
get:
tags:
- connections.externalConnection
summary: Microsoft Graph Get entities from connections
operationId: connections.externalConnection.ListExternalConnection
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:
- connections.externalConnection
summary: Microsoft Graph Add new entity to connections
operationId: connections.externalConnection.CreateExternalConnection
requestBody:
description: New entity
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalConnection
required: true
responses:
2XX:
description: Created entity
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
/connections/{externalConnection-id}:
description: >-
Provides operations to manage the collection of externalConnection
entities.
get:
tags:
- connections.externalConnection
summary: Microsoft Graph Get entity from connections by key
operationId: connections.externalConnection.GetExternalConnection
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.externalConnection
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- connections.externalConnection
summary: Microsoft Graph Update entity in connections
operationId: connections.externalConnection.UpdateExternalConnection
requestBody:
description: New 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:
- connections.externalConnection
summary: Microsoft Graph Delete entity from connections
operationId: connections.externalConnection.DeleteExternalConnection
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
/connections/{externalConnection-id}/groups:
description: >-
Provides operations to manage the groups property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get groups from connections
operationId: 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:
- connections.externalGroup
summary: Microsoft Graph Create new navigation property to groups for connections
operationId: 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
/connections/{externalConnection-id}/groups/{externalGroup-id}:
description: >-
Provides operations to manage the groups property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get groups from connections
operationId: 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:
- connections.externalGroup
summary: Microsoft Graph Update the navigation property groups in connections
operationId: 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:
- connections.externalGroup
summary: Microsoft Graph Delete navigation property groups for connections
operationId: 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
/connections/{externalConnection-id}/groups/{externalGroup-id}/members:
description: >-
Provides operations to manage the members property of the
microsoft.graph.externalConnectors.externalGroup entity.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get members from connections
description: >-
A member added to an externalGroup. You can add Microsoft Entra users,
Microsoft Entra groups, or an externalGroup as members.
operationId: 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:
- connections.externalGroup
summary: Microsoft Graph Create new navigation property to members for connections
operationId: 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
/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:
- connections.externalGroup
summary: Microsoft Graph Get members from connections
description: >-
A member added to an externalGroup. You can add Microsoft Entra users,
Microsoft Entra groups, or an externalGroup as members.
operationId: 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:
- connections.externalGroup
summary: Microsoft Graph Update the navigation property members in connections
operationId: 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:
- connections.externalGroup
summary: Microsoft Graph Delete navigation property members for connections
operationId: 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
/connections/{externalConnection-id}/groups/{externalGroup-id}/members/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get the number of the resource
operationId: connections.groups.members.GetCount-d49a
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
/connections/{externalConnection-id}/groups/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get the number of the resource
operationId: connections.groups.GetCount-6035
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
/connections/{externalConnection-id}/items:
description: >-
Provides operations to manage the items property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- connections.externalItem
summary: Microsoft Graph Get items from connections
operationId: 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:
- connections.externalItem
summary: Microsoft Graph Create new navigation property to items for connections
operationId: 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
/connections/{externalConnection-id}/items/{externalItem-id}:
description: >-
Provides operations to manage the items property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- connections.externalItem
summary: Microsoft Graph Get items from connections
operationId: 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:
- connections.externalItem
summary: Microsoft Graph Update the navigation property items in connections
operationId: 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:
- connections.externalItem
summary: Microsoft Graph Delete navigation property items for connections
operationId: 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
/connections/{externalConnection-id}/items/{externalItem-id}/activities:
description: >-
Provides operations to manage the activities property of the
microsoft.graph.externalConnectors.externalItem entity.
get:
tags:
- connections.externalItem
summary: Microsoft Graph Get activities from connections
description: Returns a list of activities performed on the item. Write-only.
operationId: connections.items.ListActivities
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.externalActivityCollectionResponse
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:
- connections.externalItem
summary: Microsoft Graph Create new navigation property to activities for connections
operationId: connections.items.CreateActivities
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalActivity
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalActivity
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
/connections/{externalConnection-id}/items/{externalItem-id}/activities/{externalActivity-id}:
description: >-
Provides operations to manage the activities property of the
microsoft.graph.externalConnectors.externalItem entity.
get:
tags:
- connections.externalItem
summary: Microsoft Graph Get activities from connections
description: Returns a list of activities performed on the item. Write-only.
operationId: connections.items.GetActivities
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.externalActivity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- connections.externalItem
summary: Microsoft Graph Update the navigation property activities in connections
operationId: connections.items.UpdateActivities
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalActivity
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalActivity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- connections.externalItem
summary: Microsoft Graph Delete navigation property activities for connections
operationId: connections.items.DeleteActivities
parameters:
- name: If-Match
in: header
description: ETag
# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/connections-openapi-original.yml