List All Entries (Filter Entries)
GET {{apiPath}}/directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22
The GET /directory/v1/{{dn}}/subtree endpoint supports a SCIM filtering parameter to limit the returned result set to those entries meeting the specified criteria. For example, the request below uses the filter objectClass eq "person" and sn eq "Jones" to search for all people with the last name of Jones.
curl -X "GET" "https://ds.example.com/directory/v1/ou=people,dc=example,dc=com/subtree?searchScope=wholeSubtree&filter=objectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22" \
-H 'Content-type: application/json' \
-H 'Authorization: Bearer accessToken'
In the Authorization request header field, the accessToken value is your full base64url-encoded JSON web token generated by the authentication service.
Filtering is done before pagination of the response data. The filter parameter is encoded into the cursor pagination parameter; it only needs to be provided in the first request.
For more information about filtering, refer to Conventions.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22=' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22=")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22="
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
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))
}
GET /directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22= HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22=")
.method("GET", body)
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22=",
"method": "GET",
"timeout": 0,
"headers": {
"Authorization": "Bearer {{accessToken}}"
},
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'GET',
'url': '{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22=',
'headers': {
'Authorization': 'Bearer {{accessToken}}'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22="
payload = {}
headers = {
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("GET", 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?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22=');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Authorization' => 'Bearer {{accessToken}}'
));
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 "net/http"
url = URI("{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22=")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"
response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope%3DwholeSubtree%26filter%3DobjectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22=")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "GET"
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?searchScope=wholeSubtree&ldapFilter=objectClass%20eq%20%22person%22%20and%20sn%20eq%20%22Jones%22"
}
},
"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"
}
}
}
]
}
}