返回所有组织 API 密钥

获取 /api/atlas/v1.0/orgs/{orgId}/apiKeys
服务账户 DigestAuth

返回指定组织的所有组织 API 密钥。 组织 API 密钥授予对组织的编程访问权限。您无法使用API密钥通过控制台登录MongoDB Cloud。

角色要求
  • 组织节点
编程 API 密钥。

路径参数

  • orgId 字符串 必需

    唯一的 24-十六进制数字 string，用于标识包含项目的组织。使用 /orgs 终结点检索经过身份验证的用户访问权限检索的所有组织。

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

查询参数

  • envelope 布尔

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

    默认值为false 。

  • includeCount 布尔

    指示MongoDB Cloud 是否计算响应的项目总数的标志。设立为 false 时， MongoDB Cloud 可能会跳过额外的计数操作。当计数可用而无需额外计算时，响应仍可能包括 totalCount。

    默认值为true 。

  • itemsPerPage 整型

    响应每页返回的列项数。

    最小值为 1，最大值为 500。默认值为 100。

  • pageNum 整型

    显示响应返回的当前总对象集的页面编号。

    最小值为 1。默认值为 1。

  • pretty 布尔

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

    默认值为false 。

    Prettyprint

响应

  • 200 application/json

    正常

    隐藏响应属性 显示响应属性 对象
    • 链接 大量[对象]

      点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。

      Web 链接规范 (RFC...
      隐藏链接属性 显示链接属性 对象
      • href 字符串

        统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

      • rel 字符串

        统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

    • 结果 大量[对象] 必需

      MongoDB Cloud 在完成此请求时提供的返回文档列表。

      隐藏结果属性 显示结果属性 对象

      编程API密钥的详细信息。

      • desc 字符串

        有人创建此组织 API 密钥时提供的目的或解释。

        最小长度为 1，最大长度为 250。

      • id 字符串

        唯一的 24-十六进制数字字符串，用于标识分配给该项目的组织API密钥。

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

      • 链接 大量[对象]

        点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。

        Web 链接规范 (RFC...
        隐藏链接属性 显示链接属性 对象
        • href 字符串

          统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

        • rel 字符串

          统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

      • privateKey 字符串

        为此组织API密钥返回经编辑的私钥。该密钥在首次创建时显示为未编辑。

      • publicKey 字符串

        为指定的组织API密钥设立的公用API密钥值。

        最小长度为 8，最大长度为 8。

      • 角色 大量[对象]

        包含API密钥所需角色的列表。您提供的所有角色必须对指定的项目或组织有效。每个请求必须至少包含一个有效角色。该资源会返回分配给该API密钥的所有项目和组织角色。

        隐藏角色属性 显示角色属性 对象

        MongoDB Cloud 用户的角色以及该角色适用的相应组织或项目。每个角色只能应用一个组织或一个项目，但不能同时应用于两者。

        MongoDB Cloud API密钥角色
        • groupId 字符串

          唯一的 24-十六进制数字字符串，用于标识此角色所属的项目。您可以为此参数或 orgId设立值，但不能在同一请求中同时为两者设置值。

          最小长度为 24，最大长度为 24。格式应符合以下模式：^([a-f0-9]{24})$。

        • orgId 字符串

          唯一的 24-十六进制数字 string，用于标识此角色所属的组织。您可以为此参数或 groupId设立值，但不能在同一请求中同时为两者设置值。

          最小长度为 24，最大长度为 24。格式应符合以下模式：^([a-f0-9]{24})$。

        • roleName 字符串

          人类可读标签，用于标识MongoDB Cloud 授予特定API密钥、 MongoDB Cloud 用户或MongoDB Cloud团队的权限集合。这些角色包括组织级角色和项目级角色。

          MongoDB Cloud 用户角色
    • 总计数 integer(int32)

      可用文档总数。当 includeCount设立为 false 时， MongoDB Cloud 可能会省略此值，或者在计数可用时返回该值，而无需额外计算。总数为估计值，可能不准确。

      最小值为 0。
  • 401 application/json

    未经授权。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串 | null

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 403 application/json

    Forbidden.

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串 | null

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 404 application/json

    未找到。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串 | null

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 500 application/json

    内部服务器错误。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串 | null

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
GET /API/Atlas/v1.0/orgs/{orgId}/apiKeys 
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/apiKeys' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
响应示例 (200) 
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "desc": "string",
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
      "publicKey": "zmmrboas",
      "roles": [
        {
          "groupId": "32b6e34b3d91647abb20e7b8",
          "orgId": "32b6e34b3d91647abb20e7b8",
          "roleName": "string"
        }
      ]
    }
  ],
  "totalCount": 42
}
响应示例 (401) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
响应示例 (403) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
响应示例 (404) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
响应示例 (500) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}