Navigation

Get Status of a Request to Verify LDAP Configuration

Returns the status of the most recent request for verification of an LDAP over TLS configuration. Atlas returns an HTTP 404 error if you request the status of any request other than the most recent.

Info With Circle IconCreated with Sketch.Note
  • Explaining RFC 4515 and RFC 4516 falls out of scope of the Atlas documentation. Review these RFCs or refer to your preferred LDAP documentation.
  • Groups and projects are synonymous. {GROUP-ID} and {PROJECT-ID} have the same meaning. The unique identifier for your existing projects/groups remains the same. This endpoint and corresponding endpoints use the terms groups and groupId.

https://cloud.mongodb.com/api/atlas/v1.0

GET /groups/{PROJECT-ID}/userSecurity/ldap/verify/{REQUEST-ID}
ParameterTypeNecessityDescription
PROJECT-IDstringRequiredUnique identifier for the Atlas project associated with the verification request.
REQUEST-IDstringRequiredUnique identifier of a request to verify an LDAP configuration. Returned in the response document to the Verify LDAP Configuration endpoint.

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.false

This endpoint does not use HTTP request body parameters.

NameTypeDescription
groupIdstringIdentifier for the Atlas project associated with the request to verify an LDAP over TLS/SSL configuration.
linksdocument arrayOne or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
requestdocumentContains the details of the request to verify an LDAP over TLS/SSL configuration. The bindPassword is not returned in the response.
request.bindUsernamestringThe user DN that Atlas uses to connect to the LDAP server.
request.hostnamestringThe hostname or IP address of the LDAP server.
request.portintegerThe port to which the LDAP server listens for client connections from Atlas.
requestIdstringThe unique identifer for the request to verify the LDAP over TLS/SSL configuration.
statusstringThe current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAIL.
validationsarray

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values are possible:

{
status: "OK" || "FAIL",
validationType: "SERVER_SPECIFIED"
}
{
status: "OK" || "FAIL",
validationType: "CONNECT"
}
{
status: "OK" || "FAIL",
validationType: "AUTHENTICATE"
}
{
status: "OK" || "FAIL",
validationType: "AUTHORIZATION_ENABLED"
}
{
status: "OK" || "FAIL",
validationType: "PARSE_AUTHZ_QUERY_TEMPLATE"
}
{
status: "OK" || "FAIL",
validationType: "QUERY_SERVER"
}

The following example requests the status of a request to verify an LDAP configuration.

curl --include --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--digest \
--request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/userSecurity/ldap/verify/{REQUEST-ID}?pretty=true"

The following example returns a status of SUCCESS.

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
1{
2 "groupId" : "{PROJECT-ID}",
3 "links" : [ {
4 "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/userSecurity/ldap/verify/{REQUEST-ID}",
5 "rel" : "self"
6 } ],
7 "request" : {
8 "bindUsername" : "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com",
9 "hostname" : "atlas-ldaps-01.ldap.myteam.com",
10 "port" : 636
11 },
12 "requestId" : "{REQUEST-ID}",
13 "status" : "SUCCESS",
14 "validations" : [ {
15 "status" : "OK",
16 "validationType" : "SERVER_SPECIFIED"
17 }, {
18 "status" : "OK",
19 "validationType" : "CONNECT"
20 }, {
21 "status" : "OK",
22 "validationType" : "AUTHENTICATE"
23 }, {
24 "status" : "OK",
25 "validationType" : "AUTHORIZATION_ENABLED"
26 }, {
27 "status" : "OK",
28 "validationType" : "PARSE_AUTHZ_QUERY_TEMPLATE"
29 }, {
30 "status" : "OK",
31 "validationType" : "QUERY_SERVER"
32 } ]
33}
Give Feedback