Skip to content

Latest commit

 

History

History
138 lines (98 loc) · 5.14 KB

externalconnectors-externalconnection-update.md

File metadata and controls

138 lines (98 loc) · 5.14 KB
title description ms.localizationpriority author ms.subservice doc_type
Update externalConnection
Update the properties of an externalConnection.
medium
snlraju-msft
search
apiPageType

Update connection

Namespace: microsoft.graph.externalConnectors

[!INCLUDE beta-disclaimer]

Update the properties of an externalConnection.

[!INCLUDE national-cloud-support]

Permissions

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.

[!INCLUDE permissions-table]

HTTP request

PATCH /external/connections/{id}

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. The following properties can be updated.

Property Type Description
configuration microsoft.graph.externalConnectors.configuration Specifies additional application IDs that are allowed to manage the connection and to index content in the connection.
description String Description of the connection displayed in the Microsoft 365 admin center.
name String The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters.

Response

If successful, this method returns a 204 No Content response code.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/external/connections/contosohr
Content-type: application/json

{
  "name": "Contoso HR Service Tickets",
  "description": "Connection to index HR service tickets"
}

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]


Response

The following example shows the response.

HTTP/1.1 204 No Content