跳至内容
从 NextAuth.js v4 迁移?阅读 我们的迁移指南.

providers/discord

内置 Discord 集成。

DiscordProfile

对应于此处记录的用户结构:https://discord.com/developers/docs/resources/user#user-object-user-structure

扩展

属性

accent_color

accent_color: null | number;

用户的横幅颜色,编码为十六进制颜色代码的整数表示

avatar

avatar: null | string;

用户的头像哈希:https://discord.com/developers/docs/reference#image-formatting

avatar_decoration

avatar_decoration: null | string;

未记录的字段;对应于 Discord 功能,例如将您的头像放在冰块中

banner: null | string;

用户的横幅哈希:https://discord.com/developers/docs/reference#image-formatting

banner_color: null | string;

未记录的字段;对应于高级功能,您可以选择自定义横幅颜色

bot?

optional bot: boolean;

用户是否属于 OAuth2 应用程序

discriminator

discriminator: string;

用户的 Discord 标签

display_name

display_name: null | string;

未记录的字段;对应于用户的自定义昵称

email

email: null | string;

用户的电子邮件

flags

flags: number;

用户帐户上的标志:https://discord.com/developers/docs/resources/user#user-object-user-flags

global_name

global_name: null | string;

用户的显示名称,如果已设置

id

id: string;

用户的 ID(即数字雪花)

image_url

image_url: string;

未记录的字段;其个人资料图片的 CDN URL

locale

locale: string;

用户选择的语言选项:https://discord.com/developers/docs/reference#locales

mfa_enabled

mfa_enabled: boolean;

用户是否在其帐户上启用了双重身份验证

premium_type

premium_type: number;

用户帐户上的 Nitro 订阅类型:https://discord.com/developers/docs/resources/user#user-object-premium-types

public_flags

public_flags: number;

用户帐户上的公开标志:https://discord.com/developers/docs/resources/user#user-object-user-flags

system?

optional system: boolean;

用户是否为官方 Discord 系统用户(紧急消息系统的一部分)

username

username: string;

用户的用户名,在整个平台上不唯一

verified

verified: boolean;

此帐户上的电子邮件是否已验证


default()

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

将 Discord 登录添加到您的页面。

设置

回调 URL

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

配置

import { Auth } from "@auth/core"
import Discord from "@auth/core/providers/discord"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Discord({
      clientId: DISCORD_CLIENT_ID,
      clientSecret: DISCORD_CLIENT_SECRET,
    }),
  ],
})

资源

注意

默认情况下,Auth.js 假设 Discord 提供者基于 OAuth 2 规范。

💡

Discord 提供者附带一个 默认配置。要覆盖您的用例的默认值,请查看 自定义内置 OAuth 提供者

免责声明 如果您认为在默认配置中发现了错误,您可以 打开一个问题

Auth.js 严格遵守规范,对提供者对规范的任何偏差概不负责。您可以打开一个问题,但如果问题是非遵守规范,我们可能不会寻求解决方案。您可以在 讨论 中寻求更多帮助。

类型参数

类型参数
P 扩展 DiscordProfile

参数

参数类型
optionsOAuthUserConfig<P>

返回值

OAuthConfig<P>

Auth.js © Balázs Orbán 和团队 -2024