对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。

atlas api mongoDbCloudUsers listOrgUsers

返回与指定组织关联的待处理和活跃 MongoDB Cloud 用户的详细信息。

atlas api 子命令是从 MongoDB Atlas Admin API 自动生成的,并提供对 Admin API 的全面覆盖。Admin API功能有自己的发布生命周期,您可以通过提供的API终结点文档链接进行检查。

注意:此资源不能用于查看通过已弃用的邀请一位 MongoDB Cloud 用户加入一个项目终结点邀请的用户的详细信息。

注意:要返回待处理和活跃用户,请使用 v2-{2025-02-19} 或更高版本。如果使用的是弃用版本,则只会返回活跃用户。

此命令是自动生成的,对应 1:1 和Atlas API终结点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgusers.

有关更多信息和示例,请参阅上面链接的参考API文档。

命令语法

atlas api mongoDbCloudUsers listOrgUsers [options]
名称
类型
必需
说明

--envelope

envelope

false

指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题,请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。

-h,--help

false

listOrgUsers 帮助

--includeCount

false

false

标志,用于指示 MongoDB 云是否计算响应的列项总数。当设置为 false 时,MongoDB 云可能会跳过额外的计数操作。当计数无需额外计算即可用时,响应可能仍然包含 totalCount。

--itemsPerPage

int

false

响应每页返回的列项数。

--orgId

/orgs

true

唯一的 24-十六进制数字字符串,用于标识包含项目的组织。 使用 [/orgs](# 标签/Organizations/operation/listOrganizations) 端点检索身份验证的用户有权访问权限的所有组织。

--orgMembershipStatus

orgMembershipStatuses

false

已弃用:请改用 orgMembershipStatuses。用于过滤用户的组织成员资格状态。允许值:ACTIVE、PENDING、INVITATION_EXPIRED、INVITATION_REJECTED。如果排除此参数,此资源将返回 ACTIVE 和 PENDING 用户。已弃用版本不支持。

--orgMembershipStatuses

活跃的

false

用于过滤用户的组织成员资格状态。您可以多次提供此参数。允许值:ACTIVE、PENDING、INVITATION_EXPIRED、INVITATION_REJECTED。替换已弃用的 orgMembershipStatus 参数。如果排除此参数,此资源将返回 ACTIVE 和 PENDING 用户。不能与 orgMembershipStatus 结合使用。已弃用版本不予支持。

-o, --output

字符串

false

首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。

--outputFile

字符串

false

要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志

--pageNum

int

false

显示响应返回的当前总对象集的页面编号。

--pretty

false

指示响应正文是否应采用 prettyprint 格式的标记。

--username

字符串

false

用于过滤用户的电子邮件地址。已弃用版本不予支持。

--version

字符串

false

调用 Atlas API 终结点时要使用的 API 版本 [选项:"2023-01-01"、"2025-02-19"]。如果用户未设置,则默认为最新版本,或者如果已设置了配置文件的 api_version 值,则默认为该值。该值默认为 "2025-02-19"。

名称
类型
必需
说明

-P, --profile

字符串

false

要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

atlas api mongoDbCloudUsers listOrgUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE
给本页内容打分