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 ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /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 de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de consulta
-
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. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita
Cuerpo
Requerido
La configuración LDAP para el proyecto especificado que deseas verificar.
-
Plantilla de consulta del Protocolo Ligero de Acceso a Directorios (LDAP) que MongoDB Cloud aplica para crear una consulta 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.
Utilice el
{USER}marcador en el Localizador Uniforme de Recursos (URL) para sustituir el nombre de usuario autenticado. La consulta se relaciona con el host especificado con el nombre de host. Formatee esta consulta según las 4516 RFC 4515 y.El valor predeterminado es
{USER}?memberOf?base. -
Contraseña que utiliza MongoDB Cloud para autenticar el
bindUsername. -
Nombre distinguido (DN) completo del usuario del Protocolo ligero de acceso a directorios (LDAP) que MongoDB Cloud utiliza para conectarse al host LDAP. Los nombres distinguidos LDAP deben tener el formato RFC 2253.
El formato debe coincidir con el siguiente patrón:
^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$.Solicitud de comentarios 2253 -
Certificado de autoridad de certificación (CA) que MongoDB Cloud utiliza para verificar la identidad del host LDAP (Protocolo ligero de acceso a directorios). MongoDB Cloud permite certificados autofirmados. Para eliminar un valor asignado, pase una cadena vacía:
"caCertificate": "". -
Etiqueta legible que identifica el nombre de host o la dirección IP del host LDAP (Protocolo ligero de acceso a directorios). Este host debe tener acceso a internet o una conexión de peering de nube privada virtual (VPC) con el 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 en el que el host del Protocolo ligero de acceso a directorios (LDAP) escucha las conexiones del cliente.
El valor predeterminado es
636.
atlas api ldapConfiguration verifyUserSecurityLdap --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/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.VerifyGroupUserSecurityLdapApiParams{}
sdkResp, httpResp, err := client.LDAPConfigurationApi.
VerifyGroupUserSecurityLdapWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \
-d '{ <Payload> }'{
"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"
}