Toggle Side Panel
Close search
View Categories

Account-level Data on Demand

1 min read

As a Cyclr Partner, you have full access to make calls to any of the Cyclr API’s endpoints against any of your Accounts. You can make calls to create Accounts, install Templates, modify Cycles and so on. You can also call the Methods of Connectors in any Accounts – referred to as Data on Demand.

There can be situations where it would be useful to enable your customers to be able to call Methods of Connectors installed into their Accounts themselves. Perhaps from within their own system or a Large Language Model (LLM)/AI-agent they use.

With the Account-level OAuth Client Credentials feature, you create a set of credentials, restricted to only that customer’s Cyclr Account and Scoped to the Data on Demand Cyclr API endpoints.

You then share the Client ID and Client Secret values of those credentials with your customer.

Your customer can then:

  • Obtain a Cyclr API Access Token by calling the POST /oauth/token endpoint using their Client ID and Client Secret values.
  • Store and use the returned access_token value in calls to Cyclr’s Data on Demand API Endpoints as shown below.
  • When their access_token expires – as defined when you created their Cyclr OAuth credentials – they simply obtain a new Access Token exactly as they did before.

Revoking Access #

If for any reason you wish to prevent a customer from using a set of Client ID and Client Secret values you’ve issued them with, you can simply Delete them from their Account-level OAuth Client Credentials page:

Data on Demand Endpoints #

A set of Account-level OAuth credentials with an OAuth Client Scope of “Data On Demand” can be used to generate a Cyclr API Access Token, but that Access Token is only valid for the following Cyclr API endpoints which relate to calling Connector Methods:

  • GET /v1.0/account/connectors
  • GET /v1.0/account/connectors/{accountConnectorId}
  • GET /v1.0/account/connectors/{accountConnectorId}/methods/{methodId}
  • POST /v1.0/account/connectors/{accountConnectorId}/methods/{methodId}
  • POST /v1.0/account/connectors/{accountConnectorId}/methods/{methodId}/body
  • GET /v1.0/connectors/{connectorId}/methods
  • GET /v1.0/connectors/{connectorName}/methods
  • GET /v1.0/connectors/{connectorName}/{version}/methods

When calling these endpoints with an Account-level Access Token, the usual X-Cyclr-Account HTTP Header is not needed as the Access Token indicates the Cyclr Account.

Details on how to use these Cyclr API endpoints can be found here:

IP Address Restrictions #

When using an Access Token obtained from Account-level OAuth credentials with an OAuth Client Scope of “Data On Demand”, Cyclr’s IP address restrictions are bypassed, meaning that any system can use them to call Data on Demand endpoints.