Skip to main content
Browse Documentation
HTTP - Management

Get group membership for a user

Created by c.neale, last modified by s.yearsley on 25 Sep 2020

Gets the groups the user is a member of.

GET/api/security/users/{userIdentifier}/groups

Parameters

NameParameter typeTypeFormatDescriptionExampleRequired
UserIdentifierpathstringuser identifierFor convenience, User resources can be referenced by using one of several identifiers - username, email address or Id."82f73a9b-2a13-4d63-bcc1-e8ee5047b01c" or "t.durden" or "t.durden@fightclub.com"true
includeInheritedquerybooleanA flag to determine whether groups a user is implicitly a member of by child groups relationships should also be returned. The default is false.true

Examples

GET: /api/security/users/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c/groups?includeInherited=true
GET: /api/security/users/tdurden/groups?includeInherited=true
GET: /api/security/users/t.durden@fightclub.com/groups?includeInherited=true

Responses

HTTP status codeReasonModel
401UnauthorizedError
403ForbiddenError
404User not foundError
500Internal server errorError