Configuración de devolución para una organización

OBTENER /api/atlas/v1.0/orgs/{orgId}/settings
Cuentas de servicio Autenticación Digest

Devuelve detalles sobre la configuración de la organización especificada.

Requisitos del rol
  • nodo de la organización

Parámetros de path

  • orgId string Requerido

    string única de 24dígitos hexadecimales que identifica la organización que contiene su proyectos. Utilice el /orgs endpoint 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 query

  • envelope booleano

    Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • bonito booleano

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

    El valor por defecto es false.

    pretty-print

Respuestas

  • 200 application/json

    OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • apiAccessListRequired booleano

      Indicador que señala si se requiere que las operaciones de la API se originen desde una dirección IP que haya sido agregada a la lista de acceso a la API para la organización especificada.

    • customSessionTimeouts Objeto

      Define la configuración de tiempo de espera de la sesión para gestionar las sesiones de usuario a nivel de organización. Cuando se establece en nulo, el valor del campo se desestablece y se aplican los ajustes por defecto de tiempo de espera.

      Ocultar atributos customSessionTimeouts Mostrar atributos de customSessionTimeouts Objeto
      • absoluteSessionTimeoutInSeconds 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).

      • idleSessionTimeoutInSeconds integer(int32)

        Especifica la duración del tiempo de espera de la sesión inactiva en segundos. Cuando se establece en null, el valor del campo se desactiva y el comportamiento por defecto depende del contexto: no hay tiempo de espera para Atlas Commercial y 600 segundos (10 minutos) para Atlas for Government. Los valores aceptados comienzan en un mínimo de 300 segundos (5 minutos). Para Atlas Commercial, el valor máximo no puede exceder el límite absoluto de tiempo de espera de sesión configurado. Para Atlas for gobierno, el valor máximo está limitado a 600 segundos (10 minutos).

    • genAIFeaturesEnabled booleano

      Indicador que señala si esta organización tiene acceso a funcionalidades de IA generativa. Esta configuración solo se aplica a Atlas Comercial y está habilitada por defecto. Una vez que se active esta configuración, los propietarios del Proyecto podrán activar o desactivar funcionalidades individuales de IA a nivel del Proyecto.

      El valor por defecto es true.

      Preguntas frecuentes sobre IA generativa
    • maxServiceAccountSecretValidityInHours integer(int32)

      Número que representa el periodo máximo antes de la caducidad 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.

    • multiFactorAuthRequired booleano

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

    • resstringirAccesoEmpleado booleano

      Indicador que señala si se debe impedir que el soporte de MongoDB acceda a la infraestructura de Atlas y a los registros de clúster de cualquier implementación en la organización especificada sin permiso explícito. Una vez que esta configuración esté activada, puedes otorgar a MongoDB Support un acceso de elusión de 24horas a la implementación de Atlas para resolver problemas de soporte. Para aprender más, consulta: https://www.mongodb.com/es/docs/atlas/security-restrict-support-access/.

    • securityContact string

      String 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 la toma de decisiones o aprobaciones de seguridad. Una string vacía es válida y borra el contacto de seguridad existente (si hay alguno).

    • 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.
  • 401 application/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
  • 403 application/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
  • 404 application/json

    No se ha encontrado.

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

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
  • 500 application/json

    Error interno del servidor.

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

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
GET /api/atlas/v1.0/orgs/{orgId}/settings 
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/settings' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuesta (200) 
{
  "apiAccessListRequired": true,
  "customSessionTimeouts": {
    "absoluteSessionTimeoutInSeconds": 42,
    "idleSessionTimeoutInSeconds": 42
  },
  "genAIFeaturesEnabled": true,
  "maxServiceAccountSecretValidityInHours": 42,
  "multiFactorAuthRequired": true,
  "restrictEmployeeAccess": true,
  "securityContact": "string",
  "streamsCrossGroupEnabled": true
}
Ejemplos de respuesta (401) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Ejemplos de respuesta (403) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Ejemplos de respuesta (404) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
Ejemplos de respuesta (500) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}