Microsoft Graph · Schema

microsoft.graph.externalConnectors.externalConnection

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphexternalconnectorsexternalconnection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.externalConnectors.externalConnection",
  "title": "microsoft.graph.externalConnectors.externalConnection",
  "allOf": [
    {
      "$ref": "#/components/schemas/microsoft.graph.entity"
    },
    {
      "title": "externalConnection",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "activitySettings": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.externalConnectors.activitySettings"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Collects configurable settings related to activities involving connector content."
        },
        "configuration": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.externalConnectors.configuration"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Specifies additional application IDs that are allowed to manage the connection and to index content in the connection. Optional."
        },
        "connectorId": {
          "type": "string",
          "description": "The Teams app ID. Optional.",
          "nullable": true
        },
        "description": {
          "type": "string",
          "description": "Description of the connection displayed in the Microsoft 365 admin center. Optional.",
          "nullable": true
        },
        "name": {
          "type": "string",
          "description": "The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. Required.",
          "nullable": true
        },
        "searchSettings": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.externalConnectors.searchSettings"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The settings configuring the search experience for content in this connection, such as the display templates for search results."
        },
        "state": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.externalConnectors.connectionState"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Indicates the current state of the connection. The possible values are: draft, ready, obsolete, limitExceeded, unknownFutureValue.",
          "readOnly": true
        },
        "groups": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.externalConnectors.externalGroup"
          },
          "x-ms-navigationProperty": true
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.externalConnectors.externalItem"
          },
          "x-ms-navigationProperty": true
        },
        "operations": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.externalConnectors.connectionOperation"
          },
          "x-ms-navigationProperty": true
        },
        "schema": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.externalConnectors.schema"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "x-ms-navigationProperty": true
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.externalConnectors.externalConnection"
}