- API >
- Public API Resources >
- Organizations and Teams >
- Organizations >
- Update One Organization
Update One Organization¶
On this page
Use this endpoint to make any of the following changes to one organization:
- Change one organization’s name.
- Map LDAP groups to Ops Manager roles for one organization.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
ORG-ID |
string | The unique identifier of the organization. |
Request Query Parameters¶
The following query parameters are optional:
Name | Type | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
pretty |
boolean | Flag indicating whether the response body should be in a prettyprint format. | false |
||||||
envelope |
boolean | Flag indicating 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 For endpoints that return one result, the response body includes:
|
false |
Request Body Parameters¶
You must include at least one of the following fields in the request body:
Name | Type | Necessity | Description |
---|---|---|---|
name | string | Optional | The new name for the organization. |
ldapGroupMappings | object array | Optional | For LDAP-backed Ops Manager, the mappings of LDAP groups to Ops Manager organization roles. Only accepted for LDAP-backed Ops Manager. |
Response¶
Name | Type | Description |
---|---|---|
id |
ObjectId | Unique identifier for the organization. |
links |
document array | One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
name |
string | New name of the organization. |
ldapGroupMappings | object array | For LDAP-backed Ops Manager, the mappings of LDAP groups to Ops Manager organization roles. Only present for LDAP-backed Ops Manager. |
ldapGroupMappings
.roleName
|
string | Ops Manager organization role. Possible values include:
|
ldapGroupMappings
.ldapGroups
|
string array | LDAP project(s) that map to the Ops Manager role. |