atlas federatedAuthentication federationSettings describe
On this page
Return the Federation Settings details for the specified organization.
To use this command, you must authenticate with a user account or an API key with the Organization Owner role.
Syntax
Command Syntax
atlas federatedAuthentication federationSettings describe [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-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. |
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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ID IDENTITY PROVIDER ID IDENTITY PROVIDER STATUS <Id> <IdentityProviderId> <IdentityProviderStatus>
Examples
# Return the JSON-formatted Federation Settings details: atlas federatedAuthentication federationSettings describe --orgId 5e2211c17a3e5a48f5497de3 --output json