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.

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.

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

Syntax

GET /groups/{PROJECT-ID}/userSecurity/ldap/verify/{REQUEST-ID}

Request Path Parameters

Parameter Type Necessity Description
PROJECT-ID string Required Unique identifier for the Atlas project associated with the verification request.
REQUEST-ID string Required Unique identifier of a request to verify an LDAP configuration. Returned in the response document to the Verify LDAP Configuration endpoint.

Request Query Parameters

The following query parameters are optional:

Query Parameter Type Description Default
pretty boolean Displays response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

Name Type Description
groupId string Identifier for the Atlas project associated with the request to verify an LDAP over TLS/SSL configuration.
links document array One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
request document Contains the details of the request to verify an LDAP over TLS/SSL configuration. The bindPassword is not returned in the response.
request.bindUsername string The user DN that Atlas uses to connect to the LDAP server.
request.hostname string The hostname or IP address of the LDAP server.
request.port integer The port to which the LDAP server listens for client connections from Atlas.
requestId string The unique identifer for the request to verify the LDAP over TLS/SSL configuration.
status string The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAIL.
validations array

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"
}

Example Request

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"

Example Response

The following example returns a status of SUCCESS.

Response Header

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}

Response Body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
  "groupId" : "{PROJECT-ID}",
  "links" : [ {
     "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/userSecurity/ldap/verify/{REQUEST-ID}",
     "rel" : "self"
  } ],
  "request" : {
  "bindUsername" : "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com",
  "hostname" : "atlas-ldaps-01.ldap.myteam.com",
  "port" : 636
  },
  "requestId" : "{REQUEST-ID}",
  "status" : "SUCCESS",
  "validations" : [ {
    "status" : "OK",
    "validationType" : "SERVER_SPECIFIED"
  }, {
    "status" : "OK",
    "validationType" : "CONNECT"
  }, {
    "status" : "OK",
    "validationType" : "AUTHENTICATE"
  }, {
    "status" : "OK",
    "validationType" : "AUTHORIZATION_ENABLED"
  }, {
    "status" : "OK",
    "validationType" : "PARSE_AUTHZ_QUERY_TEMPLATE"
  }, {
    "status" : "OK",
    "validationType" : "QUERY_SERVER"
  } ]
}