Authentication Types #
Cyclr supports various authentication types and, sometimes with the addition of scripting, it is possible to establish a connection with any API.
| Method | Description |
|---|---|
| None | When this is used, no standard authentication process will be followed so Cyclr won’t perform any of the common authentication processes or flows. This setting can be used if an API uses particularly unusual authentication so you can instead request relevant credentials by using Connector-level Parameters set to “Account” along with Script where necessary. |
| ApiKey | The user provides an API key which is sent in an HTTP header when Cyclr makes calls through the Connector. |
| Basic | The API uses HTTP Basic authentication where typically a username and password are provided. |
| OAuth1 | The API uses OAuth 1.0a authentication. Requires: * ClientId (also known as “ConsumerKey”)* ClientSecret (also known as “ConsumerSecret”)* RequestTokenUrl* AuthorizeUrl* AccessTokenUrl |
| OAuth2 | The API uses OAuth 2.0 authentication. Requires: * ClientId* ClientSecret* AuthoriseUrl* AccessTokenUrl |
| Kerberos | Select when working with an API that uses Kerberos authentication. |
| NetSuiteOAuth1 | Oracle NetSuite implements a slightly modified version of the standard OAuth 1.0 which is handled by this Cyclr Authentication Type. Specifically, NetSuite’s implementation: * skips the handshake phase. * requires tokens to be generated from within NetSuite’s interface. * forces HMAC-SHA256 encryption. |
| ClientCertificate | When an API requires a certificate to be provided as authentication. |
OAuth2Type #
These fields will only be used if the AuthType is set to OAuth2 to use one of the standard OAuth2.0 authentication flows:
| Property | Description |
|---|---|
| AuthorisationCode | The client will redirect the user to the authorization server, the user will then be asked to login to the authorization server and approve the client. |
| ClientCredentials | Client will get the access token from the authorization server without user challenge. |
| PasswordCredentials | Client will get the access token from the authorization server using username and password. |
Bearer Token #
If an API requires a Bearer Token to be sent, for example when the API Key is used, then you can add Script at the Connector-level to prepend it with “Bearer “ and set it as the Authorization HTTP Header in all Requests like this:
function before_action() {
method_request_headers.Authorization = 'Bearer ' + method_auth_value;
return true;
}Cyclr exposes the API Key entered during installation of the Connector through the method_auth_value variable in the before_action event.
Refresh Tokens #
Cyclr will only use Refresh Tokens that are valid for at least 12 hours. Any received from an API that are less than 12 hours will be ignored.
Authenticating Connectors through the Cyclr API #
See this article for information relating to authenticating installed Connectors using Cyclr’s API.