PingOne Platform APIs

Read All Users in a Group

 

GET {{apiPath}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{groupID}}%22]

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

For more information about groups, refer to Groups.

Query parameters
Parameter Description

filter

The value memberOfGroups[id eq "{{groupID}}"] is required for this request.

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{{groupID}}%22]' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{groupID}}%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}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{groupID}}%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%20eq%20%22{{groupID}}%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}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{groupID}}%22]")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{groupID}}%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}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{groupID}}%22]',
  '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%20eq%20%22{{groupID}}%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}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{groupID}}%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}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{groupID}}%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}}/environments/{{envID}}/users?filter=memberOfGroups[id%20eq%20%22{{groupID}}%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%2265631016-ecfc-4ba6-8cc0-bcc548eb58e2%22%5D"
        }
    },
    "_embedded": {
        "users": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c56e6c1a-502c-4f21-9819-9ed5a894aa7c"
                    },
                    "password": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c56e6c1a-502c-4f21-9819-9ed5a894aa7c/password"
                    },
                    "password.set": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c56e6c1a-502c-4f21-9819-9ed5a894aa7c/password"
                    },
                    "password.reset": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c56e6c1a-502c-4f21-9819-9ed5a894aa7c/password"
                    },
                    "password.check": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c56e6c1a-502c-4f21-9819-9ed5a894aa7c/password"
                    },
                    "password.recover": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c56e6c1a-502c-4f21-9819-9ed5a894aa7c/password"
                    },
                    "account.sendVerificationCode": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c56e6c1a-502c-4f21-9819-9ed5a894aa7c"
                    },
                    "linkedAccounts": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c56e6c1a-502c-4f21-9819-9ed5a894aa7c/linkedAccounts"
                    }
                },
                "id": "c56e6c1a-502c-4f21-9819-9ed5a894aa7c",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2020-02-05T00:24:48.157Z",
                "email": "gracepotter@example.com",
                "enabled": true,
                "lifecycle": {
                    "status": "ACCOUNT_OK"
                },
                "mfaEnabled": true,
                "name": {
                    "given": "Grace",
                    "family": "Potter"
                },
                "population": {
                    "id": "57f237fa-7de7-49b5-a769-f516983d36dc"
                },
                "timezone": "America/Los_Angeles",
                "updatedAt": "2020-11-20T16:56:34.742Z",
                "username": "gracepotter"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab"
                    },
                    "password": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/password"
                    },
                    "password.set": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/password"
                    },
                    "password.reset": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/password"
                    },
                    "password.check": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/password"
                    },
                    "password.recover": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/password"
                    },
                    "account.sendVerificationCode": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab"
                    },
                    "linkedAccounts": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/linkedAccounts"
                    }
                },
                "_embedded": {
                    "password": {
                        "status": "PASSWORD_EXPIRED"
                    }
                },
                "id": "8376797d-641c-4e7b-8bc1-2fdf71916cab",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2020-02-18T20:50:14.092Z",
                "email": "tomjones@example.com",
                "enabled": true,
                "lifecycle": {
                    "status": "ACCOUNT_OK"
                },
                "mfaEnabled": false,
                "name": {
                    "given": "Tom",
                    "family": "Jones"
                },
                "population": {
                    "id": "60971d3b-cc5a-4601-9c44-2be541f91bf1"
                },
                "updatedAt": "2020-11-20T17:00:01.264Z",
                "username": "tomjones"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702"
                    },
                    "password": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/password"
                    },
                    "password.set": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/password"
                    },
                    "password.reset": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/password"
                    },
                    "password.check": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/password"
                    },
                    "password.recover": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/password"
                    },
                    "account.sendVerificationCode": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702"
                    },
                    "linkedAccounts": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/linkedAccounts"
                    }
                },
                "_embedded": {
                    "password": {
                        "status": "PASSWORD_EXPIRED"
                    }
                },
                "id": "c98fd0cc-c34b-406a-9e0b-a892edb7a702",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2020-03-23T19:16:37.492Z",
                "email": "jonnydemo@example.com",
                "enabled": true,
                "lifecycle": {
                    "status": "ACCOUNT_OK"
                },
                "mfaEnabled": false,
                "name": {
                    "given": "Jonny",
                    "family": "Demo"
                },
                "population": {
                    "id": "de028bad-c535-40f4-b1d1-2987dc4ab00c"
                },
                "updatedAt": "2020-11-20T17:50:47.680Z",
                "username": "jonnydemo"
            }
        ]
    },
    "count": 3,
    "size": 3
}