PingOne Platform APIs

Read All Group Memberships for User

 

GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/memberOfGroups?expand=group&limit=100

The GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/memberOfGroups operation returns all groups that the specified user is a member of.

For more information about groups, refer to Groups.

Query parameters
Parameter Description

expand (string)

Possible value is group. When this parameter is appended to the request, the results are expanded to include additional information about each group.

limit (int)

The maximum number of results returned per page.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/users/{{userID}}/memberOfGroups?expand=group&limit=100' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users/{{userID}}/memberOfGroups?expand=group&limit=100")
{
  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/{{userID}}/memberOfGroups?expand=group&limit=100"
  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/{{userID}}/memberOfGroups?expand=group&limit=100 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/{{userID}}/memberOfGroups?expand=group&limit=100")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/users/{{userID}}/memberOfGroups?expand=group&limit=100",
  "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/{{userID}}/memberOfGroups?expand=group&limit=100',
  '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/{{userID}}/memberOfGroups?expand=group&limit=100"

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/{{userID}}/memberOfGroups?expand=group&limit=100');
$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/{{userID}}/memberOfGroups?expand=group&limit=100")

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/{{userID}}/memberOfGroups?expand=group&limit=100")!,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/328b2d99-59fd-41e7-8469-2172655fbbae/memberOfGroups?limit=100&expand=group"
        }
    },
    "_embedded": {
        "groupMemberships": [
            {
                "_links": {
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/users/328b2d99-59fd-41e7-8469-2172655fbbae/memberOfGroups/d9b142b1-e55e-44ce-a0cd-feeb4dd0944b"
                    },
                    "user": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/d9b142b1-e55e-44ce-a0cd-feeb4dd0944b"
                    },
                    "group": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups/d9b142b1-e55e-44ce-a0cd-feeb4dd0944b"
                    }
                },
                "_embedded": {
                    "group": {
                        "_links": {
                            "self": {
                                "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups/d9b142b1-e55e-44ce-a0cd-feeb4dd0944b"
                            },
                            "environment": {
                                "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                            },
                            "allUserMembers": {
                                "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%20eq%20%22d9b142b1-e55e-44ce-a0cd-feeb4dd0944b%22%5D"
                            },
                            "directUserMembers": {
                                "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%20eq%20%22d9b142b1-e55e-44ce-a0cd-feeb4dd0944b%22%20and%20type%20eq%20%22DIRECT%22%5D"
                            },
                            "allGroupMembers": {
                                "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups?filter=memberOfGroups%5Bid%20eq%20%22d9b142b1-e55e-44ce-a0cd-feeb4dd0944b%22%5D"
                            },
                            "directGroupMembers": {
                                "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups?filter=memberOfGroups%5Bid%20eq%20%22d9b142b1-e55e-44ce-a0cd-feeb4dd0944b%22%20and%20type%20eq%20%22DIRECT%22%5D"
                            }
                        },
                        "id": "d9b142b1-e55e-44ce-a0cd-feeb4dd0944b",
                        "environment": {
                            "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                        },
                        "name": "Sample Group",
                        "description": "This is a sample group created for trial demonstration purposes.",
                        "createdAt": "2021-05-12T18:32:14.826Z",
                        "updatedAt": "2021-05-12T18:32:14.826Z",
                        "checkSum": "19138920744",
                        "userFilter": "population.id eq \"0353b962-cf0b-4149-8d1b-084e33814924\"",
                        "isProvisioned": false,
                        "isExternal": false,
                        "isAdmin": false
                    }
                },
                "id": "d9b142b1-e55e-44ce-a0cd-feeb4dd0944b",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "Sample Group",
                "isExternal": false,
                "type": "INDIRECT"
            }
        ]
    },
    "count": 1,
    "size": 1
}