返回所有项目邀请 | Atlas Admin API v2 文档 (2023-01-01)

返回所有项目邀请已弃用

获取 /api/atlas/v2/groups/{groupId}/invites

服务账户 DigestAuth

返回指定项目的所有待处理邀请。要使用此资源，请求的服务账户或 API 密钥必须具有“项目所有者”角色。

路径参数

groupId 字符串必需

用于标识项目的唯一 24-十六进制数字字符串。使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

格式应符合以下模式：^([a-f0-9]{24})$。

查询参数

envelope 布尔

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

默认值为false 。
pretty 布尔

指示响应正文是否应采用 prettyprint 格式的标记。

默认值为false 。

Prettyprint
用户名 string(电子邮件)

受邀参与此项目的用户帐户的电子邮件地址。

响应

200 application/vnd.atlas.2023-01-01+json

正常
隐藏响应属性显示响应属性对象
- createdAt string(date-time)
  
  MongoDB Cloud 发送邀请的日期和时间。此参数以 UTC 的 ISO 8601 格式表示其值。
- expiresAt string(date-time)
  
  MongoDB Cloud 使邀请过期的日期和时间。此参数以 UTC 格式的 ISO 8601 表示其值。
- groupId 字符串
  
  唯一的 24 位十六进制字符串，用于标识项目。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- groupName 字符串
  
  人类可读标签，用于标识您邀请MongoDB Cloud 用户加入的项目。
  
  格式应符合以下模式：^[\p{L}\p{N}\-_.(),:&@+']{1,64}$。
- id 字符串
  
  用于标识邀请的唯一 24-十六进制字符串。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- InviterUsername string(电子邮件)
  
  发送邀请的MongoDB Cloud 用户的电子邮件解决。
- 链接大量[对象]
  
  点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。
  
  Web 链接规范 (RFC 5988)
  
  隐藏链接属性显示链接属性对象
  
  href 字符串
  
  统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。
  
  rel 字符串
  
  统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。
- 角色 array[string]
  
  要分配给该 MongoDB Cloud 用户的一个或多个组织或项目级别角色。
  
  取值为 GROUP_BACKUP_MANAGER、GROUP_CLUSTER_MANAGER、GROUP_DATA_ACCESS_ADMIN、GROUP_DATA_ACCESS_READ_ONLY、GROUP_DATA_ACCESS_READ_WRITE、GROUP_DATABASE_ACCESS_ADMIN、GROUP_OBSERVABILITY_VIEWER、GROUP_OWNER、GROUP_READ_ONLY、GROUP_SEARCH_INDEX_EDITOR 或 GROUP_STREAM_PROCESSING_OWNER。
- 用户名 string(电子邮件)
  
  受邀加入项目的MongoDB Cloud 用户的电子邮件解决。
401 application/json

未经授权。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
403 application/json

Forbidden.
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
404 application/json

未找到。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
500 application/json

内部服务器错误。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。

GET /api/atlas/v2/groups/{groupId}/invites

atlas api projects listGroupInvites --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListGroupInvitesApiParams{}
	sdkResp, httpResp, err := client.ProjectsApi.
		ListGroupInvitesWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true"

响应示例 (200)

[
  {
    "createdAt": "2025-05-04T09:42:00Z",
    "expiresAt": "2025-05-04T09:42:00Z",
    "groupId": "32b6e34b3d91647abb20e7b8",
    "groupName": "string",
    "id": "32b6e34b3d91647abb20e7b8",
    "inviterUsername": "hello@example.com",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "roles": [
      "GROUP_BACKUP_MANAGER"
    ],
    "username": "hello@example.com"
  }
]

响应示例 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

响应示例 (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

响应示例 (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

响应示例 (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

返回所有项目邀请 已弃用

路径参数

查询参数

响应

返回所有项目邀请已弃用