Atualizar uma organização conectada

Nesta página

Funções obrigatórias

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

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.: O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

O recurso federationSettings permite a você atualizar uma organização conectada para uma configuração de autenticação federada.

URL base: https://cloud.mongodb.com/api/public/v1.0

Funções obrigatórias

Você deve ter o role Organization Owner para chamar esse endpoint.

Resource

PATCH /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
`FEDERATION-SETTINGS-ID`	string	String exclusiva de 24 dígitos hexadecimais que identifica a configuração da autenticação federada.
`ORG-ID`	string	String exclusiva de 24 dígitos hexadecimais que identifica a organização conectada.

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 da 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
`content`	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Nome	Tipo	necessidade	Descrição
`domainAllowList`	array	Opcional	Lista que contém os domínios aprovados a partir da qual os usuários da organização podem se conectar. Se você fornecer um campo `domainAllowList` na solicitação, a array fornecida substituirá o `domainAllowList` atual.
`domainRestrictionEnabled`	booleano	Obrigatório	Sinalizador que indica se a restrição de domínio está habilitada para a organização conectada.
`identityProviderId`	string	Obrigatório	String exclusiva de 20 dígitos hexadecimais que identifica o provedor de identidade associado à organização conectada. Se omitido ou se o valor for `null`, o MongoDB cloud desconectará a organização especificada por `orgId` do IdP.
`orgId`	string	Obrigatório	String exclusiva de 24 dígitos hexadecimais que identifica a organização conectada.
`postAuthRoleGrants`	array	Opcional	Lista que contém as roles padrão concedidas aos usuários que se autenticam por meio do IdP em uma organização conectada. Se você fornecer um campo `postAuthRoleGrants` na solicitação, a array fornecida substituirá o `postAuthRoleGrants` atual.
`roleMappings`	array	Opcional	Lista que contém os mapeamentos de role configurados nesta organização. Se você fornecer um campo `roleMappings` na solicitação, a array fornecida substituirá o `roleMappings` atual.

Resposta

Nome	Tipo	Descrição
`domainAllowList`	array	Lista que contém os domínios aprovados a partir da qual os usuários da organização podem se conectar.
`domainRestrictionEnabled`	booleano	Sinalizador que indica se a restrição de domínio está habilitada para a organização conectada. `userConflicts` retorna `null` quando `"domainRestrictionEnabled": false`.
`identityProviderId`	string	String exclusiva de 20 dígitos hexadecimais que identifica o provedor de identidade associado à organização conectada.
`orgId`	string	String exclusiva de 24 dígitos hexadecimais que identifica a organização conectada.
`postAuthRoleGrants`	array	Lista que contém as roles padrão concedidas aos usuários que se autenticam por meio do IdP em uma organização conectada.
`roleMappings`	array	Lista que contém os mapeamentos de role configurados nesta organização.
`userConflicts`	array	Lista que contém os nomes de usuário que não correspondem a nenhum domínio na lista de permissões. `userConflicts` retorna `null` quando `"domainRestrictionEnabled": false`.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}" \
     --data '
       {
         "domainRestrictionEnabled": false,
         "identityProviderId": "0oa7i0grsgbwJiIyw357",
         "orgId": "5df7a168f10fab3a149357fb",
         "roleMappings": [
           {
             "externalGroupName": "example",
             "id": "61e89721b827b56c845ff44c",
             "roleAssignments": [
               {
                 "groupId": null,
                 "orgId": "5df7a168f10fab3a149357fb",
                 "role": "ORG_OWNER"
               }
             ]
           }
         ]
       }'

Exemplo de resposta

{
  "domainAllowList": [],
  "domainRestrictionEnabled": false,
  "identityProviderId": "0oa7i0grsgbwJiIyw357",
  "orgId": "5df7a168f10fab3a149357fb",
  "postAuthRoleGrants": [
    "ORG_OWNER"
  ],
  "roleMappings": [
    {
      "externalGroupName": "example",
      "id": "61e89721b827b56c845ff44c",
      "roleAssignments": [
        {
          "groupId": null,
          "orgId": "5df7a168f10fab3a149357fb",
          "role": "ORG_OWNER"
        }
      ]
    }
  ],
  "userConflicts": null
}

Voltar

Organização de devolução

Remover organização