atlas api federatedAuthentication deleteFederationApp
On this page
Public Preview: please provide feedback at: Deletes the federation settings instance and all associated data, including identity providers and domains.
To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api federatedAuthentication deleteFederationApp [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--federationSettingsId | string | true | Unique 24-hexadecimal digit string that identifies your federation. |
-h, --help | false | help for deleteFederationApp | |
--output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--output-file | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--version | string | false | api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Examples
atlas api federatedAuthentication deleteFederationApp --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e