atlas federatedAuthentication federationSettings connectedOrgConfigs update
On this page
Update One Org Config Connected to One Federation Setting.
Syntax
Command Syntax
atlas federatedAuthentication federationSettings connectedOrgConfigs update [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--federationSettingsId | string | true | Unique 24-hexadecimal digit string that identifies the federation settings. |
--file | string | true | Path to a JSON configuration file that defines connected orgs configurations. To learn more about connected org configuration file format, see the request body in https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig. |
-h, --help | false | help for update | |
--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. |
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
# Update the connected orgs config with the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa using the JSON configuration file config.json atlas federatedAuthentication federationSettings connectedOrgConfigs update --federationSettingsId 5d1113b25a115342acc2d1aa --file config.json