公开预览版:请提供反馈:返回指定组织的一份待处理邀请的详细信息。
公共预览版: Atlas API子命令从MongoDB Atlas Admin API自动生成,全面覆盖 Admin API ,目前处于公共预览版(请通过以下网址提供反馈:https://反馈.mongodb.com/forums/930808-Atlas-cli)。Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。
要使用此资源,请求的服务账户或 API 密钥必须具有“组织所有者”角色。
注意:邀请管理 API 已弃用。使用返回一个组织中的一个 MongoDB Cloud 用户来返回待处理用户。
此命令是自动生成的,对应 1:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationinvitation 。
有关更多信息和示例,请参阅上面链接的参考API文档。
语法
atlas api organizations getOrganizationInvitation [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题,请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
-h,--help | false | getOrganizationInvitation 帮助 | |
--invitationId | 字符串 | true | 标识该邀请的唯一 24 位十六进制数字字符串。 |
--orgId | 字符串 | true | 唯一的 24-十六进制数字字符串,用于标识包含项目的组织。 使用 [/orgs](# 标签/Organizations/operation/listOrganizations) 端点检索身份验证的用户有权访问权限的所有组织。 |
-o, --output | 字符串 | false | 首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志 |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项:"2023-01-01"],默认为最新版本或配置文件 api_version 配置值(如果设立了此值),默认为 "2023-01-01"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
atlas api organizations getOrganizationInvitation --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61