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

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

安装

安装 npm :

npm install @flowcore/sdk-oidc-client

线条 :

yarn add @flowcore/sdk-oidc-client

使用量

创建 OIDC 客户端的新实例 :

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

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

获取托肯

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

const tokenSet = await client.getToken();

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

强制刷新

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

const tokenSet = await client.getToken(true);

解码托肯

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

const decodedToken = OidcClient.DecodeToken(token);

注意:然后解码的令牌作为按键对象返回令牌 TokenInfo 界面,从此库导出. 要扩展符号信息,您可以扩展 TokenInfo 界面并将其作为通用 DecodeToken 方法.

interface CustomTokenInfo extends TokenInfo {
 customField: string;
}

const decodedToken = OidcClient.DecodeToken<CustomTokenInfo>(token);

自定义 OIDC 范围

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

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

托肯过期缓冲器

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

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

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

发展

yarn install

或带 npm :

npm install