List UserGroups

GET

https://api.getzep.com/api/v2/user-groups

GET

/api/v2/user-groups

1 from zep_cloud import Zep
2 
3 client = Zep()
4 
5 client.user_group.list(
6     project_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
7     page_number=1,
8     page_size=20,
9     search="engineering",
10 )

1 {
2   "quota": {
3     "active_managed": 5,
4     "allocation": 10,
5     "has_feature": true,
6     "resolved": true,
7     "unlimited": false
8   },
9   "row_count": 2,
10   "total_count": 50,
11   "user_groups": [
12     {
13       "attached_policy_set_count": 3,
14       "created_at": "2024-05-10T09:15:00Z",
15       "description": "Engineering team user group",
16       "kind": "managed",
17       "member_count": 25,
18       "name": "Engineering Team",
19       "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
20       "updated_at": "2024-06-01T12:00:00Z",
21       "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
22       "version": 3
23     }
24   ]
25 }

Query parameters

projectIdstringRequired

Project UUID

pageNumberintegerRequired

Page number

pageSizeintegerRequired

Page size

searchstringOptional

Name search

Response

quotaobjectOptional

row_countintegerOptional

total_countintegerOptional

user_groupslist of objectsOptional

Errors

400

Bad Request Error

403

Forbidden Error