从组织的团队中删除指定用户。
公共预览版: Atlas API子命令从MongoDB Atlas Admin API自动生成,提供对 Admin API的全面覆盖,目前处于公共预览阶段(请通过以下网址提供反馈:https://反馈.mongodb.com/forum/930808-Atlas-cli)。Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。
要使用此命令,您必须使用具有“组织用户管理员”角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas teams users delete <userId> [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
用户 ID | 字符串 | true | 用于标识用户的唯一 24 位字符串。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--force | false | 指示在继续执行请求的操作之前是否跳过确认提示的标志。 | |
-h,--help | false | 删除帮助 | |
--orgId | 字符串 | false | 要使用的组织 ID。 此选项会覆盖配置文件或环境变量中的设置。 |
--teamId | 字符串 | true | 标识团队的唯一 24 位字符串。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
User '<Name>' deleted from the team
示例
# Remove the user with the ID 5dd58c647a3e5a6c5bce46c7 from the team with the ID 5f6a5c6c713184005d72fe6e for the organization with ID 5e2211c17a3e5a48f5497de3: atlas teams users delete 5dd58c647a3e5a6c5bce46c7 --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3