Use esse endpoint para fazer qualquer uma das seguintes alterações em uma organização:
Altere o nome de uma organização.
Mapeie grupos LDAP para funções MongoDB 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 |
|---|---|---|
| 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 que indica se o corpo da resposta está em um formato pretty-print. |
|
envelope | booleano | Opcional | Sinalizador que indica se deve 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:
|
|
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 o Ops Manager apoiado por LDAP, os mapeamentos de grupos LDAP para roles de organização do Ops Manager. Aceito apenas para o Ops Manager apoiado por LDAP. |
Resposta
Nome | Tipo | Descrição |
|---|---|---|
| Identificador único da organização. | |
| array de documentos | Um ou mais links para sub-recursos e/ou recursos relacionados. A Especificação de links da web explica as relações entre URLs. |
| string | Novo nome da organização. |
| 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. |
| string | Role da organização do Ops Manager. Os valores possíveis incluem:
|
| array de strings | Grupos LDAP que mapeiam para a função 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
{ "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"] }]}