Docs Menu
Docs Home
/
MongoDB Cloud Manager
/ / /

Remove One Federation

On this page

  • Required Roles
  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response

The federationSettings resource allows you to remove one federation and all associated data, including the identity providers and domains that the federation describes.

Important

Requests to this resource fail if there is more than one connected organization in the federation.

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

You must have the Organization Owner role in the last connected organization to call this endpoint.

DELETE /federationSettings/{FEDERATION-SETTINGS-ID}
Name
Type
Description
FEDERATION-SETTINGS-ID
string
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

The following query parameters are optional:

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
false
envelope
boolean
Optional

Flag that indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

Name
Description
status
HTTP response code
envelope
Expected response body
false

This endpoint doesn't use HTTP request body parameters.

This endpoint doesn't return a response body.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--include \
--request DELETE "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}"

This endpoint doesn't return a response body.

← Remove One Role Mapping