Atlas 组织邀请 邀请
邀请指定的 MongoDB 用户加入您的组织。
要使用此命令，您必须使用具有“组织用户管理员”角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas organizations invitations invite <email> [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
电子邮件 | 字符串 | true | 属于您要邀请加入组织的用户的电子邮件地址。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-f, --file | 字符串 | false | 定义邀请设置的可选JSON配置文件的路径。 要学习；了解有关Atlas CLI邀请配置文件的更多信息，请参阅 https://XXX。 与 -- 角色, --teamId 互斥。 |
-h，--help | false | 邀请帮助 | |
--orgId | 字符串 | false | 要使用的组织 ID。 此选项会覆盖配置文件或环境变量中的设置。 |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
--role | 字符串 | false | 用户在关联组织中的角色。 有效值包括 ORG_OWNER、ORG_MEMBER、ORG_GROUP_CREATOR、ORG_BILLING_ADMIN 和 ORG_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 organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access: atlas organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json