- API >
- Cloud Manager Administration API Resources >
- Federated Authentication Configuration >
- Remove One Organization from One Federation
Remove One Organization from One Federation¶
On this page
The federationSettings
resource allows you to remove one
connected organization from the
specified federation.
Important
Requests to this endpoint fail if you attempt to remove the last organization from the specified federation.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Required Roles¶
You must have the Organization Owner
role to call this
endpoint.
Resource¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
FEDERATION-SETTINGS-ID |
string | Unique 24-hexadecimal digit string that identifies the federated authentication configuration. |
ORG-ID |
string | Unique 24-hexadecimal digit string that identifies the connected organization. |
Request Query Parameters¶
The following query parameters are optional:
Name | Type | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a prettyprint format. | 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:
|
false |
Request Body Parameters¶
This endpoint doesn’t use HTTP request body parameters.
Response¶
This endpoint doesn’t return a response body.
Example Request¶
Example Response¶
This endpoint doesn’t return a response body.