Connector

Create Delegated

Create a connector that is pending a connector config.

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

Path parameters

app_idstring required

The appId of the app the connector is attached to.

Request body

catalogIdstring

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

The description of the connector.

displayNamestring

The displayName of the connector.

userIdsstring[] nullable

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

Response

The ConnectorServiceCreateResponse is the response returned from creating a connector.

Changes

Changed in 9 of the 33 revisions of this API.6814

  • f2cf3228f366682See the full diff
    • the request property appEntitlementOwnerRefs became not nullable

      request-property-became-not-nullable

    • the request property userIds became not nullable

      request-property-became-not-nullable

    • the appManagedStateBindingRef request property type/format changed from object/ to /

      request-property-type-changed

    • the expandMask request property type/format changed from object/ to /

      request-property-type-changed

    • added c1.api.app.v1.ConnectorView subschema #2 to the connectorView response property oneOf list for the response status 200

      response-property-one-of-added

    • the connectorView response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the request property appManagedStateBindingRef/appId

      request-property-removed

    • removed the request property appManagedStateBindingRef/resourceId

      request-property-removed

    • removed the request property appManagedStateBindingRef/resourceTypeId

      request-property-removed

    • removed the request property expandMask/paths

      request-property-removed

    • removed the optional property connectorView/appPath from the response with the 200 status

      response-optional-property-removed

    • removed the optional property connectorView/capabilitiesPath from the response with the 200 status

      response-optional-property-removed

    • removed the optional property connectorView/connector from the response with the 200 status

      response-optional-property-removed

    • removed the optional property connectorView/usersPath from the response with the 200 status

      response-optional-property-removed

    • added c1.api.app.v1.AppManagedStateBindingRef subschema #2 to the appManagedStateBindingRef request property oneOf list

      request-property-one-of-added

    • added c1.api.app.v1.ConnectorExpandMask subschema #2 to the expandMask request property oneOf list

      request-property-one-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property appEntitlementOwnerRefs

      new-optional-request-property

    • added the optional property connectorView/connector/configUpdatedAt to the response with the 200 status

      response-optional-property-added

    • added the optional property connectorView/connector/parallelSyncWorkerCount to the response with the 200 status

      response-optional-property-added

    • added the optional property connectorView/connector/connectorApiVersion to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property connectorView/connector/connectorSyncCronSchedule to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property connectorView/connector/syncConfig to the response with the 200 status

      response-optional-property-added

    • added the optional property connectorView/connector/canResumeSync to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property connectorView/capabilitiesPath to the response with the 200 status

      response-optional-property-added

    • added the optional property connectorView/connector/disableCheckBadSync to the response with the 200 status

      response-optional-property-added

    • added the optional property connectorView/connector/profileAllowList to the response with the 200 status

      response-optional-property-added

    • added the optional property connectorView/connector/profileIgnoreList to the response with the 200 status

      response-optional-property-added

    This revision also has 44 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog