Atualize uma configuração de organização conectada a uma configuração de federação.
Visualização pública: o subcomando atlas api, 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 feedback em https://feedback.mongodb.com/ fóruns/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.
Sintaxe
atlas federatedAuthentication federationSettings connectedOrgConfigs update [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--federationSettingsId | string | true | string exclusiva de 24dígitos hexadecimais que identifica as configurações de federação. |
--file | string | true | Caminho para um arquivo de configuração JSON que define as configurações das organizações conectadas. Observação: os campos não suportados no arquivo JSON são ignorados. Para saber mais sobre o formato de arquivo de configuração da organização conectada, consulte o corpo da solicitação em https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation /updateConnectedOrgConfig. |
-h, --help | false | ajuda para atualização | |
--orgId | string | false | ID da organização a ser usada. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
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
# Update the connected orgs config with the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa using the JSON configuration file config.json atlas federatedAuthentication federationSettings connectedOrgConfigs update --federationSettingsId 5d1113b25a115342acc2d1aa --file config.json