Create an Organization¶

On this page

Resource
Request Parameters
Response Parameters
Example Request
Example Response
- Response Header
- Response Body

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

Important

To create an organization, you must authenticate as an Ops Manager user. If you attempt to create an organization using API Key credentials instead of Ops Manager user credentials, Ops Manager returns the API_KEY_CANNOT_CREATE_ORG error.

Resource¶

copy

POST /orgs

Request Parameters¶

Request Path Parameters¶

This endpoint does not use HTTP request path parameters.

Request Query Parameters¶

The following query parameters are optional:

Name	Type	Description	Default
`pageNum`	number	One-based integer that returns a subsection of results.	`1`
`itemsPerPage`	number	Number of items to return per page, up to a maximum of 500.	`100`
`pretty`	boolean	Flag that indicates whether the response body should be in a prettyprint format.	`false`
`envelope`	boolean	Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set `envelope : true` in the query. For endpoints that return a list of results, the `results` object is an envelope. Ops Manager adds the `status` field to the response body.	`false`

Request Body Parameters¶

Name	Type	Necessity	Description
`ldapGroupMappings`	array	Optional	Requires LDAP integration for Ops Manager. Array of documents that specify the mapping between the Ops Manager Organization Roles and the LDAP groups: Note If specifying `ldapGroupMappings`, mapping for `ORG_OWNER` role is required.
`ldapGroupMappings` `.roleName`	string	Optional	Ops Manager organization role to map. Can specify from the following list: `ORG_READ_ONLY` `ORG_MEMBER` `ORG_OWNER` You cannot specify a global role, project role, or an organization billing admin role.
`ldapGroupMappings` `.ldapGroups`	array	Optional	LDAP group(s) that map to associate to the `roleName`.
`name`	string	Required	Name of the organization you want to create.

Response Parameters¶

Name	Type	Description
`id`	string	Unique identifier for the organization.
`name`	string	Name of the organization.

Example Request¶

copy

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" }'

Example Response¶

Response Header¶

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}

Response Body¶

copy

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

← Get All Organization Users Update One Organization →