@aws-sdk/ 客户身份识别- 提供者

说明

JavaScript CignitiontoIDentity的 AWS SDK 为Node.js 提供客户端,浏览器和React Industrial.

有了Amazon Cognitto用户池 API,您可以配置用户池并认证用户. 改为: 在此 API 中认证第三方身份提供者的用户, 您可以 链接 IdP 用户与本地用户配置。学习更多 关于联邦用户的认证和授权 通过第三方添加用户池登录 和在 用户池联合会端点和管理下的登录引用。 。 。 .

此 API 引用提供了 API 操作和对象类型的详细信息 在亚马逊 科尼奥多.

除了资源管理操作, Amazon Cognitto用户集合 API 还包括类 客户端和服务器端认证的操作和授权模式 用户。 您可以与 Amazon Cognitto 用户池 API 中的操作交互 接下来的题目.

1. 一个想要配置用户池,应用程序客户端,用户, 组合,或其他用户池函数.

2. 服务器侧应用, 像网络应用程序一样, 想要使用它的 Amazon Web 服务 管理、认证或授权用户的权限.

3. 一个客户端的应用程序,像一个移动应用程序, 想要做无认证 管理、认证或授权用户的请求.

更多信息见 了解API、OIDC和管理的登录页面 认证 输入 Amazon Cognitto 开发者指南。 。 。 .

通过您的 Amazon Web 服务 SDK, 您可以构建逻辑, 在每次使用中支持操作流量 此 API 的大小写。 您也可以直接向 REST API 请求 Amazon Cognito 用户池服务端点。以下链接可以启动您 与 CognitoIdentityProvider 支持的亚马逊网络服务SDKs中的客户端.

要从亚马逊网络服务SDK开始,看 在亚马逊网络服务上构建的工具例如,行动和设想,见 使用 Amazon Web 服务的 Amazon Cognito 身份提供者的代码示例 SDKs 软件。 。 。 .

安装

要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :

• npm install @aws-sdk/client-cognito-identity-provider
• yarn add @aws-sdk/client-cognito-identity-provider
• pnpm add @aws-sdk/client-cognito-identity-provider

开始

导入

AWS SDK由客户端和命令进行调制. 要发送请求,只需导入 CognitoIdentityProviderClient 财务报告和审定财务报表 例如,您需要的命令 ListDevicesCommand数字 :

// ES5 example
const { CognitoIdentityProviderClient, ListDevicesCommand } = require("@aws-sdk/client-cognito-identity-provider");

// ES6+ example
import { CognitoIdentityProviderClient, ListDevicesCommand } from "@aws-sdk/client-cognito-identity-provider";

使用量

发出请求:

• 以配置(如证书,区域)为客户端提供证据.
  • 见 文件/中心 用于配置细节.
  • 见 @aws- sdk/ 配置 附加选项.
• 以输入参数证明命令 .
• 打电话 send 操作客户端,以输入方式提供命令对象.

const client = new CognitoIdentityProviderClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListDevicesCommand(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"后缀.

CognitoIdentityProvider 扩展 CognitoIdentityProviderClient 并额外支持所有操作,服务员, 和活人作为方法. 这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.

如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(CognitoIdentityProviderClient) (中文(简体) ). 更多详情见博客文章: javaScript 的 AWS SDK 模块包。 。 。 .

import { CognitoIdentityProvider } from "@aws-sdk/client-cognito-identity-provider";

const client = new CognitoIdentityProvider({ region: "REGION" });

// async/await.
try {
  const data = await client.listDevices(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listDevices(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listDevices(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-js aWS 开发者博客.
• 问个问题 叠叠流 并贴上标签 aws-sdk-js。 。 。 .
• 加入 AWS JavaScript 社区 发光。 。 。 .
• 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .

为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .

捐款

此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-cognito-identity-provider 软件包正在更新. 为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .

许可证

此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.

客户端命令( 操作列表)