Docs 菜单

Docs 主页 → MongoDB Ops Manager

更新 API 密钥

在此页面上

  • 资源
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

资源

PATCH /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}

请求路径参数

名称
类型
说明
ORG-ID
字符串
要检索其 API 密钥的 组织 的唯一标识符。使用/orgs端点检索经过身份验证的用户有权访问的所有组织。
API-KEY-ID
字符串
要更新的API密钥的唯一标识符。 请求/orgs/{ORG-ID}/apiKeys端点检索经过身份验证的用户有权访问的指定组织的所有API密钥。

请求查询参数

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

名称
类型
说明
默认
pageNum
整型
页码（从 1 开始）。
1
itemsPerPage
整型
每页要返回的项目数，最多 500 个。
100
pretty
布尔
指示响应正文是否应采用 美观打印 格式。
false
envelope
布尔

指示是否要将响应封装在信封中。

某些API客户端无法访问HTTP响应标头或状态代码。 要修复此问题，请在查询中设置"envelope" : true 。

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

状态
HTTP 响应代码
envelope
预期响应正文

对于返回结果列表的端点， results对象是一个信封。 Ops Manager 将status字段添加到响应正文。

无

请求正文参数

名称
类型
必需/可选
说明
desc
字符串
Optional
密钥的描述。 此参数是可选的；但是，该请求必须包含desc参数或roles参数。 如果提供了desc ，则其长度必须介于 1 到 250 个字符之间。
roles
字符串数组
Optional

API密钥应具有的角色列表。 此参数是可选的；但是，该请求必须包含desc参数或roles参数。 如果提供了roles ，则必须至少列出一个角色，并且所有角色必须对组织有效。

组织角色包括：

API 中的角色价值
角色
ORG_OWNER
Organization Owner
ORG_MEMBER
Organization Member
ORG_GROUP_CREATOR
Organization Project Creator
ORG_READ_ONLY
Organization Read Only

响应

名称
类型
说明
id
字符串
API 密钥的唯一标识符
desc
字符串
API 密钥的描述
privateKey
字符串
已编辑 API 密钥的私钥
publicKey
字符串
API 密钥的公钥
roles
对象数组
API 密钥具有的角色
roles.{ENTITY-ID}
字符串
{ENTITY-ID}代表此角色适用的组织或项目。 可能的值为： orgId或groupId 。
roles.roleName
字符串

角色的名称。 users资源返回用户在 MongoDB Atlas 或 Ops Manager 中拥有的所有角色。 可能的值为：

  • 组织角色

    API 中的角色价值
    角色
    ORG_OWNER
    Organization Owner
    ORG_MEMBER
    Organization Member
    ORG_GROUP_CREATOR
    Organization Project Creator
    ORG_READ_ONLY
    Organization Read Only

  • 项目角色

    注意

    注意：群组和项目是同义词。

    • GROUP_OWNER

    • GROUP_READ_ONLY

    • GROUP_DATA_ACCESS_ADMIN

    • GROUP_DATA_ACCESS_READ_WRITE

    • GROUP_DATA_ACCESS_READ_ONLY

    • GROUP_AUTOMATION_ADMIN

    • GROUP_BACKUP_ADMIN

    • GROUP_MONITORING_ADMIN

    • GROUP_OWNER

    • GROUP_USER_ADMIN

请求示例

注意

发出请求的用户可以采用 {USERNAME}:{APIKEY} 或 {PUBLIC-KEY}:{PRIVATE-KEY} 格式。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \
  --data '{
    "desc" : "Updated |api| key description for test purposes",
    "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
  }'

响应示例

响应标头

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 200 OK
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}

响应体

{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
← 创建 API 密钥
删除一个 API 密钥 →

在此页面上