Users
Get a list of groups
Enterprise feature
Get a list of user groups for Role-Based Access Control
get/api/admin/groups
Response
groupsSchema
Example response
{
"groups": [
{
"id": 1,
"name": "DX team",
"description": "Current members of the DX squad",
"mappingsSSO": [
"SSOGroup1",
"SSOGroup2"
],
"rootRole": 1,
"createdBy": "admin",
"createdAt": "2023-06-30T11:41:00.123Z",
"users": [
{
"joinedAt": "2023-06-30T11:41:00.123Z",
"createdBy": "admin",
"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,
"rootRole": 1,
"seenAt": "2023-06-30T11:42:00.345Z",
"createdAt": "2023-06-30T11:41:00.123Z",
"accountType": "User",
"scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
"seatType": "Regular",
"companyRole": "Developer",
"activeSessions": 2,
"deletedSessions": 1
}
}
],
"projects": [
"default",
"my-project"
],
"userCount": 1,
"scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
}
]
}Changes
Changed in 2 of the 7 revisions of this API.3
- ○
added the optional property
/////to the response with the statusresponse-optional-property-added
- ○
added the optional property
/////to the response with the statusresponse-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the optional property
/////to the response with the statusresponse-optional-property-added
- ○