Skip to main content

What are auth configs?

Auth configs are the credentials and settings that let Flowra talk to third-party services on your behalf. For example: to use Slack tools, you need to register a Slack app (OAuth) or use a token; that configuration is stored as an auth config in your project. Same for Google (Gmail, Calendar), GitHub, Airtable, and many other toolkits. One auth config is usually tied to one toolkit (or one “app” for that provider).
  • OAuth — User clicks “Connect Slack”, goes to Slack to authorize, and Flowra stores the connection. The auth config holds your app’s client ID/secret; the per-user connection is a connected account.
  • API key — Some toolkits only need an API key (e.g. a single key for your whole project). You create an auth config with that key; no “connect account” step.
Without an auth config (and, for OAuth, a connected account), tools that need that provider cannot run.

Example use cases

  • Multi-tenant app — Each of your customers connects their own Slack/Google. You create one auth config (your Slack app); each customer gets a connected account when they complete OAuth.
  • Single-tenant / internal — You have one Slack workspace. Create one auth config with OAuth (or a bot token if the toolkit supports it) and one connected account; all workflows use it.
  • API-key-only toolkit — Create an auth config with the API key; no connected accounts needed. Attach the config to the toolkit in your workflow.

How it works

  1. Create an auth config via the API (or in the Dashboard) — provide the provider/toolkit and credentials (client ID/secret for OAuth, or API key).
  2. For OAuth, users complete the link flow via connected accounts; the config is used during that flow.
  3. When a workflow runs a tool that needs that provider, Flowra uses the right auth config (and connected account, if OAuth) for that run.
The API lets you list, create, get, update, and delete auth configs so you can manage them from your own app or scripts.

API endpoints

List auth configs

GET /api/v1/auth_configs returns a paginated list with optional filters.
Query parameterDescription
page, limit, offsetPagination
sortBy, sortOrderSort (e.g. createdAt, DESC)
providerFilter by provider (e.g. composio, flowra)
toolkitSlugFilter by toolkit slug
searchSearch by name
showDisabledInclude disabled configs (default false)
cursorCursor for pagination

Create auth config

POST /api/v1/auth_configs creates a new auth configuration. Request body: CreateAuthConfigDto (see API reference). Use this when you need a new OAuth app or API key configuration for a toolkit.

Get auth config by ID

GET /api/v1/auth_configs/{id} returns a single auth config by its ID.

Update and delete

  • PATCH /api/v1/auth_configs/{id} — Update an existing config.
  • DELETE /api/v1/auth_configs/{id} — Delete an auth config.