El federationSettings El recurso le permite eliminar 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 Organization Owner rol en la última organización conectada para llamar a este punto final.
Resource
DELETE /federationSettings/{FEDERATION-SETTINGS-ID}
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Cadena de dígitos hexadecimales 24única que identifica la configuración de autenticación federada. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
| ||||||
envolvente | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Este punto final no devuelve un cuerpo de respuesta.
Ejemplo de solicitud
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request DELETE "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}"
Ejemplo de respuesta
Este punto final no devuelve un cuerpo de respuesta.