对于AI助手:文档索引位于 https://www.mongodb.com/zh-cn/docs/llms.txt — 通过将 .md 附加到任何URL路径,可以获得所有页面的降价版本。
Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
MongoDB Branding Shape
Click here >
Docs 菜单

atlas api mongoDbCloudUsers getGroupUser

返回指定项目上下文中指定 MongoDB Cloud 用户的信息。

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

注意:您只能使用此资源获取有关MongoDB Cloud 人类用户的信息。要返回有关API密钥的信息,请使用返回一个组织API密钥端点。

注意:此资源不会返回通过已弃用的“邀请一个MongoDB云用户加入一个项目”端点邀请的待处理用户的信息。

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

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

命令语法
atlas api mongoDbCloudUsers getGroupUser [options]
名称
类型
必需
说明

--envelope

envelope

false

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

--groupId

字符串

true

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

注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

-h,--help

false

getGroupUser 帮助

--orgMembershipStatuses

活跃的

false

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

-o, --output

字符串

false

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

--outputFile

字符串

false

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

--pretty

false

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

--userId

用户 ID

true

唯一的 24-十六进制数字字符串,用于标识项目中的待定用户或活动用户。如果您需要在组织中查找用户的 userId 或验证用户的状态,请使用“返回一个项目中的所有 MongoDB 云用户”资源并按 username 过滤。

--version

字符串

false

调用Atlas API端点时使用的API版本 [选项:"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 getGroupUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId]