Create Pending

Create Delegated

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

Create a connector that is pending a connector config.

Path Parameters

app_idstring

The appId of the app the connector is attached to.

Body Parameters

appManagedStateBindingRefobject

optional

The AppManagedStateBindingRef message.

Hide ParametersShow Parameters

appIdstring

optional

The appId field.

resourceIdstring

optional

The resourceId field.

resourceTypeIdstring

optional

The resourceTypeId field.

catalogIdstring

optional

The catalogId describes which catalog entry this connector is an instance of. For example, every Okta connector will have the same catalogId indicating it is an Okta connector.

descriptionstring

optional

The description of the connector.

displayNamestring

optional

The displayName of the connector.

expandMaskpathsarray of stringC1APIAppV1ConnectorExpandMask

optional

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

userIdsarray of string

optional

The userIds field is used to define the integration owners of the connector.

Returns

connectorViewC1APIAppV1ConnectorViewexpandedarray of objectC1APIAppV1ConnectorServiceCreateResponse

Request example cURL

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