介绍
auth0-get-all-users 是一个可以使用 Node.js 调用 Auth0 API 获取用户列表的 npm 包。它支持以分页方式获取所有用户信息,同时提供了过滤和排序的功能。
安装
使用 npm 进行安装:
npm install auth0-get-all-users --save
或者使用 yarn 安装:
yarn add auth0-get-all-users
使用
认证
首先,需要在 Auth0 管理后台创建一个 非交互式客户端(Non Interactive Client),并在设定的 API 中将其添加到访问允许列表中。然后,使用如下代码获取你的 API 认证 Token:
const { auth } = require('auth0-get-all-users'); const token = auth({ domain: 'YOUR_AUTH0_DOMAIN', clientId: 'YOUR_NON_INTERACTIVE_CLIENT_ID', clientSecret: 'YOUR_NON_INTERACTIVE_CLIENT_SECRET', audience: 'https://YOUR_AUTH0_DOMAIN/api/v2/' });
获取用户列表
在获取用户信息之前,首先需要使用如下代码获取分页信息:
const { getPage } = require('auth0-get-all-users'); const page = getPage();
该函数会返回默认值,你可以根据需要对其进行修改:
getPage({ per_page: 100, // 每页显示的用户数量,默认为 50 page: 1, // 要获取的页码,默认为 0 include_totals: true // 是否返回用户总数,默认为 false });
然后,你可以使用如下代码获取用户列表:
-- -------------------- ---- ------- ----- - ----------- - - ------------------------------- ----- ----- - ----- ------------- ------- -------------------- -- ----- -- ------ ------------------- -- -- ----- ----- ----- -- ---- -- --- -- ------------- ----- --- -- ----- -- -- ------------- ----- --- -- --- -------------------
查询条件和排序
你可以使用 q 和 sort 参数来指定查询条件和排序规则。具体使用方式参见 Auth0 API 文档。
以下是一个示例:
-- -------------------- ---- ------- ----- - ------------ ------- - - ------------------------------- ----- ---- - --------- --------- ---- ----- -- --------------- ---- --- ----- ----- - ----- ------------- ------- -------------------- ------ ------------------- ----- ----- -- ---------------------- ----- ------------ --- -------------------
示例代码
-- -------------------- ---- ------- ----- - ------------ -------- ---- - - ------------------------------- ----- ----- - ------ ------- -------------------- --------- --------------------------------- ------------- ------------------------------------- --------- ----------------------------------- --- ----- ---- - --------- --------- ---- ----- -- --------------- ---- --- ----- ----- - ----- ------------- ------- -------------------- ------ ------------------- ----- ----- -- ---------------------- ----- ------------ --- -------------------
总结
auth0-get-all-users 是一个便捷的 Auth0 API 用户列表获取工具。通过本文介绍,你可以轻松地使用其实现用户列表的分页、过滤和排序等功能。同时也为你提供了一个完整的示例代码,让你可以更好地理解并掌握其使用方法。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600672693660cf7123b3670f