Lists all user-groups in which the authenticated user is a member. Information about members is restricted only to group admins with GROUP_ADMIN role.

Available in: full version

Method: GET

Service URL: root/group

Header Parameter

Request with cURL:

curl -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOj' 
      http://localhost:8089/api/v1.0/group

Request with Basic authentication (for testing only):

Retrieve user-groups of marlin

curl -H 'Authorization: Basic bWFybGluOnBhc3N3b3Jk' 
      http://localhost:8089/api/v1.0/group

Response

User marlin has send the request to list user-groups. The first group belongs to him so he has the GROUP_ADMIN role and may see the members of the group. The status of the group is active.

In the 2nd group, marlin is not a group admin, so members are not shown.

[
    {
        "id": 1,
        "name": "marlin group",
        "owner": "marlin",
        "description" : "This group belongs to marlin."
        "status": "ACTIVE",
        "members": [
            {
                "userId": "marlin",
                "roles": [
                    "GROUP_ADMIN"
                ],
                "privileges" : [
                    "READ_MEMBER",
                    "WRITE_MEMBER",
                    "DELETE_MEMBER",
                    "SHARE_QUERY",
                    "DELETE_QUERY"
                ]
            },
            {
                "userId": "dory",
                "roles": [
                    "GROUP_ADMIN"
                ]
            }
        ]
    },
    {
        "id": 2,
        "name": "dory group",
        "owner": "dory"        
    }
]