Get a list of groups

GET

https://app.unleash-instance.example.com/api/admin/groups

GET

/api/admin/groups

1 var client = new RestClient("https://app.unleash-instance.example.com/api/admin/groups");
2 var request = new RestRequest(Method.GET);
3 request.AddHeader("Authorization", "<apiKey>");
4 IRestResponse response = client.Execute(request);

Try it

1 {
2   "groups": [
3     {
4       "name": "DX team",
5       "id": 1,
6       "description": "Current members of the DX squad",
7       "mappingsSSO": [
8         "SSOGroup1",
9         "SSOGroup2"
10       ],
11       "rootRole": 1,
12       "createdBy": "admin",
13       "createdAt": "2023-06-30T11:41:00.123Z",
14       "users": [
15         {
16           "user": {
17             "id": 123,
18             "name": "User",
19             "email": "user@example.com",
20             "username": "hunter",
21             "imageUrl": "https://example.com/242x200.png",
22             "inviteLink": "http://localhost:4242/invite-link/some-secret",
23             "loginAttempts": 3,
24             "emailSent": false,
25             "rootRole": 1,
26             "seenAt": "2023-06-30T11:42:00.345Z",
27             "createdAt": "2023-06-30T11:41:00.123Z",
28             "accountType": "User",
29             "permissions": [
30               "string"
31             ],
32             "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
33             "seatType": "Regular",
34             "activeSessions": 2,
35             "deletedSessions": 1
36           },
37           "joinedAt": "2023-06-30T11:41:00.123Z",
38           "createdBy": "admin"
39         }
40       ],
41       "projects": [
42         "default",
43         "my-project"
44       ],
45       "userCount": 1,
46       "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
47     }
48   ]
49 }

Enterprise feature

Get a list of user groups for Role-Based Access Control

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Response

groupsSchema

groupslist of objects or null

A list of groups

Authentication

Response

Errors