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

providers/tiktok

内置的 TikTok 集成。

TiktokProfile

更多信息

扩展

属性

data

data: {
  user: {
     avatar_large_url: string;
     avatar_url: string;
     avatar_url_100: string;
     bio_description: string;
     display_name: string;
     email: string;
     follower_count: number;
     following_count: number;
     is_verified: boolean;
     likes_count: number;
     open_id: string;
     profile_deep_link: string;
     union_id: string;
     username: string;
     video_count: number;
  };
};
user
user: {
  avatar_large_url: string;
  avatar_url: string;
  avatar_url_100: string;
  bio_description: string;
  display_name: string;
  email: string;
  follower_count: number;
  following_count: number;
  is_verified: boolean;
  likes_count: number;
  open_id: string;
  profile_deep_link: string;
  union_id: string;
  username: string;
  video_count: number;
};
user.avatar_large_url?
optional avatar_large_url: string;

用户的个人资料图片,分辨率更高

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=avatar_url_100

user.avatar_url
avatar_url: string;

用户的个人资料图片。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=avatar_url

user.avatar_url_100?
optional avatar_url_100: string;

用户个人资料图片,大小为 100x100。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=avatar_url_100

user.bio_description?
optional bio_description: string;

用户的个人资料简介,如果有的话。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=bio_description

user.display_name
display_name: string;

用户的个人资料名称

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=display_name

user.email?
optional email: string;
注意

TikTok 目前不支持电子邮件

user.follower_count?
optional follower_count: number;

用户的关注者数量。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=follower_count

user.following_count?
optional following_count: number;

用户正在关注的帐户数量。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=following_count

user.is_verified?
optional is_verified: boolean;

TikTok 是否在确认帐户属于其代表的用户后为该帐户提供了验证徽章。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=is_verified

user.likes_count?
optional likes_count: number;

用户在其所有视频中收到的总喜欢数。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=likes_count

user.open_id
open_id: string;

用户在当前应用程序中的唯一标识。客户端的 Open ID。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=open_id

optional profile_deep_link: string;

用户 TikTok 个人资料页面的链接。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=profile_deep_link

user.union_id?
optional union_id: string;

用户在同一个开发人员的不同应用程序中的唯一标识。例如,如果合作伙伴有 X 个客户,它将获得 X 个相同 TikTok 用户的 open_id,但该特定用户的 union_id 只有一个。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=union_id

user.username
username: string;

用户的用户名。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=username

user.video_count?
optional video_count: number;

用户发布的公开视频总数。

要返回此字段,请在用户个人资料请求的查询参数中添加 fields=video_count

error

error: {
  code: string;
  log_id: string;
  message: string;
};
code
code: string;

错误类别,以字符串形式表示。

log_id
log_id: string;

错误消息,以字符串形式表示。

message
message: string;

错误消息,以字符串形式表示。


default()

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

在你的页面中添加 TikTok 登录。

设置

回调 URL

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

配置

import { Auth } from "@auth/core"
import TikTok from "@auth/core/providers/tiktok"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    TikTok({ clientId: TIKTOK_CLIENT_KEY, clientSecret: TIKTOK_CLIENT_SECRET }),
  ],
})

资源

注意

💡

生产环境应用程序不能使用本地主机 URL 来登录 TikTok。您需要将域名和回调/重定向 URL 添加到您的 TikTok 应用,并由 TikTok 团队进行审核和批准。

💡

TikTok 不支持电子邮件地址。

💡

Client_ID 将是 TikTok 应用程序中的 Client Key。

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

💡

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

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

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

类型参数

类型参数
P extends TiktokProfile

参数

参数类型
optionsOAuthUserConfig<P>

返回值

OAuthConfig<P>

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