- This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.
Connect an Identity Provider to an Organization.
Syntax
atlas federatedAuthentication federationSettings connectedOrgConfigs connect [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--federationSettingsId | string | true | Unique 24-hexadecimal digit string that identifies the federation settings. |
-h, --help | false | help for connect | |
--identityProviderId | string | true | Unique identifier of the identity provider. |
--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. |
--protocol | string | false | Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC". |
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
# Connect the current profile org to identity provider with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa atlas federatedAuthentication federationSettings connectedOrgConfigs connect --identityProviderId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa
# Connect the org with ID 7d1113b25a115342acc2d1aa to identity provider with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa atlas federatedAuthentication federationSettings connectedOrgConfigs connect --orgId 7d1113b25a115342acc2d1aa --identityProviderId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa