更新一个组织
使用此端点可对一个组织进行以下任何更改：
更改一个组织的名称。
将一个组织的个LDAP群组映射到 Ops Manager 角色。
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /orgs/{ORG-ID}
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
ORG-ID | 字符串 | 组织的唯一标识符。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
您必须在请求正文中至少包含以下字段之一：
名称 | 类型 | 必要性 | 说明 |
|---|---|---|---|
名称 | 字符串 | Optional | 组织的新名称。 |
ldapGroupMappings | 对象数组 | Optional | 对于LDAP支持的MongoDB Ops Manager ， LDAP群组到MongoDB Ops Manager组织角色的映射。 仅接受LDAP支持的MongoDB Ops Manager 。 |
响应
名称 | 类型 | 说明 |
|---|---|---|
id | 组织的唯一标识符。 | |
links | 文档数组 | 指向子资源和/或相关资源的一个或多个链接。 URL 之间的关系在 Web 链接规范 中进行了解释 。 |
name | 字符串 | 组织的新名称。 |
ldapGroupMappings | 对象数组 | 对于LDAP-backed Ops Manager，这是LDAP groups到 Ops Manager 组织角色的映射。仅适用于支持 LDAP 的 Ops Manager。 |
ldapGroupMappings .roleName | 字符串 | Ops Manager 组织角色。可能的值包括：
|
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" }'
响应示例
1 { 2 "id": "{ORG-ID}", 3 "links": [{ 4 "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}", 5 "rel": "self" 6 }, 7 { 8 "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/groups", 9 "rel": "http://mms.mongodb.com/groups" 10 }, 11 { 12 "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/teams", 13 "rel": "http://mms.mongodb.com/teams" 14 }, 15 { 16 "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/users", 17 "rel": "http://mms.mongodb.com/users" 18 } 19 ], 20 "name": "Organization Name 1", 21 "ldapGroupMappings": [{ 22 "roleName": "ORG_OWNER", 23 "ldapGroups": ["org-owner"] 24 }] 25 }