Docs Home

/ /

Organizaciones

Docs Home

/ /

Organizaciones y equipos

Organizaciones

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Organizaciones y equipos

Organizaciones

Actualizar una organización

Utiliza este endpoint para realizar cualquiera de los siguientes cambios en una organización:

Cambiar el nombre de una organización.
Map GruposLDAP en 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 la ruta de solicitud

Nombre	Tipo	Descripción
`ORG-ID`	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 señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

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:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

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.
Asignaciones de grupos ldap	objeto arreglo	Opcional	Para el gestor de operaciones respaldado por LDAP, las asignaciones de Grupos LDAP para roles de organización de Ops Manager. Solo se acepta para Ops Manager con respaldo LDAP.

Respuesta

Nombre	Tipo	Descripción
`id`	ObjectId	Identificador único para la organización.
`links`	matriz de documentos	Uno o más enlaces a sub-recursos y/o recursos relacionados. Las relaciones entre las URL se explican en la Especificación de Enlaces Web.
`name`	string	Nuevo nombre de la organización.
`ldapGroupMappings`	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.
`ldapGroupMappings` `.roleName`	string	Rol de la organización en Ops Manager. Los valores posibles incluyen: `ORG_OWNER` `ORG_MEMBER` `ORG_GROUP_CREATOR` `ORG_READ_ONLY`
`ldapGroupMappings` `.ldapGroups`	arreglo de string	Grupos LDAP que se corresponden con el rol de Administrador de Operaciones.

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

1 {
2   "id": "{ORG-ID}",
3   "links": [{
4       "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}",
5       "rel": "self"
6     },
7     {
8       "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/groups",
9       "rel": "http://mms.mongodb.com/groups"
10     },
11     {
12       "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/teams",
13       "rel": "http://mms.mongodb.com/teams"
14     },
15     {
16       "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/users",
17       "rel": "http://mms.mongodb.com/users"
18     }
19   ],
20   "name": "Organization Name 1",
21   "ldapGroupMappings": [{
22     "roleName": "ORG_OWNER",
23     "ldapGroups": ["org-owner"]
24   }]
25 }

Volver

Crear organización

Eliminar organización

1	{
2	"id": "{ORG-ID}",
3	"links": [{
4	"href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}",
5	"rel": "self"
6	},
7	{
8	"href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/groups",
9	"rel": "http://mms.mongodb.com/groups"
10	},
11	{
12	"href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/teams",
13	"rel": "http://mms.mongodb.com/teams"
14	},
15	{
16	"href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/users",
17	"rel": "http://mms.mongodb.com/users"
18	}
19	],
20	"name": "Organization Name 1",
21	"ldapGroupMappings": [{
22	"roleName": "ORG_OWNER",
23	"ldapGroups": ["org-owner"]
24	}]
25	}