@ dynatrace-sdk/ 客户 - iam
身份与访问管理配置.
允许在平台内查看用户及其访问能力.
安装
npm install @dynatrace-sdk/client-iam
获得帮助
许可证
此 SDK 分布于 Apache 许可证,2.0版本,更多信息见LICENSE.
API 参考
最新版本SDK的API 完整参考文件也可在 Dynatrace 开发者。 。 。 .
用户和组
import { usersAndGroupsClient } from '@dynatrace-sdk/client-iam';
从组织级别获取主动用户
and Groups Client. Get Aactive User from Organization Level( 配置): 保证 <公共用户> 翻译:
从组织层面获取活跃用户
所需范围 : iam:用户:已读
授权基于调用用户对“ 级别类型” 和“ 级别编号” 相关账户的指派 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限
参数
| 名称 | 类型 | 说明 |
|---|
| 配置。 级别*必须 | 字符串 | “ 级别类型” 的标识符 。 最大允许长度为36. 为了衡算起见,使用其UUID. 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限 |
| 配置。 级别类型*必须 | 字符串 | 允许的值:账户、环境 |
| 配置( uuid)*必须 | 字符串 | 用户 UUID |
回返
| 返回类型 | 状态代码 | 说明 |
|---|
| 公共用户 | 200个 | 用户已成功获取 |
掷出
| 错误类型 | 错误消息 |
|---|
| 公众例外 | 缺少授权头或错误 。 QQ 执行用户不允许执行此动作 。 | 调用用户未分配到请求的账户, 或请求的环境未分配到指定用户的账户或不存在“ 级别标识” 的账户 |
| 公众例外 | 发出过多的请求 -- -- 请求被节制 |
代码示例
import { usersAndGroupsClient } from "@dynatrace-sdk/client-iam";
const data =
await usersAndGroupsClient.getActiveUserFromOrganizationalLevel(
{ levelType: "...", levelId: "...", uuid: "..." },
);
获取组织级的主动用户
and Groups Client.get Aactive Users For Organization Level(配置): 承诺 <用户公众响应> 翻译:
让组织一级的积极用户参与
所需范围 : iam:用户:已读
至少为其中一个参数提供值 : “ 部分字符串 ” 或 “ uuid ” .
如果提供了“ 部分 String” 和“ uuid” 两种查询参数, 则结果返回符合任何过滤标准的用户 .
归来用户先取名后取名.
授权基于调用用户对“ 级别类型” 和“ 级别编号” 相关账户的指派 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限
参数
| 名称 | 类型 | 说明 |
|---|
| 配置。 级别*必须 | 字符串 | “ 级别类型” 的标识符 。 最大允许长度为36. 为了衡算起见,使用其UUID. 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限 |
| 配置。 级别类型*必须 | 字符串 | 允许的值:账户、环境 |
| 配置. 页 | 编号 | 基于偏移的 Pugination - page. 默认值: 1. 要返回的页码 。 基于偏移的 PGination 无法使用基于 Cursor 的 PGination ! |
| 配置.page 键 | 字符串 | 以光标为基础的 Pagination - 页面键. 光标到下一页,包括页码和过滤值. 隐含的过滤值将被页面密钥属性所覆盖. 基于光标的 PGination 无法与 Offset 的 PGination 一起使用 ! 最大长度: 2000 |
| 配置.页面大小 | 编号 | 平分 - 页面大小. 默认值: 1000. 最低值:1. 最大值:1000
默认 : 1000
最小值 : 1 |
| 配置。 部分结构 | 字符串 | 过滤值 - 搜索其电子邮件中包含提供值的用户和其“名名”或“名名”以提供值开头的用户 。 最小长度:3. 最大长度:320 |
| 配置( uuid) | 矩阵 <字符串> 翻译: | 用户UUID列表. 过滤值 - 等于 。 允许多个值。 允许的最大尺寸: 25 |
回返
| 返回类型 | 状态代码 | 说明 |
|---|
| 用户公众响应 | 200个 | 成功获取组织一级的用户 |
掷出
| 错误类型 | 错误消息 |
|---|
| 公众例外 | 缺少授权头或错误 。 QQ 执行用户不允许执行此动作 。 | 调用用户未分配到请求的账户, 或请求的环境未分配到指定用户的账户或不存在“ 级别标识” 的账户 |
| 公众例外 | 发出过多的请求 -- -- 请求被节制 |
代码示例
import { usersAndGroupsClient } from "@dynatrace-sdk/client-iam";
const data =
await usersAndGroupsClient.getActiveUsersForOrganizationalLevel(
{ levelType: "...", levelId: "..." },
);
获取组织级的主动用户
and Groups Client. Get Aactive Users for Organization LevelPost(配置): 承诺 <用户公众响应> 翻译:
让组织一级的积极用户参与
所需范围 : iam:用户:已读
它需要提供包含用户UUID列表的请求正文或部分String.
如果两者都得到提供,则结果返回符合任何规定标准的用户.
归来用户先取名后取名.
授权基于调用用户对“ 级别类型” 和“ 级别编号” 相关账户的指派 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限
参数
| 名称 | 类型 | 说明 |
|---|
| 配置. 身体*必须 | 矩阵 <字符串> 翻译: | |
| 配置。 级别*必须 | 字符串 | “ 级别类型” 的标识符 。 最大允许长度为36. 为了衡算起见,使用其UUID. 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限 |
| 配置。 级别类型*必须 | 字符串 | 允许的值:账户、环境 |
| 配置. 页 | 编号 | 基于偏移的 Pugination - page. 默认值: 1. 要返回的页码 。 基于偏移的 PGination 无法使用基于 Cursor 的 PGination ! |
| 配置.page 键 | 字符串 | 以光标为基础的 Pagination - 页面键. 光标到下一页,包括页码和过滤值. 隐含的过滤值将被页面密钥属性所覆盖. 基于光标的 PGination 无法与 Offset 的 PGination 一起使用 ! 最大长度: 2000 |
| 配置.页面大小 | 编号 | 平分 - 页面大小. 默认值: 1000. 最低值:1. 最大值:1000
默认 : 1000
最小值 : 1 |
| 配置。 部分结构 | 字符串 | 过滤值 - 搜索其电子邮件中包含提供值的用户和其“名名”或“名名”以提供值开头的用户 。 最小长度:3. 最大长度:320 |
回返
掷出
| 错误类型 | 错误消息 |
|---|
| 公众例外 | 缺少授权头或错误 。 QQ 执行用户不允许执行此动作 。 | 调用用户未分配到请求的账户, 或请求的环境未分配到指定用户的账户或不存在“ 级别标识” 的账户 |
| 公众例外 | 发出过多的请求 -- -- 请求被节制 |
代码示例
import { usersAndGroupsClient } from "@dynatrace-sdk/client-iam";
const data =
await usersAndGroupsClient.getActiveUsersForOrganizationalLevelPost(
{ levelType: "...", levelId: "...", body: ["..."] },
);
获得可用服务用户
and Groups Client.get Available Services Users(配置): 保证 <搜索结果> 翻译:
从组织层面获取执行用户可以使用的主动服务用户
所需范围 : iam:服务用户:使用
环境层面的查询是在账户背景下执行的,因为环境和服务用户之间没有直接联系.
参数
| 名称 | 类型 | 说明 |
|---|
| 配置。 级别*必须 | 字符串 | “ 级别类型” 的标识符 。 最大允许长度为36. 为了衡算起见,使用其UUID. 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限 |
| 配置。 级别类型*必须 | 字符串 | 允许的值:账户、环境 |
| 配置. 页 | 编号 | 基于偏移的 Pugination - page. 默认值: 1. 要返回的页码 。 基于偏移的 PGination 无法使用基于 Cursor 的 PGination ! |
| 配置.page 键 | 字符串 | 以光标为基础的 Pagination - 页面键. 光标到下一页,包括页码和过滤值. 隐含的过滤值将被页面密钥属性所覆盖. 基于光标的 PGination 无法与 Offset 的 PGination 一起使用 ! 最大长度: 2000 |
| 配置.页面大小 | 编号 | 平分 - 页面大小. 默认值: 1000. 最低值:1. 最大值:1000
最小值 : 1 |
回返
| 返回类型 | 状态代码 | 说明 |
|---|
| 搜索结果 | 200个 | 由用户权限过滤的组织一级的主动服务用户成功获取 |
掷出
| 错误类型 | 错误消息 |
|---|
| 公众例外 | 缺少授权头或错误 。 QQ 执行用户不允许执行此动作 。 | “ 级别- id” 参数不存在 |
| 公众例外 | 发出过多的请求 -- -- 请求被节制 |
代码示例
import { usersAndGroupsClient } from "@dynatrace-sdk/client-iam";
const data =
await usersAndGroupsClient.getAvailableServiceUsers({
levelType: "...",
levelId: "...",
});
获取可视分组账户
用户和 Groups Client. 获得可视Groups for count( 配置): 承诺 <重新组合公众主义响应> 翻译:
从组织一级召集醒目的团体
所需范围 : iams:组:已读
为至少一个参数提供值 : “ 部分组名 ” 或 “ uuid ” .
如果提供了“ 部分组名” 和“ uuid” 两个查询参数, 则结果将是符合任何过滤标准的组 .
授权基于调用用户对“ 级别类型” 和“ 级别编号” 相关账户的指派 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限
参数
| 名称 | 类型 | 说明 |
|---|
| 配置。 级别*必须 | 字符串 | “ 级别类型” 的标识符 。 最大允许长度为36. 为了衡算起见,使用其UUID. 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限 |
| 配置。 级别类型*必须 | 字符串 | 允许的值:账户、环境 |
| 配置. 页 | 编号 | 基于偏移的 Pugination - page. 默认值: 1. 要返回的页码 。 基于偏移的 PGination 无法使用基于 Cursor 的 PGination ! |
| 配置.page 键 | 字符串 | 以光标为基础的 Pagination - 页面键. 光标到下一页,包括页码和过滤值. 隐含的过滤值将被页面密钥属性所覆盖. 基于光标的 PGination 无法与 Offset 的 PGination 一起使用 ! 最大长度: 2000 |
| 配置.页面大小 | 编号 | 平分 - 页面大小. 默认值: 1000. 最低值:1. 最大值:1000
默认 : 1000
最小值 : 1 |
| 配置。 部分组Name | 字符串 | 过滤值 - 包含 。 最小长度:3. 最大长度:320 |
| 配置( uuid) | 矩阵 <字符串> 翻译: | 团体UUID列表. 过滤值 - 等于 。 允许定义多个值。 允许的最大大小: 10 |
回返
掷出
| 错误类型 | 错误消息 |
|---|
| 公众例外 | 缺少“ 部分组名” 和“ uuid” 过滤值, 或值不符合要求 。 QQ 授权头缺失或错误 。 QQ 执行用户不允许执行此动作 。 | 调用用户未分配到请求的账户, 或请求的环境未分配到指定用户的账户或不存在“ 级别标识” 的账户 |
| 公众例外 | 发出过多的请求 -- -- 请求被节制 |
代码示例
import { usersAndGroupsClient } from "@dynatrace-sdk/client-iam";
const data =
await usersAndGroupsClient.getVisibleGroupsForAccount({
levelType: "...",
levelId: "...",
});
获取可查看的账户组
用户和 Groups Client. 获得可视Groups for Accounts( 配置): 承诺 <重新组合公众主义响应> 翻译:
从组织一级召集醒目的团体
所需范围 : iams:组:已读
它需要根据请求提供包含组类uids或部分组类列表的正文Name.
如果两者都得到提供,则结果小组将符合任何规定的标准.
授权基于调用用户对“ 级别类型” 和“ 级别编号” 相关账户的指派 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限
参数
| 名称 | 类型 | 说明 |
|---|
| 配置. 身体*必须 | 矩阵 <字符串> 翻译: | |
| 配置。 级别*必须 | 字符串 | “ 级别类型” 的标识符 。 最大允许长度为36. 为了衡算起见,使用其UUID. 对于环境的“级别类型”用户,必须指定对环境的账户,用户在这种环境中不需要任何权限 |
| 配置。 级别类型*必须 | 字符串 | 允许的值:账户、环境 |
| 配置. 页 | 编号 | 基于偏移的 Pugination - page. 默认值: 1. 要返回的页码 。 基于偏移的 PGination 无法使用基于 Cursor 的 PGination ! |
| 配置.page 键 | 字符串 | 以光标为基础的 Pagination - 页面键. 光标到下一页,包括页码和过滤值. 隐含的过滤值将被页面密钥属性所覆盖. 基于光标的 PGination 无法与 Offset 的 PGination 一起使用 ! 最大长度: 2000 |
| 配置.页面大小 | 编号 | 平分 - 页面大小. 默认值: 1000. 最低值:1. 最大值:1000
默认 : 1000
最小值 : 1 |
| 配置。 部分组Name | 字符串 | 过滤值 - 包含 。 最小长度:3. 最大长度:320 |
回返
掷出
| 错误类型 | 错误消息 |
|---|
| 公众例外 | 缺少“ 部分组名” 和“ uuid” 过滤值, 或值不符合要求 。 QQ 授权头缺失或错误 。 QQ 执行用户不允许执行此动作 。 | 调用用户未分配到请求的账户, 或请求的环境未分配到指定用户的账户或不存在“ 级别标识” 的账户 |
| 公众例外 | 发出过多的请求 -- -- 请求被节制 |
代码示例
import { usersAndGroupsClient } from "@dynatrace-sdk/client-iam";
const data =
await usersAndGroupsClient.getVisibleGroupsForAccountPost(
{ levelType: "...", levelId: "...", body: ["..."] },
);
类型
答错
反应约束异常
答错细节
错误 Throtling 响应
公众例外
公众除外
恢复组合公共
包含分解结果的收集
| 名称 | 类型 |
|---|
| 组Name*必须 | 字符串 |
| 类型*必须 | "LOCAL""ALL USERS""SCIM""赛马" |
| 乌伊德*必须 | 字符串 |
重新组合公众主义响应
| 名称 | 类型 | 说明 |
|---|
| 下一个PageKey | 字符串 | 请求下一页结果的密钥 |
| 结果 | 矩阵 <恢复组合公共> 翻译: | 包含分解结果的收集 |
| 总计 | 编号 | 记录总数 |
公共用户
包含分解结果的收集
用户公众响应
| 名称 | 类型 | 说明 |
|---|
| 下一个PageKey | 字符串 | 请求下一页结果的密钥 |
| 结果 | 矩阵 <公共用户> 翻译: | 包含分解结果的收集 |
| 总计 | 编号 | 记录总数 |
搜索结果
| 名称 | 类型 | 说明 |
|---|
| 下一个PageKey | 字符串 | 请求下一页结果的密钥 |
| 结果 | 矩阵 <服务用户Dto> 翻译: | 包含分解结果的收集 |
| 总计 | 编号 | 记录总数 |
服务用户Dto
包含分解结果的收集
数字
恢复组公共类型
⚠️ 折旧
使用字面值.
Enum 键
AllUsers | Local | Saml | Scim
关于 @dynatrace-sdk/client-iam 的常见问题
@dynatrace-sdk/client-iam 是什么？
身份与访问管理配置. 允许在平台内查看用户及其访问能力.
如何安装 @dynatrace-sdk/client-iam？
在项目目录运行 npm install @dynatrace-sdk/client-iam，或使用 pnpm add / yarn add / bun add。
@dynatrace-sdk/client-iam 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@dynatrace-sdk/client-iam 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require() 都可以使用，打包工具会自动选择合适的版本。
@dynatrace-sdk/client-iam 可以商用吗？
@dynatrace-sdk/client-iam 使用 Apache-2.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。
@dynatrace-sdk/client-iam 的下载量有多少？
根据 npm 官方下载统计，@dynatrace-sdk/client-iam 在 2026/10/13 – 2026/11/11 这 30 天内被下载 13,689 次，日均约 456 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@dynatrace-sdk/client-iam 还在维护吗？
最新版本 1.1.0 发布于 2026/11/12（1 天前）；至今共发布 2 个版本，其中过去 12 个月发布了 2 个；首次发布于 2026/02/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。