Atualizar configurações de uma organização
Atualiza as configurações da organização. Para usar este recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário da organização.
parâmetros de caminho
-
24String exclusiva de dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
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 consulta. 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.O valor padrão é
false. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
Detalhes para atualizar as configurações da organização especificada.
-
Sinalizador que indica se é necessário que as operações da API se originem de um endereço IP adicionado à lista de acesso à API para a organização especificada.
-
Sinalizador que indica se esta organização tem acesso a AI recursos IA generativa . Esta configuração só se aplica ao Atlas Commercial e está habilitada por padrão. Depois que essa configuração estiver ativada, os proprietários do projeto poderão ativar ou desativar AI recursos individuais de IA no nível do projeto .
O valor padrão é
true.Perguntas frequentes sobre IA generativa -
Número que representa o período máximo antes da expiração em horas para novos segredos de conta do Atlas Admin API Service na organização especificada .
O valor mínimo é
8, o valor máximo é8760. -
Sinalizador que indica se é necessário que os usuários definam a Autenticação Multifator (MFA) antes de acessar a organização especificada. Para saber mais, consulte: https://www.mongodb.com/pt-br/docs/atlas/security-multi-factor-authentication/.
-
Sinalizador que determina se deve bloquear o acesso da equipe de suporte do MongoDB à infraestrutura do Atlas e aos logs de cluster de qualquer sistema na organização especificada, sem permissão explícita. Depois que essa configuração estiver ativada, você poderá conceder 24ao Suporte do MongoDB um acesso de desvio de horas à implantação do Atlas para resolver problemas de suporte. Para saber mais, consulte: https://www.mongodb.com/pt-br/docs/atlas/security-restrict-support-access/.
-
string string que especifica um único endereço de e-mail para a organização especificada receber notificações relacionadas à segurança. A especificação de um contato de segurança não concede a ele autorização ou acesso ao Atlas para decisões ou aprovações de segurança. Uma string vazia é válida e limpa o contato de segurança existente (se houver).
-
Sinalizador que indica se as instâncias do Atlas Stream Processing de um grupo nessa organização podem criar conexões com os clusters de outros grupos na mesma organização.
atlas api organizations updateOrgSettings --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20231115001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.UpdateOrgSettingsApiParams{}
sdkResp, httpResp, err := client.OrganizationsApi.
UpdateOrgSettingsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-11-15+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-11-15+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \
-d '{ <Payload> }'{
"apiAccessListRequired": true,
"genAIFeaturesEnabled": true,
"maxServiceAccountSecretValidityInHours": 42,
"multiFactorAuthRequired": true,
"restrictEmployeeAccess": true,
"securityContact": "string",
"streamsCrossGroupEnabled": true
}{
"apiAccessListRequired": true,
"genAIFeaturesEnabled": true,
"maxServiceAccountSecretValidityInHours": 42,
"multiFactorAuthRequired": true,
"restrictEmployeeAccess": true,
"securityContact": "string",
"streamsCrossGroupEnabled": true
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}