Skip to content
ConductorOne Docs
  • Auto
  • Light
  • Dark
Get Started

Update

Update
post/api/v1/apps/{app_id}/connectors/{id}

Update a connector.

Path Parameters
app_idstring

The id of the app the connector is associated with.

idstring

The id of the connector.

Body Parameters
connectoridstringappIdstringcatalogIdstringconfigobjectcreatedAtstringdeletedAtstringdescriptionstringdisplayNamestringdownloadUrlstringoauthAuthorizedAsC1APIAppV1OAuth2AuthorizedAsprofileAllowListarray of stringprofileIgnoreListarray of stringstatusC1APIAppV1ConnectorStatussyncDisabledAtstringsyncDisabledCategorystringsyncDisabledReasonstringupdatedAtstringuserIdsarray of stringC1APIAppV1Connector
optional

A Connector is used to sync objects into Apps

expandMaskpathsarray of stringC1APIAppV1ConnectorExpandMask
optional

The ConnectorExpandMask is used to expand related objects on a connector.

updateMaskstring
optional
Returns
Request example cURL
curl https://{tenantDomain}.conductor.one/api/v1/apps/$APP_ID/connectors/$ID \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"
200 Example
{
  "connectorView": {
    "appPath": "appPath",
    "connector": {
      "id": "id",
      "appId": "appId",
      "catalogId": "catalogId",
      "config": {
        "@type": "@type"
      },
      "description": "description",
      "displayName": "displayName",
      "oauthAuthorizedAs": {},
      "profileAllowList": [
        "string"
      ],
      "profileIgnoreList": [
        "string"
      ],
      "status": {
        "completedAt": "2019-12-27T18:11:19.117Z",
        "lastError": "lastError",
        "startedAt": "2019-12-27T18:11:19.117Z",
        "status": "SYNC_STATUS_UNSPECIFIED",
        "updatedAt": "2019-12-27T18:11:19.117Z"
      },
      "syncDisabledCategory": "syncDisabledCategory",
      "syncDisabledReason": "syncDisabledReason",
      "userIds": [
        "string"
      ]
    },
    "usersPath": "usersPath"
  },
  "expanded": [
    {
      "@type": "@type"
    }
  ]
}