Visualização pública: forneça comentários: Exclui a instância de configurações de federação e todos os dados associados, incluindo fornecedores de identidade e domínios.
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 na última organização conectada restante. Aviso: as solicitações para esse recurso falharão se houver mais de uma organização conectada na federação.
Este comando é gerado automaticamente e 1 corresponde:1 ao ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation/deletefederationapp .
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api federatedAuthentication deleteFederationApp [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--federationSettingsId | string | true | String exclusiva de 24 dígitos hexadecimais que identifica sua federação. |
-h, --help | false | ajuda para deleteFederationApp | |
-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-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
atlas api federatedAuthentication deleteFederationApp --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e