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

atlas dbusers 更新

在此页面上

  • 语法
  • 参数
  • 选项
  • 继承选项
  • 输出
  • 示例

修改项目中数据库用户的详细信息。

要使用此命令,您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。

命令语法
atlas dbusers update <username> [options]
名称
类型
必需
说明

用户名

字符串

true

要在 MongoDB database 中更新的用户名。

名称
类型
必需
说明

--authDB

字符串

false

身份验证数据库名称。 如果用户使用 Amazon Web Services IAM、x.509 或 LDAP 进行身份验证,则此值应为 $external。如果用户使用 SCRAM-SHA 进行身份验证,则此值应为 admin。

--desc

字符串

false

此数据库用户的描述。

-h,--help

false

更新帮助

-o, --output

字符串

false

输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。

-p, --password

字符串

false

数据库用户的密码。

--projectId

字符串

false

标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。

--role

字符串

false

用户的角色以及角色适用的数据库或collection。传递此标志会替换先前存在的数据。

--scope

字符串

false

该用户有权访问权限的集群数组。 传递此标志会替换先前存在的数据。

-u, --username

字符串

false

用于向 MongoDB 进行身份验证的用户名。

--x509Type

字符串

false

X. 509方法,用于对指定用户名进行身份验证。 有效值包括 NONE、MANAGED 和 CUSTOMER。 如果将其设置为 MANAGED,用户将使用 Atlas 托管的 X. 509证书进行身份验证。 如果将其设置为 CUSTOMER,则用户将使用自我管理的 X. 509证书进行身份验证。 此值默认为“NONE”。

名称
类型
必需
说明

-P, --profile

字符串

false

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

如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。

Successfully updated database user '<Username>'.
# Update roles for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas dbuser update myUser --role readWriteAnyDatabase --projectId 5e2211c17a3e5a48f5497de3
# Update scopes for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas dbuser update myUser --scope resourceName:resourceType --projectId 5e2211c17a3e5a48f5497de3

后退

名单