URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Roles necesarios
Su clave API debe tener la Global Owner rol para llamar a este recurso exitosamente.
Nota
Si usa una clave de API programática global para crear una organización, Ops Manager la crea sin Organization Owner un. Para agregar un,Organization Owner consulte Acceso a Ops Manager.
Solicitud
POST /orgs
Request Parameters
Parámetros de la ruta de solicitud
Este punto final no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
número de página | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
artículos por página | Número | Opcional | Número de artículos a devolver por página, hasta un máximo de 500. |
|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato. |
|
envolvente | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure Para los puntos finales que devuelven una lista de resultados, el objeto |
|
Parámetros del cuerpo de la solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| arreglo | Opcional | Requiere integración LDAP para Ops Manager. Matriz 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.roleName | string | Opcional | Rol de la organización de Ops Manager para asignar. Puede especificarlo de la siguiente lista:
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 | Grupo(s)LDAP que se asignan para asociarse |
| string | Requerido | Nombre de la organización que desea crear. |
Parámetros de respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único de la organización. |
| string | Nombre de la organización. |
Ejemplo de solicitud
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" }'
Ejemplo de respuesta
Encabezado de respuesta
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
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}
Cuerpo de respuesta
{ "id" : "{ORG-ID}", "name" : "myNewOrganization" }