Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kavachos.com/llms.txt

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

​
Setup

1

​
Get credentials

Go to the WeChat Open Platform and register a website app. Set the authorization callback domain (not a full URL, just the domain):
your-app.com
KavachOS will handle the path /api/kavach/auth/oauth/callback/wechat.
2

​
Configure

lib/kavach.ts
import { createKavach } from 'kavachos';
import { oauth } from 'kavachos/auth';

const kavach = await createKavach({
  database: { provider: 'sqlite', url: 'kavach.db' },
  plugins: [
    oauth({
      providers: [
        {
          id: 'wechat',
          clientId: process.env.WECHAT_APP_ID!,
          clientSecret: process.env.WECHAT_APP_SECRET!,
        },
      ],
    }),
  ],
});

WECHAT_APP_ID=...
WECHAT_APP_SECRET=...

​
Scopes

Default scopes: snsapi_login
ScopeWhat it unlocks
snsapi_loginWeb login, returns openid and unionid
snsapi_userinfoFull profile (name, avatar, gender)
WeChat uses appid and secret rather than the standard client_id / client_secret naming, but KavachOS maps these correctly. The WeChat Open Platform requires ICP filing for mainland China deployments.

​
Endpoints

MethodPathDescription
GET/auth/oauth/authorize/wechatRedirect to WeChat
GET/auth/oauth/callback/wechatHandle callback
Last modified on April 29, 2026