Docs Home

/ /

Organizaciones

Docs Home

/ /

Organizaciones y equipos

Organizaciones

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Organizaciones y equipos

Organizaciones

Crear una organización

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

Roles necesarios

Tu clave de API debe tener la Global Owner rol para llamar exitosamente a este recurso.

Nota

Si utilizas una clave API programática global para crear una organización, Ops Manager crea la organización sin un Organization Owner. Para agregar una Organization Owner, consulta Acceso de Ops Manager.

Solicitud

POST /orgs

Request Parameters

Parámetros de ruta de solicitud

Este endpoint no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediarlo, establezca `envelope : true` en la query. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Necesidad	Descripción
`ldapGroupMappings`	arreglo	Opcional	Requiere integración con LDAP para Ops Manager. Arreglo de documentos que especifican la asignación entre los Roles de la organización de Ops Manager y los Grupos LDAP. Si se especifica `ldapGroupMappings`, se requiere un mapeo para el rol `ORG_OWNER`.
`ldapGroupMappings` `.roleName`	string	Opcional	Rol de la organización de Ops Manager que se va a asignar. Se puede elegir de la siguiente lista: `ORG_READ_ONLY` `ORG_MEMBER` `ORG_OWNER` No se puede especificar un rol global, un rol de proyecto o un rol de administrador de facturación de la organización.
`ldapGroupMappings` `.ldapGroups`	arreglo	Opcional	LDAP grupo(s) que mapean para asociar con el `roleName`.
`name`	string	Requerido	Nombre de la organización que deseas crear.

Parámetros de respuesta

Nombre	Tipo	Descripción
`id`	string	Identificador único para la organización.
`name`	string	Nombre de la organización.

Solicitud de ejemplo

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

Respuesta de ejemplo

Encabezado de respuesta

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}

Respuesta del cuerpo

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

Volver

Obtener todos los usuarios

Renombrar organización