atlas API federatedAuthentication listIdentityProviders

O suporte do Atlas CLI para executar comandos com o está em pré-visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

experimental: retorna todos os fornecedores de identidade com o protocolo fornecido e digita a federação especificada.

Se nenhum protocolo for especificado, somente fornecedores de identidade SAML serão retornados. Se nenhum idpType for especificado, somente fornecedores de identidade da WORKFORCE serão retornados. Para usar esse recurso, a chave de API solicitada deve ter a função "Proprietário da organização" em uma das organizações conectadas. Este comando está invocando o endpoint com OperationID: 'listIdentityProviders'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders

Sintaxe

Sintaxe do comando

atlas api federatedAuthentication listIdentityProviders [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--envelope		false	sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope
--federationSettingsId	string	true	string exclusiva de dígitos hexadecimais 24que identifica sua federação
-h, --help		false	ajuda para listIdentityProviders
--idpType	array de strings	false	os tipos de provedores de identidade de destino
--itemsPerPage	int	false	número de itens que a resposta retorna por página
--output	string	false	formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".
--output-file	string	false	no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip)
--pageNum	int	false	número da página que exibe o conjunto atual do total de objetos que a resposta retorna
--protocol	array de strings	false	os protocolos dos provedores de identidade de destino
--version	string	false	Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01".

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.

Voltar

listConnectedOrgConfigs

listRoleMappings