For connectors that require your user to be taken through an OAuth flow.

Connectors using OAuth require that the user goes through a webflow where they are sent to the third party application to sign in and grant access to Cyclr.

You’ll need to create an Account Sign-In Token for a User to access the account. The Token will be valid for 5 minutes, as indicated by the ExpiresAtUtc value in the response.


POST  /v1.0/accounts/{Account ID}/signintoken
Content-Type: application/json
Authorization: Bearer 0000000000000000000000000000000000000000000000000000000000000000

    "Username": "example_user"


    "Token": "ABCD12340000000000000=",
    "ExpiresAtUtc": "2017-12-08T11:02:48.7436471Z"

The user should then be sent here in their browser:

https://{Partner Service Domain}/connectorauth/updateaccountconnectoroauth?id={Account Connector ID}&token={Account Sign-In Token}&targetOrigin=...

For example:

The following query string parameters can be included:

Parameter Description Example
token The account sign-in token generated above ABCD12340000000000000=
targetOrigin Required. Either the origin of another browser window for the JavaScript callback event to be dispatched to, or a URL to redirect the user to. Used after the OAuth authentication is complete.
callbackMessage Callback message to be sent by JavaScript postMessage to the parent window. Don’t include if using a redirect for targetOrigin. done

Remember to URL encode all parameter values.

Cyclr redirects the user to the appropriate sign in page of the target application, captures the OAuth tokens generated by that app, and stores them internally. Token refresh is handled automatically later.

On completion the user will either be redirected to targetOrigin or the JavaScript message specified by the callbackMessage will be posted to the parent window to notify the host app that the authentication flow has completed.

Providing Client ID and Client Secret Values

Typically, systems using OAuth allow you to create a single App which you can use with Cyclr to access all of your customer’s accounts. Some systems however, require the use of separate Apps for each cutomer. The correct setup should be described in each Connector’s Cyclr Connector Guide.

For systems that allow a single App for all customers, you should set the Client ID and Client Secret values of that App in your Cyclr Console’s Application Connector Library entry.

For Connectors that require the Client ID and Client Secret values to be provided separately for each Account Connector, or if you have chosen to provide them for each, add the following (using these exact names) as Account Connector Properties:

  • ClientId
  • ClientSecret

Step Setup
API Key Authentication
HTTP Basic Authentication

Tags: installing
Edit me