Liste os fornecedores de identidade a partir das configurações da federação.
Visualização pública: o subcomando da API atlas, 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 API com o role Proprietário da organização.
Sintaxe
atlas federatedAuthentication federationSettings identityProvider list [options]
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 lista | |
--idpType | string | false | Tipo de provedor de identidade. Os valores válidos são WORKFORCE ou WORKLOAD. Este valor padrão é "WORKFORCE". |
--limit | int | false | Número de itens por página de resultados, até um máximo de 500. Se você tiver mais de 500 resultados, especifique a opção --page para alterar a página de resultados. Este valor é padronizado para 100. |
-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. |
--page | int | false | Número da página que especifica uma página de resultados. Este valor é padronizado como 1. |
--protocol | string | false | Protocolo usado para autenticar o usuário. O valor válido é OIDC ou SAML. Este valor padrão é "OIDC". |
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
# List the identity providers from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa and idpType WORKLOAD atlas federatedAuthentication federationSettings identityProvider list --federationSettingsId 5d1113b25a115342acc2d1aa --idpType WORKLOAD