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/SSL configuration. Atlas returns an HTTP 404 error if you request the status of any request other than the most recent.

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

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

Syntax

POST /groups/{GROUP-ID}/userSecurity/ldap/verify/{REQUEST-ID}

Request Path Parameters

Parameter Required/Optional Description
GROUP-ID Required Identifier for the Atlas project associated with the verification request.
REQUEST-ID string Identifier of a request to verify an LDAP configuration. Returned in the response document to the /api/atlas/v1.0/groups/{GROUP-ID}/userSecurity/ldap/verify endpoint.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name Type Description Default
pretty boolean Display 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 -X GET -i -u "fred@example.com:457026b5-07a6-40a9-9706-ae0b374e775g" /
  --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/6b8df67087d9d615da86401c/userSecurity/ldap/verify/6bc01f8e87d9d61d96c1b635?pretty=true"

Example Response

The following example returns a status of SUCCESS.

{
  "groupId" : "6b8df67087d9d615da86401c",
  "links" : [ {
     "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/6b8df67087d9d615da86401c/userSecurity/ldap/verify/6bc01f8e87d9d61d96c1b635",
     "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" : "6bc01f8e87d9d61d96c1b635",
  "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"
  } ]
}