@ dofe/sso-节点
运行时中性节点 SDK sso.dofe.ai 内部服务API.
安装
pnpm add @dofe/sso-node
使用量
import { createSsoInternalClient } from '@dofe/sso-node';
const sso = createSsoInternalClient({
baseUrl: process.env.SSO_INTERNAL_API_URL!,
internalSecret: process.env.INTERNAL_API_SECRET!,
serviceName: 'agents.dofe.ai',
});
const user = await sso.users.get('00000000-0000-0000-0000-000000000000');
const permissions = await sso.permissions.getUserPermissions(user.id);
对于暴露出平坦方法的当地老年客户的移徙,使用 createSsoLegacyClient数字 :
import { createSsoLegacyClient } from '@dofe/sso-node/legacy';
const sso = createSsoLegacyClient({
baseUrl: process.env.SSO_INTERNAL_API_URL!,
internalSecret: process.env.INTERNAL_API_SECRET!,
internalBasePath: '/api/internal',
authMode: 'x-internal-secret',
serviceName: 'agents.dofe.ai',
});
const user = await sso.getUser('00000000-0000-0000-0000-000000000000');
const hasPermission = await sso.checkPermission(user.id, 'team.read', 'team-id');
const role = await sso.getUserTeamRole('team-id', user.id);
认证模式
| 模式 | 页眉 |
|---|---|
bearer | Authorization: Bearer <internalSecret> |
x-internal-secret | X-Internal-Secret: <internalSecret> |
默认模式是 bearer启用 x-internal-secret 仅用于移民时的遗产服务.
默认取取器拒绝 HTTP 重定向既用于输入方法,又用于 raw 请求,
包括重定向到同一来源。 设定 baseUrl 财务报告和审定财务报表 internalBasePath 页:1
最终内部API地址. 防止转发服务证明或遗留机密
头到方向方向 习惯 fetcher 必须执行同样的规则.
验证
运行 pnpm --filter @dofe/sso-node test 用于构建和测试软件包。 定向测试
使用本地的HTTP服务器和合成证书;它们不需要现场SSO访问.
边界
这个软件包是只供客户使用的 SDK. 它不包括雀巢JS模块,Redis订阅者,Prisma,迁移,种子,或数据库连接逻辑.
可选届会时间安排
SessionV2ClientOptions.onTiming 财务报告和审定财务报表 SessionV2BffOptions.onTiming 接受
SessionV2TimingObserver, (中文(简体) ), (event: SessionV2TimingEvent) => void | Promise<void>。 。 。 .
所有时间类型均从包根导出. 钩是可选的;
同步抛出 同步拒绝 被忽略 承诺永远不会
等着呢 保持观察同步工作缩短.
活动仅包含 phase, (中文(简体) ), operation,非负数 durationMs, (中文(简体) ), outcome
(单位:千美元)success 或者说 error),和可选数字 HTTP status没有识别器,
请求对象、URL、证书或应答有效载荷被释放.
| 阶段 | 运行 | 边界 |
|---|---|---|
remote | exchange-code, (中文(简体) ), rotate, (中文(简体) ), introspect, (中文(简体) ), renew-ticket, (中文(简体) ), confirmation, (中文(简体) ), bootstrap-exchange, (中文(简体) ), logout-confirmation, (中文(简体) ), logout, (中文(简体) ), call | SSO 通过 JSON 机构解析和 HTTP 错误处理获取 . call 是其它路径的固定倒置。 呼叫后的方法级计划检查不在此限. |
active-entry | read | 故障读取,过期和撤销检查. |
admission | begin-dispatch, (中文(简体) ), begin-window-dispatch | 地铁招生,包括其远程内测和租赁收购. |
completion | complete | 破损完成承诺. |
compat-dispatch | dispatch | 通过缓冲体和完成来进行上游取水的相容性,或流接;不包括随后的流接期. |
嵌入跨度重叠:不总和录取/完成及其远程跨度.
status 是原始的 HTTP 响应状态, 即使SDK 正在使一个
错误为 503. 远程成功描述 HTTP/ JSON 完成, 不是活动
课程赠款。 兼容性 HTTP 状态 QQ 400 产生出错误结果而不包含
改变上游的反应。 直接运输仍在进行中,且未发出
相近的间隔。 兼容性响应转发保留 Server-Timing
和现有的 x-request-id; 它不注入或重写有校正条件的请求
标题或向前任意的上游标题。 未添加关联标识符
用于事件;应用程序可以使用自己的同步上下文连接事件.