Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / /

atlas api mongoDbCloudUsers getOrganizationUser

公共预览版:请提供反馈:返回指定组织上下文中指定MongoDB Cloud 用户的信息。

The Atlas API子命令从MongoDB Atlas Admin API自动生成,提供对 Admin API的完整覆盖,目前处于公共预览阶段(请通过以下网址提供反馈:https://反馈.mongodb.com/forums/930808-Atlas-cli)。Admin API功能有自己的发布生命周期,您可以通过提供的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-getorganizationuser

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

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

--envelope

envelope

false

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

-h,--help

false

getOrganizationUser 帮助

--orgId

字符串

true

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

-o, --output

字符串

false

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

--outputFile

字符串

false

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

--pretty

false

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

--userId

字符串

true

唯一的 24 位十六进制数字字符串,用于标识组织中待处理或活跃用户。如果您需要查找用户的用户 ID 或验证用户在组织中的状态,请使用“返回一个组织中的所有 MongoDB Cloud 用户”资源,并按用户名进行过滤。

--version

字符串

false

进行API调用时要使用的API版本 [选项:"2025-02-19"],默认为最新版本或配置文件 api_version 配置值(如果设立了此值),默认为 "2025-02-19"。

名称
类型
必需
说明

-P, --profile

字符串

false

atlas api mongoDbCloudUsers getOrganizationUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId]

后退

createUser

在此页面上