experimental: atualiza uma configuração da organização conectada a partir da federação especificada.
Para usar esse recurso, a chave de API solicitada deve ter a função "Proprietário da organização". Aviso: se a configuração da organização não tiver um provedor 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 está invocando o endpoint com OperationID: 'updateConnectedOrgConfig'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig
Sintaxe
atlas api federatedAuthentication updateConnectedOrgConfig [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--envelope | false | sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope | |
--federationSettingsId | string | true | string exclusiva de dígitos hexadecimais 24que identifica sua federação |
--file | string | false | caminho para o arquivo que contém o conteúdo da solicitação de API |
-h, --help | false | ajuda para updateConnectedOrgConfig | |
--orgId | string | true | string exclusiva de 24dígitos hexadecimais que identifica a configuração da organização conectada a ser atualizada |
--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-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. |