Cyclr Community
  • Forums
  • Tutorials
  • Documentation
    • User Documentation
    • Connector Guides
  • Resources
    • New Features
    • Blog
    • Changelog
    • Support Portal
    • Newsletter Archive
    Sign in
    Cyclr Logo
    Cyclr Logo
    • Forums
    • Tutorials
    • Documentation
      • User Documentation
      • Connector Guides
    • Resources
      • New Features
      • Blog
      • Changelog
      • Support Portal
      • Newsletter Archive

    About Cyclr

    6
    • Introduction to Cyclr
    • Minimum requirements
    • Glossary
    • Errors
    • IP Allow List
    • Legal notices

    Cyclr Console

    14
    • Partner Console Dashboard
    • The Builder
    • Reports
    • Console Configuration
    • General Settings
    • Notifications
    • Embedding Customization
    • Security settings
    • Data retention settings
    • Custom Service Domains
    • Handle transaction errors
    • Payload Size Limitations
    • Performance tips
    • GitHub Integration

    Connectors

    33
    • Introduction to Connectors
    • Connectivity Comparison
    • Connector Guides
    • Application Connectors
      • Introduction to Application Connectors
    • Utility Connectors
      • Introduction to Utility Connectors
      • Counter Storage
      • Cross Updating Preventer
      • Data Tools
      • Entity Cross Ref Storage
      • Generic File
      • Generic File Downloader
      • Generic Form
      • Generic Webhook
      • Data Storage
        • Introduction to Data Storage Connectors
        • Global Data Storage
        • Global Object Storage
        • Cycle Data Storage
        • Cycle Object Storage
    • Custom Connectors
      • Introduction to Custom Connectors
      • Methods
      • Triggers
      • Last Successful Run Date
      • Parameters
      • Scripting
      • Data Types
      • Paging
      • Custom Objects
      • Dynamic Custom Fields
      • Automatically Install Webhooks
      • Connector Standards
      • Settings
      • Authentication
      • Rate Limits

    Templates

    17
    • Introduction to Templates
    • Template Settings
    • Create a Template
    • Tools
    • Connectivity Tools
    • Map fields
    • Add custom fields
    • Custom Object Method Categories
    • Test Scripts
    • Collection splitting
    • Pass data between two steps
    • Test a template
    • Template versioning
    • Introduction to Cycles
    • Stop a cycle
    • Copy Cycles as Templates
    • Import or Export Templates

    Accounts

    5
    • Introduction to Accounts
    • Account Users
    • Sub Accounts
    • Connector Authentication Link
    • Export or Import Cycles

    Embedding

    17
    • Introduction to Embedding
    • ORBIT
    • Installing a Partner Connector
    • Embed Cyclr in an iFrame
    • Launch
      • Introduction to Launch
      • User Experience
      • Customize Appearance
      • Build Compatible Templates
      • Handle LAUNCH callbacks
      • Deploy LAUNCH
    • Marketplace
      • Introduction to Marketplace
      • Set up a Marketplace
      • Styling Marketplace
      • Deploying a Marketplace
      • Marketplace Callback
      • Marketplace Webhook Callback
      • Marketplace Settings

    API

    19
    • Introduction to the Cyclr API
    • Authentication
    • Authorize Account API calls
    • Install Connectors into an Account
    • Install a Cycle from a Template
    • Step Setup
    • Activate a Cycle
    • Install Connectors
    • Create an Account
    • API Example Walkthrough
    • Connector Authentication
      • Introduction to Connector Authentication
      • API Key Authentication
      • HTTP Basic Authentication
      • OAuth Authentication
    • Data on Demand
      • Introduction to Data on Demand
      • Get Account Connectors
      • Get Connector Methods
      • Call a Connector Method
      • IP Restriction

    Release Notes

    27
    • Introduction to Release Notes
    • 2025
      • 2025-05
      • 2025-04
      • 2025-03
      • 2025-02
      • 2025-01
    • 2024
      • 2024-12
      • 2024-11
      • 2024-10
      • 2024-09
      • 2024-08
      • 2024-07
      • 2024-06
      • 2024-05
      • 2024-04
      • 2024-03
      • 2024-02
      • 2024-01
    • 2023
      • 2023-12
      • 2023-11
      • 2023-10
      • 2023-06
      • 2023-05
      • 2023-04
    • Archive
      • Archive
      • 2022
      • 2021
    View Categories
    • Home
    • Documentation
    • API
    • Connector Authentication
    • Introduction to Connector Authentication

    Introduction to Connector Authentication

    1 min read

    Installed Account Connectors must be setup and authenticated before Cycles using them can run.

    Cyclr supports several types of authentications in Connectors, these being the main 3:

    AuthTypeDescription
    API KeyYour user will provide an API Key from the third party application that gives access to the third party API.
    HTTP BasicYour user will provide a username and password to access the third Party API.
    OAuthYour user will be taken through an OAuth flow which will generate an access token that’s returned to Cyclr which is then used to access the third party API.

    For each Connector requiring authentication, take your user through the appropriate flow.

    Note: Setting up an Account Connector through Cyclr’s API can be involved, depending on the authentication the Connector use and any additional properties that must be set.

    Installing and authenticating the Connector within an Account through Cyclr’s interface, noting the options that are displayed and how each effects the actual values stored on the Account Connector itself is a good way to understand the process.

    You can retrieve the current state of an Account Connector using this Cyclr API endpoint:
    GET /v1.0/account/connectors/{id}

    Checking the Authentication Type #

    To check the Authentication Type that an installed Account Connector requires, make the following call:

    Request: #

    GET /v1.0/account/connectors/{id}
    Authorization Bearer ********************
    X-Cyclr-Account: 00000000-0000-0000-0000-000000000000

    Response: #

        {
            "Id": 0,
            "Name": "Pipedrive",
            "Description": null,
            "AuthValue": null,
            "Authenticated": false,
            "Connector": {
                "Id": 0,
                "Name": "Pipedrive",
                "Description": "Sales CRM for small teams with big ambitions.",
                "Status": "Approved",
                "Version": "1.0",
                "Icon": null,
                "AuthDescription": null,
                "AuthType": "ApiKey",
                "OAuth2Type": "Unknown",
                "AuthScheme": null
            },
            "IsPartnerIntegrationConnector": false,
            "Properties": [],
            "CustomFields": []
        }

    In this example, the AuthType for this Account Connector is “ApiKey”.

    The Response also confirms that the Account Connector is not considered to have been authenticated yet, showing:
    "Authenticated": false

    Account Connector Properties #

    Before beginning the authentication process, you should set the values of any Parameters on the Account Connector that aren’t marked as Optional.

    To identify what these Parameters are, look in the Connector section you receive when making the Cyclr API call above for Parameters with IsAccountConnectorProperty:true and IsOptional:false.

    You could provide some interface of your own to obtain the values for these Parameters from the user.

    Call the POST /v1.0/account/connectors/{accountConnectorId}/properties endpoint to set each of those values on your Account Connector.

    The Account Connector should now be ready to authenticate.

    API Key Authentication
    HTTP Basic Authentication
    OAuth Authentication

    Share This Article :
    • Facebook
    • X
    • LinkedIn
    • Pinterest
    API Key Authentication
    Page Contents
    • Checking the Authentication Type
      • Request:
      • Response:
    • Account Connector Properties

    Company

    • Company
    • About Us
    • Security and Compliance
    • Pricing
    • Blog
    • Branding
    • Embedded iPaaS

    Legal

    • Website Terms
    • Privacy Policy
    • Terms and Conditions
    • Data Protection Agreement
    • SLA
    • GDPR

    UK Office

    +44 (0) 3300 102 525

    US Office

    +1 (646) 585-2525


    White labelled API integration framework for creating & managing in-app SaaS integrations.

    © 2025 Cyclr. All rights reserved.