ManagedConnectors

Use the ManagedConnectors endpoint to view information about third party Connectors for which you are the vendor or that you manage. Other endpoints associated with ManagedConnectors include:

Customers — Use the Customers endpoints to view and control customer access to Managed Connectors. See Managing Connectors in the TIBCO Scribe® Help.

Endpoints — Use the links in the Endpoints section below to access the TIBCO Scribe® Swagger page and try out the API against your Organization.

Fields For ManagedConnectors Endpoints — Review the field definition table below the list of Endpoints for detailed field level information.

Endpoints

/v1/orgs/{orgId}/managedconnectors

Return a list of Connectors managed by an Organization

/v1/orgs/{orgId}/managedconnectors/{id}

Return information about a Managed Connector

Fields For ManagedConnectors Endpoints

The list of fields defined in this table is comprehensive across all ManagedConnectors endpoints. See Endpoints for a list of ManagedConnectors endpoints with links to the associated Swagger page.

Name Type Data Type	Description	Endpoints
Parameters
limit query integer	Maximum number of Managed Connectors to return. Default value is 100. See Reading Resources for more information on offset and limit parameters.	GET /v1/orgs/{orgId}/managedconnectors
id query string	GUID/UUID of the Managed Connector. Required	GET /v1/orgs/{orgId}/managedconnectors/{id}
name query string	Name of the Managed Connector.	GET /v1/orgs/{orgId}/managedconnectors
offset query integer	Number of Managed Connectors to skip before returning results. Default value is 0. See Reading Resources for more information on offset and limit parameters.	GET /v1/orgs/{orgId}/managedconnectors
orgId path integer	Unique ID for each Organization. Required	All
showCustomers query boolean	Controls whether or not to return a list of customer Organizations using the Connector. Default is false. true — Returns Organizations. false — Does not return Organizations.	GET /v1/orgs/{orgId}/managedconnectors GET /v1/orgs/{orgId}/managedconnectors/{id}
Response
customers response array	Array of customers that have the Managed Connector installed. Customer data includes the following: orgId — ID of the customer Organization that installed the vendor's Managed Connector. orgName — Name of the customer Organization that installed the vendor's Managed Connector. provisionedBy — Username of the person in your Organization who provided access to this Connector or the user from the customer Organization who downloaded it from the Marketplace.. provisionedDate — Date the customer Organization installed the Connector. See Customers.	GET /v1/orgs/{orgId}/managedconnectors GET /v1/orgs/{orgId}/managedconnectors/{id}
description response string	Description of the Connector, such as TIBCO Scribe® Connector for Eloqua.	GET /v1/orgs/{orgId}/managedconnectors GET /v1/orgs/{orgId}/managedconnectors/{id}
id response string	GUID/UUID of the Connector.	GET /v1/orgs/{orgId}/managedconnectors GET /v1/orgs/{orgId}/managedconnectors/{id}
isCloudSupported response boolean	Indicates whether or not the Connector can be used with a Cloud Agent.	GET /v1/orgs/{orgId}/managedconnectors GET /v1/orgs/{orgId}/managedconnectors/{id}
isFree response boolean	Indicates whether or not the Connector vendor requires payment.	GET /v1/orgs/{orgId}/managedconnectors GET /v1/orgs/{orgId}/managedconnectors/{id}
isInMarketPlace response boolean	Indicates whether or not the Connector is displayed in the TIBCO Scribe® Marketplace.	GET /v1/orgs/{orgId}/managedconnectors GET /v1/orgs/{orgId}/managedconnectors/{id}
name response string	Name of the Connector, such as Eloqua. Value cannot be NULL.	GET /v1/orgs/{orgId}/managedconnectors GET /v1/orgs/{orgId}/managedconnectors/{id}
vendorName response string	Name of the company that created the Connector, such as TIBCO Software Inc..	GET /v1/orgs/{orgId}/managedconnectors GET /v1/orgs/{orgId}/managedconnectors/{id}
version response string	Version number of the Connector, such as 1.0.	GET /v1/orgs/{orgId}/managedconnectors GET /v1/orgs/{orgId}/managedconnectors/{id}

See

Endpoints

API Basics