Create externalConnection

Namespace: microsoft.graph.externalConnectors

Create a new externalConnection object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet


Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All

HTTP request

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 object.

You can specify the following properties when creating an externalConnection.

Property Type Description
id String The connection ID. Required.
name String The connection name. Required.
description String The connection description. Required.
configuration microsoft.graph.externalConnectors.configuration The connection configurations. Optional.


If successful, this method returns a 201 Created response code and an externalConnection object in the response body.

Note: When you create an external connection with a broken adaptive card for the result layout, the first call will fail with a 503 Service Unavailable. When you try the call again, the second call will fail with a 409 Conflict response that states that a connection with the same name already exists. This happens because the connection was created even though the first call failed with 503 Service Unavailable. For more details, see Known issues.



Content-Type: application/json

  "id": "contosohr",
  "name": "Contoso HR",
  "description": "Connection to index Contoso HR system"


The following example shows the response. Note that the id, name, and description properties in the response payload are generated by the system and are different from the ones that are in the connection that was created.

HTTP/1.1 200 Created
Content-Type: application/json

  "id": "0a4f4e74-4e74-0a4f-744e-4f0a744e4f0a",
  "name": "String",
  "description": "String",
  "state": "ready",
  "configuration": {
    "authorizedAppIds": [