创建一个组织

在此页面上

所需角色

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

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

所需角色

您的API密钥必须具有 Global Owner角色才能成功调用此资源。

注意

如果您使用全局编程 API 密钥创建组织，Ops Manager 将创建没有Organization Owner的组织。要添加Organization Owner ，请参阅Ops Manager 访问权限。

请求

POST /orgs

请求参数

请求路径参数

此端点不使用 HTTP 请求路径参数。

请求查询参数

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

名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用 prettyprint 格式的标志格式。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点， `content`对象是一个信封。 Ops Manager 将`status`字段添加到响应正文。	`false`

请求正文参数

名称	类型	必要性	说明
`ldapGroupMappings`	阵列	Optional	Ops Manager 需要LDAP集成。指定MongoDB Ops Manager组织角色和LDAP群组之间映射的文档数组。如果指定`ldapGroupMappings` ，则需要`ORG_OWNER`角色的映射。
`ldapGroupMappings` `.roleName`	字符串	Optional	要映射的 Ops Manager 组织角色。可以从以下列表中指定： `ORG_READ_ONLY` `ORG_MEMBER` `ORG_OWNER` 您不能指定全局角色、项目角色或组织计费管理员角色。
`ldapGroupMappings` `.ldapGroups`	阵列	Optional	映射到关联到`roleName`的LDAP群组。
`name`	字符串	必需	要创建的组织名称。

响应参数

名称	类型	说明
`id`	字符串	组织的唯一标识符。
`name`	字符串	组织名称。

请求示例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request POST "https://{opsManagerHost}:{port}/api/public/v1.0/orgs" \
 --data
   '{ "name" : "myNewOrganization" }'

响应示例

响应标头

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}

响应体

{
  "id" : "{ORG-ID}",
  "name" : "myNewOrganization"
}

后退

获取所有组织用户

来年

更新一个组织