atlas API federatedAuthentication updateConnectedOrgConfig

O suporte do Atlas CLI para executar comandos com a API de administração do Atlas está em 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.

Visualização pública: forneça comentários: Atualiza a configuração de uma organização conectada a partir da federação especificada.

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 a chave de API solicitante deve ter a função proprietário da organização.

Aviso: se a configuração da organização não tiver um fornecedor de identidade associado, você não poderá usar esse recurso para atualizar mapeamentos de role ou publicar concessões de role de autorização.

Observação: o campo domainRestrictionEnabled fica definido como "false" por padrão se não for fornecido na solicitação.

Observação: se o campo identityProviderId não for fornecido, você desconectará a organização e o provedor de identidade.

Aviso: os fornecedores de identidade de acesso a dados conectados no momento que não estão no campo dataAccessIdentityProviderIDs serão desconectados.

Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation/update-connectedorgconfig.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe

Sintaxe do comando

atlas api federatedAuthentication updateConnectedOrgConfig [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.
--file	string	false	caminho para seu arquivo de solicitação de API. Deixe vazio para usar a entrada padrão - você deve fornecer um ou outro, mas não ambos.
-h, --help		false	ajuda para updateConnectedOrgConfig
--orgId	string	true	String exclusiva de 24 dígitos hexadecimais que identifica a configuração da organização conectada que será atualizada.
-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.