Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
项目和用户
/
项目

创建一个项目邀请

在此页面上

  • 所需角色
  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

检索指定 Cloud Manager 项目的一项待处理邀请的详细信息。

所需角色

您可以使用 Project User Admin角色成功调用此端点。

Resource

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

POST /groups/{GROUP-ID}/invites/{INVITATION-ID}

请求路径参数

路径元素
类型
必要性
说明

群组 ID（group ID）

字符串

必需

用于标识项目的唯一的 24 位十六进制数字字符串。

请求查询参数

以下查询参数为可选参数：

名称
类型
必要性
说明
默认

pretty

布尔

Optional

指示响应正文是否应采用 美观打印 的标志 格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称
说明

status

HTTP 响应代码

content

预期响应正文

false

请求正文参数

名称
类型
说明

角色

字符串数组

要分配给受邀用户的 Cloud Manager角色。

如果用户接受邀请，Cloud Manager 则会为其分配这些角色。

用户名

字符串

Cloud Manager 向其发送邀请的电子邮件地址。 如果接受此邀请，则用户将使用此电子邮件地址作为其 Cloud Manager 用户名。

响应

名称
类型
说明

createdAt

字符串

ISO8601 格式的时间戳 Cloud Manager 发送邀请时的日期和时间格式（ UTC 格式）。

expiresAt

字符串

ISO8601 格式的时间戳 邀请过期时的日期和时间格式（ UTC 格式）。

用户有 30 天的时间接受 Cloud Manager 项目邀请。

groupId

字符串

用于标识项目的唯一的 24 位十六进制数字字符串。

groupName

字符串

项目名称。

id

字符串

标识该邀请的唯一 24 位十六进制数字字符串。

InviterUsername

字符串

邀请用户名加入项目的 Cloud Manager 用户。

角色

字符串数组

要分配给受邀用户的 Cloud Manager角色。

如果用户接受邀请，Cloud Manager 则会为其分配这些角色。

用户名

字符串

Cloud Manager 向其发送邀请的电子邮件地址。

如果用户接受邀请，他们将使用此电子邮件地址作为 Cloud Manager 用户名。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/invites?pretty=true"

响应示例

响应标头

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

1{
2  "createdAt": "2021-02-18T18:51:46Z",
3  "expiresAt": "2021-03-20T18:51:46Z",
4  "groupId": "{GROUP-ID}",
5  "groupName": "group",
6  "id": "{INVITATION-ID}",
7  "inviterUsername": "admin@example.com",
8  "roles": [
9    "GROUP_OWNER"
10  ],
11  "username": "jane.smith@example.com"
12}

后退

删除用户

来年

删除邀请