对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。

更新一个组织

使用此端点可对一个组织进行以下任何更改:

  • 更改一个组织的名称。

  • 将LDAP群组映射到一个组织的MongoDB Ops Manager角色。

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

PATCH /orgs/{ORG-ID}
名称
类型
说明

ORG-ID

字符串

组织的唯一标识符。

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

名称
类型
必要性
说明
默认

pretty

布尔

Optional

指示响应正文是否采用 pretty-print 格式的标志。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。

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

  • status: HTTP 响应代码

  • content:预期响应正文

false

您必须在请求正文中至少包含以下字段之一:

名称
类型
必要性
说明

名称

字符串

Optional

组织的新名称。

ldapGroupMappings

对象数组

Optional

对于LDAP-backed Ops Manager,这是LDAP groups到 Ops Manager 组织角色的映射。仅接受支持 LDAP 的 Ops Manager。

名称
类型
说明

id

组织的唯一标识符。

links

文档数组

指向子资源和/或相关资源的一个或多个链接。 Web 链接规范解释了 URL 之间的关系。

name

字符串

组织的新名称。

ldapGroupMappings

对象数组

对于LDAP-backed Ops Manager,这是LDAP groups到 Ops Manager 组织角色的映射。仅适用于支持 LDAP 的 Ops Manager。

ldapGroupMappings
.roleName

字符串

Ops Manager 组织角色。可能的值包括:

  • ORG_OWNER

  • ORG_MEMBER

  • ORG_GROUP_CREATOR

  • ORG_READ_ONLY

ldapGroupMappings
.ldapGroups

字符串数组

映射到Ops Manager角色的LDAP群组。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}?pretty=true" \ --data ' { "ldapGroupMappings": [{ "roleName": "ORG_OWNER", "ldapGroups": ["org-owner"] }] }, "name": "Organization Name 1" }'
{ "id": "{ORG-ID}", "links": [{ "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}", "rel": "self" }, { "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/groups", "rel": "http://mms.mongodb.com/groups" }, { "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/teams", "rel": "http://mms.mongodb.com/teams" }, { "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/users", "rel": "http://mms.mongodb.com/users" } ], "name": "Organization Name 1", "ldapGroupMappings": [{ "roleName": "ORG_OWNER", "ldapGroups": ["org-owner"] }]}