Some Connectors provide multiple Authentication Types to enable you to decide how to set them up. Examples are the Google Sheets and Salesforce Connectors.
When installing a Connector using Cyclr’s API, if you don’t specify the Authentication Type when there are multiple, the default defined on the Connector is used.
After installing a Connector, if you need to change its Authentication Type, you can use the Cyclr API endpoints described below.
It’s not currently possible to change the Authentication Type of a Connector through Cyclr’s interface. You can use the Cyclr API, as described on this page, or install the Connector again and select the appropriate Authentication Type.
List Authentication Types #
Endpoint: GET /v1.0/account/connectors/{id}/authenticationtypes
Returns every Authentication Type supported by the Release of the underlying Connector an Account Connector is using, and indicates which is in use with the IsCurrentAuthenticationType flags.
Example Response:
[
{ "Id": "b3f1...", "AuthName": "OAuth2", "IsCurrentAuthenticationType": true },
{ "Id": "9ac2...", "AuthName": "API Key", "IsCurrentAuthenticationType": false }
]Set Authentication Type #
Endpoint: PUT /v1.0/account/connectors/{id}/authenticationtype
Sets the Authentication Type to be used by an Account Connector by providing an Id as returned by the GET /v1.0/account/connectors/{id}/authenticationtypes endpoint described above.
Example Request:
{
"ConnectorAuthenticationId": "9ac2..."
}Behavior when changing Authentication Type #
| Situation | What happens? |
|---|---|
| Requested type is already the active one | No change. Returns the Account Connector unchanged with no disruption to integrations using it. |
| Account Connector was previously authenticated and configured | Deauthenticates the Account Connector – existing credentials and Connector Properties are cleared. Any running integrations using that Account Connector are also deactivated. |
| Account Connector was not yet authenticated and configured | Authentication Type is changed immediately. No deauthentication is performed. |
| Requested Authentication Type does not exist for the underlying Connector | Rejected – 400 Bad Request |
| Connector ID isn’t valid | Rejected – 404 Not Found |
| No ConnectorAuthenticationId provided | Rejected – 400 validation error |
In every situation, the Account Connector is left in a consistent state, either fully updated to the new Authentication Type or entirely unchanged. No partial updates occur.
Further Information #
- Re-authentication is required after changing type.
If an Account Connector was already authenticated, changing its Authentication Type clears the existing credentials. You’ll need to authenticate again using the newly selected type before any integrations depending on it can be started again. - This is a destructive action with no built-in confirmation at the API level.
We recommend prompting your users for confirmation before calling the Set Authentication Type endpoint on a live, authenticated Account Connector. - No reinstall or Template rebuild needed.
You can now update the Authentication Type on an existing installed Account Connector directly, including those already deployed across Accounts. - Switching an unauthenticated Connector is non-disruptive.
If the Account Connector was never fully setup, changing its Authentication Type has no side effects: no credentials to clear, no integrations are affected.