公共预览版：请提供反馈：在指定项目中创建一个数据库用户。
公共预览版： Atlas API子命令从MongoDB Atlas Admin API自动生成，全面覆盖 Admin API ，目前处于公共预览版（请通过以下网址提供反馈：https://反馈.mongodb.com/forums/930808-Atlas-cli）。Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。
此 MongoDB Cloud 支持每个项目最多 100 个数据库用户。如果某个项目需要超过 100 个数据库用户，请联系支持部门。要使用此资源，请求的服务帐户或 API 密钥必须具有“项目所有者”角色、“项目图表管理员”角色、“项目流处理所有者”角色或“项目数据库访问管理员”角色。
1此命令是自动生成的，对应于:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2 /operation/operation-createdatabaseuser 。
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api databaseUsers createDatabaseUser [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--file | 字符串 | false | API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一，但不能同时提供两者。 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串。 使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。 注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。 |
-h，--help | false | createDatabaseUser 帮助 | |
-o, --output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pretty | false | 指示响应正文是否应采用 prettyprint 格式的标记。 | |
--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。 |
示例
AWS IAM 身份验证
创建以下文件并将其另存为 payload.json
{ "awsIAMType": "USER", "databaseName": "$external", "groupId": "32b6e34b3d91647abb20e7b8", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" }
创建 payload.json 后，在同一目录中运行以下命令。
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
LDAP 身份验证
创建以下文件并将其另存为 payload.json
{ "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", "ldapAuthType": "GROUP", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "CN=marketing,OU=groups,DC=example,DC=com" }
创建 payload.json 后，在同一目录中运行以下命令。
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
OIDC Workforce 联合身份验证
创建以下文件并将其另存为 payload.json
{ "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", "oidcAuthType": "IDP_GROUP", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "5dd7496c7a3e5a648454341c/sales" }
创建 payload.json 后，在同一目录中运行以下命令。
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
OIDC 工作负载联合身份验证
创建以下文件并将其另存为 payload.json
{ "databaseName": "$external", "groupId": "32b6e34b3d91647abb20e7b8", "oidcAuthType": "USER", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "5dd7496c7a3e5a648454341c/sales" }
创建 payload.json 后，在同一目录中运行以下命令。
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
SCRAM-SHA 身份验证
创建以下文件并将其另存为 payload.json
{ "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", "password": "changeme123", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "david" }
创建 payload.json 后，在同一目录中运行以下命令。
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
X509 身份验证
创建以下文件并将其另存为 payload.json
{ "databaseName": "$external", "groupId": "32b6e34b3d91647abb20e7b8", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "CN=david@example.com,OU=users,DC=example,DC=com", "x509Type": "CUSTOMER" }
创建 payload.json 后，在同一目录中运行以下命令。
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8