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

providers/auth0

使用 Auth0 集成的内置登录。

Auth0Profile

使用配置文件回调时,Auth0 返回的用户配置文件。 参考.

扩展

属性

app_metadata

app_metadata: object;

存储有关用户的信息的自定义字段,这些信息会影响用户的访问权限,例如支持计划、安全角色(如果未使用授权核心功能集)或访问控制组。要了解更多信息,请阅读元数据概述。

blocked

blocked: boolean;

指示用户是否已被阻止。导入允许订阅者在迁移到 Auth0 时确保用户保持被阻止状态。

created_at

created_at: Date;

指示用户配置文件首次创建时间的日期戳。

email

email: string;

(唯一) 用户的电子邮件地址。

email_verified

email_verified: boolean;

指示用户是否已验证其电子邮件地址。

family_name

family_name: string;

用户的姓氏。

given_name

given_name: string;

用户的姓名。

identities

identities: {
[key: string]: any;   connection: string;
  isSocial: boolean;
  profileData: object;
  provider: string;
  user_id: string;
  }[];

包含从用户最初进行身份验证的身份提供者处检索到的信息。用户还可以将他们的个人资料链接到多个身份提供者;这些身份也将出现在此数组中。单个身份提供者对象的內容因提供者而异。在某些情况下,它还将包含一个 API 访问令牌,用于与提供者一起使用。

last_ip

last_ip: string;

与用户上次登录相关的 IP 地址。

last_login

last_login: Date;

指示用户上次登录时间的日期戳。如果用户被阻止并登录,则被阻止的会话将更新 last_login。如果您从规则内部使用 user< 对象使用此属性,其值将与触发规则的登录相关联;这是因为规则在登录后执行。

last_password_reset

last_password_reset: Date;

指示用户上次重置/更改密码时间的日期戳。在用户创建时,此字段不存在。此属性仅适用于数据库连接。

logins_count

logins_count: number;

用户登录的次数。如果用户被阻止并登录,则被阻止的会话将计入 logins_count。

multifactor

multifactor: string;

用户注册的多因素提供者列表。

name

name: string;

用户的全名。

nickname

nickname: string;

用户的昵称。

phone_number

phone_number: string;

用户的电话号码。仅适用于具有 SMS 连接的用户。

phone_verified

phone_verified: boolean;

指示用户是否已验证其电话号码。仅适用于具有 SMS 连接的用户。

picture

picture: string;

指向用户个人资料图片的 URL。

sub

sub: string;

用户的唯一标识符。

updated_at

updated_at: Date;

指示用户个人资料上次更新/修改时间的日期戳。last_login 的更改被视为更新,因此大多数情况下,updated_at 将与 last_login 匹配。

user_id

user_id: string;

(唯一) 用户的标识符。导入允许用户记录在不使用映射表的情况下在多个系统之间同步。

user_metadata

user_metadata: object;

存储有关用户的信息的自定义字段,这些信息不会影响他们可以访问或不能访问的内容,例如工作地址、家庭住址或用户偏好。要了解更多信息,请阅读元数据概述。

username

username: string;

(唯一) 用户的用户名。


default()

default(config): OIDCConfig<Auth0Profile>

设置

回调 URL

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

配置

import { Auth } from "@auth/core"
import Auth0 from "@auth/core/providers/auth0"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Auth0({
      clientId: AUTH0_ID,
      clientSecret: AUTH0_SECRET,
    }),
  ],
})

资源

注意

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

帮助

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

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

参数

参数类型
configOIDCUserConfig<Auth0Profile>

返回值

OIDCConfig<Auth0Profile>

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