User group details (description, policies, visible members)
Read-only. The group's policies are shown to the member for reference (an admin edits them via /policy-groups). Only members visible to me are listed (visibility grant).
curl -X GET "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/user-groups/example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/user-groups/example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/user-groups/example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/user-groups/example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/user-groups/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"id": "example_string",
"name": "John Doe",
"description": "example_string",
"logoUri": "example_string",
"color": "example_string",
"emoji": "example_string",
"memberCount": 10,
"members": [
{
"id": "example_string",
"name": "John Doe",
"username": "John Doe",
"image": "example_string",
"color": "example_string",
"emoji": "example_string"
}
],
"policies": [
{
"id": "example_string",
"code": "example_string",
"name": "John Doe",
"description": "example_string",
"logoUri": "example_string",
"color": "example_string",
"emoji": "example_string",
"actionType": "example_string",
"effect": "example_string",
"enabled": true
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
GET
/api/v1/vaults/{code}/user-groups/{id}GET
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token
Bearer Tokenstring
RequiredSession token. Mobile/services. The web uses a cookie.
Session token. Mobile/services. The web uses a cookie.
API Key (cookie: session_token)
session_tokenstring
RequiredAPI key (sent in cookie)
path
codestring
RequiredUnique Vault code (slug)
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token. Session token. Mobile/services. The web uses a cookie.
path
parameterstring
RequiredAPI Key for authentication. Provide your API key in the cookie.
Path Parameters
Responses
idstring
Requirednamestring
Requireddescriptionstring
RequiredlogoUristring
Requiredcolorstring
Requiredemojistring
RequiredmemberCountinteger
RequiredTotal members
membersarray
RequiredMembers visible to me
policiesarray
RequiredWas this page helpful?