# @flowcore/sdk-oidc-client 中文文档

规范地址：https://npmcn.com/package/%40flowcore/sdk-oidc-client/

版本：1\.3\.1
npm 元数据更新时间：2026-03-02T10:38:17.473Z
中文译文更新时间：2026-11-15T00:14:55.176Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flowcore/sdk-oidc-client
原文对照：https://npmcn.com/package/%40flowcore/sdk-oidc-client/?lang=original
源码仓库：https://github.com/flowcore-io/library-sdk-oidc-client-ts

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：55.5 kB，19 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=17\.0\.0
- 运行依赖：0 个
- 首次发布：2024-03-28T16:40:07.858Z
- 最新版本发布：2024-04-17T09:03:57.889Z
- 近 30 天下载量：27453（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

一个提供开放的id连接提供者功能的Flowcore SDK模块,用于与Flowcore平台.

## 安装

```sh
npm install @flowcore/sdk-oidc-client
```

也可以使用：`pnpm add @flowcore/sdk-oidc-client`、`yarn add @flowcore/sdk-oidc-client`、`bun add @flowcore/sdk-oidc-client`

## README

# Flowcore SDK 模块 - 打开 ID 连接提供者

一个提供开放的id连接提供者功能的Flowcore SDK模块,用于与Flowcore平台.

## 安装

安装 npm :

```bash
npm install @flowcore/sdk-oidc-client
```

线条 :

```bash
yarn add @flowcore/sdk-oidc-client
```

## 使用量

创建 OIDC 客户端的新实例 :

```typescript
import { OidcClient } from '@flowcore/sdk-oidc-client';

const client = new OidcClient("your client id", "your client secret", "well known endpoint");
```

### 获取托肯

从 OIDC 提供者那里取出一个令牌, 这将从提供者那里取出令牌并缓存到将来使用 :

```typescript
const tokenSet = await client.getToken();
```

> 说明: 符号过期时会自动刷新,客户端会为您处理. 这也将解决 url 的象征端点 从众所周知的端点. 符将回为弦. 如果无法取回该令牌, 此客户端会丢出错误 .

### 强制刷新

要强制刷新默认版本的符号, 您可以通过 `true` 页:1 `getToken` 方法 :

```typescript
const tokenSet = await client.getToken(true);
```

### 解码托肯

库还提供了解码符号的方法:

```typescript
const decodedToken = OidcClient.DecodeToken(token);
```

> 注意:然后解码的令牌作为按键对象返回令牌 `TokenInfo` 界面,从此库导出. 要扩展符号信息,您可以扩展 `TokenInfo` 界面并将其作为通用 `DecodeToken` 方法.
> 
> ```typescript
> interface CustomTokenInfo extends TokenInfo {
>  customField: string;
> }
> 
> const decodedToken = OidcClient.DecodeToken<CustomTokenInfo>(token);
> ```

### 自定义 OIDC 范围

要覆盖默认范围,可以将范围传给 `options` 构造器中的对象 :

```typescript
const client = new OidcClient("your client id", "your client secret", "well known endpoint", { scope: "custom scope" });
```

### 托肯过期缓冲器

要设置符号过期的缓冲器,您可以在秒内将缓冲器传递到 `options` 构造器中的对象 :

```typescript
const client = new OidcClient("your client id", "your client secret", "well known endpoint", { expirationBuffer: 60 });
```

> 诺比! 缓冲为秒,而默认为20秒. 如果您将缓冲设置为超过符号到期时间, 每次拨打都会刷新 `getToken`。 。 。 .

## 发展

```bash
yarn install
```

或带 npm :

```bash
npm install
```

## 常见问题

### @flowcore/sdk-oidc-client 是什么？

一个提供开放的id连接提供者功能的Flowcore SDK模块,用于与Flowcore平台\.

### 如何安装 @flowcore/sdk-oidc-client？

在项目目录运行 npm install @flowcore/sdk-oidc-client，或使用 pnpm add / yarn add / bun add。

### @flowcore/sdk-oidc-client 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @flowcore/sdk-oidc-client 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @flowcore/sdk-oidc-client 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=17\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @flowcore/sdk-oidc-client 可以商用吗？

@flowcore/sdk-oidc-client 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @flowcore/sdk-oidc-client 的下载量有多少？

根据 npm 官方下载统计，@flowcore/sdk-oidc-client 在 2026/10/15 – 2026/11/13 这 30 天内被下载 27,453 次，日均约 915 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @flowcore/sdk-oidc-client 还在维护吗？

最新版本 1\.3\.1 发布于 2024/04/17（2 年前）；至今共发布 8 个版本，其中过去 12 个月发布了 0 个；首次发布于 2024/03/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。