npm 包 @hiroga/cognito-userpool-cli 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

@hiroga/cognito-userpool-cli 是一款基于 Node.js 的命令行工具，主要用于对 AWS Cognito User Pool 进行管理和操作。该工具提供了一系列的 CLI 命令，可以用于管理用户池的用户、客户端、域名、资源服务器等，是开发人员在开发身份认证和授权相关功能时的好帮手。

安装

使用 npm 包管理器进行安装。可以全局安装或者在项目中作为依赖进行安装。

全局安装：

npm install -g @hiroga/cognito-userpool-cli

项目依赖（在项目根目录下安装）：

npm install --save-dev @hiroga/cognito-userpool-cli

配置

在使用工具之前需要进行一些配置，主要是设置 AWS 访问密钥，以便工具可以访问 AWS 服务。你需要事先在 AWS IAM 中创建有读写权限的用户，并获得其 Access Key ID 和 Secret Access Key。

创建 ~/.aws/credentials 文件，并写入以下内容，将 Access Key ID 和 Secret Access Key 替换成你自己的：
```
[default]
aws_access_key_id=YOUR_ACCESS_KEY_ID
aws_secret_access_key=YOUR_SECRET_ACCESS_KEY
```
创建 ~/.aws/config 文件，并写入以下内容：
```
[default]
region=us-west-2
```
其中，us-west-2 是你的 AWS 区域。你可以根据实际情况进行修改。

使用

@hiroga/cognito-userpool-cli 提供了多个 CLI 命令，下面简单介绍几个常用命令的用法。

列出用户池中所有的用户

$ cognito-userpool-cli list-users --user-pool-id <USER_POOL_ID> --output json

这个命令可以列出指定用户池中的所有用户，并将结果输出为 JSON 格式。

其中，<USER_POOL_ID> 是你的用户池 ID。你可以在 AWS 管理控制台中找到它。

创建用户

$ cognito-userpool-cli create-user --user-pool-id <USER_POOL_ID> --username <USERNAME> --password <PASSWORD> --email <EMAIL_ADDRESS>

这个命令可以创建一个新的用户，并将它添加到指定的用户池中。其中，<USERNAME> 和 <PASSWORD> 是必填参数，<EMAIL_ADDRESS> 则是可选参数。

更改用户密码

$ cognito-userpool-cli change-password --user-pool-id <USER_POOL_ID> --username <USERNAME> --previous-password <OLD_PASSWORD> --proposed-password <NEW_PASSWORD>

这个命令可以修改指定用户的密码。

更改用户属性

$ cognito-userpool-cli update-user --user-pool-id <USER_POOL_ID> --username <USERNAME> --attributes "[{\"Name\":\"email\",\"Value\":\"<NEW_EMAIL_ADDRESS>\"}]"

这个命令可以修改指定用户的属性。你可以指定多个属性，每个属性使用 JSON 格式进行描述。

示例代码

下面是一段示例代码，演示如何使用 @hiroga/cognito-userpool-cli 列出指定用户池中的用户：

-- -------------------- ---- -------
----- -------- - ----------------------------------

----- --------- - -- -- -
  ----- ---------- - ----------
  ----- ---------- - -----------------
  ----- ---------- - -------

  ----- ------ - ------------------------------ ---------- -------------- ------------- -------- --------------- -
    ---- -
      -------------- -----------
    -
  ---
  ------ ------------------------------
--

在这个示例中，我们调用 cognito-userpool-cli 的 list-users 命令来获取用户列表，并将其解析为 JSON 格式。你可以基于此代码进行进一步开发，实现对用户池中用户的增删改查操作。

总结

@hiroga/cognito-userpool-cli 是一个十分实用的 AWS Cognito User Pool 管理工具，可以帮助开发人员快速实现身份认证和授权相关功能。在使用工具之前，我们需要进行配置，以便工具可以访问 AWS 服务。工具提供了多个 CLI 命令，可以用于管理用户池的用户、客户端、域名、资源服务器等。同时，你还可以基于示例代码进行进一步开发。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600672e50520b171f02e1dc5