Customers

Use the Customers endpoints to view and control customer access to Managed Connectors.

The TIBCO Scribe® Connector Developer Kit (CDK) allows vendors and partners to develop and configure Connectors for products of their choice to be used with TIBCO Scribe® Maps and Solutions to perform specific tasks. Once these Managed Connectors have been certified by TIBCO Scribe®, they can be made available to other TIBCO Scribe® users.

The TIBCO Scribe® Marketplace is a portal used to provide custom Connectors to TIBCO Scribe® users. These Managed Connectors, configured using the TIBCO Scribe® CDK, allow a Connector Vendor's customers to perform a wide variety of tasks. It is up to the Connector vendor, to determine what that Connector does.

TIBCO Scribe® provides two levels of customer access to Connectors:

  • Marketplace — These Connectors are available from the Marketplace. Customers can install them from the Marketplace Connectors page.
  • Restricted — These Connectors are only available directly from the vendor. To use this Connector, the vendor must grant access to a specific Organization. Access can be granted from the TIBCO Scribe® User Interface using the Marketplace: New Customer dialog box as described in Adding Customers. Once access has been granted, the Connector is installed and displays on the Connectors page with the Restricted icon.

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 Customers Endpoints — Review the field definition table below the list of Endpoints for detailed field level information.

Endpoints

Return a list of customer Organizations with access to a Managed Connector

Remove a customer Organization's access to a Managed Connector

Grant a customer Organization access to a Managed Connector

Fields For Customers Endpoints

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

Name
Type
Data Type

Description

Endpoints

Parameters

connectorId

path

string

GUID/UUID of the Managed Connector for which you are requesting a list of customer Organizations. Required

  • GET /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers
  • DELETE /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers/{id}
  • POST /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers/{id}

id

path

integer

GUID/UUID of the customer Organization. Required

  • DELETE /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers/{id}
  • POST /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers/{id}

limit

query

integer

Maximum number of customer Organizations to return. Default value is 100.

See Reading Resources for more information on offset and limit parameters.

  • GET /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers

offset

query

integer

Number of customer Organizations 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/{connectorId}/customers

orgId

path

integer

Unique ID for each Organization. Required

Note: This is the ID of the Vendor's Managing Organization.

All

Response

orgId

response

integer

ID of the customer Organization that installed the vendor's Managed Connector.

  • GET /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers
  • POST /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers/{id}

orgName

response

string

Name of the customer Organization that installed the vendor's Managed Connector.

  • GET /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers
  • POST /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers/{id}

provisionedBy

response

string

User name or email address of the person who installed the Connector for the customer Organization.

  • For Connectors installed from the Marketplace — The username of the person at the customer's Organization.
  • For Connectors installed by the managing Organization — The username of the person in your Organization who provided access to this Connector.
  • GET /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers
  • POST /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers/{id}

provisionedDate

response

string

Date the customer Organization installed the Connector.

  • GET /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers
  • POST /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers/{id}

 

See

Endpoints

API Basics