Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/ / / /

取消指定单个项目中单个组织的 API 密钥

在此页面上

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

对该端点的所有请求都必须源自IP MongoDB Ops Manager用户的API 访问权限列表上的 解决。有关配置API访问权限列表的完整文档,请参阅需要为组织提供API访问列表。

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

DELETE /orgs/{PROJECT-ID}/apiKeys/{API-KEY-ID}
名称
类型
说明
PROJECT-ID
字符串
您希望从 API密钥取消分配的项目的唯一标识符。 使用/groups端点检索经过身份验证的用户有权访问权限的所有组织。
API-KEY-ID
字符串
要更新的API密钥的唯一标识符。 请求/groups/{PROJECT-ID}/apiKeys端点检索经过身份验证的用户有权访问的指定组织的所有API密钥。

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

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

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

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

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

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

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

此端点不使用 HTTP 请求正文参数。

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request DELETE "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/5d1d12c087d9d63e6d682438"
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}

此端点不返回响应正文。

后退

修改一个组织 API 密钥在一个项目中的角色