@aws-sdk/客户端-so-oidc
说明
JavaScript SSOOIDC 节点客户端的 AWS SDK,浏览器和React Industrial.
IAM身份中心OpenID Connected(OIDC)是一种允许客户端(如CLI或A)的网络服务 在IAM身份中心注册。 服务还使客户端能够获取 用户在IAM身份中心成功认证和授权后的访问符.
API 命名空间
IAM身份中心使用 sso 财务报告和审定财务报表 identitystore API 命名空间. IAM 身份识别中心
OpenID 连接使用 sso-oauth 名称空间.
使用本指南的考虑因素
在开始使用本指南之前,我们建议你首先审查以下内容: 关于IAM身份中心OIDC服务如何运作的重要信息.
-
IAM身份中心 OIDC 服务目前只执行 OAuth 2. 0 设备的部分 授权授予标准https://tools.ietf.org/html/rfc8628 (中文(简体) )),这是实现单一性所必需的 与 CLI 进行签名认证.
-
随着旧版本的CLI,服务只发布OIDC访问令牌,所以 获得新令牌,用户必须明确重新认证. 要访问 OIDC 流量 支持符号刷新并不需要重新认证, 更新到最新的 CLI 版本 (1.27.10 用于 CLI V1 和 2.9.0 用于 CLI V2), 支持 OIDC 令牌刷新 和可配置的IAM身份中心会期。 更多信息见 配置 Amazon 网络服务访问门户会话持续时间 。 。 。 .
-
该服务提供的访问符允许访问所有 Amazon 网络服务账户 指定给IAM身份中心用户的应享权利,而不仅仅是特定的应用程序.
-
本指南中的文档没有描述转换访问的机制 用于使用IAM保护的 Amazon 网络服务的 Auth (“sigv4”) 证书 结束点。 更多信息见 获取证书 输入 IAM 身份识别中心门户 API 参考 指南。 。 。 .
有关IAM身份中心的一般资料,见: 这是什么 IAM身份证中心? 输入 IAM 身份中心用户指南。 。 。 .
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-sso-oidcyarn add @aws-sdk/client-sso-oidcpnpm add @aws-sdk/client-sso-oidc
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 SSOOIDCClient 财务报告和审定财务报表
例如,您需要的命令 CreateTokenCommand数字 :
// ES5 example
const { SSOOIDCClient, CreateTokenCommand } = require("@aws-sdk/client-sso-oidc");
// ES6+ example
import { SSOOIDCClient, CreateTokenCommand } from "@aws-sdk/client-sso-oidc";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new SSOOIDCClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new CreateTokenCommand(params);
自动/等待
我们建议使用 等待时 运算符等待通过发送操作返回的承诺如下:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
承诺
您还可以使用 承诺连锁。 。 。 .
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
合并客户端
归集客户端类别从同套件中导出,但没有"Client"后缀.
SSOOIDC 扩展 SSOOIDCClient 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(SSOOIDCClient) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { SSOOIDC } from "@aws-sdk/client-sso-oidc";
const client = new SSOOIDC({ region: "REGION" });
// async/await.
try {
const data = await client.createToken(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.createToken(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.createToken(params, (err, data) => {
// process err and data.
});
解决问题
当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
另见 文档/错误。 。 。 .
获取帮助
请利用这些社区资源获得帮助. 我们使用 GitHub 问题来跟踪错误和特性请求,但处理它们的带宽有限.
- 访问 开发者指南 或者说 API 参考。 。 。 .
- 看看贴有标签的博客文章
aws-sdk-jsaWS 开发者博客. - 问个问题 叠叠流 并贴上标签
aws-sdk-js。 。 。 . - 加入 AWS JavaScript 社区 发光。 。 。 .
- 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .
为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .
捐款
此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-sso-oidc 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.