Skip to main content
REST client

Connect

The 1 operation under connect, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Connect

Available from @codespar/sdk 0.12.0, which is not on npm yet. The published version today is 0.11.0, and it has no cs.api; 0.12.0 is on the main branch of codespar-core. The examples below are not compiled against the installed package for that reason.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

POST /v1/connect/start

POST/v1/connect/start
Deprecated

Begin the Connect Link OAuth flow for a provider

const result = await cs.api.post("/v1/connect/start", {
  body: {
    server_id: "srv_0000000000000000",
    user_id: "user_0000000000000000",
    redirect_uri: "https://example.com/hook",
    scopes: "string"
  }
});

Parameters, body and every documented response: POST /v1/connect/start in the HTTP reference.

Connect | CodeSpar