Remover uma federação
Nesta página
- 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ê remover uma federação e todos os dados associados, incluindo os fornecedores de identidade e domínios que a federação descreve.
Importante
As solicitações para esse recurso falharão se houver mais de uma organização conectada na federação.
URL base: https://cloud.mongodb.com/api/public/v1.0
Funções obrigatórias
Você deve ter a função Organization Owner na última organização conectada para chamar esse endpoint.
Resource
DELETE /federationSettings/{FEDERATION-SETTINGS-ID}
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
| string | String exclusiva de 24 dígitos hexadecimais que identifica a configuração da autenticação federada. |
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. |
| ||||||
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:
|
|
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Este endpoint não retorna um corpo de resposta.
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request DELETE "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}"
Exemplo de resposta
Este endpoint não retorna um corpo de resposta.