Retorne os detalhes das Configurações de federação da organização especificada.
Visualização pública: o subcomando atlas api, gerado automaticamente a partir da API de administração do MongoDB Atlas , oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/ fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave de API com a role Proprietário da organização.
Sintaxe
atlas federatedAuthentication federationSettings describe [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-h, --help | false | ajuda para descrever | |
--orgId | string | false | ID da organização a ser usada. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
-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 IDENTITY PROVIDER ID IDENTITY PROVIDER STATUS <Id> <IdentityProviderId> <IdentityProviderStatus>
Exemplos
# Return the JSON-formatted Federation Settings details: atlas federatedAuthentication federationSettings describe --orgId 5e2211c17a3e5a48f5497de3 --output json