Create

Create

post/api/v1/apps/{app_id}/connectors/create

Create a configured connector.

Path Parameters

app_idstring

The appId field.

Body Parameters

catalogIdstring

optional

The catalogId field.

configobject

optional

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

descriptionstring

optional

The description field.

expandMaskpathsarray of stringC1APIAppV1ConnectorExpandMask

optional

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

userIdsarray of string

optional

The userIds field.

Returns

connectorViewC1APIAppV1ConnectorViewexpandedarray of objectC1APIAppV1ConnectorServiceCreateResponse

Request example cURL

curl https://{tenantDomain}.conductor.one/api/v1/apps/$APP_ID/connectors/create \
    -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"
    }
  ]
}