@auth/core
Version:
Authentication for the Web.
76 lines (75 loc) • 2.42 kB
JavaScript
/**
* Add Mastodon login to your page.
*
* ### Setup
*
* #### Callback URL
* ```
* https://example.com/api/auth/callback/mastodon
* ```
*
* #### Configuration
*```ts
* 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](https://docs.joinmastodon.org/client/token/)
* - [Mastodon OAuth Configuration](https://mastodon.social/settings/applications)
*
* ### Notes
*
* By default, Auth.js assumes that the Mastodon provider is
* based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) 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](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/mastodon.ts).
* To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/configuring-oauth-providers).
*
* :::
*
* :::info **Disclaimer**
*
* If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-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](https://authjs.dev/new/github-discussions).
*
* :::
*/
export default function Mastodon(options) {
return {
id: "mastodon",
name: "Mastodon",
type: "oauth",
authorization: `${options.issuer}/oauth/authorize?scope=read`,
token: `${options.issuer}/oauth/token`,
userinfo: `${options.issuer}/api/v1/accounts/verify_credentials`,
profile(profile) {
return {
id: profile.id,
name: profile.username,
image: profile.avatar_static,
email: null,
};
},
options,
};
}