更新对您指定的 Cloud Manager 组织的一个待处理邀请。
所需角色
您可以使用Organization User Admin角色成功调用此端点。
Resource
基本 URL： https://cloud.mongodb.com/api/public/v1.0
PATCH /orgs/{ORG-ID}/invites请求路径参数
路径元素 | 类型 | 必要性 | 说明 |
|---|---|---|---|
ORG-ID | 字符串 | 必需 | 标识组织的唯一 24 位十六进制数字字符串。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式的标记。 |
|
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
|
|
请求正文参数
正文参数 | 类型 | 必要性 | 说明 |
|---|---|---|---|
角色 | 字符串数组 | 必需 | 要分配给受邀用户的 Cloud Manager角色。 如果用户接受邀请，Cloud Manager 则会为其分配这些角色。 重要提示： Cloud Manager会将邀请中的角色替换为您在此请求中提供的角色。 确保在此请求中包含要分配给用户的所有角色。 |
用户名 | 字符串 | 必需 | 要更新其邀请的用户的用户名。在 Cloud Manager 中，受邀用户的用户名是 Cloud Manager 向其发送邀请的电子邮件地址。 |
响应
名称 | 类型 | 说明 |
|---|---|---|
createdAt | 字符串 | Timestamp in ISO 8601 date and time format in UTC when Cloud Manager sent the invitation. |
expiresAt | 字符串 | 邀请过期时采用 ISO 8601 日期和时间格式（UTC 格式）的时间戳。 用户有 30 天的时间接受 Cloud Manager 项目邀请。 |
id | 字符串 | 标识该邀请的唯一 24 位十六进制数字字符串。 |
InviterUsername | 字符串 | 邀请用户名加入组织的 Cloud Manager 用户。 |
orgId | 字符串 | 标识组织的唯一 24 位十六进制数字字符串。 |
orgName | 字符串 | 组织名称。 |
角色 | 字符串数组 | 要分配给受邀用户的 Cloud Manager角色。 如果用户接受邀请，Cloud Manager 则会为其分配这些角色。 |
teamIds | 字符串数组 | 唯一的 24 位十六进制数字字符串，用于标识用户受邀加入的团队。 |
用户名 | 字符串 | Cloud Manager 向其发送邀请的电子邮件地址。 如果用户接受邀请，他们将使用此电子邮件地址作为 Cloud Manager 用户名。 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invites?pretty=true" \ --data ' { "roles": [ "ORG_OWNER" ], "username": "wyatt.smith@example.com" }'响应示例
响应标头
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}响应体
{ "createdAt": "2021-02-18T21:05:40Z", "expiresAt": "2021-03-20T21:05:40Z", "id": "{INVITATION-ID}", "inviterUsername": "admin@example.com", "orgId": "{ORG-ID}", "orgName": "{ORG-NAME}", "roles": [ "ORG_OWNER" ], "teamIds": [], "username": "wyatt.smith@example.com"}