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
-
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
-
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. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.Impresión bonita
Cuerpo
Requerido
La configuración LDAP para el proyecto especificado que deseas verificar.
-
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. -
Contraseña que MongoDB Cloud utiliza para autenticar el
bindUsername. -
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 -
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": "". -
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 IANA al que el host del Protocolo Ligero de Acceso a Directorios (LDAP) escucha para conexiones del cliente.
El valor por defecto es
636.
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}'
{
"authzQueryTemplate": "{USER}?memberOf?base",
"bindPassword": "string",
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"port": 636
}
{
"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"
}
]
}
{
"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": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}