Atlas 项目邀请
邀请指定的 MongoDB 用户加入您的项目。
要使用此命令，您必须使用具有项目用户管理员角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas 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。 |
--teamId | 字符串 | false | 标识团队的唯一 24 位字符串。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功，CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
User '<Username>' invited.
举例
# Invite the MongoDB user with the email user@example.com to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access: atlas projects invitations invite user@example.com --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json