providers/mastodon

Built-in Mastodon integration.

default()

default<P>(options): OAuthConfig< P >

Add Mastodon login to your page.

Setup

Callback URL

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

Configuration

import Auth from "@auth/core"
import Mastodon from "@auth/core/providers/mastodon"

const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Mastodon({
      clientId: MASTODON_CLIENT_ID,
      clientSecret: MASTODON_CLIENT_SECRET,
      issuer: MASTODON_ISSUER
    })
  ]
})

Resources

• Mastodon OAuth documentation
• Mastodon OAuth Configuration

Notes

By default, Auth.js assumes that the Mastodon provider is based on the OAuth 2 specification.

Due to Mastodons infrastructure beeing a Fediverse you have to define the issuer you want to connect to.

tip

The Mastodon 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.

Type parameters

Parameter
P extends MastodonProfile< P >

Parameters

Parameter	Type
options	OAuthUserConfig< P > & {issuer: string;}

Returns

OAuthConfig< P >