Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas api federatedAuthentication removeConnectedOrgConfig

On this page

  • Syntax
  • Options
  • Inherited Options

experimental: Removes one connected organization configuration from the specified federation.

To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. This command is invoking the endpoint with OperationID: 'removeConnectedOrgConfig'. 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/removeConnectedOrgConfig

Command Syntax
atlas api federatedAuthentication removeConnectedOrgConfig [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 removeConnectedOrgConfig

--orgId

string

true

unique 24-hexadecimal digit string that identifies the connected organization configuration to remove

--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".

Name
Type
Required
Description

-P, --profile

string

false

Back

listRoleMappings