> ## Documentation Index
> Fetch the complete documentation index at: https://docs.versori.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Embedded connectors

An embedded connector allows external users — people outside your organisation — to authenticate with their own
credentials when using your integration. Instead of storing a single set of credentials, the connector defines the
required authentication method and delegates credential management to each individual user.

This is the foundation for building **multi-tenant integrations** where many customers connect to the same integration
independently, each with their own accounts and permissions in the target system.

## How embedded connectors work

A standard connector stores credentials that you provide directly. When the integration runs, it authenticates using
those fixed credentials on your behalf.

An embedded connector works differently. You configure the authentication method (for example, OAuth2 or API Key) but no
credentials are provided. Each external user then supplies their own credentials when they activate the integration,
either through the **Users** tab in the platform or via your own application using the Versori APIs.

<Frame caption="An embedded connection defines the authentication method without storing credentials — each user connects independently">
  <img src="https://mintcdn.com/versori/c6vWqYMEOXL2DTKb/images/guides/connect/embedded-connection-001.png?fit=max&auto=format&n=c6vWqYMEOXL2DTKb&q=85&s=a145e05bc915c4603c5b2403a86df08e" alt="Embedded Connection view showing Authentication Method Name Apikey, Authentication Type API Key, and an info banner explaining that external users connect with their own credentials via the Users tab or Versori APIs" width="1024" height="300" data-path="images/guides/connect/embedded-connection-001.png" />
</Frame>

|                      | Standard connector             | Embedded connector                                |
| -------------------- | ------------------------------ | ------------------------------------------------- |
| **Credentials**      | Stored directly by you         | Provided by each external user at activation time |
| **Tenant model**     | Single-tenant                  | Multi-tenant                                      |
| **User activation**  | Immediate — ready once created | Users activate via the Users tab or Versori APIs  |
| **Typical audience** | Internal teams                 | External customers, partners, or end users        |

## When to use an embedded connector

Embedded connectors are the right choice whenever your integration needs to operate on behalf of multiple independent
users or organisations. Common scenarios include:

### Customer-facing integrations

You are building a product that offers integrations to your customers. Each customer connects their own account — for
example, their own Salesforce instance or Slack workspace — rather than sharing a single set of credentials controlled
by you.

### Marketplace or partner integrations

You publish integrations that partners or third-party users can adopt. Each partner activates the integration with their
own credentials, keeping their data isolated from other users.

### Multi-tenant SaaS platforms

Your platform serves multiple tenants, each of which needs to push or pull data from external systems using their own
API keys or OAuth tokens. Embedded connectors ensure that each tenant's credentials are scoped to their own activation.

<Tip>
  If your integration only needs to run with a single set of credentials that you control, a standard connection is
  simpler. Switch to an embedded connector when external users need to authenticate independently.
</Tip>

## Setting up an embedded connector

You enable embedded mode when creating a connection for a connector. The process follows the same steps as creating a
standard connection, with one key difference: you toggle **Embedded Connection** on, which removes the credential
fields.

<Steps>
  <Step title="Open the connector and start a new connection">
    Navigate to the **Connect** tab, select the connector, and click **+ New Connection**.
  </Step>

  <Step title="Configure the authentication method">
    Choose the authentication type that the target API requires (for example, API Key or OAuth2). Fill in the auth method
    fields — such as the header name and insertion point for an API Key — and click **Create**.

    <Frame caption="Select the authentication method that external users will use when they activate">
      <img src="https://mintcdn.com/versori/pH7QqH6iOJALtSUh/images/guides/connect/embedded-auth-selection.png?fit=max&auto=format&n=pH7QqH6iOJALtSUh&q=85&s=3817641ea7065f384b11eec9bfd8af45" alt="Authentication method selection showing available options for an embedded connector" width="1018" height="646" data-path="images/guides/connect/embedded-auth-selection.png" />
    </Frame>
  </Step>

  <Step title="Enable embedded mode">
    In the **Connection** section, toggle **Embedded Connection** on. The credential input fields disappear because each
    user will supply their own credentials at activation time.
  </Step>

  <Step title="Save the embedded connection">
    Click **Connect** to create the embedded connection. The connector is now ready to accept external users.

    <Frame caption="The embedded connector overview confirms the authentication method and indicates that external users connect independently">
      <img src="https://mintcdn.com/versori/pH7QqH6iOJALtSUh/images/guides/connect/embedded-connector.png?fit=max&auto=format&n=pH7QqH6iOJALtSUh&q=85&s=e834c3432a4b1a850a861945fc57b29d" alt="Embedded Connector overview showing the configured authentication method without stored credentials" width="1962" height="468" data-path="images/guides/connect/embedded-connector.png" />
    </Frame>
  </Step>
</Steps>

<Warning>
  An embedded connection does not function until at least one external user has been activated. Activate users through
  the **Users** tab or programmatically via the Versori APIs.
</Warning>

## Next steps

<CardGroup cols={2}>
  <Card title="Multi-tenant integrations" icon="users" href="/latest/guides/use-cases/multi-tenancy">
    Learn how to design integrations that serve multiple tenants with isolated credentials and data.
  </Card>

  <Card title="Connecting guide" icon="plug" href="/latest/guides/getting-started/connect">
    See the full guide on creating connections, including standard and bypassed authentication.
  </Card>
</CardGroup>
