PingOne Platform APIs

Step 5: Read all users in a group

 

GET {{apiPath}}/environments/{{envID}}/users?filter=memberOfGroups[id eq "{{UseCaseGroupID}}"]

The GET /environments/{{envID}}/users?filter=memberOfGroups[id eq "{{groupID}}"] operation modifies the returns all the users request. The added filter lists all users that belong to the specified group.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{UseCaseGroupID}}%22]' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users?filter=memberOfGroups[id eq \"{{UseCaseGroupID}}\"]")
{
  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}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{UseCaseGroupID}}%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 /environments/{{envID}}/users?filter=memberOfGroups[id eq "{{UseCaseGroupID}}"] 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}}/environments/{{envID}}/users?filter=memberOfGroups[id eq \"{{UseCaseGroupID}}\"]")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/users?filter=memberOfGroups[id eq \"{{UseCaseGroupID}}\"]",
  "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}}/environments/{{envID}}/users?filter=memberOfGroups[id eq "{{UseCaseGroupID}}"]',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{apiPath}}/environments/{{envID}}/users?filter=memberOfGroups[id eq \"{{UseCaseGroupID}}\"]"

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}}/environments/{{envID}}/users?filter=memberOfGroups[id eq "{{UseCaseGroupID}}"]');
$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}}/environments/{{envID}}/users?filter=memberOfGroups[id eq \"{{UseCaseGroupID}}\"]")

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}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{UseCaseGroupID}}%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://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?limit=100&filter=memberOfGroups%5Bid%20eq%20%2205e68035-b323-4165-9b65-95fa1b0df878%22%5D"
        }
    },
    "_embedded": {
        "users": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/7edab314-8ed8-40d9-b66d-f6714a35ba02"
                    },
                    "password": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/7edab314-8ed8-40d9-b66d-f6714a35ba02/password"
                    },
                    "password.set": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/7edab314-8ed8-40d9-b66d-f6714a35ba02/password"
                    },
                    "password.reset": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/7edab314-8ed8-40d9-b66d-f6714a35ba02/password"
                    },
                    "password.check": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/7edab314-8ed8-40d9-b66d-f6714a35ba02/password"
                    },
                    "password.recover": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/7edab314-8ed8-40d9-b66d-f6714a35ba02/password"
                    },
                    "account.sendVerificationCode": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/7edab314-8ed8-40d9-b66d-f6714a35ba02"
                    },
                    "linkedAccounts": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/7edab314-8ed8-40d9-b66d-f6714a35ba02/linkedAccounts"
                    }
                },
                "id": "7edab314-8ed8-40d9-b66d-f6714a35ba02",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "account": {
                    "canAuthenticate": true,
                    "status": "OK"
                },
                "createdAt": "2023-06-28T15:29:26.630Z",
                "email": "example@pingidentity.com",
                "enabled": true,
                "identityProvider": {
                    "type": "PING_ONE"
                },
                "lifecycle": {
                    "status": "ACCOUNT_OK"
                },
                "mfaEnabled": false,
                "name": {
                    "given": "Test",
                    "family": "GroupUser"
                },
                "population": {
                    "id": "397c0200-4b75-4a8e-ac08-cfe4bd128e16"
                },
                "updatedAt": "2023-06-28T15:30:36.243Z",
                "username": "usecasegroup_user_1687966166",
                "verifyStatus": "NOT_INITIATED"
            }
        ]
    },
    "count": 1,
    "size": 1
}