Atlas 组织邀请更新
修改针对组织的指定待处理邀请的详细信息。
您可以使用邀请 ID 或用户的电子邮件地址来指定邀请。
要使用此命令,您必须使用具有“组织所有者”角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas organizations invitations update [invitationId] [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
invitationId | 字符串 | false | 标识邀请的唯一 24 位字符串。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
字符串 | false | 用户的电子邮件地址。 | |
-h,--help | false | 更新帮助 | |
--orgId | 字符串 | false | 要使用的组织 ID。 此选项会覆盖配置文件或环境变量中的设置。 |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
--role | 字符串 | true | 用户在关联组织中的角色。 有效值包括 ORG_OWNER、ORG_MEMBER、ORG_GROUP_CREATOR、ORG_BILLING_ADMIN 和 ORG_READ_ONLY。 传递此标志会替换先前存在的数据。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
Invitation <Id> updated.
示例
# Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: atlas organizations invitations update 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json
# Modify the invitation for the user with the email address user@example.com to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: atlas organizations invitations update --email user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json