Navigation

Create an Organization

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

Resource

POST /orgs

Request Parameters

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

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 Description
ldapMapping Array of documents

Optional. Available for LDAP-backed Ops Manager only.

Array of documents that specify the mapping between the Ops Manager Organization Roles and the LDAP groups:

Note

If specifying ldapMapping, mapping for ORG_OWNER role is required.

  • roleName

    Ops Manager organization roles. Can specify from the following list:

    • ORG_READ_ONLY
    • ORG_MEMBER
    • ORG_OWNER

    You cannot specify a global role, group/project role, or an organization billing admin role mapping.

  • ldapGroups

    Array of strings. The LDAP group(s) that map to associate to the roleName.

name string The name of the organization you want to create.

Response

Name Description
id The unique identifier for the organization.
name The name of the organization.

Example Request

curl --user '{USERNAME}:{APIKEY}' --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}

Response Body

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