Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos da API de administração do Ops Manager
/
Organizações e equipes
/
Organizações

Atualizar uma organização

Nesta página

  • Resource
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta

Use esse endpoint para fazer qualquer uma das seguintes alterações em uma organização:

  • Altere o nome de uma organização.

  • Mapeie gruposLDAP para roles do Ops Manager para uma organização.

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

Resource

PATCH /orgs/{ORG-ID}

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição
ORG-ID
string
O identificador exclusivo da organização.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default
pretty
booleano
Opcional
Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato.
false
envelope
booleano
Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição
Status
Código de resposta HTTP
envelope
Corpo de resposta esperado
false

Parâmetros do corpo da solicitação

Você deve incluir pelo menos um dos seguintes campos no corpo da solicitação:

Nome
Tipo
necessidade
Descrição
name
string
Opcional
O novo nome da organização.
ldapGroupMappings
array de objetos
Opcional
Para LDAPo apoiado MongoDB Ops Manager por , os mapeamentos de LDAP grupos para MongoDB Ops Manager funções da organização . Aceito somente para o MongoDB Ops Manager apoiado pelo LDAP.

Resposta

Nome
Tipo
Descrição
id
Identificador único da organização.
links
array de documentos
Um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web .
name
string
Novo nome da organização.
ldapGroupMappings
array de objetos
Para o Ops Manager apoiado por LDAP, os mapeamentos de grupos LDAP para roles de organização do Ops Manager. Presente apenas para o Ops Manager suportado por LDAP.
ldapGroupMappings
.roleName
string

Role da organização do Ops Manager. Os valores possíveis incluem:

  • ORG_OWNER

  • ORG_MEMBER

  • ORG_GROUP_CREATOR

  • ORG_READ_ONLY

ldapGroupMappings
.ldapGroups
array de strings
Projeto(s) LDAP que mapeiam para a role de Ops Manager.

Exemplo de solicitação

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

Exemplo de resposta

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}

Voltar

Criar uma organização

Próximo

Excluir uma organização