List group members
curl --request GET \
--url https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members \
--header 'Authorization: Bearer <token>'import requests
url = "https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"subject": "12345678901",
"display_name": "João Silva",
"joined_at": "2024-01-15T10:30:00Z",
"added_by": "98765432109"
},
{
"subject": "23456789012",
"display_name": "Maria Santos",
"joined_at": "2024-01-10T09:15:00Z",
"added_by": "98765432109"
}
]{
"detail": "Could not validate credentials"
}{
"detail": "Permission denied to view members of group 'engineering_team:backend'"
}{
"detail": "Group 'unknown-group' not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Failed to retrieve group members: Database connection error"
}memberships
List group members
List all members of a specific group with their membership details.
Authorization: Users can view members of groups they have permission to access. Permissions are checked via Cerbos policies.
Member Information: Returns each member’s CPF, display name (if available), join timestamp, and who added them to the group.
Use Cases:
- View team composition
- Audit group membership
- Administrative oversight
- Access control verification
Sorting: Members are returned sorted by join date (newest first).
GET
/
api
/
v1
/
groups
/
{group_name}
/
members
List group members
curl --request GET \
--url https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members \
--header 'Authorization: Bearer <token>'import requests
url = "https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"subject": "12345678901",
"display_name": "João Silva",
"joined_at": "2024-01-15T10:30:00Z",
"added_by": "98765432109"
},
{
"subject": "23456789012",
"display_name": "Maria Santos",
"joined_at": "2024-01-10T09:15:00Z",
"added_by": "98765432109"
}
]{
"detail": "Could not validate credentials"
}{
"detail": "Permission denied to view members of group 'engineering_team:backend'"
}{
"detail": "Group 'unknown-group' not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Failed to retrieve group members: Database connection error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
List of group members retrieved successfully
User's CPF (Brazilian tax ID)
Example:
"12345678901"
ISO timestamp when the user joined the group
Example:
"2024-01-15T10:30:00Z"
User's display name if available
Example:
"João Silva"
CPF of the user who added this member
Example:
"98765432109"
