Search Using POST

POST {{apiPath}}/directory/v1/{{dn}}/subtree/search

You can also search using a POST /directory/v1/{{dn}}/subtree/search request to avoid placing confidential information in the request URI. Any parameters that are typically placed in the query string are passed in as a JSON object in the request body. The self and next links in the response have data attributes that contain the request body associated with the link.

Headers

Authorization Bearer {{accessToken}}

Content-Type application/json

Body

raw ( application/json )

{
    "filter": "objectClass eq \"person\" and sn eq \"Jones\"",
    "searchScope": "wholeSubtree",
    "limit": 20,
    "includeAttributes": "*,_operationalAttributes",
    "excludeAttributes": "sn,isMemberOf"
}

Example Request

curl --location --globoff '{{apiPath}}/directory/v1/{{dn}}/subtree/search' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "filter": "objectClass eq \"person\" and sn eq \"Jones\"",
    "searchScope": "wholeSubtree",
    "limit": 20,
    "includeAttributes": "*,_operationalAttributes",
    "excludeAttributes": "sn,isMemberOf"
}'

var options = new RestClientOptions("{{apiPath}}/directory/v1/{{dn}}/subtree/search")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""filter"": ""objectClass eq \""person\"" and sn eq \""Jones\""""," + "\n" +
@"    ""searchScope"": ""wholeSubtree""," + "\n" +
@"    ""limit"": 20," + "\n" +
@"    ""includeAttributes"": ""*,_operationalAttributes""," + "\n" +
@"    ""excludeAttributes"": ""sn,isMemberOf""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/directory/v1/{{dn}}/subtree/search"
  method := "POST"

  payload := strings.NewReader(`{
    "filter": "objectClass eq \"person\" and sn eq \"Jones\"",
    "searchScope": "wholeSubtree",
    "limit": 20,
    "includeAttributes": "*,_operationalAttributes",
    "excludeAttributes": "sn,isMemberOf"
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

POST /directory/v1/{{dn}}/subtree/search HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "filter": "objectClass eq \"person\" and sn eq \"Jones\"",
    "searchScope": "wholeSubtree",
    "limit": 20,
    "includeAttributes": "*,_operationalAttributes",
    "excludeAttributes": "sn,isMemberOf"
}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"filter\": \"objectClass eq \\\"person\\\" and sn eq \\\"Jones\\\"\",\n    \"searchScope\": \"wholeSubtree\",\n    \"limit\": 20,\n    \"includeAttributes\": \"*,_operationalAttributes\",\n    \"excludeAttributes\": \"sn,isMemberOf\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/directory/v1/{{dn}}/subtree/search")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/directory/v1/{{dn}}/subtree/search",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "filter": "objectClass eq \"person\" and sn eq \"Jones\"",
    "searchScope": "wholeSubtree",
    "limit": 20,
    "includeAttributes": "*,_operationalAttributes",
    "excludeAttributes": "sn,isMemberOf"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/directory/v1/{{dn}}/subtree/search',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "filter": "objectClass eq \"person\" and sn eq \"Jones\"",
    "searchScope": "wholeSubtree",
    "limit": 20,
    "includeAttributes": "*,_operationalAttributes",
    "excludeAttributes": "sn,isMemberOf"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests
import json

url = "{{apiPath}}/directory/v1/{{dn}}/subtree/search"

payload = json.dumps({
  "filter": "objectClass eq \"person\" and sn eq \"Jones\"",
  "searchScope": "wholeSubtree",
  "limit": 20,
  "includeAttributes": "*,_operationalAttributes",
  "excludeAttributes": "sn,isMemberOf"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/directory/v1/{{dn}}/subtree/search');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "filter": "objectClass eq \\"person\\" and sn eq \\"Jones\\"",\n    "searchScope": "wholeSubtree",\n    "limit": 20,\n    "includeAttributes": "*,_operationalAttributes",\n    "excludeAttributes": "sn,isMemberOf"\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/directory/v1/{{dn}}/subtree/search")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "filter": "objectClass eq \"person\" and sn eq \"Jones\"",
  "searchScope": "wholeSubtree",
  "limit": 20,
  "includeAttributes": "*,_operationalAttributes",
  "excludeAttributes": "sn,isMemberOf"
})

response = http.request(request)
puts response.read_body

let parameters = "{\n    \"filter\": \"objectClass eq \\\"person\\\" and sn eq \\\"Jones\\\"\",\n    \"searchScope\": \"wholeSubtree\",\n    \"limit\": 20,\n    \"includeAttributes\": \"*,_operationalAttributes\",\n    \"excludeAttributes\": \"sn,isMemberOf\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/directory/v1/{{dn}}/subtree/search")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://ds.example.com/directory/v1/ou=people,dc=example,dc=com/subtree/search",
            "data": {
                "filter": "objectClass eq \"person\" and sn eq \"Jones\"",
                "searchScope": "wholeSubtree",
                "limit": 20,
                "includeAttributes": "*,_operationalAttributes",
                "excludeAttributes": "sn,isMemberOf"
            }
        }
    },
    "size": 1,
    "_embedded": {
        "entries": [
            {
                "_dn": "uid=lindajones,ou=people,dc=example,dc=com",
                "objectClass": [
                    "top",
                    "person",
                    "organizationalPerson",
                    "inetOrgPerson"
                ],
                "uid": [
                    "lindajones"
                ],
                "cn": [
                    "Linda Jones"
                ],
                "sn": [
                    "Jones"
                ],
                "_links": {
                    "schemas": [
                        {
                            "href": "https://ds.example.com/directory/v1/schemas/inetOrgPerson"
                        }
                    ],
                    "self": {
                        "href": "https://ds.example.com/directory/v1/uid=lindajones,ou=people,dc=example,dc=com"
                    }
                }
            }
        ]
    }
}

PingDirectory API Reference

Search Using POST

Headers

Body

Example Request

Example Response