Visualização pública: forneça comentários em: 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 provedores de identidade WORKFORCE serão retornados. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização em uma das organizações conectadas.
Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Autenticação/operation/listIdentityProviders.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api federatedAuthentication listIdentityProviders [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--envelope | envelope | false | Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta. |
--federationSettingsId | string | true | String exclusiva de 24 dígitos hexadecimais que identifica sua federação. |
-h, --help | false | ajuda para listIdentityProviders | |
--idpType | array de strings | false | Os tipos dos 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 dos objetos totais 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. |
Exemplos
Execute o comando abaixo.
atlas api federatedAuthentication listIdentityProviders --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --itemsPerPage 100 --pageNum 1