Skip to main content

Documentation Index

Fetch the complete documentation index at: https://authsome.agentr.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authsome ships with 14 bundled OAuth2 providers. Each has a default flow (PKCE, device code, or Dynamic Client Registration) and a host_url for proxy injection. You can override any of them by dropping a JSON file with the same name into ~/.authsome/providers/.

Bundled OAuth providers

ProviderFlowHostNotes
atlassianpkceapi.atlassian.comJira and Confluence Cloud.
discordpkcediscord.comBot and user OAuth.
githubpkceapi.github.comDevice code also supported.
gitlabpkcegitlab.comSelf-hosted via --base-url.
googlepkceregex:.*googleapis.*Covers Gmail, Drive, Calendar, etc.
hubspotpkceapi.hubapi.com
klaviyo-oauthpkcea.klaviyo.comOAuth variant. The API-key variant is klaviyo.
linearpkceregex:.*\.linear\.appStandard OAuth app.
microsoftpkcegraph.microsoft.comMicrosoft Graph.
notionpkceapi.notion.comStandard OAuth app.
notion_dcrdcr_pkcemcp.notion.comDCR variant of Notion via the MCP endpoint.
postizdevice_codeapi.postiz.comHeadless-friendly.
slackpkceslack.comWorkspace-scoped.
xpkceapi.twitter.comX (formerly Twitter).
For all providers in one CLI view:
uvx authsome list

How the bundled flow is chosen

Every provider definition declares a default flow. The four flow types:
FlowWhen
pkceStandard OAuth2 with PKCE. Browser-capable setup. Requires registering an OAuth app at the provider.
device_codeHeadless OAuth2. User enters a code on a separate device. No callback URL to register.
dcr_pkceDynamic Client Registration followed by PKCE. The provider registers an OAuth client for you. Used for services that support DCR.
api_keyNot OAuth. See API-key providers.
Override the flow at login time if the provider supports the alternative:
uvx authsome login github --flow device_code

Add an OAuth provider

If authsome doesn’t bundle the provider you need:
  1. Find the provider’s authorization_url, token_url, and supported scopes.
  2. Write a JSON definition. See Custom providers for templates.
  3. uvx authsome register ./<name>.json.
The JSON schema is in Provider schema.

What’s next

Log in with OAuth

The full OAuth login walkthrough.

API-key providers

The other half of the bundled set.

Custom providers

Add an OAuth provider authsome doesn’t ship.

Provider registry

How authsome resolves names to definitions.