Skip to main content

Get user group

GET 
/groups-srv/usergroups/:groupId

This API retrieves user group for given groupId; By passing the query parameters with the groupId you can also get the information about the allowed roles, mapped user subgroups, etc.

Parameters:

  • groupId (path, required): The unique group identifier to retrieve
  • extendedView (query, optional, default: false): Returns extended view including group type information
  • allowedRoles (query, optional, default: false): Returns all currently allowed roles for this group based on groupType configuration
  • includeSubGroups (query, optional, default: false): Returns all subgroups mapped to this group

Response Formats:

  • Default: Returns basic user group information
  • With extendedView=true: Returns user group with embedded group type details
  • With allowedRoles=true: Returns user group with list of allowed roles
  • With includeSubGroups=true: Returns user group with all its subgroups

Validation Rules:

  • groupId: Required, must be a valid group identifier, case-sensitive
  • Group must exist in the system
  • Only one query parameter can be used at a time (extendedView, allowedRoles, or includeSubGroups)

Business Rules:

  • The allowedRoles query returns roles based on the group's groupType configuration
  • If groupType has roleMode: allowed_roles, returns the list from groupType's allowedRoles
  • If groupType has roleMode: any_roles, returns all available roles in the system
  • If groupType has roleMode: no_roles, returns an empty array

Note: You can only pass one query parameter in this request and select the response format depending on the query parameter.

Request​

Responses​

OK