El federationSettings recurso te permite remover una federación y todos los datos asociados, incluidos los proveedores de identidad y los dominios que describe la federación.
Importante
Las solicitudes a este recurso fallan si hay más de una organización conectada en la federación.
URL base: https://cloud.mongodb.com/api/public/v1.0
Roles necesarios
Debes tener el rol Organization Owner en la última organización conectada para llamar a este endpoint.
Resource
DELETE /federationSettings/{FEDERATION-SETTINGS-ID}
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | string única de 24 dígitos hexadecimales que identifica la configuración de autenticación federada. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint. |
| ||||||
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Este endpoint no devuelve un cuerpo de respuesta.
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request DELETE "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}"
Respuesta de ejemplo
Este endpoint no devuelve un cuerpo de respuesta.