---
title: OAuth 2.1 Provider
description: A Better Auth plugin that enables your auth server to serve as an OAuth 2.1 provider.
---

An **OAuth 2.1 Provider Plugin** that allows you to turn your authentication server into an OAuth provider with OIDC compatibility allowing users and other services to authenticate with your API.

The plugin has a secured configuration by default providing ease to users unfamiliar with the details of OAuth.

**Key Features**:

- **OAuth 2.1**: Restricted security practices to [OAuth 2.1](https://oauth.net/2.1/)
- **Issuer Validation**: Authorization responses include `iss` parameter to prevent [mix-up attacks](https://datatracker.ietf.org/doc/html/rfc9207)
- **MCP Enabled**: Support with [MCP authentication](#mcp)
- **OIDC compatibility**: [OIDC](https://openid.net/specs/openid-connect-core-1_0.html)-compliant with the `openid` scope
  - **UserInfo**: Endpoint providing current user details
  - **id_token**: JWT-signed user information
  - **OIDC Logout**: [RP-initiated](https://openid.net/specs/openid-connect-rpinitiated-1_0.html)-compliant Logout
- **Dynamic Client Registration**: Allow clients to register clients dynamically.
  - **Public Clients**: Support public clients for native mobile clients and user-agent clients (like AI)
  - **Confidential Clients**: Supports confidential clients for web clients
  - **Trusted Clients**: Configure hard-coded trusted clients with optional consent bypass.
- **JWT Plugin compatibility**: required by default with an option to disable
  - **JWT Signing**: sign JWT tokens when requesting a `resource`
  - **JWKS Verifiable**: verify tokens remotely at the [`/jwks`](/docs/plugins/jwt#verifying-the-token) endpoint
- **Authorization Prompts**: prompts that initiate specific login flows
  - **Consent**: Ensure consent is granted for each scope. Forcible with `prompt=consent`.
  - **Select Account**: Ensure an account is selected prior when specific scopes being granted. Forcible with `prompt=select_account`.
- **Resource Endpoints**: Read and manage tokens.
  - **Introspection**: [RFC7662](https://datatracker.ietf.org/doc/html/rfc7662)-compliant Introspection.
  - **Revocation**: [RFC7009](https://datatracker.ietf.org/doc/html/rfc7009)-compliant Revocation.

**Grants Supported**

- **authorization_code**: Code for user token exchange with PKCE and S256 requirements.
- **refresh_token**: Issue refresh tokens and handle access token renewal using `offline_access` scope.
- **client_credentials**: Machine to Machine tokens for API communication.

## Installation

<Steps>
  <Step>
    ### Mount the Plugin

    Add the OIDC plugin to your auth config. See [Configuration Section](#configuration) on how to configure the plugin.

    ```ts title="auth.ts"
    import { betterAuth } from "better-auth";
    import { jwt } from "better-auth/plugins";
    import { oauthProvider } from "@better-auth/oauth-provider";

    const auth = betterAuth({
      disabledPaths: [
        "/token",
      ],
      plugins: [
        jwt(),
        oauthProvider({
          loginPage: "/sign-in",
          consentPage: "/consent",
          // ...other options
        })
      ],
    });
    ```
  </Step>

  <Step>
    ### Migrate the Database

    Run the migration or generate the schema to add the necessary fields and tables to the database.

    <Tabs items={["migrate", "generate"]}>
      <Tab value="migrate">
      ```bash
      npx @better-auth/cli migrate
      ```
      </Tab>
      <Tab value="generate">
      ```bash
      npx @better-auth/cli generate
      ```
      </Tab>
    </Tabs>
    See the [Schema](#schema) section to add the fields manually.
  </Step>

  <Step>
    ### Add `./well-known` endpoints

    Please add all [Well-Known endpoints](#well-known) to your project. The locations are provided as warnings if you are unsure.

    - You **MUST** add the OAuth Authorization Server metadata endpoint at your issuer path (root if no path).
    - If you are using the `openid` scope, you **MUST** add the openid configuration at your issuer path (root if no path).
    - If you are using the resource server (ie for MCP), you **MUST** add the resource server metadata to your API, with the issuer path appended.

  </Step>

  <Step>
    ### Create your first oauth client

    Create your first confidential oauth client.

    ```ts
    const client = await auth.api.createOAuthClient({
			headers,
			body: {
				redirect_uris: [redirectUri],
			}
		});
    console.log(client); // If you wish, you may add the `client_id` to `cachedTrustedClients`
    ```

    <Callout type="info">
    To create a public client (ie. without a client secret), set `token_endpoint_auth_method: "none"`.
    </Callout>
  </Step>
</Steps>


## Client Plugins

There exists two clients. You may wish to add one or both depending on your setup.

### OAuth Client

The OAuth Client is the connecting `oauthClient` such a mobile or web application.

```ts title="client.ts"
import { createAuthClient } from "better-auth/client";
import { oauthProviderClient } from "@better-auth/oauth-provider/client"
export const authClient = createAuthClient({
  plugins: [oauthProviderClient()],
});
```

### Resource Client

The Resource Server is a client that operates on your API server to perform actions like token verification and provide metadata.

```ts title="server-client.ts"
import { auth } from "@/lib/auth";
import { createAuthClient } from "better-auth/client";
import { oauthProviderResourceClient } from "@better-auth/oauth-provider/resource-client"
export const serverClient = createAuthClient({
  plugins: [oauthProviderResourceClient(auth)], // auth optional
});
```


## Usage

The plugin operates as an OAuth 2.1 server with OIDC compatible endpoints and JWT verifiable access tokens. The following provides more detailed information about each endpoint.


### OAuth Clients

In OAuth there are two types of clients:
- **Public Clients**: Cannot store a client secret such as native mobile clients and user-agent clients (like AI)
- **Confidential Clients**: Can store a client secret such as web clients

#### Get Client

To obtain client information owned by a specific user or organization use the following endpoint:

<APIMethod path="/oauth2/get-client" method="GET" requireSession>
```ts
type getOAuthClient = {
  /**
   * The OAuth client's client_id
   */
  client_id: string,
}
```
</APIMethod>

#### Get Public Client

To obtain public client fields to display on login flow pages such as consent, use the following endpoint. Note: the user must be signed in to use this endpoint.:

<APIMethod path="/oauth2/public-client" method="GET" requireSession>
```ts
type getOAuthClientPublic = {
  /**
   * The OAuth client's client_id
   */
  client_id: string,
}
```
</APIMethod>

#### List Clients

To obtain a list of clients owned by a specific user or organization, use the following endpoint:

<APIMethod path="/oauth2/get-clients" method="GET" requireSession>
```ts
type getOAuthClients = {
}
```
</APIMethod>

#### Create Client

To create an oauth client tied to a specific user or organization, use the `/oauth2/create-client` endpoint (eg. `createOAuthClient`). The parameters are equivalent to the registration endpoint described by [RFC7591](https://datatracker.ietf.org/doc/html/rfc7591).

The following fields on the database are considered restricted and should only be editable by admin users.
- `client_secret_expires_at`: The expiration time for a secret of a confidential client
- `skip_consent`: Allows the ability to skip user consent flow. Useful for trusted clients.
- `enable_end_session`: Allows a user to logout of a session from the client via their `id_token` at the `/oauth2/end-session` endpoint. Used in OIDC-setups and specified trusted clients.
- `metadata`: Additional private metadata to attach to the client.

In some cases, you may wish to create logic to create oauth clients with restricted fields through custom APIs, company admin portals, or server initialization, you may use the following server-only endpoint:

```ts
await auth.api.adminCreateOAuthClient({
  headers,
  body: {
    redirect_uris: [redirectUri],
    client_secret_expires_at: 0, // [!code highlight]
    skip_consent: true, // [!code highlight]
    enable_end_session: true, // [!code highlight]
  }
});
```

#### Update Client

To update an oauth client tied to a specific user or organization, use the `/oauth2/update-client` endpoint (eg. `updateOAuthClient`). The parameters are equivalent to the registration endpoint described by [RFC7591](https://datatracker.ietf.org/doc/html/rfc7591).

<APIMethod path="/oauth2/update-client" method="POST" requireSession>
```ts
type updateOAuthClient = {
  /**
   * The OAuth client's client_id
   */
  client_id: string,
  /**
   * The fields to update
   */
  update: OAuthClient,
}
```
</APIMethod>

Restrictions on this endpoint:
- You are unable to switch between confidential and public clients. The client type must be determined at creation.
- You cannot update the client secret. To rotate the `client_secret` use the rotate client secret endpoint.

In some cases, you may wish to create logic to update oauth clients with restricted fields through custom APIs, company admin portals, or server initialization, you may use the following server-only endpoint. The fields are described in the create section.:

```ts
await auth.api.adminUpdateOAuthClient({
  headers,
  body: {
    redirect_uris: [redirectUri],
    client_secret_expires_at: 0, // [!code highlight]
    skip_consent: true, // [!code highlight]
    enable_end_session: true, // [!code highlight]
  }
});
```

#### Rotate Client Secret

<Callout type="warn">
The current implementation rotates the client secret immediately and the previous secret is invalidated immediately.
</Callout>

To rotate a client secret, you must use the following endpoint:

<APIMethod path="/oauth2/client/rotate-secret" method="POST" requireSession>
```ts
type rotateClientSecret = {
  /**
   * The OAuth client's client_id
   */
  client_id: string,
}
```
</APIMethod>

#### Delete Client

To delete a user or organization's client, use the following endpoint:

<APIMethod path="/oauth2/delete-client" method="POST" requireSession>
```ts
type deleteOAuthClient = {
  /**
   * The OAuth client's client_id
   */
  client_id: string,
}
```
</APIMethod>


### OAuth Consent

Consent is required on all non-trusted clients, specifically those without `skip_consent`. The following endpoints allow users or `reference_id` manage their given consents.

#### Get Consent

To obtain details of a specific consent, use the following endpoint:

<APIMethod path="/oauth2/get-consent" method="GET" requireSession>
```ts
type getOAuthConsent = {
  /**
   * The consent id
   */
  id: string,
}
```
</APIMethod>

#### List Consent

To obtain a list of user consents, use the following endpoint:

<APIMethod path="/oauth2/get-consents" method="GET" requireSession>
```ts
type getOAuthConsents = {
}
```
</APIMethod>

#### Update Consent

To update a specific consent, use the following endpoint:

<APIMethod path="/oauth2/update-consent" method="POST" requireSession>
```ts
type updateOAuthClient = {
  /**
   * The consent id
   */
  id: string,
  /**
   * The values to update
   */
  update: OAuthConsent,
}
```
</APIMethod>

#### Delete Consent

Revokes a user's consent for a specific client.

<APIMethod path="/oauth2/delete-consent" method="POST" requireSession>
```ts
type deleteOAuthConsent = {
  /**
   * The consent id
   */
  id: string,
}
```
</APIMethod>


### Dynamic Registration Endpoint

<Callout type="info">
This endpoint supports [RFC7591](https://datatracker.ietf.org/doc/html/rfc7591) compliant client registration.
</Callout>

Once installed, you can utilize the OAuth Provider to manage authentication flows within your application.

After the client is created, you will receive a `client_id` and `client_secret` that you can display to the user. The `client_secret` can only be provided once, ensure the user saves it.

#### Setup

To enable client registration set `allowDynamicClientRegistration: true` in your BetterAuth config.

```ts title="auth.ts"
oauthProvider({
  allowDynamicClientRegistration: true,
  // ... other options
})
```

To enable unauthenticated client registration which allows for dynamically registered public clients, additionally set `allowUnauthenticatedClientRegistration: true` in your auth config.

<Callout type="warn">
Support for `allowUnauthenticatedClientRegistration` **will be deprecated** when the MCP protocol standardizes unauthenticated dynamic client registration. As of writing, both [Client ID Metadata Documents](https://github.com/modelcontextprotocol/modelcontextprotocol/issues/991) and [`software_statement` and `jwks_uri`](https://github.com/modelcontextprotocol/modelcontextprotocol/issues/1032) are under debate.
</Callout>

```ts title="auth.ts"
oauthProvider({
  allowDynamicClientRegistration: true,
  allowUnauthenticatedClientRegistration: true,
  // ... other options
})
```

#### Basic Example

To register a new OIDC client, use the `oauth2.register` method.

```ts
const client = await client.oauth2.register({
  client_name: "My Client",
  redirect_uris: ["https://client.example.com/callback"],
});
```

For all endpoint parameters, see [RFC 7591 Registration](https://datatracker.ietf.org/doc/html/rfc7591#section-2).

Note the following parameters are not yet supported:
- `jwks`
- `jwks_uri`

### Authorize Endpoint

An [OAuth 2.1 authorization endpoint](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-13#name-authorization-endpoint). Since many of the details are not yet fully described, parts are adapted from the legacy [OAuth 2.0 Authorization Endpoint Section](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1) but always implements the [differences from OAuth 2.0](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-13#name-differences-from-oauth-20).

The Authorization Endpoint is the entry point for initiating an OAuth 2.1 authorization flows.

Important notes:
- In OAuth 2.1, only `response_type: "code"` is supported.
- `code_challenge_method: "plain"` will not be supported since this is a security vulnerability.
- All authorization responses (success and error) include the `iss` parameter for issuer validation ([RFC 9207](https://datatracker.ietf.org/doc/html/rfc9207)).

**State**

We require sending a state to mitigate cross-site request forgery (CSRF) attacks. This works by ensuring your client only responds to requests that your client initially requested.

Generate a state value from your client and store on your client such as in a secure, HTTP-only cookie or database.

**Code Challenge**

Code challenges helps protect the authorization `code` returned from the authorization endpoint.

To do so, a code challenge is derived from a code verifier and sent in a [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) to the Authorization Server.

Now at your `redirect_uri` (ie callback), check to see if the returned state matches the initial state, use the `authorization_code` grant and original code verifier at the [Token Endpoint](#token-endpoint) to obtain the tokens.


### Token Endpoint

By default, the token endpoint supports providing tokens for the following grants:

- "authorization_code"
- "client_credentials"
- "refresh_token"

#### Authorization code grant

The authorization code grant enables clients to obtain access user access tokens and optionally refresh tokens (with the "offline_access" scope).

#### Client credentials grant

The client credentials grant enables clients to obtain machines to obtain access tokens.

#### Refresh token grant

The refresh token grant enables clients to update their access token without needing the user to login again.

This implementation currently issues a new refresh token for every refresh request.


### Consent Endpoint

Accept or deny user consent for a set of scopes. Note that when denying scopes, the consent cancels and pre-existing consent remains. To remove consent, delete that user's "oauthConsent" for that client.

<APIMethod path="/oauth2/consent" method="POST" requireSession>
```ts
type oauth2Consent = {
  /**
   * Accept or deny user consent for a set of scopes
   */
  accept: boolean,
  /**
   * Space-separated list of accepted scopes. If not provided, the originally requested scopes are accepted.
   */
  scope?: string,
}
```
</APIMethod>

### Continue Endpoint

Sign up registration pages must be [configured](#sign-up-account-screen) to perform account registration steps.
Account selection must be [configured](#select-account-screen) to perform account selection.
Post login must be [configured](#post-login-screen) to perform post login selection.

<APIMethod path="/oauth2/continue" method="POST" requireSession>
```ts
type oauth2Continue = {
  /**
   * Confirms an account was selected.
   */
  selected?: boolean,
  /**
   * Confirms an account was registered
   */
  created?: boolean,
  /**
   * Confirms completion of post login activity
   */
  postLogin?: boolean,
}
```
</APIMethod>


### Introspect Endpoint

[RFC7662](https://datatracker.ietf.org/doc/html/rfc7662)-compliant Introspection.

This endpoint provides details of the provided token. If the token is additionally tied to a session, the endpoint will ensure the session is `active`.

To provide resource specific claims via `customAccessTokenClaims`, store the allowed resources that a confidential client can use in its `resources` field.


### Revoke Endpoint

[RFC7009](https://datatracker.ietf.org/doc/html/rfc7009)-compliant Revocation.

This endpoint revokes the provided token.

- opaque `access_token`: immediately removes that `access_token` from the database. `refresh_token` is still valid.
- JWT `access_token`: verifies that token is safe to remove from client storage.
- `refresh_token`: removes all `access_tokens` granted using that `refresh_token` and removes the `refresh_token` to prevent further token issuance.

For an `access_token` type, 


### End Session Endpoint

[RP-initiated](https://openid.net/specs/openid-connect-rpinitiated-1_0.html)-compliant Logout

This endpoint allows specified trusted clients to logout remotely.

To allow rp-initiated logout, a trusted client must specifically be created to perform session logout.

```ts
await auth.api.adminCreateOAuthClient({
  headers,
  body: {
    redirect_uris: [redirectUri],
    enable_end_session: true, // [!code highlight]
  }
});
```

<Callout type="info">
If `disableJwtPlugin: true`, public clients will never be able to logout using this endpoint since no `id_token` is sent.
</Callout>


### UserInfo Endpoint

The UserInfo Endpoint provides [OIDC](https://openid.net/specs/openid-connect-core-1_0.html)-compliant user information. Available at `/oauth2/userinfo`, the endpoint requires a valid access token with at least the scope `openid`.

```ts title="client-app.ts"
// Example of how a client would use the UserInfo endpoint
const response = await fetch('https://your-domain.com/api/auth/oauth2/userinfo', {
  headers: {
    'Authorization': 'Bearer ACCESS_TOKEN'
  }
});

const userInfo = await response.json();
// userInfo contains user details based on the scopes granted
```

The UserInfo endpoint returns different claims based on the scopes that were granted during authorization:

- `openid`: Returns the user's ID (`sub` claim)
- `profile`: Returns `name`, `picture`, `given_name`, `family_name`
- `email`: Returns `email` and `email_verified`

The `customUserInfoClaims` function receives the user object, requested scopes array, and the passed access token, allowing you to add additional information to the response.


### Well known

#### Openid Configuration

Provides [OpenID connect discovery metadata](https://openid.net/specs/openid-connect-discovery-1_0.html) located at `/.well-known/openid-configuration`.

This endpoint requires the scope `openid`.

You **must** add the configuration at the issuer path. If an issuer is unset, this will be your basePath `/api/auth`.
If this path is not at the root and you don't have an openid-configuration already at the root, we recommend you to add one in case a client incorrectly hard-coded `/.well-known/openid-configuration` (ignoring the issuer path in the spec).

NOTE: For issuers with paths, OpenId utilizes path appending, thus any path on the issuer should be prepended before `/.well-known/openid-configuration`. If no issuer path is specified, the path should start at the root.

```ts title="[issuer-path]/.well-known/openid-configuration/route.ts"
import { oauthProviderOpenIdConfigMetadata } from "@better-auth/oauth-provider";
import { auth } from "@/lib/auth";

export const GET = oauthProviderOpenIdConfigMetadata(auth);
```

<Callout type="info">
If you get a CORS issue when testing locally such as with the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector), this is due to the frontend calling the endpoint instead of the backend. Add `Access-Control-Allow-Methods": "GET"` and `"Access-Control-Allow-Origin": "*"` for testing.
</Callout>


#### OAuth Authorization Server

Provides [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414)-compliant metadata located at `/.well-known/oauth-authorization-server`.

You **must** add the configuration at the issuer path. If an issuer is unset, this will be your basePath `/api/auth`.

NOTE: For issuers with paths, OAuth 2.1 Authorization Server utilizes path insertion, thus any path on the issuer should be appended after `/.well-known/oauth-authorization-server`. If no issuer path is specified, the path should start at the root.

```ts title="/.well-known/oauth-authorization-server/[issuer-path]/route.ts"
import { oauthProviderAuthServerMetadata } from "@better-auth/oauth-provider";
import { auth } from "@/lib/auth";

export const GET = oauthProviderAuthServerMetadata(auth);
```

<Callout type="info">
If you get a CORS issue when testing locally such as with the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector), this is due to the frontend calling the endpoint instead of the backend. Add `Access-Control-Allow-Methods": "GET"` and `"Access-Control-Allow-Origin": "*"` for testing.
</Callout>


## API Server

This section shows how your API should verify tokens received from your clients.

### Verification

Verification can be performed using `verifyAccessToken` available through the `oauthProviderResourceClient` plugin or `better-auth/oauth2` package.

With `better-auth` package:

```ts title="api/[endpoint].ts"
import { verifyAccessToken } from "better-auth/oauth2";

export const GET = async (req: Request) => {
  const authorization = req.headers?.get("authorization") ?? undefined;
  const accessToken = authorization?.startsWith("Bearer ")
    ? authorization.replace("Bearer ", "")
    : authorization;
  const payload = await verifyAccessToken(
    accessToken, {
      verifyOptions: {
        issuer: "https://auth.example.com",
        audience: "https://api.example.com",
      },
      scopes: ["read:post"], // optional
    }
  );
  // ...continue
}
```

With `oauthProviderResourceClient` plugin:

```ts title="api/[endpoint].ts"
import { serverClient } from "@/lib/server-client";

export const POST = async (req: Request) => {
  const authorization = req.headers?.get("authorization") ?? undefined;
  const accessToken = authorization?.startsWith("Bearer ")
    ? authorization.replace("Bearer ", "")
    : authorization;
  const payload = await serverClient.verifyAccessToken(
    accessToken, {
      verifyOptions: {
        issuer: "https://auth.example.com",
        audience: "https://api.example.com",
      },
      scopes: ["write:post"], // optional
    }
  );
  // ...continue
}
```

#### JWT Verification

- Verify the token is valid:
  - Validate the _signature_ using the JWKS.
  - Check the `iss` (issuer) and `aud` (audience) claims.
  - Verify the `exp` (expiration) and (if sent) `nbf` claim.
- Validate the appropriate `scope` for each endpoint.

#### Opaque Access Tokens

- Send the received token to `/oauth2/introspect` and assert that `active: true` is returned.
- Validate the appropriate `scope` for each endpoint.

#### Recommendations

The simplest approach is to _only accept JWT-formatted access tokens_ for your API and deny opaque tokens.

**Benefits**:
- **Fast**: locally verifiable, no network call required.
- **Future-proof**: independent of the authorization server after issuance.
- **No client secret needed**: the API can validate tokens without confidential client credentials.

Accepting _opaque access tokens in addition to JWT tokens_ is possible, but comes with trade-offs.

**Benefits**:
- Immediate token and client validation.
- Client does not require a `resource` parameter (depending on authorization server configuration).

**Drawbacks**:
- **DOS**: If the client is external (ie external APIs, MCP agents), opaque `access_token` verifications can overload your authorization server.
- **Performance**: Every received opaque `access_token` requires a network call to the introspection endpoint.
- **Secret required**: Introspection typically requires a `client_secret`, which public clients cannot safely provide.
  - NOTE: Introspection bearer token and Private Key JWT methods are not yet implemented.


### Scopes vs. Permissions

- **Scopes** define what a client application *requests* on behalf of a user. They are usually coarse-grained labels included in an access token.
- **Permissions** define the fine-grained actions a user (or service) is actually allowed to perform on resources, typically enforced at the resource server.

In practice, you may also combine approaches depending on system complexity and how your resource server handles authorization.

**Scopes and Permissions are the Same**

Each scope directly represents a permission.
- Example: A scope `read:post` corresponds exactly to the permission `read:post`.

_Pros_:
- Simple to implement and reason about.
- No extra mapping logic required.

_Cons_:
- Access tokens can become large if permissions are very detailed, especially with JWTs.
- Limited flexibility for future, more granular permissions.

**Scopes and Permissions are Different**

Scopes represent high-level access categories, and each scope maps to one or more underlying permissions.

- **Example:** A scope `view:post` could map to:
  - `read:post:content`
  - `read:post:metadata` (but only for posts the user owns)

_Pros_:
- Flexible and scalable for complex systems.
- Tokens remain compact, since only scopes are included, not all permissions.

_Cons_:
- The resource server must resolve scopes into permissions for each request.
- Adds complexity to implementation and authorization checks.


## Configuration


### Redirect Screens

During the OAuth flow, users are likely redirected between pages. For example, a user may start on a login screen then redirect to a consent screen before returning to the application. The following outlines possible login flows and configurations needed to provide each flow.

To process each redirect step in the login flow, we verify the signed query provided in the initial `/oauth2/authorize` redirect. All parameters sent to the authorize endpoint (including any custom ones), are signed and verified.

If your sign-in pages include any custom query parameters, you may append them to the end of the signed query (ie after the `sig` field).

If you utilize the Client Plugin `oauthProviderClient`, then the `oauth_query` parameter is automatically sent to every endpoint that requires it. If you have custom sign-in endpoints, you would need to manually add the window's signed query in the request body `oauth_query`. This should only include the signed query parameters.


#### Login Screen

When a user is redirected to the OIDC provider for authentication, if they are not already logged in, they will be redirected to the login page. You can customize the login page by providing a `loginPage` option during initialization.

```ts title="auth.ts"
oauthProvider({
  loginPage: "/sign-in" // [!code highlight]
})
```

You don't need to handle anything from your side; when a new session is created, the plugin will handle continuing the authorization flow.


#### Consent Screen

When a user is redirected to the OIDC provider for authentication, they may be prompted to authorize the application to access their data.

**Note**: Trusted clients with `skipConsent: true` will bypass the consent screen entirely, providing a seamless experience for first-party applications.

```ts title="auth.ts"
oauthProvider({
  consentPage: "/consent" // [!code highlight]
})
```

The plugin will redirect the user to the specified path with `client_id` and `scope` query parameters. You can use this information to display a custom consent screen. Once the user consents, you can call `oauth2.consent` to complete the authorization.

```ts title="consent-page.ts"
const res = await client.oauth2.consent({
	accept: true,
  // optional scopes accepted (if not sent, accepted scopes matches the original request)
  scope: "openid profile email"
});
```


#### Sign Up Account Screen

To direct users from the client to a sign up page using `prompt: create`, use `signup`.

```ts title="auth.ts"
oauthProvider({
  signUp: {
    page: "/sign-up", // [!code highlight]
  }
})
```

To stop sign in process to complete registration forms, use the `shouldRedirect` function.

```ts title="auth.ts"
import { userRegistered } from "@lib";

oauthProvider({
  signUp: {
    page: "/sign-up",
    shouldRedirect: async ({ headers }) => { // [!code highlight]
      const isUserRegistered = await userRegistered(headers);
      return isUserRegistered ? false : "/setup";
    },
  }
})
```


#### Select Account Screen

When a user is redirected to the select account page during authentication, they may be prompted to select an account before consenting. To enable account selection, you must add the following configuration to your settings.

The following example uses the multi-session plugin and automatically redirects to the select-account page if more than one session is logged in:

```ts title="auth.ts"
oauthProvider({
  selectAccount: {
    page: "/select-account", // [!code highlight]
    shouldRedirect: async ({ headers }) => { // [!code highlight]
      const allSessions = await auth.api.listDeviceSessions({
        headers,
      })
      return allSessions?.length >= 1;
    },
  }
})
```

The plugin will redirect the user to the `selectAccount.page`. This page should prompt for account selection and upon completion of selection, should call `oauth2Continue`.

```ts title="select-account.ts"
await authClient.multiSession.setActive({
  sessionToken,
});
await client.oauth2.oauth2Continue({
  selected: true,
});
```

#### Post Login Screen

If a requested scope requires an organization. You would need to provide all of the following options to tie the `reference_id` (ie organization id, team id) to the login flow. This step occurs post login and prior to consent.

The following example uses the organization plugin to automatically redirect to the select-organization page for organization specific scopes.

```ts title="auth.ts"
oauthProvider({
  scopes: ["openid", "profile", "email", "read:organization"]
  postLogin: {
    page: "/select-organization", // [!code highlight]
    shouldRedirect: async ({ session, scopes, headers }) => { // [!code highlight]
      const userOnlyScopes = ["openid", "profile", "email", "offline_access"];
      if (scopes.every((sc) => userOnlyScopes.includes(sc))) {
        return false;
      }
      const organizations = await auth.api.listOrganizations({
        headers,
      });
      return organizations.length > 1 || !(
        organizations.length === 1 && organizations.at(0)?.id === session.activeOrganizationId
      )
    },
    consentReferenceId: ({ session, scopes }) => { // [!code highlight]
      if (scopes.includes("read:organization")) {
        const activeOrganizationId = (session?.activeOrganizationId ?? undefined) as string | undefined;
        if (!activeOrganizationId) {
          throw new APIError("BAD_REQUEST", {
            error: "set_organization",
            error_description: "must set organization for these scopes",
          })
        }
        return activeOrganizationId;
      } else {
        return undefined;
      }
    },
  }
})
```

The plugin will redirect the user to the `postLogin.page` to provide a prompt for account selection. Upon completion, you should call `oauth2Continue`.

```ts title="select-organization.ts"
await authClient.organization.setActive({
  organizationId,
});
await client.oauth2.oauth2Continue({
  postLogin: true,
});
```


### Cached Trusted Clients

For first-party applications and internal services, you can cache trusted clients for better performance. Values are cached in memory for all mentioned clients. Additionally, they prevent changes through the CRUD endpoints.

```ts title="auth.ts"
oauthProvider({
  // List of clientIds of the clients
  cachedTrustedClients: new Set([
    "internal-dashboard",
    "mobile-app",
  ]),
})
```

### Valid Audiences

A list of valid audiences (ie resources) for this oauth server. If not specified, the default audience is the baseUrl. It is recommended to specify an audience other than the baseUrl such as your API.

```ts title="auth.ts"
oauthProvider({
  validAudiences: [
    "https://api.example.com",
    "https://api.example.com/mcp",
  ]
})
```

### Scopes

Scopes allow clients specific access to specific resources.
By default, we support the following scopes are supported:

- `openid`: Returns the user's ID (`sub` claim).
- `profile`: Returns name, picture, given_name, family_name
- `email`: Returns email and email_verified
- `offline_access`: Returns a refresh token

The scopes configuration can contain as many or as few scopes as you wish! Note that `openid` is required to be considered an OIDC server, otherwise this is a standard OAuth 2.1 server. All supported scopes must be in this array.

```ts title="auth.ts"
oauthProvider({
  scopes: [ "openid", "profile", "offline_access", "read:post", "write:post" ],
})
```

### Claims

Internally, we support the following claims are supported: ["sub", "iss", "aud", "exp", "iat", "sid", "scope", "azp"].

Id token and user info claims should be namespaced when possible to avoid potential future conflicts.

Claims added inside `customIdTokenClaims` and `customUserInfoClaims` should be added to the `advertisedMetadata.claims_supported` so clients can validate that claim received. In the following example, it would be the base claims plus "locale" and "https://example.com/org".

Pro tip: these functions can may also throw errors such as a user is no longer a member of the organization or no longer has the requested permissions.

```ts title="auth.ts"
oauthProvider({
  // Attach claims to id tokens
  customIdTokenClaims: ({ user, scopes, metadata }) => {
    return {
      locale: "en-GB",
    };
  },
  // Attach claims to access tokens
  customAccessTokenClaims: ({ user, scopes, referenceId, resource, metadata }) => {
    return {
      "https://example.com/org": referenceId,
      "https://example.com/roles": ["editor"],
    };
  },
  // Additional user info claims
  customUserInfoClaims: ({ user, scopes, jwt }) => {
    return {
      locale: "en-GB",
    };
  },
})
```

### Expirations

Each token type and grant type can independently can set a default expiration.

- `accessTokenExpiresIn` defaults 1 hour
- `m2mAccessTokenExpiresIn` defaults 1 hour
- `idTokenExpiresIn` defaults 10 hours
- `refreshTokenExpiresIn` defaults 30 days
- `codeExpiresIn` defaults 10 minutes

Additionally, Access Tokens can set lower expirations based on scopes. This is useful for higher-privilege scopes that require shorter expiration times. The earliest expiration will take precedence. If not specified, the default will take place. Note: values should be lower than the defaults `accessTokenExpiresIn` and `m2mAccessTokenExpiresIn`.

```ts title="auth.ts"
oauthProvider({
  scopeExpirations: {
    "write:payments": "5m",
    "read:payments": "30m",
  },
})
```


### Registration

#### Dynamic Client Registration

Dynamic registration allows for authorized registration of both public and confidential clients.

```ts title="auth.ts"
oauthProvider({
  allowDynamicClientRegistration: true, // [!code highlight]
})
```

Unauthenticated client registration additionally allows for public clients (never confidential) to register without an authorization header. This is especially useful for an MCP to dynamically register themselves as a public client.

```ts title="auth.ts"
oauthProvider({
  allowDynamicClientRegistration: true,
  allowUnauthenticatedClientRegistration: true, // [!code highlight]
})
```

<Callout type="warn">
Support for `allowUnauthenticatedClientRegistration` **will be deprecated** when the MCP protocol standardizes unauthenticated dynamic client registration. As of writing, both [Client ID Metadata Documents](https://github.com/modelcontextprotocol/modelcontextprotocol/issues/991) and [`software_statement` and `jwks_uri`](https://github.com/modelcontextprotocol/modelcontextprotocol/issues/1032) are under debate.
</Callout>

#### Dynamic Client Registration Expiration

You can set an expiration time for how long a dynamically registered confidential client should last for. By default, dynamically registered confidential clients do not expire.

```ts title="auth.ts"
oauthProvider({
  allowDynamicClientRegistration: true,
  clientRegistrationClientSecretExpiration: "30d", // [!code highlight]
})
```

#### Dynamic Client Registration Scopes

To set a list of default scopes for newly registered clients when scopes parameter is not sent, set the `clientRegistrationDefaultScopes` field. All scopes must be defined in `scopes`.

```ts title="auth.ts"
oauthProvider({
  scopes: ["reader", "editor"],
  clientRegistrationDefaultScopes: ["reader"], // [!code highlight]
})
```

To also set a list of allowed scopes for newly registered clients when scopes parameter is not sent, set the `clientRegistrationAllowedScopes` field. These are **in addition** to the `clientRegistrationDefaultScopes`. All scopes must be defined in `scopes`.

```ts title="auth.ts"
oauthProvider({
  scopes: ["reader", "editor"],
  clientRegistrationDefaultScopes: ["reader"],
  clientRegistrationAllowedScopes: ["editor"], // [!code highlight]
})
```


### Organizations

OAuth Clients are tied to either a user or `reference_id` at registration and is immutable. If you are utilizing the [organization plugin](/docs/plugins/organization), you must ensure that the [`activeOrganizationId`](/docs/plugins/organization#active-organization) is set on your active session when you create new clients.

```ts title="auth.ts"
oauthProvider({
  clientReference: ({ session }) => {
    return (session?.activeOrganizationId as string | undefined) ?? undefined;
  },
})
```

To set user-specific permissions and roles on tokens see [Claims](#claims).


### Client CRUD Privileges

To determine whether a logged in user has the ability to perform specific actions in client creation, you can utilize the `clientPrivileges` configuration setting. By default, CRUD actions are allowed for users with matching `userId` or `clientReference`.

The following is a basic example that allows all OAuth Client CRUD actions for organization owners assuming ordinary users cannot create clients:

```ts title="auth.ts"
oauthProvider({
  clientPrivileges: async ({ action, headers, user, session }) => {
    if (!session?.activeOrganizationId) return false;
    const { data: member } = await auth.api.getActiveMember({
      headers,
    });
    return member.role === 'owner';
  },
})
```


### Storage

By default all secrets are `hashed` by default on the database. This helps protect the `client_secret` in case of a database leak.

- **storeClientSecret**: the storage method of application `client_secrets`. Only when `disableJwtPlugin: true`, the client secret shall rather be `encrypted`.
- **storeTokens**: the storage method of token values, specifically session refresh tokens and opaque access tokens.


### Rate Limiting

The OAuth Provider includes built-in rate limiting for all OAuth endpoints to protect against abuse and denial-of-service attacks.

<Callout type="info">
Rate limiting is **per-IP per-endpoint**. Each client IP address has its own rate limit counter for each endpoint. Rate limits reset after the window period expires.
</Callout>

<Callout type="warn">
These rate limits only apply when Better Auth's global rate limiting is enabled. By default, rate limiting is only enabled in production. See [Rate Limiting](/docs/concepts/rate-limit) for global configuration.
</Callout>

**Default limits:**

| Endpoint | Window | Max Requests |
|----------|--------|--------------|
| `/oauth2/token` | 60s | 20 |
| `/oauth2/authorize` | 60s | 30 |
| `/oauth2/introspect` | 60s | 100 |
| `/oauth2/revoke` | 60s | 30 |
| `/oauth2/register` | 60s | 5 |
| `/oauth2/userinfo` | 60s | 60 |

You can customize the rate limits for each endpoint:

```ts title="auth.ts"
oauthProvider({
  rateLimit: {
    token: { window: 60, max: 20 },        // 20 requests per minute
    authorize: { window: 60, max: 30 },    // 30 requests per minute
    introspect: { window: 60, max: 100 },  // 100 requests per minute
    revoke: { window: 60, max: 30 },       // 30 requests per minute
    register: { window: 60, max: 5 },      // 5 requests per minute
    userinfo: { window: 60, max: 60 },     // 60 requests per minute
  },
})
```

To remove the per-endpoint rate limit override and fall back to global rate limits, set it to `false`:

```ts title="auth.ts"
oauthProvider({
  rateLimit: {
    introspect: false, // Uses global rate limits instead of per-endpoint limits
  },
})
```

<Callout type="info">
Setting an endpoint to `false` removes the OAuth Provider's stricter per-endpoint limit. The endpoint will still be subject to Better Auth's global rate limiting if enabled.
</Callout>


### Refresh Token Customization

You can choose to format your session tokens in a different string format using the `formatRefreshToken`.

These functions allow you to add additional functionality on the refresh token itself such as refresh token encryption.

Example with change in refresh token format with backwards compatibility with original token-only format:

```ts title="auth.ts"
oauthProvider({
  formatRefreshToken: {
    encrypt: (token, sessionId) => {
      const res = sessionId ? `1.${token}.${sessionId}` : token;
      return res;
    },
    decrypt: (token) => {
      const tokenSplit = token.split('.');
      if (tokenSplit.length === 3 && tokenSplit.at(0) === '1') {
        return {
          token: tokenSplit.at(1),
          sessionId: tokenSplit.at(2),
        };
      }
      return { token };
    },
  }
})
```

Pseudocode for a token encryption method:

```ts title="auth.ts"
import { CompactEncrypt, compactDecrypt } from 'jose'

const secret = "SOME_SECRET_OR_KEY"
const alg = "A256KW"
const enc = "A256GCM"

const auth = betterAuth({
  plugins: [oauthProvider({
    formatRefreshToken: {
      encrypt: (token, sessionId) {
        const value = JSON.stringify({
          sessionId,
          token,
        });
        const jwe = await new CompactEncrypt(Buffer.from(value))
          .setProtectedHeader({ alg, enc })
          .encrypt(secret);
        return jwe;
      },
      decrypt: (token) {
        const { plaintext } = await compactDecrypt(token, secret);
        const payload = new TextDecoder().decode(plaintext);
        return JSON.parse(payload);
      },
    }
  })]
})
```


### Advertised Metadata

The metadata endpoint can be customized so that the publicized scopes and claims differ from those which the server can deliver. This can prevent showcasing all your supported scopes and claims on your metadata endpoint.

All scopes inside the advertisedMetadata section MUST be listed in `scopes` otherwise initialization will fail.

#### Scopes

```ts title="auth.ts"
oauthProvider({
  scopes: ["openid", "profile", "email", "offline_access", "read:post"],
  advertisedMetadata: {
    scopes_supported: ["openid", "profile", "read:post"],
  },
})
```

#### Claims

Claims are in addition to the internally supported claims which are automatically determined by `scopes`. Claims are only applicable for the OIDC (ie "openid" scope).

```ts title="auth.ts"
oauthProvider({
  advertisedMetadata: {
    claims_supported: ["https://example.com/roles"],
  },
})
```

### Disable JWT Plugin

By default, access and id tokens can be issued and verified through the JWT plugin.

You can disable the JWT requirement in which access tokens will always be opaque and id tokens are always signed in `HS256` using the `client_secret`. Note that disabling the JWT Plugin is still OIDC compliant, `/userinfo` still works and signed `id_token` is still provided.

Key Differences:
- Providing a valid `resource` will always provide you with an opaque access token instead of an JWT formatted token.
- `id_token` is not returned for public clients, but the `access_token` returned can still utilize the `/oauth2/userinfo` endpoint to obtain the user data.
- `id_token` for a confidential client is signed by their `client_secret`.

```ts title="auth.ts"
oauthProvider({
  disableJwtPlugin: true, // [!code highlight]
})
```


### MCP

You can easily make your APIs [MCP-compatible](https://modelcontextprotocol.io/specification/draft/basic/authorization) simply by adding a resource server which directs users to this OAuth 2.1 authorization server.

<Callout type="info">
If you are using "openid" and confidential MCP clients, you cannot disable the JWT plugin since `id_token` verification may not necessarily be supported via a `client_secret`.
</Callout>

#### Installation

<Steps>
  <Step>
    ### Ensure Well Known Paths are correct

    See [well-known endpoints](#well-known).
  </Step>

  <Step>
    ### Add Resource Server Client

    (Optional) If you have your auth configuration available locally, add the configuration as a parameter to the client to fill in these values and warn you about configuration errors. You can always override these values in the function call. If this is not supplied, typescript will guide you with the minimal configuration values needed.

    ```ts title="server-client.ts"
    import { auth } from "@/lib/auth";
    import { createAuthClient } from "better-auth/client";
    import { oauthProviderResourceClient } from "@better-auth/oauth-provider/resource-client"

    export const serverClient = createAuthClient({
      plugins: [oauthProviderResourceClient(auth)], // auth optional
    });
    ```
  </Step>

  <Step>
    ### Add OAuth Protected Resource Metadata to your API

    ```ts title="/.well-known/oauth-protected-resource/[resource-path]/route.ts"
    import { serverClient } from "@/lib/server-client";

    export const GET = async () => {
      const metadata = await serverClient.getProtectedResourceMetadata({
        resource: "https://api.example.com", // `aud` claim
        authorization_servers: ["https://auth.example.com"],
      })

      return new Response(JSON.stringify(metadata), {
        headers: {
          "Content-Type": "application/json",
          "Cache-Control":
            "public, max-age=15, stale-while-revalidate=15, stale-if-error=86400",
        },
      });
    };
    ```
  </Step>

  <Step>
  If you use `allowUnauthenticatedClientRegistration`, you must ensure that your API Server is a confidential client itself:

  ```ts
  await auth.api.createOAuthClient({
    headers,
    body: {
      redirect_uris: [redirectUri],
    }
  });
  ```

  These values should be used in the verify options `remoteVerify.clientId` and `remoteVerify.clientSecret`. Additionally, `remoteVerify.introspectUrl` would be something like `${BASE_URL}/${AUTH_PATH}/oauth2/introspect`.

  <Callout type="info">
  If you choose to not support `allowUnauthenticatedClientRegistration` (and only `allowDynamicClientRegistration`), the MCP client (ie. ChatGPT, Anthropic, Gemini) would need to allow you to put in a public client_id in their UI or at runtime while chatting with the AI.
  </Callout>
  </Step>

  <Step>
    ### Handle MCP Errors for your API

    Always verify against a specified `audience`, the default will compare against all `validAudiences` or `baseUrl`.

    - Using the client `verifyAccessToken` function

    See [Verification](#verification) for verification examples.

    - With auth available, use the client `verifyAccessToken` function to automatically determine endpoints

    ```ts title="api/[endpoint].ts"
    import { auth } from "@/lib/auth";
    import { serverClient } from "@/lib/server-client";

    export const GET = async (req: Request) => {
      const authorization = req.headers?.get("authorization") ?? undefined;
      const accessToken = authorization?.startsWith("Bearer ")
        ? authorization.replace("Bearer ", "")
        : authorization;
      const payload = await serverClient.verifyAccessToken(
        accessToken, {
          verifyOptions: {
            audience: "https://api.example.com",
          }
        }
      );
      // ...continue
    }
    ```

    - Using `mcpHandler` helper

    ```ts title="api/[transport]/route.ts"
    import { createMcpHandler } from "mcp-handler";
    import { mcpHandler } from "@better-auth/oauth-provider";
    import { z } from "zod";

    const handler = mcpHandler({
      jwksUrl: "https://auth.example.com/api/auth/jwks",
      verifyOptions: {
        issuer: "https://auth.example.com",
        audience: "https://api.example.com",
      },
    }, (req, jwt) => {
      return createMcpHandler(
        (server) => {
          server.registerTool(
            "echo", {
              description: "Echo a message",
              inputSchema: {
                message: z.string(),
              },
            },
            async ({ message }) => {
              return {
                content: [
                  {
                    type: "text",
                    text: `Echo: ${message}${
                      jwt?.sub
                        ? ` for user ${jwt.sub}`
                        : ""
                    }`,
                  },
                ],
              };
            }
          );
        }, {
          serverInfo: {
            name: "demo-better-auth",
            version: "1.0.0",
          }
        }, {
          basePath: "/api",
          maxDuration: 60,
          verboseLogs: true,
        }
      )(req);
    });

    export { handler as GET, handler as POST, handler as DELETE };
    ```
  </Step>
</Steps>


## Schema

The OAuth Provider plugin adds the following tables to the database:

### OAuth Client

Table Name: `oauthClient`

<DatabaseTable
  fields={[
    {
      name: "id",
      type: "string",
      description: "Database ID of the OAuth client",
      isPrimaryKey: true,
    },
    {
      name: "clientId",
      type: "string",
      description: "Unique identifier for each OAuth client",
      isPrimaryKey: true,
    },
    {
      name: "clientSecret",
      type: "string",
      description: "Secret key for the OAuth client. Optional for public clients using PKCE.",
      isOptional: true,
    },
    {
      name: "disabled",
      type: "boolean",
      description: "Field that indicates if the current application is disabled",
      isOptional: true,
    },
    {
      name: "skipConsent",
      type: "boolean",
      description: "Field that indicates if the application can skip consent. You may choose to enable this for trusted applications.",
      isOptional: true,
    },
    {
      name: "enableEndSession",
      type: "boolean",
      description: "Field that indicates if the application can logout via an id_token. You may choose to enable this for trusted applications.",
      isOptional: true,
    },
    {
      name: "scopes",
      type: "string[]",
      description: "Scopes this client is allowed to use",
      isOptional: true,
    },
    {
      name: "userId",
      type: "string",
      description: "ID of the client owner. (optional)",
      isOptional: true,
      isForeignKey: true,
      references: { model: "user", field: "id" },
    },
    {
      name: "referenceId",
      type: "string",
      description: "ID of the reference of the client owner if not a user. (optional)",
      isOptional: true,
      isForeignKey: true,
    },
    {
      name: "createdAt",
      type: "Date",
      description: "Timestamp of when the OAuth client was created",
    },
    {
      name: "updatedAt",
      type: "Date",
      description: "Timestamp of when the OAuth client was last updated",
    },
    {
      name: "name",
      type: "string",
      description: "Name of the OAuth client",
      isOptional: true,
    },
    {
      name: "uri",
      type: "string",
      description: "Website Uri displayed on UI Screens",
      isOptional: true,
    },
    {
      name: "icon",
      type: "string",
      description: "Website Icon displayed on UI Screens",
      isOptional: true,
    },
    {
      name: "contacts",
      type: "string[]",
      description: "Client contact list (ie customer service emails, phone numbers) to be displayed on UI Screens",
      isOptional: true,
    },
    {
      name: "tos",
      type: "string",
      description: "Client Terms of Service displayed on UI Screens",
      isOptional: true,
    },
    {
      name: "policy",
      type: "string",
      description: "Client Privacy policy displayed on UI Screens",
      isOptional: true,
    },
    {
      name: "softwareId",
      type: "string",
      description: "Client-defined software identifier. This should remain the same across multiple versions for the same piece of software.",
      isOptional: true,
    },
    {
      name: "softwareVersion",
      type: "string",
      description: "Client-defined version number of the softwareId.",
      isOptional: true,
    },
    {
      name: "softwareStatement",
      type: "string",
      description: "Signed JWT containing the software metadata as signed claims.",
      isOptional: true,
    },
    {
      name: "redirectUris",
      type: "string[]",
      description: "Array of of redirect uris",
      isRequired: true,
    },
    {
      name: "tokenEndpointAuthMethod",
      type: "string",
      description: "Indicator of requested authentication method for the token endpoint. Supports: ['none', 'client_secret_basic', 'client_secret_post']",
      isOptional: true,
    },
    {
      name: "grantTypes",
      type: "string[]",
      description: "Array of supported grant types. Supports: ['authorization_code', 'client_credentials', 'refresh_token']",
      isOptional: true,
    },
    {
      name: "responseTypes",
      type: "string[]",
      description: "Array of supported grant types. Supports: ['code']",
      isOptional: true,
    },
    {
      name: "public",
      type: "boolean",
      description: "Indication if the client is confidential or public",
      isOptional: true,
    },
    {
      name: "type",
      type: "string",
      description: "Type of OAuth client. Supports: ['web', 'native', 'user-agent-based']",
      isOptional: true,
    },
    {
      name: "metadata",
      type: "json",
      description: "Additional metadata for the OAuth client",
      isOptional: true,
    },
  ]}
/>

### OAuth Refresh Token

Table Name: `oauthRefreshToken`

<DatabaseTable
  fields={[
    {
      name: "id",
      type: "string",
      description: "Database ID of the refresh token",
      isPrimaryKey: true,
    },
    {
      name: "token",
      type: "string",
      description: "Hashed/encrypted refresh token",
      isRequired: true,
    },
    {
      name: "clientId",
      type: "string",
      description: "ID of the OAuth client",
      isForeignKey: true,
      isRequired: true,
      references: { model: "oauthClient", field: "clientId" },
    },
    {
      name: "sessionId",
      type: "string",
      description: "ID of the session used at issuance of the token (and still active)",
      isForeignKey: true,
      isRequired: false,
      references: { model: "session", field: "id" },
    },
    {
      name: "userId",
      type: "string",
      description: "ID of the user associated with the token",
      isForeignKey: true,
      isRequired: true,
      references: { model: "user", field: "id" },
    },
    {
      name: "referenceId",
      type: "string",
      description: "ID of the consented reference",
      isOptional: true,
      isForeignKey: true,
    },
    {
      name: "scopes",
      type: "string[]",
      description: "Array of granted scopes",
      isRequired: true,
    },
    {
      name: "revoked",
      type: "Date",
      description: "Timestamp when the token was revoked",
      isOptional: true,
    },
    {
      name: "createdAt",
      type: "Date",
      description: "Timestamp when the token was created",
    },
    {
      name: "expiresAt",
      type: "Date",
      description: "Timestamp when the token will expire",
    },
  ]}
/>

### OAuth Access Token

Table Name: `oauthAccessToken`

<DatabaseTable
  fields={[
    {
      name: "id",
      type: "string",
      description: "Database ID of the opaque access token",
      isPrimaryKey: true,
    },
    {
      name: "token",
      type: "string",
      description: "Hashed/encrypted access token",
      isRequired: true,
    },
    {
      name: "clientId",
      type: "string",
      description: "ID of the OAuth client",
      isForeignKey: true,
      isRequired: true,
      references: { model: "oauthClient", field: "clientId" }
    },
    {
      name: "sessionId",
      type: "string",
      description: "ID of the session used at issuance of the token (and still active)",
      isForeignKey: true,
      isOptional: true,
      references: { model: "session", field: "id" },
    },
    {
      name: "refreshId",
      type: "string",
      description: "ID of the refresh associated with the token",
      isForeignKey: true,
      isOptional: true,
      references: { model: "oauthRefreshToken", field: "id" },
    },
    {
      name: "userId",
      type: "string",
      description: "ID of the user associated with the token",
      isForeignKey: true,
      isOptional: true,
      references: { model: "user", field: "id" },
    },
    {
      name: "referenceId",
      type: "string",
      description: "ID of the consented reference",
      isOptional: true,
      isForeignKey: true,
    },
    {
      name: "scopes",
      type: "string[]",
      description: "Array of granted scopes",
      isRequired: true,
    },
    {
      name: "createdAt",
      type: "Date",
      description: "Timestamp when the token was created" 
    },
    {
      name: "expiresAt",
      type: "Date",
      description: "Timestamp when the token will expire",
    },
  ]}
/>

### OAuth Consent

Table Name: `oauthConsent`

<DatabaseTable
  fields={[
    {
      name: "id",
      type: "string",
      description: "Database ID of the consent",
      isPrimaryKey: true
    },
    {
      name: "userId",
      type: "string",
      description: "ID of the user who gave consent",
      isForeignKey: true,
      references: { model: "user", field: "id" }
    },
    {
      name: "clientId",
      type: "string",
      description: "ID of the OAuth client",
      isForeignKey: true,
      references: { model: "oauthClient", field: "clientId" }
    },
    {
      name: "referenceId",
      type: "string",
      description: "ID of the consented reference",
      isOptional: true,
      isForeignKey: true,
    },
    {
      name: "scopes",
      type: "string",
      description: "Comma-separated list of scopes consented to",
      isRequired: true
    },
    {
      name: "createdAt",
      type: "Date",
      description: "Timestamp of when the consent was given" 
    },
    {
      name: "updatedAt",
      type: "Date",
      description: "Timestamp of when the consent was last updated"
    },
  ]}
/>

## Options

### Prefix

Add a `prefix` to opaque access tokens, refresh tokens, or client secrets. This is useful for Secret Scanners (ie. [GitHub Secret Scanners](https://docs.github.com/code-security/secret-scanning), [GitGuardian](https://www.gitguardian.com/solutions/secrets-scanning), [Trufflehog](https://github.com/trufflesecurity/trufflehog)) that may rely on the prefix to help determine the token format.

We recommend to add a prefix to each of the following prior to your first production deployment. Once deployed consider them immutable, otherwise the following generate functions as specified:

The following are available under the `prefix` configuration setting:
- **opaqueAccessToken**: `string | undefined` - add a prefix onto opaque access tokens. If previously deployed, utilize `generateOpaqueAccessToken` to perform this functionality instead.
- **refreshToken**: `string | undefined` - add a prefix onto refresh tokens.  If previously deployed, utilize `generateRefreshToken` to perform this functionality instead.
- **clientSecret**:: `string | undefined` - add a prefix onto client secrets.  If previously deployed, utilize `generateClientSecret` to perform this functionality instead.

## Optimizations

To improve lookup performance, database adapters may map the field `client_id` on the table `oauthClient` to `id`. Note that `id` should support strings formatted like UUIDs and urls.

## Migrations

### From [OIDC Provider Plugin](/docs/plugins/oidc-provider)

#### Configuration

- **`idTokenExpiresIn`** now defaults to `10 hours` (previously `1 hour` through `accessTokenExpiresIn`)
- **`refreshTokenExpiresIn`** now defaults to `30 days` (previously `7 days`)
- **`advertisedMetadata`** (previously `metadata`) no longer supports changing metadata fields to prevent accidental misconfiguration.
- **`clientRegistrationDefaultScopes`** (previously `defaultScope`) is now in array format instead of a space-separated string
- **`consentPage`** is now required
- **`getConsentHTML`** is removed in favor of the `consentPage` as raw html is not a response type supported by the authorize endpoint in OAuth
- **`requirePKCE`** is removed as PKCE is required in OAuth 2.1
- **`allowPlainCodeChallengeMethod`** is removed as the `plain` code challenge is considered less secure than the default `S256` method
- **`customUserInfoClaims`** (previously `getAdditionalUserInfoClaim`) passes the jwt payload instead of the client of the access token used in the request.
- **`storeClientSecret`** now defaults to `hashed`, or `encrypted` if `disableJwtPlugin: true` (previously `plain`).
- JWT plugin now is enabled by default. To disable the plugin, set `disableJwtPlugin: true`.
- Authorization query `code_challenge_method` "S256" must be in caps as described by OAuth 2.1

#### Database

##### Table: `oauthClient`

Previously `oauthApplication`

- If `storeClientSecret` was unset or `plain`, you must hash all the stored `clientSecret` values into its "SHA-256" representation then convert it into base64Url format or use another storage method specified by `storeClientSecret`.
The following function will convert a `plain` representation into the default hash:
```ts
import { createHash } from "@better-auth/utils/hash";
import { base64Url } from "@better-auth/utils/base64";

const defaultHasher = async (value: string) => {
	const hash = await createHash("SHA-256").digest(
		new TextEncoder().encode(value),
	);
	const hashed = base64Url.encode(new Uint8Array(hash), {
		padding: false,
	});
	return hashed;
};
```
- `type` field is no longer a required field. Instead, the schema requires `public` of type `boolean`. Migrate with the following rules:
    - Clients with `type: "public"`: set `type: undefined`, `public: true`, and `clientSecret: undefined`
    - Clients with `type: "native"`: set `public: true` and `clientSecret: undefined`
    - Clients with `type: "user-agent-based"`: set `public: true` and `clientSecret: undefined`
    - Clients with `clientSecret: undefined`: set `public: true`
- `redirectURLs` renamed to `redirectUris`
- `metadata` is now stored in database as individual fields instead of a JSON object. Parse the metadata into their respective fields. The OIDC plugin did not utilize this field but this OAuth plugin may utilize them in the future.

##### Table: `oauthAccessToken`

Option 1 (simple):

You may choose to opt-out of this table conversion with minimal impact. By doing so, users of the existing application will simply need to login again. Simply delete the existing table `oauthAccessToken`.

Option 2 (more complex):

Migrate all tables (you may need to create a clone of `oauthAccessToken` into `oauthRefreshToken` before a migration).

- Convert `oauthAccessToken` with `refreshToken` field into a new `oauthRefreshToken` entry.
```ts
{
  token: defaultHasher(refreshToken),
  expiresAt: refreshTokenExpiresAt,
  clientId: clientId,
  scopes: scopes,
  userId: userId,
  createdAt: createdAt,
  updatedAt: updatedAt,
}
```

- Keep `oauthAccessToken` but reference new `oauthRefreshToken`.
```ts
{
  token: defaultHasher(accessToken),
  expiresAt: accessTokenExpiresAt,
  clientId: clientId,
  scopes: scopes,
  refreshId: oauthRefreshToken.id, // `undefined` if no refreshToken
  createdAt: createdAt,
  updatedAt: updatedAt,
}
```


### From [MCP Plugin](/docs/plugins/mcp)

The MCP endpoints moved from `/mcp` to the `/oauth2` equivalent.

- `/oauth2/authorize` (previously `/mcp/authorize`)
- `/oauth2/token` (previously `/mcp/token`)
- `/oauth2/register` (previously `/mcp/register`)
- `/mcp/get-session` removed as not OAuth 2 compliant, use `/oauth2/introspect` instead
- `/.well-known/oauth-protected-resource` removed, use the helper `mcpHandler` (or manually with the server `api.oAuth2introspectVerify` or the resource client `verifyAccessToken`)
-  Database changes are equivalent to the [From OIDC Provider Plugin](#from-oidc-provider-plugin) section.
