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

providers/yandex

内置的 Yandex 集成。

YandexProfile

属性

birthday?

optional birthday: null | string;

用户的出生日期,格式为 YYYY-MM-DD。日期中未知的元素将用零填充,例如:0000-12-23。如果用户的出生日期未知,则 birthday 将为 null

client_id

client_id: string;

请求中颁发 OAuth 令牌的应用的 ID。在 应用属性 中可用。要打开属性,请单击应用名称。

default_avatar_id?

optional default_avatar_id: string;

Yandex 用户个人资料图片的 ID。下载用户头像的格式:https://avatars.yandex.net/get-yapic/<default_avatar_id>/<size>

示例
"https://avatars.yandex.net/get-yapic/31804/BYkogAC6AoB17bN1HKRFAyKiM4-1/islands-200"
Available sizes:
`islands-small`: 28×28 pixels.
`islands-34`: 34×34 pixels.
`islands-middle`: 42×42 pixels.
`islands-50`: 50×50 pixels.
`islands-retina-small`: 56×56 pixels.
`islands-68`: 68×68 pixels.
`islands-75`: 75×75 pixels.
`islands-retina-middle`: 84×84 pixels.
`islands-retina-50`: 100×100 pixels.
`islands-200`: 200×200 pixels.

default_email?

optional default_email: string;

用于联系用户的默认电子邮件地址。

default_phone?

optional default_phone: {
  id: number;
  number: string;
};

用于联系用户的默认电话号码。API 可以自行决定从响应中排除用户的电话号码。该字段包含以下参数:id:电话号码 ID。number:用户的电话号码。

id
id: number;
number
number: string;

display_name?

optional display_name: string;

emails?

optional emails: string[];

用户电子邮件地址的数组。当前仅包含默认电子邮件地址。

first_name?

optional first_name: string;

id

id: string;

Yandex 用户的唯一 ID。

is_avatar_empty?

optional is_avatar_empty: boolean;

表示 default_avatar_id 字段中指定了存根(在 Yandex 中注册时自动分配的个人资料图片)ID。

last_name?

optional last_name: string;

login

login: string;

用户的 Yandex 登录名。

psuid

psuid: string;

授权的 Yandex 用户 ID。它是根据 client_iduser_id 对在 Yandex 侧形成的。

real_name?

optional real_name: string;

用户在 Yandex ID 中指定的姓和名。姓和名的非拉丁字符以 Unicode 格式呈现。

sex?

optional sex: null | "female" | "male";

用户的性别。null 表示未知或未指定的性别。如果 Yandex 未提供,则将为 undefined


default()

default(options): OAuthConfig<YandexProfile>

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

设置

回调 URL

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

配置

import { Auth } from "@auth/core"
import Yandex from "@auth/core/providers/yandex"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Yandex({ clientId: YANDEX_CLIENT_ID, clientSecret: YANDEX_CLIENT_SECRET }),
  ],
})

资源

💡

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

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

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

参数

参数类型
optionsOAuthUserConfig<YandexProfile>

返回值

OAuthConfig<YandexProfile>

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