atlas api federatedAuthentication deleteIdentityProvider
On this page
experimental: Deletes one identity provider in the specified federation.
To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see Manage Organization Mapping for Federated Authentication. This command is invoking the endpoint with OperationID: 'deleteIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider
Syntax
atlas api federatedAuthentication deleteIdentityProvider [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--federationSettingsId | string | true | unique 24-hexadecimal digit string that identifies your federation |
-h, --help | false | help for deleteIdentityProvider | |
--identityProviderId | string | true | unique 24-hexadecimal digit string that identifies the identity provider to connect |
--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-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". |
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. |