PingDirectory API Reference

READ search group members by group display name

GET {{apiPath}}/Groups/?filter=displayName eq "group-9"

Use the GET /Groups endpoint to filter for matching group member resources.

This example shows /Groups/?filter=displayName eq "group-9" using the group’s displayName query parameter and eq operator.

Prerequisites

If the request is valid, the response returns a 200 status code.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/scim+json

Accept      application/scim+json

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/Groups/?filter=displayName%20eq%20%22group-9%22' \
--header 'Accept: application/scim+json' \
--header 'Content-Type: application/scim+json' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/Groups/?filter=displayName eq \"group-9\"")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Accept", "application/scim+json");
request.AddHeader("Content-Type", "application/scim+json");
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}}/Groups/?filter=displayName%20eq%20%22group-9%22"
  method := "GET"

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/scim+json")
  req.Header.Add("Content-Type", "application/scim+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))
}
GET /Groups/?filter=displayName eq "group-9" HTTP/1.1
Host: {{apiPath}}
Accept: application/scim+json
Content-Type: application/scim+json
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/scim+json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/Groups/?filter=displayName eq \"group-9\"")
  .method("GET", body)
  .addHeader("Accept", "application/scim+json")
  .addHeader("Content-Type", "application/scim+json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/Groups/?filter=displayName eq \"group-9\"",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Accept": "application/scim+json",
    "Content-Type": "application/scim+json",
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/Groups/?filter=displayName eq "group-9"',
  'headers': {
    'Accept': 'application/scim+json',
    'Content-Type': 'application/scim+json',
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/Groups/?filter=displayName eq \"group-9\""

payload = {}
headers = {
  'Accept': 'application/scim+json',
  'Content-Type': 'application/scim+json',
  '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}}/Groups/?filter=displayName eq "group-9"');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Accept' => 'application/scim+json',
  'Content-Type' => 'application/scim+json',
  '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 "json"
require "net/http"

url = URI("{{apiPath}}/Groups/?filter=displayName eq \"group-9\"")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/scim+json"
request["Content-Type"] = "application/scim+json"
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/Groups/?filter=displayName%20eq%20%22group-9%22")!,timeoutInterval: Double.infinity)
request.addValue("application/scim+json", forHTTPHeaderField: "Accept")
request.addValue("application/scim+json", forHTTPHeaderField: "Content-Type")
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

{
    "displayName": "test-group",
    "members": {
        "value": [
            "uid=user.0,ou=People,dc=example,dc=com",
            "uid=user.1,ou=People,dc=example,dc=com",
            "uid=user.2,ou=People,dc=example,dc=com",
            "uid=user.3,ou=People,dc=example,dc=com",
            "uid=user.4,ou=People,dc=example,dc=com",
            "uid=user.5,ou=People,dc=example,dc=com",
            "uid=user.6,ou=People,dc=example,dc=com",
            "uid=user.7,ou=People,dc=example,dc=com",
            "uid=user.8,ou=People,dc=example,dc=com",
            "uid=user.9,ou=People,dc=example,dc=com"
        ]
    },
    "id": "1a8e021b-c7b0-4bd9-8e2d-af5691c035ce",
    "meta": {
        "resourceType": "Groups",
        "location": "https://example.com:443/scim/v2/Groups/1a8e021b-c7b0-4bd9-8e2d-af5691c035ce"
    },
    "schemas": [
        "urn:pingidentity:schemas:Group:1.0"
    ]
}