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:


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, in their browser, to: https://{Partner Service Domain}/connectorauth/updateaccountconnectoroauth?id={Account Connector ID}&token={Account Sign-In Token}

For example:

The following query string parameters can be included:

Parameter Description Example
token The account sign-in token generated above ABCD12340000000000000=
targetOrigin Either the origin of the other window for the JavaScript callback event to be dispatched or a URL to redirect the user to after the OAuth authentication is completed
callbackMessage Callback message to be sent by JavaScript postMessage to the parent window. Don’t include if using redirect 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.

Step Setup
API Key Authentication
HTTP Basic Authentication

Tags: installing
Edit me