Skip to main content
GET
/
identity
/
groups
Get a User's Groups
curl --request GET \
  --url http://{host}:{port}/{contextPath}/identity/groups \
  --header 'Authorization: Basic <encoded-value>'
{
  "groups": [
    {
      "id": "group1Id",
      "name": "group1"
    }
  ],
  "groupUsers": [
    {
      "firstName": "firstName",
      "lastName": "lastName",
      "displayName": "firstName lastName",
      "id": "anotherUserId"
    }
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

userId
string
required

The id of the user to get the groups for.

Response

Request successful.

groups
object[] | null

An array of group objects.

groupUsers
object[] | null

An array that contains all users that are member in one of the groups.