Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

atlas federatedAuthentication federationSettings connectedOrgConfigs describe

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Describe a Connected Org Config.

Command Syntax
atlas federatedAuthentication federationSettings connectedOrgConfigs describe [options]
Name
Type
Required
Description

--federationSettingsId

string

true

Unique 24-hexadecimal digit string that identifies the federation settings.

-h, --help

false

help for describe

--orgId

string

false

Organization ID to use. This option overrides the settings in the configuration file or environment variable.

-o, --output

string

false

Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.

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.

# Describe a connected org config from the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa
atlas federatedAuthentication federationSettings connectedOrgConfigsConfig describe --federationSettingsId 5d1113b25a115342acc2d1aa
# Describe a connected org config from the org with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa
atlas federatedAuthentication federationSettings connectedOrgConfigs describe --orgId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa

Back

delete