公共预览版：请在以下位置提供反馈：从指定项目中删除一个数据库用户。
要使用此资源，请求的 API 密钥必须具有“项目所有者”角色、“项目流处理所有者”角色或“项目数据库访问管理员”角色。
此命令是自动生成的，对应于 1:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Database-Users/operation/deleteDatabaseUser.
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api databaseUsers deleteDatabaseUser [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--databaseName | $external | true | 数据库用户进行身份验证所依据的数据库。数据库用户必须提供用户名和身份验证数据库才能日志MongoDB。如果用户使用Amazon Web Services IAM、x.509、 LDAP或 OIDC 工作负载进行身份验证，则此值应为 $external。 如果用户使用SCRAM-SHA 或 OIDC Workforce 进行身份验证，则此值应为 |
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串。 使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。 注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。 |
-h，--help | false | deleteDatabaseUser 帮助 | |
--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> 格式。 | |
--username | 字符串 | true | 人类可读标签，表示向 MongoDB 进行身份验证的用户。此标签的格式取决于身份验证方法： Authentication Method | Parameter Needed | Parameter Value | username Format | ------| | Amazon Web Services IAM | awsIAMType |角色 | <abbr title="Amazon Resource Name">ARN</abbr> | | Amazon Web Services IAM | awsIAMType | USER | <abbr title="Amazon Resource Name">ARN</abbr> | | x.509 | x509类型 |客户 | [RFC 2253](https://tools.ietf.org/html/2253)标识名 | | | x.509 | x. | x. | x。 x509 类型 |托管 |2253 [RFC]( https://tools.ietf.org/html/2253 )标识名 | | LDAP | ldapAuthType | ldapAuthType USER | [RFC 2253](https://tools.ietf.org/html/2253)标识名 | | LDAP | ldapAuthType | ldapAuthType群组 |2253 [RFC]( https://tools.ietf.org/html/2253 )标识名 | | OIDC 劳动力 | oidcAuthType | oidcAuthType IDP_GROUP | Atlas OIDC IdP ID （在联合设置中找到），后跟“/”，然后是 IdP群组名称 | | OIDC 工作负载 | oidcAuthType | oidcAuthType USER | Atlas OIDC IdP ID （可在联合设置中找到），后跟“/”，然后是 IdP 用户名 | | SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType |无 |字母数字字符串 | |
--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 databaseUsers deleteDatabaseUser --version 2023-01-01 --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName