Skip to main content

Get user group relation

GET 

/groups-srv/usergroups/:groupId/users/:sub

This API call retrieves the user group map for a user in group groupId.

Parameters:

  • groupId (path, required): The unique group identifier
  • sub (path, required): The user ID to retrieve the group membership for

Validation Rules:

  • groupId: Required, must be a valid group identifier, group must exist
  • sub: Required, must be a valid user ID (UUID format), user must exist
  • The user group map must exist (user must be a member of the group)

Usage:

  • Use this endpoint to check if a specific user is a member of a specific group
  • Returns the roles assigned to the user in this group
  • Useful for authorization checks and role verification

Request

Responses

OK - User group map retrieved successfully