公共预览版：请在以下位置提供反馈：返回具有指定的用户唯一标识符的一个MongoDB Cloud 用户帐户的详细信息。
您无法使用此终结点返回 API 密钥上的信息。要返回有关 API 密钥的信息，请使用返回一个组织 API 密钥终结点。您可以随时找回自己的用户帐户。如果您是 MongoDB Cloud 组织或项目的所有者，还可以找回具有该组织或项目成员资格的任何用户的用户个人资料。要使用此资源，请求的 API 密钥可以具有任何角色。
此命令是自动生成的，对应于 1:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/MongoDB-Cloud-Users/operation/getUser.
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api mongoDbCloudUsers getUser [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
-h，--help | false | getUser 帮助 | |
--output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pretty | false | 指示响应正文是否应位于 <a href=" https://en.wikipedia.org/wiki/Prettyprint "target="_blank" rel="noopener noreferrer">pretty-print</a> 格式。 | |
--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. |
示例
运行以下命令。
atlas api mongoDbCloudUsers getUser --version 2023-01-01 --envelope false --pretty false --userId [userId]