Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / / /

Atlas 组织邀请更新

修改针对组织的指定待处理邀请的详细信息。

公共预览版: Atlas API子命令从MongoDB Atlas Admin API自动生成,提供对 Admin API的全面覆盖,目前处于公共预览阶段(请通过以下网址提供反馈:https://反馈.mongodb.com/forum/930808-Atlas-cli)。Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。

您可以使用邀请 ID 或用户的电子邮件地址来指定邀请。

要使用此命令,您必须使用具有“组织所有者”角色的用户帐户或 API 密钥进行身份验证。

命令语法
atlas organizations invitations update [invitationId] [options]
名称
类型
必需
说明

invitationId

字符串

false

标识邀请的唯一 24 位字符串。

名称
类型
必需
说明

--email

字符串

false

用户的电子邮件地址。

-f, --file

字符串

false

定义邀请设置的可选JSON配置文件的路径。注意: JSON文件中不支持的字段将被忽略。

与角色互斥。

-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。 传递此标志会替换先前存在的数据。

与 --文件 互斥。

名称
类型
必需
说明

-P, --profile

字符串

false

如果命令成功,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

在此页面上