Manage Connectors in Settings

Connectors in JumpCloud allow administrators to link external services, webhooks, and third-party tools natively into JumpCloud Workflows and identity lifecycles. By setting up connectors, you can automate user provisioning, trigger real-time event notifications, or sync identity details securely with your external IT and developer stacks.

Prerequisites

• Roles: You must have Administrator or Administrator With Billing privileges in your JumpCloud tenant.
• External API Details: Ensure you have the target service’s API Endpoint URLs, Auth Tokens, or Secret Keys ready before configuration.

Accessing the Connectors Settings

1. Log in to the JumpCloud Admin Portal.
2. Go to Settings
3. Select Connectors.

Adding a Connector

To add a new connector:

1. On the Connectors page, click +Add.
2. For Status, the Enabled button is selected by default. Leave it as is to activate the connector immediately after saving. You can switch the button to Disabled if you prefer to enable the connector later. 
3. Enter a unique name.
4. For Base URL, enter the root API endpoint address you intend to communicate with.

Example format: https://api.example.com/v1 or https://example.com/api

Note: Do not include specific resource paths here if they change dynamically during workflows.

5. In the Authentication section, select how JumpCloud should authenticate requests sent to your Base URL. Choose one of the following tabs based on your target service's requirements:
   • None: Select this if the endpoint is public or does not require a verification handshake.
   • Basic: Used for standard username and password credentials.
   • Bearer: Used for token-based authentication (such as OAuth tokens or API tokens formatted as Bearer <token>).
   • Header: Passes a specialized authorization API key directly inside a custom request header.
   • Query: Appends an authentication key directly into the URL string as a query parameter (for example, ?apiKey=12345).

6.  If your integration requires specific global metadata parameters (such as content-type definitions or custom application IDs), map them in the Headers section.
   • In the Key column, enter the required HTTP header string (for example, Content-Type or X-Organization-ID).
   • In the Value column, enter the corresponding setting string (such as, application/json).
   • To add more headers, click the Add Header button.

7. Once all fields are filled out, verify your endpoints and click Save.