OAuth 2.0 authentication

Connect user accounts with OAuth 2.0 flows in Corsair plugins.

OAuth 2.0 lets users authorize your application to act on their behalf. Corsair handles the entire flow through Hub: minting connect links, processing callbacks, storing tokens encrypted, and refreshing them automatically when they expire.

How it works

1. You register an OAuth app with the service and get a client_id and client_secret
2. Your app calls client.connect.createLink() and redirects the user to the returned URL
3. After the user approves, the service redirects back with an authorization code
4. Corsair exchanges the code for access and refresh tokens and stores them encrypted
5. On every API call, Corsair checks token expiry and refreshes automatically

Hub hosts the connect UI and OAuth callback. Call client.connect.createLink() and redirect the user to the returned URL. See Connect / OAuth for the full reference.

corsair.ts

import { createCorsair } from "corsair";
import { gmail } from "@corsair-dev/gmail";

export const corsair = createCorsair({
    plugins: [gmail({ authType: "oauth_2" })],
    kek: process.env.CORSAIR_KEK!,
    database: db,
});

Solo setup

Solo mode connects a single account to your application. Use this for scripts, internal tools, or apps that only ever connect one account.

corsair.ts

export const corsair = createCorsair({
    plugins: [gmail({ authType: "oauth_2" })],
    kek: process.env.CORSAIR_KEK!,
    database: db,
});

Store your OAuth app credentials, then start the flow:

pnpm corsair setup --plugin=gmail client_id=your-client-id client_secret=your-client-secret
pnpm corsair auth --plugin=gmail

The CLI prints an authorization URL. Open it in a browser, approve, and tokens are stored automatically.

After that, all API calls use your connected account:

usage.ts

const messages = await corsair.gmail.api.messages.list({ maxResults: 10 });

Tokens are refreshed automatically when they expire, no intervention needed.

Multi-tenant setup

In multi-tenant mode, each user connects their own account. Configure Hub and mount the management handler.

corsair.ts

export const corsair = createCorsair({
    multiTenancy: true,
    plugins: [gmail({ authType: "oauth_2" })],
    kek: process.env.CORSAIR_KEK!,
    database: db,
    hub: {
        projectApiKey: process.env.CORSAIR_DEV_API_KEY!,
        signingSecret: process.env.CORSAIR_DEV_SIGNING_SECRET!,
    },
});

app/api/corsair/[[...path]]/route.ts

import { toNextJsHandler } from "corsair";
import { corsair } from "@/server/corsair";

export const { GET, POST, OPTIONS } = toNextJsHandler(corsair, {
    basePath: "/api/corsair",
});

1. Store your OAuth app credentials

Store your client credentials once. These are shared across all tenants:

pnpm corsair setup --plugin=gmail client_id=your-client-id client_secret=your-client-secret

2. Create a connect link

When a user wants to connect, mint a link from your authenticated backend and redirect them:

app/actions/connect.ts

"use server";

import { corsair } from "@/server/corsair";
import { getSessionTenantId } from "@/server/auth";

export async function startOAuthConnect(plugin: string) {
    const tenantId = await getSessionTenantId();
    if (!tenantId) throw new Error("Unauthorized");

    const { connectUrl } = await corsair.manage.connect.createLink({
        plugin,
        tenantId,
    });

    return connectUrl;
}

Or from the client via the management client:

connect-button.tsx

"use client";

import { createCorsairReactClient } from "corsair/client/react";

const { useCreateConnectLink } = createCorsairReactClient({
    baseURL: "/api/corsair",
});

function ConnectGmail({ tenantId }: { tenantId: string }) {
    const { mutate, loading } = useCreateConnectLink();

    return (
        <button
            disabled={loading}
            onClick={async () => {
                const link = await mutate({ plugin: "gmail", tenantId });
                if (link) window.location.href = link.connectUrl;
            }}
        >
            Connect Gmail
        </button>
    );
}

The signed state is embedded in connectUrl. Hub hosts the connect page and OAuth callback, so you do not build those routes yourself.

3. Make API calls per tenant

usage.ts

const tenant = corsair.withTenant("user_abc123");

// Uses user_abc123's connected account
const messages = await tenant.gmail.api.messages.list({ maxResults: 10 });

Automatic token refresh

OAuth access tokens expire (typically after 1 hour). Corsair checks token expiry before every API call and refreshes automatically using the stored refresh token. Your code never needs to handle token expiry.

See Authentication for more details.