OAuth authentication link

If the connector requires OAuth authentication to work with the third party API, you need to show the user a window to let them authenticate with their details.

If the user doesn’t have access to the Cyclr account, you can use an account one time sign in token:

Call the /v1.0/accounts/{id}/signintoken endpoint to retrieve the one time sign in token.
Build the URL.
Send the URL to your user.

You can use the sign in token to build a URL to send to the user. Call the /v1.0/accounts/{id}/signintoken endpoint to retrieve the one time sign in token.

Request

POST https://{yourCyclrInstance}/v1.0/accounts/{AccountId}/signintoken
Authorization: Bearer {access_token}
{
  "Username":"The username of user you want to sign in"
}

Note: If the user doesn’t already exist, this call creates one with this name.

Response

{
  "Token":"***************************************",
  "ExpiresAtUtc":"2001-03-28T11:22:33.138Z"
}

Build the URL

When you send the user the built URL, it redirects them to the third party OAuth flow. When they authenticate the account connector, the URL redirects the user to targetOrigin or a JavaScript message posts to the parent window.

https://{Partner Service Domain}/connectorauth/updateaccountconnectoroauth?id={AccountId}&token={SignInToken}&targetOrigin={RedirectURL}&callbackMessage={Message}

To view your Partner Service Domain, go to the console Settings > General Settings.

URL query string

Parameter	Type	Description
`id`	integer	Enter the `Id` of the installed connector you want the user to authenticate.
`token`	string	Enter the account sign in `Token`.
`targetOrigin`	string	Specify what the origin of the other window must be to dispatch the javascript callback. If the callback message is null we will redirect to the targetOrigin
`callbackMessage`	string, optional	Write a callback message to send to the parent window.

Example built URL

https://PartnerServiceDomain]/connectorauth/updateaccountconnectoroauth?id=1&token=***************************************&targetOrigin=example.com&callbackMessage=done

In This Article