You were redirected from a different version of the documentation. Click here to go back.

Remove One Federation

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


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

Base URL:

Required Roles

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



Request Path Parameters

Name Type Description
FEDERATION-SETTINGS-ID string Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

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:

Name Description
status HTTP response code
envelope Expected response body

Request Body Parameters

This endpoint doesn’t use HTTP request body parameters.


This endpoint doesn’t return a response body.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --include \

Example Response

This endpoint doesn’t return a response body.