Utiliza este endpoint para realizar cualquiera de los siguientes cambios en una organización:
Cambiar el nombre de una organización.
Mapear grupos LDAP a roles de Ops Manager para una organización.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /orgs/{ORG-ID}Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | El identificador único de la organización. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Debe incluir al menos uno de los siguientes campos en el cuerpo de la solicitud:
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
Nombre | string | Opcional | El nuevo nombre de la organización. |
ldapGroupMappings | objeto arreglo | Opcional | Para el Ops Manager respaldado por LDAP, las asignaciones de grupos de LDAP a roles de organización en el Ops Manager. Solo se acepta para Ops Manager respaldado por LDAP. |
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| Identificador único para la organización. | |
| arreglo de documentos | Uno o más enlaces a sub-recursos y/o recursos relacionados. La Especificación de vinculación web explica las relaciones entre URL. |
| string | Nuevo nombre de la organización. |
| objeto arreglo | Para Ops Manager respaldado por LDAP, los mapeos de grupos LDAP a roles de organización de Ops Manager. Solo presente para Ops Manager respaldado por LDAP. |
| string | Rol de la organización en Ops Manager. Los valores posibles incluyen:
|
| arreglo de string | Grupos de LDAP que se asignan al rol de Ops Manager. |
Solicitud de ejemplo
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" }'Respuesta de ejemplo
{ "id": "{ORG-ID}", "links": [{ "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}", "rel": "self" }, { "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/groups", "rel": "http://mms.mongodb.com/groups" }, { "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/teams", "rel": "http://mms.mongodb.com/teams" }, { "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/users", "rel": "http://mms.mongodb.com/users" } ], "name": "Organization Name 1", "ldapGroupMappings": [{ "roleName": "ORG_OWNER", "ldapGroups": ["org-owner"] }]}