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

返回一个具有指定的用户唯一标识符的 MongoDB Cloud 用户账户的详细信息。

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

您无法使用此端点返回 API 密钥的相关信息。要返回有关 API 密钥的信息,请使用返回一个组织 API 密钥端点。您可以随时找回自己的用户账户。如果您是 MongoDB Cloud 组织或项目的所有者,还可以找回具有该组织或项目成员资格的任何用户的用户个人资料。要使用此资源,请求的服务账户或 API 密钥可以具有任何角色。

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

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

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

--envelope

envelope

false

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

-h,--help

false

getUser 帮助

-o, --output

字符串

false

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

--outputFile

字符串

false

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

--pretty

false

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

--userId

字符串

true

用于标识此用户的唯一的 24 位十六进制数字字符串。

--version

字符串

false

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

名称
类型
必需
说明

-P, --profile

字符串

false

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