Verifica la configuración de LDAP en un proyecto

publicación /api/atlas/v1.0/groups/{groupId}/userSecurity/ldap/verify

Verifica la configuración LDAP del proyecto especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de 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.

    Impresión bonita
aplicación/json

Cuerpo Requerido

La configuración LDAP para el proyecto especificado que deseas verificar.

  • Plantilla de consulta de autenticación string

    Plantilla de query Lightweight Directory Access Protocol (LDAP) que MongoDB Cloud aplica para crear una query LDAP que devuelva los grupos LDAP asociados al usuario autenticado de MongoDB. MongoDB Cloud 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 se refiere al host especificado con el nombre de host. Formatee esta query según RFC 4515 y RFC 4516.

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

  • bindPassword string Requerido

    Contraseña que MongoDB Cloud utiliza para autenticar el bindUsername.

  • bindUsername string Requerido

    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 Requerido

    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) Requerido

    Puerto IANA al que el host del Protocolo Ligero de Acceso a Directorios (LDAP) escucha para conexiones del cliente.

    El valor por defecto es 636.

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • ID del grupo string

      string única de dígitos hexadecimales 24que identifica el Proyecto asociado a esta configuración de Lightweight Directory Access Protocol (LDAP) sobre Transport Layer Security (TLS).

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

    • Solicitud Objeto

      Solicita la información necesaria para verificar una configuración de Lightweight Directory Access Protocol (LDAP) sobre Transport Layer Security (TLS). La respuesta no devuelve bindPassword.

      Ocultar atributos de solicitud Mostrar atributos de la solicitud Objeto
      • bindUsername string Requerido

        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 Requerido

        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) Requerido

        Puerto IANA al que el host del Protocolo Ligero de Acceso a Directorios (LDAP) escucha para conexiones del cliente.

        El valor por defecto es 636.

    • requestId string

      Una 24-hexadecimal digit string única que identifica esta solicitud para verificar una configuración de Lightweight Directory Access Protocol (LDAP).

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

    • Estado string

      string legible por humanos que indica el estado de la configuración del protocolo Ligero de Acceso a directorio (LDAP) sobre la seguridad de la Capa de Transporte (TLS).

      Los valores son FAIL, PENDING o SUCCESS.

    • validación arreglo[objeto]

      Lista que contiene los mensajes de validación relacionados con la verificación de los detalles de configuración proporcionados de Protocolo ligero de acceso a directorios (LDAP) sobre Seguridad de la capa de transporte (TLS). La lista contiene un documento para cada prueba que ejecuta MongoDB nube. MongoDB nube deja de ejecutar pruebas después del primer fallo.

      Ocultar atributos de validación Mostrar atributos de validaciones Objeto

      Una prueba que ejecuta MongoDB Cloud para verificar los detalles de la configuración proporcionada del Protocolo Ligero de Acceso a Directorios (LDAP) sobre Capas de Seguridad de Transporte (TLS).

      • Estado string

        string legible para seres humanos que indica el resultado de esta prueba de verificación.

        Los valores son FAIL o OK.

      • validationType string

        Etiqueta legible por humanos que identifica esta prueba de verificación que ejecuta MongoDB Cloud.

        Los valores son AUTHENTICATE, AUTHORIZATION_ENABLED, CONNECT, PARSE_AUTHZ_QUERY, QUERY_SERVER, SERVER_SPECIFIED o TEMPLATE.

  • 400 aplicación/json

    Solicitud incorrecta.

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

      Detalle de solicitud incorrecta.

      Ocultar 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

      Código de error de aplicación devuelto 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.

  • 401 aplicación/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

      Ocultar 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

      Código de error de aplicación devuelto 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 aplicación/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

      Ocultar 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

      Código de error de aplicación devuelto 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 aplicación/json

    No se encontró.

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

      Detalle de solicitud incorrecta.

      Ocultar 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

      Código de error de aplicación devuelto 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 aplicación/json

    Error interno del servidor.

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

      Detalle de solicitud incorrecta.

      Ocultar 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

      Código de error de aplicación devuelto 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.

POST /api/atlas/v1.0/groups/{groupId}/userSecurity/ldap/verify
curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/userSecurity/ldap/verify' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"authzQueryTemplate":"{USER}?memberOf?base","bindPassword":"string","bindUsername":"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com","caCertificate":"string","hostname":"string","port":636}'
Solicitar ejemplos
{
  "authzQueryTemplate": "{USER}?memberOf?base",
  "bindPassword": "string",
  "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
  "caCertificate": "string",
  "hostname": "string",
  "port": 636
}
Ejemplos de respuestas (200)
{
  "groupId": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "request": {
    "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
  },
  "requestId": "32b6e34b3d91647abb20e7b8",
  "status": "FAIL",
  "validations": [
    {
      "status": "FAIL",
      "validationType": "AUTHENTICATE"
    }
  ]
}
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 (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"
}