Synergy provides /api/groups
endpoint where applications can send HTTP GET request for list of available user groups within team. Request has to be authenticated using JWT token header (see authentication page ) either for current user or service itself. Mapping of team groups provided by Synergy to application roles is a responsibility of application. Interactive documentation is available on http://team1.synergy.cxn.io/swagger-ui.html#!/gateway45public45api45controller/listGroupsUsingGET (to try out change team1
to your subdomain and authorise the requests on gateway-public section by client id and client secret).
Example
HTTP GET https://team1.synergy.example.com/api/groups
Response Example
[
{
"id": 37,
"realm": 33,
"memberIds": [ 56 ],
"groupName": "TEAM_ADMIN",
"isTeamAdminGroup": true },
{
"id": 38,
"realm": 33,
"memberIds": [],
"groupName": "RESEARCHERS",
"isTeamAdminGroup": false
},
{
"id": 39,
"realm": 33,
"memberIds": [],
"groupName": "GUESTS",
"isTeamAdminGroup": false
}
]