- Esta versão da documentação foi arquivada e não é mais suportada. Consulte adocumentação atual do para saber como atualizar sua versão da Atlas CLI.
Descreva o provedor de identidade especificado nas configurações da federação.
Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave API com o role Proprietário da organização.
Sintaxe
atlas federatedAuthentication federationSettings identityProvider describe <identityProviderId> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
identityProviderId | string | true | ID do identityProvider. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--federationSettingsId | string | true | string exclusiva de 24dígitos hexadecimais que identifica as configurações de federação. |
-h, --help | false | ajuda para descrever | |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
ID DISPLAY NAME ISSUER URI CLIENT ID IDP TYPE <Id> <DisplayName> <IssuerUri> <ClientId> <IdpType>
Exemplos
# Describe the identity provider with ID aa2223b25a115342acc1f108 with federationSettingsId 5d1113b25a115342acc2d1aa. atlas federatedAuthentication federationSettings identityProvider describe aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa