atlas api databaseUsers updateDatabaseUser

--databaseName

$external

true

数据库用户进行身份验证所依据的数据库。数据库用户必须提供用户名和身份验证数据库才能日志MongoDB。如果用户使用Amazon Web Services IAM、x.509、 LDAP或 OIDC 工作负载进行身份验证，则此值应为 $external。 如果用户使用SCRAM-SHA 或 OIDC Workforce 进行身份验证，则此值应为 admin。

--envelope

envelope

false

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

--file

字符串

false

API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一，但不能同时提供两者。

--groupId

字符串

true

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

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

-h，--help

false

updateDatabaseUser 帮助

-o, --output

字符串

false

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

--outputFile

字符串

false

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

--pretty

false

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

--username

awsIAMType

true

人类可读标签，表示向 MongoDB 进行身份验证的用户。此标签的格式取决于身份验证方法：

身份验证方法 |所需参数 |参数值 |用户名格式 |

AWS IAM | awsIAMType | ROLE | <abbr title="Amazon Resource Name">ARN</abbr>
| AWS IAM | awsIAMType | USER | <abbr title="Amazon Resource Name">ARN</abbr>




| 509 | x. | x. | x. | x. x509Type | CUSTOMER | [RFC 2253]( https://tools.ietf.org/html/2253 ) 标识名 | 509 | x. | x. | x. | x。 x509Type | MANAGED | [RFC 2253]( https://tools.ietf.org/html/2253 ) 标识名 | LDAP | ldapAuthType | USER | [RFC 2253]( https://tools.ietf.org/html/2253 ) 标识名 | LDAP | ldapAuthType | GROUP | | [RFC 2253]( https://tools.ietf.org/html/2253 ) 标识名 | OIDC 劳动力 | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID （在联合设置中找到），后跟“/”，然后是 IdP群组名称 | OIDC 工作负载 | oidcAuthType | USER | Atlas OIDC IdP ID （可在联合设置中找到），后跟“/”，然后是 IdP 用户名 | SCRAM-SHA | awsIAMType、x509Type、ldapAuthType、oidcAuthType | NONE |字母数字字符串

|

--version

字符串

false

调用Atlas API端点时使用的API版本 [选项："2023-01-01"]。如果用户未设立，则默认为最新版本或配置文件的 api_version 配置值（如果设立）。该值默认为“2023-01-01”。