- 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.
Describe the specified identity provider from your federation settings.
To use this command, you must authenticate with a user account or an API key with the Org Owner role.
Syntax
atlas federatedAuthentication federationSettings identityProvider describe <identityProviderId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
identityProviderId | string | true | ID of the identityProvider. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--federationSettingsId | string | true | Unique 24-hexadecimal digit string that identifies the federation settings. |
-h, --help | false | help for describe | |
-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 DISPLAY NAME ISSUER URI CLIENT ID IDP TYPE <Id> <DisplayName> <IssuerUri> <ClientId> <IdpType>
Examples
# Describe the identity provider with ID aa2223b25a115342acc1f108 with federationSettingsId 5d1113b25a115342acc2d1aa. atlas federatedAuthentication federationSettings identityProvider describe aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa