Actualizar la configuración de una organización

PARCHE /api/atlas/v2/orgs/{orgId}/configuración

Actualiza la configuración de la organización. Para usar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de propietario de la organización.

Parámetros de ruta

  • orgId string Requerido

    Cadena 24hexadecimal única que identifica la organización que contiene sus proyectos. Utilice el /orgs punto de conexión para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

Parámetros de consulta

  • envolvente booleano

    Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

    El valor predeterminado es false.

  • bonita booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.

    El valor predeterminado es false.

    Impresión bonita
application/vnd.atlas.2023-01-01+json

Cuerpo Requerido

Detalles para actualizar la configuración de la organización especificada.

  • Lista de acceso a API requerida booleano

    Bandera que indica si se debe requerir que las operaciones de API se originen desde una dirección IP agregada a la lista de acceso de API para la organización especificada.

  • customSessionTimeouts Objeto

    Define la configuración del tiempo de espera de sesión para administrar las sesiones de usuario a nivel de organización. Si se establece como nulo, el valor del campo no se establece y se aplica la configuración de tiempo de espera predeterminada.

    Ocultar atributos customSessionTimeouts Mostrar atributos customSessionTimeouts Objeto
    • Tiempo de espera de sesión absoluto en segundos integer(int32)

      Especifica la duración absoluta del tiempo de espera de la sesión en segundos. Cuando se establece en null, el valor del campo se desactiva y se aplica el valor por defecto de 43,200 segundos (12 horas). Los valores aceptados están en un rango de un mínimo de 3,600 segundos (1 hora) y un máximo de 43,200 segundos (12 horas).

    • Tiempo de espera de sesión inactiva en segundos integer(int32)

      Especifica la duración del tiempo de espera de la sesión inactiva en segundos. Si se establece en nulo, el valor del campo no se establece y el comportamiento predeterminado depende del contexto: sin tiempo de espera para Atlas Commercial y 600 segundos (10 minutos) para Atlas for Government. Los valores aceptados comienzan con un mínimo de 300 segundos (5 minutos). Para Atlas Commercial, el valor máximo no puede superar el tiempo de espera absoluto de la sesión configurado. Para Atlas for Government, el valor máximo está limitado a 600 segundos (10 minutos).

  • Funciones genAI habilitadas booleano

    Indicador que indica si esta organización tiene acceso a funciones de IA generativa. Esta configuración solo se aplica a Atlas Commercial y está habilitada de forma predeterminada. Una vez activada, los propietarios de proyectos podrán habilitar o deshabilitar funciones de IA individuales a nivel de proyecto.

    El valor predeterminado es true.

    Preguntas frecuentes sobre IA generativa
  • Validez máxima del secreto de la cuenta de servicio en horas integer(int32)

    Número que representa el período máximo antes del vencimiento en horas para los nuevos secretos de la cuenta de servicio de API de administración de Atlas dentro de la organización especificada.

    El valor mínimo es 8, el valor máximo es 8760.

  • Autorización multifactor requerida booleano

    Marca que indica si se requiere que los usuarios configuren laautenticación multifactor (MFA) antes de acceder a la organización especificada. Para obtener más información, consulte: https://www.mongodb.com/es/docs/atlas/security-multi-factor-authentication/.

  • restringir el acceso de los empleados booleano

    Marca que indica si se debe impedir que el soporte técnico de MongoDB acceda a la infraestructura de Atlas y a los registros del clúster de cualquier implementación de la organización especificada sin permiso explícito. Una vez activada esta opción, puede otorgar 24al soporte técnico de MongoDB un acceso de omisión de horas a la implementación de Atlas para resolver problemas de soporte. Para obtener más información, consulte: https://www.mongodb.com/es/docs/atlas/security-restrict-support-access/.

  • Contacto de seguridad string

    Cadena que especifica una única dirección de correo electrónico para que la organización especificada reciba notificaciones relacionadas con la seguridad. Especificar un contacto de seguridad no le otorga autorización ni acceso a Atlas para tomar decisiones o aprobaciones de seguridad. Una cadena vacía es válida y borra el contacto de seguridad existente (si lo hay).

  • streamsCrossGroupEnabled booleano

    Bandera que indica si los espacios de trabajo de Atlas Stream Processing de un grupo en esta organización pueden crear conexiones con los clústeres de otros grupos en la misma organización.

Respuestas

  • 200 application/vnd.atlas.2023-01-01+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Lista de acceso a API requerida booleano

      Bandera que indica si se debe requerir que las operaciones de API se originen desde una dirección IP agregada a la lista de acceso de API para la organización especificada.

    • customSessionTimeouts Objeto

      Define la configuración del tiempo de espera de sesión para administrar las sesiones de usuario a nivel de organización. Si se establece como nulo, el valor del campo no se establece y se aplica la configuración de tiempo de espera predeterminada.

      Ocultar atributos customSessionTimeouts Mostrar atributos customSessionTimeouts Objeto
      • Tiempo de espera de sesión absoluto en segundos integer(int32)

        Especifica la duración absoluta del tiempo de espera de la sesión en segundos. Cuando se establece en null, el valor del campo se desactiva y se aplica el valor por defecto de 43,200 segundos (12 horas). Los valores aceptados están en un rango de un mínimo de 3,600 segundos (1 hora) y un máximo de 43,200 segundos (12 horas).

      • Tiempo de espera de sesión inactiva en segundos integer(int32)

        Especifica la duración del tiempo de espera de la sesión inactiva en segundos. Si se establece en nulo, el valor del campo no se establece y el comportamiento predeterminado depende del contexto: sin tiempo de espera para Atlas Commercial y 600 segundos (10 minutos) para Atlas for Government. Los valores aceptados comienzan con un mínimo de 300 segundos (5 minutos). Para Atlas Commercial, el valor máximo no puede superar el tiempo de espera absoluto de la sesión configurado. Para Atlas for Government, el valor máximo está limitado a 600 segundos (10 minutos).

    • Funciones genAI habilitadas booleano

      Indicador que indica si esta organización tiene acceso a funciones de IA generativa. Esta configuración solo se aplica a Atlas Commercial y está habilitada de forma predeterminada. Una vez activada, los propietarios de proyectos podrán habilitar o deshabilitar funciones de IA individuales a nivel de proyecto.

      El valor predeterminado es true.

      Preguntas frecuentes sobre IA generativa
    • Validez máxima del secreto de la cuenta de servicio en horas integer(int32)

      Número que representa el período máximo antes del vencimiento en horas para los nuevos secretos de la cuenta de servicio de API de administración de Atlas dentro de la organización especificada.

      El valor mínimo es 8, el valor máximo es 8760.

    • Autorización multifactor requerida booleano

      Marca que indica si se requiere que los usuarios configuren laautenticación multifactor (MFA) antes de acceder a la organización especificada. Para obtener más información, consulte: https://www.mongodb.com/es/docs/atlas/security-multi-factor-authentication/.

    • restringir el acceso de los empleados booleano

      Marca que indica si se debe impedir que el soporte técnico de MongoDB acceda a la infraestructura de Atlas y a los registros del clúster de cualquier implementación de la organización especificada sin permiso explícito. Una vez activada esta opción, puede otorgar 24al soporte técnico de MongoDB un acceso de omisión de horas a la implementación de Atlas para resolver problemas de soporte. Para obtener más información, consulte: https://www.mongodb.com/es/docs/atlas/security-restrict-support-access/.

    • Contacto de seguridad string

      Cadena que especifica una única dirección de correo electrónico para que la organización especificada reciba notificaciones relacionadas con la seguridad. Especificar un contacto de seguridad no le otorga autorización ni acceso a Atlas para tomar decisiones o aprobaciones de seguridad. Una cadena vacía es válida y borra el contacto de seguridad existente (si lo hay).

    • streamsCrossGroupEnabled booleano

      Bandera que indica si los espacios de trabajo de Atlas Stream Processing de un grupo en esta organización pueden crear conexiones con los clústeres de otros grupos en la misma organización.

  • 400 aplicación/json

    Solicitud incorrecta.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 429 aplicación/json

    Demasiadas solicitudes.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

PARCHE /api/atlas/v2/orgs/{orgId}/configuraciones
atlas api organizations updateOrgSettings --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231001001/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-10-01+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-10-01+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \
  -d '{ <Payload> }'
Solicitar ejemplos
{
  "apiAccessListRequired": true,
  "customSessionTimeouts": {
    "absoluteSessionTimeoutInSeconds": 42,
    "idleSessionTimeoutInSeconds": 42
  },
  "genAIFeaturesEnabled": true,
  "maxServiceAccountSecretValidityInHours": 42,
  "multiFactorAuthRequired": true,
  "restrictEmployeeAccess": true,
  "securityContact": "string",
  "streamsCrossGroupEnabled": true
}
Ejemplos de respuestas (200)
{
  "apiAccessListRequired": true,
  "customSessionTimeouts": {
    "absoluteSessionTimeoutInSeconds": 42,
    "idleSessionTimeoutInSeconds": 42
  },
  "genAIFeaturesEnabled": true,
  "maxServiceAccountSecretValidityInHours": 42,
  "multiFactorAuthRequired": true,
  "restrictEmployeeAccess": true,
  "securityContact": "string",
  "streamsCrossGroupEnabled": true
}
Ejemplos de respuestas (400)
{
  "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"
}
Ejemplos de respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "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"
}
Ejemplos de respuestas (429)
{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}