Visualização pública: forneça comentários: retorna um provedor de identidade na federação especificada pelo ID do fornecedor de identidade.
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 comentários em https://feedback.mongodb.com/forums/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 recurso, a conta de serviço ou chave de API solicitante deve ter a função de proprietário da organização em uma das organizações conectadas.
Este comando é gerado automaticamente e corresponde 1:1 ao ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation/getidentityprovider.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api federatedAuthentication getIdentityProvider [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 getIdentityProvider | |
--identityProviderId | string | true | String única que identifica o provedor de identidade a ser conectado. Se estiver usando uma versão da API anterior a 11-15-2023, use o ID legado 20-hexadecimal. Esse ID pode ser encontrado na aba Console de gerenciamento de federação > Provedores de identidade, clicando no ícone de informações na linha ID do IdP de um provedor de identidade configurado. Para todas as outras versões, use o ID de 24 dígitos hexadecimais. |
-o, --output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--outputFile | 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) |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-11-15"], 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-11a15". |
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
atlas api federatedAuthentication getIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8