| title | Update oneRosterApiDataConnector |
|---|---|
| description | Update the properties of a oneRosterApiDataConnector object. |
| author | dakelle |
| ms.localizationpriority | medium |
| ms.subservice | industry-data-etl |
| doc_type | apiPageType |
| ms.date | 06/18/2024 |
Namespace: microsoft.graph.industryData
[!INCLUDE beta-disclaimer]
Update the properties of a oneRosterApiDataConnector object.
[!INCLUDE national-cloud-support]
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]
PATCH /external/industryData/dataConnectors/{industryDataConnectorId}| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| Content-Type | application/json. Required. |
[!INCLUDE table-intro]
| Property | Type | Description |
|---|---|---|
| displayName | String | The name of the data connector. Inherited from industryDataConnector. Required. |
| apiFormat | microsoft.graph.industryData.apiFormat | The API format of the external system being connected to. Inherited from apiDataConnector. The possible values are: oneRoster, unknownFutureValue. Required. |
| baseUrl | String | The base URI including the scheme, host, and path for the API (with or without a trailing '/'). Example: https://example.com/ims/oneRoster/v1p1. Inherited from apiDataConnector. Required. |
| credential | microsoft.graph.industryData.credential | The base type for all supported credentials. Inherited from apiDataConnector. Required. |
| apiVersion | String | The API version of the OneRoster source. Required. |
| isDemographicsEnabled | Boolean | Indicates whether the user specified to import optional demographics data. Required. |
| isFlagsEnabled | Boolean | Indicates whether the user specified to import optional flags data. Required. |
| isContactsEnabled | Boolean | Indicates whether the user specified to import optional contacts data. Required. |
If successful, this method returns a 204 No Content response code.
The following example shows a request.
PATCH https://graph.microsoft.com/beta/external/industryData/dataConnectors/51dca0a0-85f6-4478-f526-08daddab2271
Content-type: application/json
{
"@odata.type": "microsoft.graph.industryData.oneRosterApiDataConnector",
"displayName": "One Roster Connector"
}[!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]
The following example shows the response.
HTTP/1.1 204 No Content