Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
API reference
twitch

providers/twitch

Built-in Twitch integration.

TwitchProfile

Extends

  • Record<string, any>

Properties

email

email: string;

picture

picture: string;

preferred_username

preferred_username: string;

sub

sub: string;

default()

default(config): OIDCConfig<TwitchProfile>

Add Twitch login to your page.

Setup

Callback URL

https://example.com/api/auth/callback/twitch

Configuration

import { Auth } from "@auth/core"
import Twitch from "@auth/core/providers/twitch"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Twitch({ clientId: TWITCH_CLIENT_ID, clientSecret: TWITCH_CLIENT_SECRET }),
  ],
})

Resources

Add the following redirect URL into the console http://<your-next-app-url>/api/auth/callback/twitch

Notes

By default, Auth.js assumes that the Twitch provider is based on the Open ID Connect specification.

💡

The Twitch provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.

Disclaimer If you think you found a bug in the default configuration, you can open an issue.

Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.

Parameters

ParameterType
configOIDCUserConfig<TwitchProfile>

Returns

OIDCConfig<TwitchProfile>

Auth.js © Balázs Orbán and Team - 2024