Docs 菜单
Docs 主页
/ /
MongoDB CLI
/ / / /

mongocli iam 项目邀请 邀请

在此页面上

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

邀请指定的 MongoDB 用户加入您的项目。

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

命令语法
mongocli iam projects invitations invite <email> [options]
名称
类型
必需
说明

电子邮件

字符串

true

属于您要邀请加入项目的用户的电子邮件地址。

名称
类型
必需
说明

-h,--help

false

邀请帮助

-o, --output

字符串

false

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

--projectId

字符串

false

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

--role

字符串

true

关联项目的用户角色。 有效值包括 GROUP_CLUSTER_MANAGER、GROUP_DATA_ACCESS_ADMIN、GROUP_DATA_ACCESS_READ_ONLY、GROUP_DATA_ACCESS_READ_WRITE、GROUP_OWNER、GROUP_READ_ONLY、GROUP_AUTOMATION_ADMIN、GROUP_BACKUP_ADMIN 和 GROUP_MONITORING_ADMIN。

--teamId

字符串

false

标识团队的唯一 24 位字符串。

名称
类型
必需
说明

-P, --profile

字符串

false

要从配置文件中使用的配置文件的名称。 要了解 MongoCLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-configuration-file。

# Invite the MongoDB user with the email user@example.com to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access:
mongocli iam projects invitations invite user@example.com --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json

后退

描述