Visualização pública: forneça feedback em: Exclui um provedor de identidade na federação especificada.
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.
Aviso: as solicitações para este recurso falharão se o fornecedor de identidade tiver organizações conectadas. Antes de excluir um fornecedor de identidade, desconecte todas as organizações e confirme que nenhuma organização em sua conta utiliza este fornecedor de identidade. Para saber mais, consulte Gerenciar mapeamento da organização para a autenticação federada.
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/deleteIdentityProvider.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api federatedAuthentication deleteIdentityProvider [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 deleteIdentityProvider | |
--identityProviderId | string | true | String única de 24 dígitos hexadecimais que identifica o fornecedor de identidade a ser conectado. |
--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) |
--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
Execute o comando abaixo.
atlas api federatedAuthentication deleteIdentityProvider --version 2023-11-15 --envelope false --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8