Devolver LDAP o X.509 Configuración

OBTENER /api/atlas/v1.0/groups/{groupId}/userSecurity

Devuelve la configuración actual de LDAP para el proyecto especificado.

Requisitos del rol
  • Propietario del proyecto

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

    NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

    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
    • customerX509 Objeto

      Configuraciones para configurar certificados TLS para usuarios de bases de datos.

      Ocultar atributos de customerX509 Mostrar los atributos de customerX509 Objeto
      • cas string

        Lista concatenada de certificados de autoridad de certificación de clientes necesarios para autenticar a los usuarios de base de datos. MongoDB nube espera esto como un certificado en formato PEM.

    • ldap Objeto

      Detalles de configuración de Protocolo Ligero de Acceso a Directorios (LDAP) sobre Seguridad de la Capa de Transporte (TLS) que se aplican al proyecto específico.

      Ocultar atributos ldap Mostrar atributos de ldap Objeto
      • authenticationEnabled booleano

        Indicador que señala si los usuarios pueden autenticarse utilizando un host Lightweight Directory Access Protocol (LDAP).

      • authorizationEnabled booleano

        Bandera que indica si los usuarios pueden autorizar el acceso a los recursos de MongoDB Cloud utilizando un host de Protocolo Ligero de Acceso a Directorios (LDAP).

      • authzQueryTemplate string

        Plantilla de query Lightweight Directory Access Protocol (LDAP) que MongoDB Cloud ejecuta para obtener los grupos LDAP asociados al usuario autenticado. MongoDB nube utiliza este parámetro solo para la autorización de usuarios. Utiliza el marcador de posición {USER} en el Localizador Uniforme de Recursos (URL) para sustituir el nombre de usuario autenticado. La query está relacionada con el host especificado mediante el nombre del host. Da formato a esta query según RFC 4515 y RFC 4516.

        El valor por defecto es {USER}?memberOf?base.

      • bindUsername string

        Nombre distinguido completo (DN) del usuario de Protocolo ligero de acceso a directorios (LDAP) que MongoDB Cloud utiliza para conectarse al host LDAP. Los nombres distinguidos de LDAP deben estar formateados según la RFC 2253.

        El formato debe coincidir con el siguiente patrón: ^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$.

        RFC 2253
      • caCertificate string

        Certificado de la Autoridad de Certificación (CA) que MongoDB Nube utiliza para verificar la identidad del host de Protocolo Ligero de Acceso a Directorios (LDAP). MongoDB Cloud permite certificados autofirmados. Para borrar un valor asignado, pasa una string vacía: "caCertificate": "".

      • Nombre del host string

        Etiqueta legible por humanos que identifica el nombre de host o la dirección de Protocolo de Internet (IP) del host de Lightweight Directory Access Protocol (LDAP). Este host debe tener acceso a Internet o una conexión de emparejamiento Virtual Private Cloud (VPC) a tu clúster.

        El formato debe coincidir con el siguiente patrón: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$.

      • Puerto integer(int32)

        El puerto al que escucha el host del Protocolo de Acceso a Directorios Lightweights (LDAP) para conexiones de clientes.

        El valor por defecto es 636.

      • userToDNMapping arreglo[objeto]

        Mapa de usuario a nombre distinguido (DN) que MongoDB Cloud utiliza para transformar un nombre de usuario Lightweight Directory Access Protocol (LDAP) en un DN de LDAP.

        Ocultar atributos de userToDNMapping Mostrar atributos de userToDNMapping Objeto

        Mapa de usuario a nombre distinguido (DN) que MongoDB Cloud utiliza para transformar un nombre de usuario Lightweight Directory Access Protocol (LDAP) en un DN de LDAP.

        • ldapQuery string

          Plantilla de query del Protocolo Ligero de Acceso a Directorios (LDAP) que inserta el nombre LDAP que la expresión regular coincide en un Identificador Uniforme de Recursos (URI) de query LDAP. El formato de la consulta debe ajustarse a RFC 4515 y RFC 4516.

        • coincidencia string Requerido

          Expresión regular que MongoDB Cloud utiliza para comparar con el nombre de usuario proporcionado del Protocolo ligero de acceso a directorios (LDAP). Cada sección encerrada entre paréntesis representa un grupo de captura de expresión regular que utiliza la sustitución o la plantilla ldapQuery.

        • sustitución string

          Plantilla de nombre distinguido (DN) del protocolo Ligero de Acceso a directorios (LDAP) que convierte el nombre de usuario LDAP que coincide con la expresión regular en el parámetro match en un nombre distinguido (DN) de LDAP.

  • 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/groups/{groupId}/userSecurity
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/userSecurity' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuesta (200)
{
  "customerX509": {
    "cas": "string",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ]
  },
  "ldap": {
    "authenticationEnabled": true,
    "authorizationEnabled": true,
    "authzQueryTemplate": "{USER}?memberOf?base",
    "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
    "caCertificate": "string",
    "hostname": "string",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "port": 636,
    "userToDNMapping": [
      {
        "ldapQuery": "string",
        "match": "(.*)",
        "substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
      }
    ]
  },
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ]
}
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"
}