Get users and groups in project | Unleash Documentation

curl https://app.unleash-instance.example.com/api/admin/projects/projectId/access \
     -H "Authorization: <apiKey>"

{
  "groups": [
    {
      "id": 1,
      "name": "DX team",
      "addedAt": "2023-08-01T14:35:16Z",
      "roleId": 5,
      "roles": [
        5
      ],
      "description": "Current members of the DX squad",
      "mappingsSSO": [
        "SSOGroup1",
        "SSOGroup2"
      ],
      "rootRole": 1,
      "createdBy": "admin",
      "createdAt": "2023-06-30T11:41:00.123Z",
      "users": [
        {
          "user": {
            "id": 123,
            "name": "User",
            "email": "user@example.com",
            "username": "hunter",
            "imageUrl": "https://example.com/242x200.png",
            "inviteLink": "http://localhost:4242/invite-link/some-secret",
            "loginAttempts": 3,
            "emailSent": false,
            "rootRole": 1,
            "seenAt": "2023-06-30T11:42:00.345Z",
            "createdAt": "2023-06-30T11:41:00.123Z",
            "accountType": "User",
            "permissions": [
              "string"
            ],
            "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
            "seatType": "Regular",
            "companyRole": "Developer",
            "productUpdatesEmailConsent": false,
            "activeSessions": 2,
            "deletedSessions": 1
          },
          "joinedAt": "2023-06-30T11:41:00.123Z",
          "createdBy": "admin"
        }
      ],
      "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
    }
  ],
  "users": [
    {
      "id": 1,
      "name": "Hunter Burgan",
      "email": "hunter@hunter.com",
      "imageUrl": "string",
      "addedAt": "2023-08-01T14:35:16Z",
      "roleId": 5,
      "roles": [
        5
      ],
      "isAPI": false
    }
  ],
  "roles": [
    {
      "id": 9,
      "type": "root",
      "name": "Editor",
      "description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
      "project": "default"
    }
  ]
}

curl https://app.unleash-instance.example.com/api/admin/projects/projectId/access \
     -H "Authorization: <apiKey>"

{
  "groups": [
    {
      "id": 1,
      "name": "DX team",
      "addedAt": "2023-08-01T14:35:16Z",
      "roleId": 5,
      "roles": [
        5
      ],
      "description": "Current members of the DX squad",
      "mappingsSSO": [
        "SSOGroup1",
        "SSOGroup2"
      ],
      "rootRole": 1,
      "createdBy": "admin",
      "createdAt": "2023-06-30T11:41:00.123Z",
      "users": [
        {
          "user": {
            "id": 123,
            "name": "User",
            "email": "user@example.com",
            "username": "hunter",
            "imageUrl": "https://example.com/242x200.png",
            "inviteLink": "http://localhost:4242/invite-link/some-secret",
            "loginAttempts": 3,
            "emailSent": false,
            "rootRole": 1,
            "seenAt": "2023-06-30T11:42:00.345Z",
            "createdAt": "2023-06-30T11:41:00.123Z",
            "accountType": "User",
            "permissions": [
              "string"
            ],
            "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
            "seatType": "Regular",
            "companyRole": "Developer",
            "productUpdatesEmailConsent": false,
            "activeSessions": 2,
            "deletedSessions": 1
          },
          "joinedAt": "2023-06-30T11:41:00.123Z",
          "createdBy": "admin"
        }
      ],
      "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
    }
  ],
  "users": [
    {
      "id": 1,
      "name": "Hunter Burgan",
      "email": "hunter@hunter.com",
      "imageUrl": "string",
      "addedAt": "2023-08-01T14:35:16Z",
      "roleId": 5,
      "roles": [
        5
      ],
      "isAPI": false
    }
  ],
  "roles": [
    {
      "id": 9,
      "type": "root",
      "name": "Editor",
      "description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
      "project": "default"
    }
  ]
}

Enterprise feature

Get all groups, users and their roles, and available roles for the given project.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

projectIdstringRequired

Response

projectAccessSchema

groupslist of objects

A list of groups that have access to this project

userslist of objects

A list of users and their roles within this project

roleslist of objects

A list of roles that are available within this project.

Errors

401

Unauthorized Error

403

Forbidden Error

$	curl https://app.unleash-instance.example.com/api/admin/projects/projectId/access \
>	-H "Authorization: <apiKey>"

1	{
2	"groups": [
3	{
4	"id": 1,
5	"name": "DX team",
6	"addedAt": "2023-08-01T14:35:16Z",
7	"roleId": 5,
8	"roles": [
9	5
10	],
11	"description": "Current members of the DX squad",
12	"mappingsSSO": [
13	"SSOGroup1",
14	"SSOGroup2"
15	],
16	"rootRole": 1,
17	"createdBy": "admin",
18	"createdAt": "2023-06-30T11:41:00.123Z",
19	"users": [
20	{
21	"user": {
22	"id": 123,
23	"name": "User",
24	"email": "user@example.com",
25	"username": "hunter",
26	"imageUrl": "https://example.com/242x200.png",
27	"inviteLink": "http://localhost:4242/invite-link/some-secret",
28	"loginAttempts": 3,
29	"emailSent": false,
30	"rootRole": 1,
31	"seenAt": "2023-06-30T11:42:00.345Z",
32	"createdAt": "2023-06-30T11:41:00.123Z",
33	"accountType": "User",
34	"permissions": [
35	"string"
36	],
37	"scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
38	"seatType": "Regular",
39	"companyRole": "Developer",
40	"productUpdatesEmailConsent": false,
41	"activeSessions": 2,
42	"deletedSessions": 1
43	},
44	"joinedAt": "2023-06-30T11:41:00.123Z",
45	"createdBy": "admin"
46	}
47	],
48	"scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
49	}
50	],
51	"users": [
52	{
53	"id": 1,
54	"name": "Hunter Burgan",
55	"email": "hunter@hunter.com",
56	"imageUrl": "string",
57	"addedAt": "2023-08-01T14:35:16Z",
58	"roleId": 5,
59	"roles": [
60	5
61	],
62	"isAPI": false
63	}
64	],
65	"roles": [
66	{
67	"id": 9,
68	"type": "root",
69	"name": "Editor",
70	"description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
71	"project": "default"
72	}
73	]
74	}