Create Or Modify An OAuth Connection

Supports 3 legged OAuth 2.0.

  • API support for OAuth Connections is being added gradually. OAuth Connections are supported for the following Connectors.
    • HubSpot
    • Eloqua Bulk
  • To modify general Connection properties, such as alias, do not include a key for “properties”.
  • To reset the Connection and trigger reauthentication, send an empty properties array “properties” : “[]”.
  1. Verify that you have the Connector ID for the type of Connection you are creating. If you do not have that ID:
    1. Call the GET connectors method. The list of Connectors available to your Organization is returned.
    2. Choose the Connector for your new Connection. The Connector ID is used in later calls.
  2. Verify that you have an Agent that supports the Connector:
    1. Call the GET agents method and filter on Connector ID.
    2. Choose an Agent from the list of Agents that support the Connector that is returned.
  3. Determine if any additional properties must be provided to create a Connection for this Connector type. For most OAuth Connections, there are no additional properties required.

    For details on the properties of your Connector, see the Connections topic in the TIBCO Scribe® Help Center.

  4. Call the POST connections method. An encrypted OAuth URL is returned. Uses the same encryption method used for regular Connections. See Connection Properties for additional information on encryption and links to code samples.
  5. Launch a browser window with the decrypted OAuth URL. The user is asked for credentials for that Connection. When the credentials are successfully entered, authentication details are returned directly to TIBCO Scribe®.
  6. Every 15 to 30 seconds, call the GET connection method, until the property named Status has the value pending test.
  7. Call the POST test connection method.
  8. Every 15 to 30 seconds, call the GET connection method, until there is no longer a property named Status in the array of properties.

See

How Do I...